1% texinfo.tex -- TeX macros to handle Texinfo files. 2% 3% Load plain if necessary, i.e., if running under initex. 4\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi 5% 6\def\texinfoversion{2003-05-04.08} 7% 8% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, 9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc. 10% 11% This texinfo.tex file is free software; you can redistribute it and/or 12% modify it under the terms of the GNU General Public License as 13% published by the Free Software Foundation; either version 2, or (at 14% your option) any later version. 15% 16% This texinfo.tex file is distributed in the hope that it will be 17% useful, but WITHOUT ANY WARRANTY; without even the implied warranty 18% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19% General Public License for more details. 20% 21% You should have received a copy of the GNU General Public License 22% along with this texinfo.tex file; see the file COPYING. If not, write 23% to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 24% Boston, MA 02111-1307, USA. 25% 26% In other words, you are welcome to use, share and improve this program. 27% You are forbidden to forbid anyone else to use, share and improve 28% what you give them. Help stamp out software-hoarding! 29% 30% Please try the latest version of texinfo.tex before submitting bug 31% reports; you can get the latest version from: 32% ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex 33% (and all GNU mirrors, see http://www.gnu.org/order/ftp.html) 34% ftp://tug.org/tex/texinfo.tex 35% (and all CTAN mirrors, see http://www.ctan.org), 36% and /home/gd/gnu/doc/texinfo.tex on the GNU machines. 37% 38% The GNU Texinfo home page is http://www.gnu.org/software/texinfo. 39% 40% The texinfo.tex in any given Texinfo distribution could well be out 41% of date, so if that's what you're using, please check. 42% 43% Send bug reports to bug-texinfo@gnu.org. Please include including a 44% complete document in each bug report with which we can reproduce the 45% problem. Patches are, of course, greatly appreciated. 46% 47% To process a Texinfo manual with TeX, it's most reliable to use the 48% texi2dvi shell script that comes with the distribution. For a simple 49% manual foo.texi, however, you can get away with this: 50% tex foo.texi 51% texindex foo.?? 52% tex foo.texi 53% tex foo.texi 54% dvips foo.dvi -o # or whatever; this makes foo.ps. 55% The extra TeX runs get the cross-reference information correct. 56% Sometimes one run after texindex suffices, and sometimes you need more 57% than two; texi2dvi does it as many times as necessary. 58% 59% It is possible to adapt texinfo.tex for other languages, to some 60% extent. You can get the existing language-specific files from the 61% full Texinfo distribution. 62 63\message{Loading texinfo [version \texinfoversion]:} 64 65% If in a .fmt file, print the version number 66% and turn on active characters that we couldn't do earlier because 67% they might have appeared in the input file name. 68\everyjob{\message{[Texinfo version \texinfoversion]}% 69 \catcode`+=\active \catcode`\_=\active} 70 71\message{Basics,} 72\chardef\other=12 73 74% We never want plain's \outer definition of \+ in Texinfo. 75% For @tex, we can use \tabalign. 76\let\+ = \relax 77 78% Save some plain tex macros whose names we will redefine. 79\let\ptexb=\b 80\let\ptexbullet=\bullet 81\let\ptexc=\c 82\let\ptexcomma=\, 83\let\ptexdot=\. 84\let\ptexdots=\dots 85\let\ptexend=\end 86\let\ptexequiv=\equiv 87\let\ptexexclam=\! 88\let\ptexgtr=> 89\let\ptexhat=^ 90\let\ptexi=\i 91\let\ptexindent=\indent 92\let\ptexlbrace=\{ 93\let\ptexless=< 94\let\ptexplus=+ 95\let\ptexrbrace=\} 96\let\ptexslash=\/ 97\let\ptexstar=\* 98\let\ptext=\t 99 100% If this character appears in an error message or help string, it 101% starts a new line in the output. 102\newlinechar = `^^J 103 104% Set up fixed words for English if not already set. 105\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi 106\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi 107\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi 108\ifx\putwordin\undefined \gdef\putwordin{in}\fi 109\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi 110\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi 111\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi 112\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi 113\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi 114\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi 115\ifx\putwordof\undefined \gdef\putwordof{of}\fi 116\ifx\putwordon\undefined \gdef\putwordon{on}\fi 117\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi 118\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi 119\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi 120\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi 121\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi 122\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi 123\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi 124% 125\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi 126\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi 127\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi 128\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi 129\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi 130\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi 131\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi 132\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi 133\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi 134\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi 135\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi 136\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi 137% 138\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi 139\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi 140\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi 141\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi 142\ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi 143\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi 144\ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi 145 146% In some macros, we cannot use the `\? notation---the left quote is 147% in some cases the escape char. 148\chardef\colonChar = `\: 149\chardef\commaChar = `\, 150\chardef\dotChar = `\. 151\chardef\equalChar = `\= 152\chardef\exclamChar= `\! 153\chardef\questChar = `\? 154\chardef\semiChar = `\; 155\chardef\spaceChar = `\ % 156\chardef\underChar = `\_ 157 158% Ignore a token. 159% 160\def\gobble#1{} 161 162% True if #1 is the empty string, i.e., called like `\ifempty{}'. 163% 164\def\ifempty#1{\ifemptyx #1\emptymarkA\emptymarkB}% 165\def\ifemptyx#1#2\emptymarkB{\ifx #1\emptymarkA}% 166 167% Hyphenation fixes. 168\hyphenation{ap-pen-dix} 169\hyphenation{eshell} 170\hyphenation{mini-buf-fer mini-buf-fers} 171\hyphenation{time-stamp} 172\hyphenation{white-space} 173 174% Margin to add to right of even pages, to left of odd pages. 175\newdimen\bindingoffset 176\newdimen\normaloffset 177\newdimen\pagewidth \newdimen\pageheight 178 179% Sometimes it is convenient to have everything in the transcript file 180% and nothing on the terminal. We don't just call \tracingall here, 181% since that produces some useless output on the terminal. We also make 182% some effort to order the tracing commands to reduce output in the log 183% file; cf. trace.sty in LaTeX. 184% 185\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% 186\def\loggingall{% 187 \tracingstats2 188 \tracingpages1 189 \tracinglostchars2 % 2 gives us more in etex 190 \tracingparagraphs1 191 \tracingoutput1 192 \tracingmacros2 193 \tracingrestores1 194 \showboxbreadth\maxdimen \showboxdepth\maxdimen 195 \ifx\eTeXversion\undefined\else % etex gives us more logging 196 \tracingscantokens1 197 \tracingifs1 198 \tracinggroups1 199 \tracingnesting2 200 \tracingassigns1 201 \fi 202 \tracingcommands3 % 3 gives us more in etex 203 \errorcontextlines\maxdimen 204}% 205 206% add check for \lastpenalty to plain's definitions. If the last thing 207% we did was a \nobreak, we don't want to insert more space. 208% 209\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount 210 \removelastskip\penalty-50\smallskip\fi\fi} 211\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount 212 \removelastskip\penalty-100\medskip\fi\fi} 213\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount 214 \removelastskip\penalty-200\bigskip\fi\fi} 215 216% For @cropmarks command. 217% Do @cropmarks to get crop marks. 218% 219\newif\ifcropmarks 220\let\cropmarks = \cropmarkstrue 221% 222% Dimensions to add cropmarks at corners. 223% Added by P. A. MacKay, 12 Nov. 1986 224% 225\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines 226\newdimen\cornerlong \cornerlong=1pc 227\newdimen\cornerthick \cornerthick=.3pt 228\newdimen\topandbottommargin \topandbottommargin=.75in 229 230% Main output routine. 231\chardef\PAGE = 255 232\output = {\onepageout{\pagecontents\PAGE}} 233 234\newbox\headlinebox 235\newbox\footlinebox 236 237% \onepageout takes a vbox as an argument. Note that \pagecontents 238% does insertions, but you have to call it yourself. 239\def\onepageout#1{% 240 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi 241 % 242 \ifodd\pageno \advance\hoffset by \bindingoffset 243 \else \advance\hoffset by -\bindingoffset\fi 244 % 245 % Do this outside of the \shipout so @code etc. will be expanded in 246 % the headline as they should be, not taken literally (outputting ''code). 247 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% 248 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% 249 % 250 {% 251 % Have to do this stuff outside the \shipout because we want it to 252 % take effect in \write's, yet the group defined by the \vbox ends 253 % before the \shipout runs. 254 % 255 \escapechar = `\\ % use backslash in output files. 256 \indexdummies % don't expand commands in the output. 257 \normalturnoffactive % \ in index entries must not stay \, e.g., if 258 % the page break happens to be in the middle of an example. 259 \shipout\vbox{% 260 % Do this early so pdf references go to the beginning of the page. 261 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi 262 % 263 \ifcropmarks \vbox to \outervsize\bgroup 264 \hsize = \outerhsize 265 \vskip-\topandbottommargin 266 \vtop to0pt{% 267 \line{\ewtop\hfil\ewtop}% 268 \nointerlineskip 269 \line{% 270 \vbox{\moveleft\cornerthick\nstop}% 271 \hfill 272 \vbox{\moveright\cornerthick\nstop}% 273 }% 274 \vss}% 275 \vskip\topandbottommargin 276 \line\bgroup 277 \hfil % center the page within the outer (page) hsize. 278 \ifodd\pageno\hskip\bindingoffset\fi 279 \vbox\bgroup 280 \fi 281 % 282 \unvbox\headlinebox 283 \pagebody{#1}% 284 \ifdim\ht\footlinebox > 0pt 285 % Only leave this space if the footline is nonempty. 286 % (We lessened \vsize for it in \oddfootingxxx.) 287 % The \baselineskip=24pt in plain's \makefootline has no effect. 288 \vskip 2\baselineskip 289 \unvbox\footlinebox 290 \fi 291 % 292 \ifcropmarks 293 \egroup % end of \vbox\bgroup 294 \hfil\egroup % end of (centering) \line\bgroup 295 \vskip\topandbottommargin plus1fill minus1fill 296 \boxmaxdepth = \cornerthick 297 \vbox to0pt{\vss 298 \line{% 299 \vbox{\moveleft\cornerthick\nsbot}% 300 \hfill 301 \vbox{\moveright\cornerthick\nsbot}% 302 }% 303 \nointerlineskip 304 \line{\ewbot\hfil\ewbot}% 305 }% 306 \egroup % \vbox from first cropmarks clause 307 \fi 308 }% end of \shipout\vbox 309 }% end of group with \normalturnoffactive 310 \advancepageno 311 \ifnum\outputpenalty>-20000 \else\dosupereject\fi 312} 313 314\newinsert\margin \dimen\margin=\maxdimen 315 316\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} 317{\catcode`\@ =11 318\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi 319% marginal hacks, juha@viisa.uucp (Juha Takala) 320\ifvoid\margin\else % marginal info is present 321 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi 322\dimen@=\dp#1 \unvbox#1 323\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi 324\ifr@ggedbottom \kern-\dimen@ \vfil \fi} 325} 326 327% Here are the rules for the cropmarks. Note that they are 328% offset so that the space between them is truly \outerhsize or \outervsize 329% (P. A. MacKay, 12 November, 1986) 330% 331\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} 332\def\nstop{\vbox 333 {\hrule height\cornerthick depth\cornerlong width\cornerthick}} 334\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} 335\def\nsbot{\vbox 336 {\hrule height\cornerlong depth\cornerthick width\cornerthick}} 337 338% Parse an argument, then pass it to #1. The argument is the rest of 339% the input line (except we remove a trailing comment). #1 should be a 340% macro which expects an ordinary undelimited TeX argument. 341% 342\def\parsearg#1{% 343 \let\next = #1% 344 \begingroup 345 \obeylines 346 \futurelet\temp\parseargx 347} 348 349% If the next token is an obeyed space (from an @example environment or 350% the like), remove it and recurse. Otherwise, we're done. 351\def\parseargx{% 352 % \obeyedspace is defined far below, after the definition of \sepspaces. 353 \ifx\obeyedspace\temp 354 \expandafter\parseargdiscardspace 355 \else 356 \expandafter\parseargline 357 \fi 358} 359 360% Remove a single space (as the delimiter token to the macro call). 361{\obeyspaces % 362 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}} 363 364{\obeylines % 365 \gdef\parseargline#1^^M{% 366 \endgroup % End of the group started in \parsearg. 367 % 368 % First remove any @c comment, then any @comment. 369 % Result of each macro is put in \toks0. 370 \argremovec #1\c\relax % 371 \expandafter\argremovecomment \the\toks0 \comment\relax % 372 % 373 % Call the caller's macro, saved as \next in \parsearg. 374 \expandafter\next\expandafter{\the\toks0}% 375 }% 376} 377 378% Since all \c{,omment} does is throw away the argument, we can let TeX 379% do that for us. The \relax here is matched by the \relax in the call 380% in \parseargline; it could be more or less anything, its purpose is 381% just to delimit the argument to the \c. 382\def\argremovec#1\c#2\relax{\toks0 = {#1}} 383\def\argremovecomment#1\comment#2\relax{\toks0 = {#1}} 384 385% \argremovec{,omment} might leave us with trailing spaces, though; e.g., 386% @end itemize @c foo 387% will have two active spaces as part of the argument with the 388% `itemize'. Here we remove all active spaces from #1, and assign the 389% result to \toks0. 390% 391% This loses if there are any *other* active characters besides spaces 392% in the argument -- _ ^ +, for example -- since they get expanded. 393% Fortunately, Texinfo does not define any such commands. (If it ever 394% does, the catcode of the characters in questionwill have to be changed 395% here.) But this means we cannot call \removeactivespaces as part of 396% \argremovec{,omment}, since @c uses \parsearg, and thus the argument 397% that \parsearg gets might well have any character at all in it. 398% 399\def\removeactivespaces#1{% 400 \begingroup 401 \ignoreactivespaces 402 \edef\temp{#1}% 403 \global\toks0 = \expandafter{\temp}% 404 \endgroup 405} 406 407% Change the active space to expand to nothing. 408% 409\begingroup 410 \obeyspaces 411 \gdef\ignoreactivespaces{\obeyspaces\let =\empty} 412\endgroup 413 414 415\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} 416 417%% These are used to keep @begin/@end levels from running away 418%% Call \inENV within environments (after a \begingroup) 419\newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi} 420\def\ENVcheck{% 421\ifENV\errmessage{Still within an environment; press RETURN to continue} 422\endgroup\fi} % This is not perfect, but it should reduce lossage 423 424% @begin foo is the same as @foo, for now. 425\newhelp\EMsimple{Press RETURN to continue.} 426 427\outer\def\begin{\parsearg\beginxxx} 428 429\def\beginxxx #1{% 430\expandafter\ifx\csname #1\endcsname\relax 431{\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else 432\csname #1\endcsname\fi} 433 434% @end foo executes the definition of \Efoo. 435% 436\def\end{\parsearg\endxxx} 437\def\endxxx #1{% 438 \removeactivespaces{#1}% 439 \edef\endthing{\the\toks0}% 440 % 441 \expandafter\ifx\csname E\endthing\endcsname\relax 442 \expandafter\ifx\csname \endthing\endcsname\relax 443 % There's no \foo, i.e., no ``environment'' foo. 444 \errhelp = \EMsimple 445 \errmessage{Undefined command `@end \endthing'}% 446 \else 447 \unmatchedenderror\endthing 448 \fi 449 \else 450 % Everything's ok; the right environment has been started. 451 \csname E\endthing\endcsname 452 \fi 453} 454 455% There is an environment #1, but it hasn't been started. Give an error. 456% 457\def\unmatchedenderror#1{% 458 \errhelp = \EMsimple 459 \errmessage{This `@end #1' doesn't have a matching `@#1'}% 460} 461 462% Define the control sequence \E#1 to give an unmatched @end error. 463% 464\def\defineunmatchedend#1{% 465 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}% 466} 467 468 469%% Simple single-character @ commands 470 471% @@ prints an @ 472% Kludge this until the fonts are right (grr). 473\def\@{{\tt\char64}} 474 475% This is turned off because it was never documented 476% and you can use @w{...} around a quote to suppress ligatures. 477%% Define @` and @' to be the same as ` and ' 478%% but suppressing ligatures. 479%\def\`{{`}} 480%\def\'{{'}} 481 482% Used to generate quoted braces. 483\def\mylbrace {{\tt\char123}} 484\def\myrbrace {{\tt\char125}} 485\let\{=\mylbrace 486\let\}=\myrbrace 487\begingroup 488 % Definitions to produce \{ and \} commands for indices, 489 % and @{ and @} for the aux file. 490 \catcode`\{ = \other \catcode`\} = \other 491 \catcode`\[ = 1 \catcode`\] = 2 492 \catcode`\! = 0 \catcode`\\ = \other 493 !gdef!lbracecmd[\{]% 494 !gdef!rbracecmd[\}]% 495 !gdef!lbraceatcmd[@{]% 496 !gdef!rbraceatcmd[@}]% 497!endgroup 498 499% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent 500% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. 501\let\, = \c 502\let\dotaccent = \. 503\def\ringaccent#1{{\accent23 #1}} 504\let\tieaccent = \t 505\let\ubaraccent = \b 506\let\udotaccent = \d 507 508% Other special characters: @questiondown @exclamdown 509% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. 510\def\questiondown{?`} 511\def\exclamdown{!`} 512 513% Dotless i and dotless j, used for accents. 514\def\imacro{i} 515\def\jmacro{j} 516\def\dotless#1{% 517 \def\temp{#1}% 518 \ifx\temp\imacro \ptexi 519 \else\ifx\temp\jmacro \j 520 \else \errmessage{@dotless can be used only with i or j}% 521 \fi\fi 522} 523 524% Be sure we're in horizontal mode when doing a tie, since we make space 525% equivalent to this in @example-like environments. Otherwise, a space 526% at the beginning of a line will start with \penalty -- and 527% since \penalty is valid in vertical mode, we'd end up putting the 528% penalty on the vertical list instead of in the new paragraph. 529{\catcode`@ = 11 530 % Avoid using \@M directly, because that causes trouble 531 % if the definition is written into an index file. 532 \global\let\tiepenalty = \@M 533 \gdef\tie{\leavevmode\penalty\tiepenalty\ } 534} 535 536% @: forces normal size whitespace following. 537\def\:{\spacefactor=1000 } 538 539% @* forces a line break. 540\def\*{\hfil\break\hbox{}\ignorespaces} 541 542% @/ allows a line break. 543\let\/=\allowbreak 544 545% @. is an end-of-sentence period. 546\def\.{.\spacefactor=3000 } 547 548% @! is an end-of-sentence bang. 549\def\!{!\spacefactor=3000 } 550 551% @? is an end-of-sentence query. 552\def\?{?\spacefactor=3000 } 553 554% @w prevents a word break. Without the \leavevmode, @w at the 555% beginning of a paragraph, when TeX is still in vertical mode, would 556% produce a whole line of output instead of starting the paragraph. 557\def\w#1{\leavevmode\hbox{#1}} 558 559% @group ... @end group forces ... to be all on one page, by enclosing 560% it in a TeX vbox. We use \vtop instead of \vbox to construct the box 561% to keep its height that of a normal line. According to the rules for 562% \topskip (p.114 of the TeXbook), the glue inserted is 563% max (\topskip - \ht (first item), 0). If that height is large, 564% therefore, no glue is inserted, and the space between the headline and 565% the text is small, which looks bad. 566% 567% Another complication is that the group might be very large. This can 568% cause the glue on the previous page to be unduly stretched, because it 569% does not have much material. In this case, it's better to add an 570% explicit \vfill so that the extra space is at the bottom. The 571% threshold for doing this is if the group is more than \vfilllimit 572% percent of a page (\vfilllimit can be changed inside of @tex). 573% 574\newbox\groupbox 575\def\vfilllimit{0.7} 576% 577\def\group{\begingroup 578 \ifnum\catcode13=\active \else 579 \errhelp = \groupinvalidhelp 580 \errmessage{@group invalid in context where filling is enabled}% 581 \fi 582 % 583 % The \vtop we start below produces a box with normal height and large 584 % depth; thus, TeX puts \baselineskip glue before it, and (when the 585 % next line of text is done) \lineskip glue after it. (See p.82 of 586 % the TeXbook.) Thus, space below is not quite equal to space 587 % above. But it's pretty close. 588 \def\Egroup{% 589 \egroup % End the \vtop. 590 % \dimen0 is the vertical size of the group's box. 591 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox 592 % \dimen2 is how much space is left on the page (more or less). 593 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal 594 % if the group doesn't fit on the current page, and it's a big big 595 % group, force a page break. 596 \ifdim \dimen0 > \dimen2 597 \ifdim \pagetotal < \vfilllimit\pageheight 598 \page 599 \fi 600 \fi 601 \copy\groupbox 602 \endgroup % End the \group. 603 }% 604 % 605 \setbox\groupbox = \vtop\bgroup 606 % We have to put a strut on the last line in case the @group is in 607 % the midst of an example, rather than completely enclosing it. 608 % Otherwise, the interline space between the last line of the group 609 % and the first line afterwards is too small. But we can't put the 610 % strut in \Egroup, since there it would be on a line by itself. 611 % Hence this just inserts a strut at the beginning of each line. 612 \everypar = {\strut}% 613 % 614 % Since we have a strut on every line, we don't need any of TeX's 615 % normal interline spacing. 616 \offinterlineskip 617 % 618 % OK, but now we have to do something about blank 619 % lines in the input in @example-like environments, which normally 620 % just turn into \lisppar, which will insert no space now that we've 621 % turned off the interline space. Simplest is to make them be an 622 % empty paragraph. 623 \ifx\par\lisppar 624 \edef\par{\leavevmode \par}% 625 % 626 % Reset ^^M's definition to new definition of \par. 627 \obeylines 628 \fi 629 % 630 % Do @comment since we are called inside an environment such as 631 % @example, where each end-of-line in the input causes an 632 % end-of-line in the output. We don't want the end-of-line after 633 % the `@group' to put extra space in the output. Since @group 634 % should appear on a line by itself (according to the Texinfo 635 % manual), we don't worry about eating any user text. 636 \comment 637} 638% 639% TeX puts in an \escapechar (i.e., `@') at the beginning of the help 640% message, so this ends up printing `@group can only ...'. 641% 642\newhelp\groupinvalidhelp{% 643group can only be used in environments such as @example,^^J% 644where each line of input produces a line of output.} 645 646% @need space-in-mils 647% forces a page break if there is not space-in-mils remaining. 648 649\newdimen\mil \mil=0.001in 650 651\def\need{\parsearg\needx} 652 653% Old definition--didn't work. 654%\def\needx #1{\par % 655%% This method tries to make TeX break the page naturally 656%% if the depth of the box does not fit. 657%{\baselineskip=0pt% 658%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak 659%\prevdepth=-1000pt 660%}} 661 662\def\needx#1{% 663 % Ensure vertical mode, so we don't make a big box in the middle of a 664 % paragraph. 665 \par 666 % 667 % If the @need value is less than one line space, it's useless. 668 \dimen0 = #1\mil 669 \dimen2 = \ht\strutbox 670 \advance\dimen2 by \dp\strutbox 671 \ifdim\dimen0 > \dimen2 672 % 673 % Do a \strut just to make the height of this box be normal, so the 674 % normal leading is inserted relative to the preceding line. 675 % And a page break here is fine. 676 \vtop to #1\mil{\strut\vfil}% 677 % 678 % TeX does not even consider page breaks if a penalty added to the 679 % main vertical list is 10000 or more. But in order to see if the 680 % empty box we just added fits on the page, we must make it consider 681 % page breaks. On the other hand, we don't want to actually break the 682 % page after the empty box. So we use a penalty of 9999. 683 % 684 % There is an extremely small chance that TeX will actually break the 685 % page at this \penalty, if there are no other feasible breakpoints in 686 % sight. (If the user is using lots of big @group commands, which 687 % almost-but-not-quite fill up a page, TeX will have a hard time doing 688 % good page breaking, for example.) However, I could not construct an 689 % example where a page broke at this \penalty; if it happens in a real 690 % document, then we can reconsider our strategy. 691 \penalty9999 692 % 693 % Back up by the size of the box, whether we did a page break or not. 694 \kern -#1\mil 695 % 696 % Do not allow a page break right after this kern. 697 \nobreak 698 \fi 699} 700 701% @br forces paragraph break 702 703\let\br = \par 704 705% @dots{} output an ellipsis using the current font. 706% We do .5em per period so that it has the same spacing in a typewriter 707% font as three actual period characters. 708% 709\def\dots{% 710 \leavevmode 711 \hbox to 1.5em{% 712 \hskip 0pt plus 0.25fil minus 0.25fil 713 .\hss.\hss.% 714 \hskip 0pt plus 0.5fil minus 0.5fil 715 }% 716} 717 718% @enddots{} is an end-of-sentence ellipsis. 719% 720\def\enddots{% 721 \leavevmode 722 \hbox to 2em{% 723 \hskip 0pt plus 0.25fil minus 0.25fil 724 .\hss.\hss.\hss.% 725 \hskip 0pt plus 0.5fil minus 0.5fil 726 }% 727 \spacefactor=3000 728} 729 730% @page forces the start of a new page. 731% 732\def\page{\par\vfill\supereject} 733 734% @exdent text.... 735% outputs text on separate line in roman font, starting at standard page margin 736 737% This records the amount of indent in the innermost environment. 738% That's how much \exdent should take out. 739\newskip\exdentamount 740 741% This defn is used inside fill environments such as @defun. 742\def\exdent{\parsearg\exdentyyy} 743\def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}} 744 745% This defn is used inside nofill environments such as @example. 746\def\nofillexdent{\parsearg\nofillexdentyyy} 747\def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount 748\leftline{\hskip\leftskip{\rm#1}}}} 749 750% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current 751% paragraph. For more general purposes, use the \margin insertion 752% class. WHICH is `l' or `r'. 753% 754\newskip\inmarginspacing \inmarginspacing=1cm 755\def\strutdepth{\dp\strutbox} 756% 757\def\doinmargin#1#2{\strut\vadjust{% 758 \nobreak 759 \kern-\strutdepth 760 \vtop to \strutdepth{% 761 \baselineskip=\strutdepth 762 \vss 763 % if you have multiple lines of stuff to put here, you'll need to 764 % make the vbox yourself of the appropriate size. 765 \ifx#1l% 766 \llap{\ignorespaces #2\hskip\inmarginspacing}% 767 \else 768 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% 769 \fi 770 \null 771 }% 772}} 773\def\inleftmargin{\doinmargin l} 774\def\inrightmargin{\doinmargin r} 775% 776% @inmargin{TEXT [, RIGHT-TEXT]} 777% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; 778% else use TEXT for both). 779% 780\def\inmargin#1{\parseinmargin #1,,\finish} 781\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. 782 \setbox0 = \hbox{\ignorespaces #2}% 783 \ifdim\wd0 > 0pt 784 \def\lefttext{#1}% have both texts 785 \def\righttext{#2}% 786 \else 787 \def\lefttext{#1}% have only one text 788 \def\righttext{#1}% 789 \fi 790 % 791 \ifodd\pageno 792 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin 793 \else 794 \def\temp{\inleftmargin\lefttext}% 795 \fi 796 \temp 797} 798 799% @include file insert text of that file as input. 800% Allow normal characters that we make active in the argument (a file name). 801\def\include{\begingroup 802 \catcode`\\=\other 803 \catcode`~=\other 804 \catcode`^=\other 805 \catcode`_=\other 806 \catcode`|=\other 807 \catcode`<=\other 808 \catcode`>=\other 809 \catcode`+=\other 810 \parsearg\includezzz} 811% Restore active chars for included file. 812\def\includezzz#1{\endgroup\begingroup 813 % Read the included file in a group so nested @include's work. 814 \def\thisfile{#1}% 815 \let\value=\expandablevalue 816 \input\thisfile 817\endgroup} 818 819\def\thisfile{} 820 821% @center line 822% outputs that line, centered. 823% 824\def\center{\parsearg\docenter} 825\def\docenter#1{{% 826 \ifhmode \hfil\break \fi 827 \advance\hsize by -\leftskip 828 \advance\hsize by -\rightskip 829 \line{\hfil \ignorespaces#1\unskip \hfil}% 830 \ifhmode \break \fi 831}} 832 833% @sp n outputs n lines of vertical space 834 835\def\sp{\parsearg\spxxx} 836\def\spxxx #1{\vskip #1\baselineskip} 837 838% @comment ...line which is ignored... 839% @c is the same as @comment 840% @ignore ... @end ignore is another way to write a comment 841 842\def\comment{\begingroup \catcode`\^^M=\other% 843\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% 844\commentxxx} 845{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} 846 847\let\c=\comment 848 849% @paragraphindent NCHARS 850% We'll use ems for NCHARS, close enough. 851% NCHARS can also be the word `asis' or `none'. 852% We cannot feasibly implement @paragraphindent asis, though. 853% 854\def\asisword{asis} % no translation, these are keywords 855\def\noneword{none} 856% 857\def\paragraphindent{\parsearg\doparagraphindent} 858\def\doparagraphindent#1{% 859 \def\temp{#1}% 860 \ifx\temp\asisword 861 \else 862 \ifx\temp\noneword 863 \defaultparindent = 0pt 864 \else 865 \defaultparindent = #1em 866 \fi 867 \fi 868 \parindent = \defaultparindent 869} 870 871% @exampleindent NCHARS 872% We'll use ems for NCHARS like @paragraphindent. 873% It seems @exampleindent asis isn't necessary, but 874% I preserve it to make it similar to @paragraphindent. 875\def\exampleindent{\parsearg\doexampleindent} 876\def\doexampleindent#1{% 877 \def\temp{#1}% 878 \ifx\temp\asisword 879 \else 880 \ifx\temp\noneword 881 \lispnarrowing = 0pt 882 \else 883 \lispnarrowing = #1em 884 \fi 885 \fi 886} 887 888% @firstparagraphindent WORD 889% If WORD is `none', then suppress indentation of the first paragraph 890% after a section heading. If WORD is `insert', then do indentat such 891% paragraphs. 892% 893% The paragraph indentation is suppressed or not by calling 894% \suppressfirstparagraphindent, which the sectioning commands do. We 895% switch the definition of this back and forth according to WORD. By 896% default, we suppress indentation. 897% 898\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} 899\newdimen\currentparindent 900% 901\def\insertword{insert} 902% 903\def\firstparagraphindent{\parsearg\dofirstparagraphindent} 904\def\dofirstparagraphindent#1{% 905 \def\temp{#1}% 906 \ifx\temp\noneword 907 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent 908 \else\ifx\temp\insertword 909 \let\suppressfirstparagraphindent = \relax 910 \else 911 \errhelp = \EMsimple 912 \errmessage{Unknown @firstparagraphindent option `\temp'}% 913 \fi\fi 914} 915 916% Here is how we actually suppress indentation. Redefine \everypar to 917% \kern backwards by \parindent, and then reset itself to empty. 918% 919% We also make \indent itself not actually do anything until the next 920% paragraph. 921% 922\gdef\dosuppressfirstparagraphindent{% 923 \gdef\indent{% 924 \global\let\indent=\ptexindent 925 \global\everypar = {}% 926 }% 927 \global\everypar = {% 928 \kern-\parindent 929 \global\let\indent=\ptexindent 930 \global\everypar = {}% 931 }% 932}% 933 934 935% @asis just yields its argument. Used with @table, for example. 936% 937\def\asis#1{#1} 938 939% @math outputs its argument in math mode. 940% We don't use $'s directly in the definition of \math because we need 941% to set catcodes according to plain TeX first, to allow for subscripts, 942% superscripts, special math chars, etc. 943% 944\let\implicitmath = $%$ font-lock fix 945% 946% One complication: _ usually means subscripts, but it could also mean 947% an actual _ character, as in @math{@var{some_variable} + 1}. So make 948% _ within @math be active (mathcode "8000), and distinguish by seeing 949% if the current family is \slfam, which is what @var uses. 950% 951{\catcode\underChar = \active 952\gdef\mathunderscore{% 953 \catcode\underChar=\active 954 \def_{\ifnum\fam=\slfam \_\else\sb\fi}% 955}} 956% 957% Another complication: we want \\ (and @\) to output a \ character. 958% FYI, plain.tex uses \\ as a temporary control sequence (why?), but 959% this is not advertised and we don't care. Texinfo does not 960% otherwise define @\. 961% 962% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. 963\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} 964% 965\def\math{% 966 \tex 967 \mathcode`\_="8000 \mathunderscore 968 \let\\ = \mathbackslash 969 \mathactive 970 \implicitmath\finishmath} 971\def\finishmath#1{#1\implicitmath\Etex} 972 973% Some active characters (such as <) are spaced differently in math. 974% We have to reset their definitions in case the @math was an 975% argument to a command which set the catcodes (such as @item or @section). 976% 977{ 978 \catcode`^ = \active 979 \catcode`< = \active 980 \catcode`> = \active 981 \catcode`+ = \active 982 \gdef\mathactive{% 983 \let^ = \ptexhat 984 \let< = \ptexless 985 \let> = \ptexgtr 986 \let+ = \ptexplus 987 } 988} 989 990% @bullet and @minus need the same treatment as @math, just above. 991\def\bullet{\implicitmath\ptexbullet\implicitmath} 992\def\minus{\implicitmath-\implicitmath} 993 994% @refill is a no-op. 995\let\refill=\relax 996 997% If working on a large document in chapters, it is convenient to 998% be able to disable indexing, cross-referencing, and contents, for test runs. 999% This is done with @novalidate (before @setfilename). 1000% 1001\newif\iflinks \linkstrue % by default we want the aux files. 1002\let\novalidate = \linksfalse 1003 1004% @setfilename is done at the beginning of every texinfo file. 1005% So open here the files we need to have open while reading the input. 1006% This makes it possible to make a .fmt file for texinfo. 1007\def\setfilename{% 1008 \iflinks 1009 \readauxfile 1010 \fi % \openindices needs to do some work in any case. 1011 \openindices 1012 \fixbackslash % Turn off hack to swallow `\input texinfo'. 1013 \global\let\setfilename=\comment % Ignore extra @setfilename cmds. 1014 % 1015 % If texinfo.cnf is present on the system, read it. 1016 % Useful for site-wide @afourpaper, etc. 1017 % Just to be on the safe side, close the input stream before the \input. 1018 \openin 1 texinfo.cnf 1019 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi 1020 \closein1 1021 \temp 1022 % 1023 \comment % Ignore the actual filename. 1024} 1025 1026% Called from \setfilename. 1027% 1028\def\openindices{% 1029 \newindex{cp}% 1030 \newcodeindex{fn}% 1031 \newcodeindex{vr}% 1032 \newcodeindex{tp}% 1033 \newcodeindex{ky}% 1034 \newcodeindex{pg}% 1035} 1036 1037% @bye. 1038\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} 1039 1040 1041\message{pdf,} 1042% adobe `portable' document format 1043\newcount\tempnum 1044\newcount\lnkcount 1045\newtoks\filename 1046\newcount\filenamelength 1047\newcount\pgn 1048\newtoks\toksA 1049\newtoks\toksB 1050\newtoks\toksC 1051\newtoks\toksD 1052\newbox\boxA 1053\newcount\countA 1054\newif\ifpdf 1055\newif\ifpdfmakepagedest 1056 1057\ifx\pdfoutput\undefined 1058 \pdffalse 1059 \let\pdfmkdest = \gobble 1060 \let\pdfurl = \gobble 1061 \let\endlink = \relax 1062 \let\linkcolor = \relax 1063 \let\pdfmakeoutlines = \relax 1064\else 1065 \pdftrue 1066 \pdfoutput = 1 1067 \input pdfcolor 1068 \def\dopdfimage#1#2#3{% 1069 \def\imagewidth{#2}% 1070 \def\imageheight{#3}% 1071 % without \immediate, pdftex seg faults when the same image is 1072 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) 1073 \ifnum\pdftexversion < 14 1074 \immediate\pdfimage 1075 \else 1076 \immediate\pdfximage 1077 \fi 1078 \ifx\empty\imagewidth\else width \imagewidth \fi 1079 \ifx\empty\imageheight\else height \imageheight \fi 1080 \ifnum\pdftexversion<13 1081 #1.pdf% 1082 \else 1083 {#1.pdf}% 1084 \fi 1085 \ifnum\pdftexversion < 14 \else 1086 \pdfrefximage \pdflastximage 1087 \fi} 1088 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}} 1089 \def\pdfmkpgn#1{#1} 1090 \let\linkcolor = \Blue % was Cyan, but that seems light? 1091 \def\endlink{\Black\pdfendlink} 1092 % Adding outlines to PDF; macros for calculating structure of outlines 1093 % come from Petr Olsak 1094 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% 1095 \else \csname#1\endcsname \fi} 1096 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax 1097 \advance\tempnum by1 1098 \expandafter\xdef\csname#1\endcsname{\the\tempnum}} 1099 \def\pdfmakeoutlines{{% 1100 \openin 1 \jobname.toc 1101 \ifeof 1\else\begingroup 1102 \closein 1 1103 % Thanh's hack / proper braces in bookmarks 1104 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace 1105 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace 1106 % 1107 \def\chapentry ##1##2##3{} 1108 \def\secentry ##1##2##3##4{\advancenumber{chap##2}} 1109 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}} 1110 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}} 1111 \let\appendixentry = \chapentry 1112 \let\unnumbchapentry = \chapentry 1113 \let\unnumbsecentry = \secentry 1114 \let\unnumbsubsecentry = \subsecentry 1115 \let\unnumbsubsubsecentry = \subsubsecentry 1116 \input \jobname.toc 1117 \def\chapentry ##1##2##3{% 1118 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}} 1119 \def\secentry ##1##2##3##4{% 1120 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}} 1121 \def\subsecentry ##1##2##3##4##5{% 1122 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}} 1123 \def\subsubsecentry ##1##2##3##4##5##6{% 1124 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}} 1125 \let\appendixentry = \chapentry 1126 \let\unnumbchapentry = \chapentry 1127 \let\unnumbsecentry = \secentry 1128 \let\unnumbsubsecentry = \subsecentry 1129 \let\unnumbsubsubsecentry = \subsubsecentry 1130 % 1131 % Make special characters normal for writing to the pdf file. 1132 % 1133 \indexnofonts 1134 \let\tt=\relax 1135 \turnoffactive 1136 \input \jobname.toc 1137 \endgroup\fi 1138 }} 1139 \def\makelinks #1,{% 1140 \def\params{#1}\def\E{END}% 1141 \ifx\params\E 1142 \let\nextmakelinks=\relax 1143 \else 1144 \let\nextmakelinks=\makelinks 1145 \ifnum\lnkcount>0,\fi 1146 \picknum{#1}% 1147 \startlink attr{/Border [0 0 0]} 1148 goto name{\pdfmkpgn{\the\pgn}}% 1149 \linkcolor #1% 1150 \advance\lnkcount by 1% 1151 \endlink 1152 \fi 1153 \nextmakelinks 1154 } 1155 \def\picknum#1{\expandafter\pn#1} 1156 \def\pn#1{% 1157 \def\p{#1}% 1158 \ifx\p\lbrace 1159 \let\nextpn=\ppn 1160 \else 1161 \let\nextpn=\ppnn 1162 \def\first{#1} 1163 \fi 1164 \nextpn 1165 } 1166 \def\ppn#1{\pgn=#1\gobble} 1167 \def\ppnn{\pgn=\first} 1168 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,} 1169 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1170 \def\skipspaces#1{\def\PP{#1}\def\D{|}% 1171 \ifx\PP\D\let\nextsp\relax 1172 \else\let\nextsp\skipspaces 1173 \ifx\p\space\else\addtokens{\filename}{\PP}% 1174 \advance\filenamelength by 1 1175 \fi 1176 \fi 1177 \nextsp} 1178 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} 1179 \ifnum\pdftexversion < 14 1180 \let \startlink \pdfannotlink 1181 \else 1182 \let \startlink \pdfstartlink 1183 \fi 1184 \def\pdfurl#1{% 1185 \begingroup 1186 \normalturnoffactive\def\@{@}% 1187 \let\value=\expandablevalue 1188 \leavevmode\Red 1189 \startlink attr{/Border [0 0 0]}% 1190 user{/Subtype /Link /A << /S /URI /URI (#1) >>}% 1191 % #1 1192 \endgroup} 1193 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} 1194 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1195 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} 1196 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} 1197 \def\maketoks{% 1198 \expandafter\poptoks\the\toksA|ENDTOKS| 1199 \ifx\first0\adn0 1200 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 1201 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 1202 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 1203 \else 1204 \ifnum0=\countA\else\makelink\fi 1205 \ifx\first.\let\next=\done\else 1206 \let\next=\maketoks 1207 \addtokens{\toksB}{\the\toksD} 1208 \ifx\first,\addtokens{\toksB}{\space}\fi 1209 \fi 1210 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 1211 \next} 1212 \def\makelink{\addtokens{\toksB}% 1213 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} 1214 \def\pdflink#1{% 1215 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} 1216 \linkcolor #1\endlink} 1217 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} 1218\fi % \ifx\pdfoutput 1219 1220 1221\message{fonts,} 1222% Font-change commands. 1223 1224% Texinfo sort of supports the sans serif font style, which plain TeX does not. 1225% So we set up a \sf analogous to plain's \rm, etc. 1226\newfam\sffam 1227\def\sf{\fam=\sffam \tensf} 1228\let\li = \sf % Sometimes we call it \li, not \sf. 1229 1230% We don't need math for this one. 1231\def\ttsl{\tenttsl} 1232 1233% Default leading. 1234\newdimen\textleading \textleading = 13.2pt 1235 1236% Set the baselineskip to #1, and the lineskip and strut size 1237% correspondingly. There is no deep meaning behind these magic numbers 1238% used as factors; they just match (closely enough) what Knuth defined. 1239% 1240\def\lineskipfactor{.08333} 1241\def\strutheightpercent{.70833} 1242\def\strutdepthpercent {.29167} 1243% 1244\def\setleading#1{% 1245 \normalbaselineskip = #1\relax 1246 \normallineskip = \lineskipfactor\normalbaselineskip 1247 \normalbaselines 1248 \setbox\strutbox =\hbox{% 1249 \vrule width0pt height\strutheightpercent\baselineskip 1250 depth \strutdepthpercent \baselineskip 1251 }% 1252} 1253 1254% Set the font macro #1 to the font named #2, adding on the 1255% specified font prefix (normally `cm'). 1256% #3 is the font's design size, #4 is a scale factor 1257\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} 1258 1259% Use cm as the default font prefix. 1260% To specify the font prefix, you must define \fontprefix 1261% before you read in texinfo.tex. 1262\ifx\fontprefix\undefined 1263\def\fontprefix{cm} 1264\fi 1265% Support font families that don't use the same naming scheme as CM. 1266\def\rmshape{r} 1267\def\rmbshape{bx} %where the normal face is bold 1268\def\bfshape{b} 1269\def\bxshape{bx} 1270\def\ttshape{tt} 1271\def\ttbshape{tt} 1272\def\ttslshape{sltt} 1273\def\itshape{ti} 1274\def\itbshape{bxti} 1275\def\slshape{sl} 1276\def\slbshape{bxsl} 1277\def\sfshape{ss} 1278\def\sfbshape{ss} 1279\def\scshape{csc} 1280\def\scbshape{csc} 1281 1282\newcount\mainmagstep 1283\ifx\bigger\relax 1284 % not really supported. 1285 \mainmagstep=\magstep1 1286 \setfont\textrm\rmshape{12}{1000} 1287 \setfont\texttt\ttshape{12}{1000} 1288\else 1289 \mainmagstep=\magstephalf 1290 \setfont\textrm\rmshape{10}{\mainmagstep} 1291 \setfont\texttt\ttshape{10}{\mainmagstep} 1292\fi 1293% Instead of cmb10, you may want to use cmbx10. 1294% cmbx10 is a prettier font on its own, but cmb10 1295% looks better when embedded in a line with cmr10 1296% (in Bob's opinion). 1297\setfont\textbf\bfshape{10}{\mainmagstep} 1298\setfont\textit\itshape{10}{\mainmagstep} 1299\setfont\textsl\slshape{10}{\mainmagstep} 1300\setfont\textsf\sfshape{10}{\mainmagstep} 1301\setfont\textsc\scshape{10}{\mainmagstep} 1302\setfont\textttsl\ttslshape{10}{\mainmagstep} 1303\font\texti=cmmi10 scaled \mainmagstep 1304\font\textsy=cmsy10 scaled \mainmagstep 1305 1306% A few fonts for @defun, etc. 1307\setfont\defbf\bxshape{10}{\magstep1} %was 1314 1308\setfont\deftt\ttshape{10}{\magstep1} 1309\def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf} 1310 1311% Fonts for indices, footnotes, small examples (9pt). 1312\setfont\smallrm\rmshape{9}{1000} 1313\setfont\smalltt\ttshape{9}{1000} 1314\setfont\smallbf\bfshape{10}{900} 1315\setfont\smallit\itshape{9}{1000} 1316\setfont\smallsl\slshape{9}{1000} 1317\setfont\smallsf\sfshape{9}{1000} 1318\setfont\smallsc\scshape{10}{900} 1319\setfont\smallttsl\ttslshape{10}{900} 1320\font\smalli=cmmi9 1321\font\smallsy=cmsy9 1322 1323% Fonts for small examples (8pt). 1324\setfont\smallerrm\rmshape{8}{1000} 1325\setfont\smallertt\ttshape{8}{1000} 1326\setfont\smallerbf\bfshape{10}{800} 1327\setfont\smallerit\itshape{8}{1000} 1328\setfont\smallersl\slshape{8}{1000} 1329\setfont\smallersf\sfshape{8}{1000} 1330\setfont\smallersc\scshape{10}{800} 1331\setfont\smallerttsl\ttslshape{10}{800} 1332\font\smalleri=cmmi8 1333\font\smallersy=cmsy8 1334 1335% Fonts for title page: 1336\setfont\titlerm\rmbshape{12}{\magstep3} 1337\setfont\titleit\itbshape{10}{\magstep4} 1338\setfont\titlesl\slbshape{10}{\magstep4} 1339\setfont\titlett\ttbshape{12}{\magstep3} 1340\setfont\titlettsl\ttslshape{10}{\magstep4} 1341\setfont\titlesf\sfbshape{17}{\magstep1} 1342\let\titlebf=\titlerm 1343\setfont\titlesc\scbshape{10}{\magstep4} 1344\font\titlei=cmmi12 scaled \magstep3 1345\font\titlesy=cmsy10 scaled \magstep4 1346\def\authorrm{\secrm} 1347\def\authortt{\sectt} 1348 1349% Chapter (and unnumbered) fonts (17.28pt). 1350\setfont\chaprm\rmbshape{12}{\magstep2} 1351\setfont\chapit\itbshape{10}{\magstep3} 1352\setfont\chapsl\slbshape{10}{\magstep3} 1353\setfont\chaptt\ttbshape{12}{\magstep2} 1354\setfont\chapttsl\ttslshape{10}{\magstep3} 1355\setfont\chapsf\sfbshape{17}{1000} 1356\let\chapbf=\chaprm 1357\setfont\chapsc\scbshape{10}{\magstep3} 1358\font\chapi=cmmi12 scaled \magstep2 1359\font\chapsy=cmsy10 scaled \magstep3 1360 1361% Section fonts (14.4pt). 1362\setfont\secrm\rmbshape{12}{\magstep1} 1363\setfont\secit\itbshape{10}{\magstep2} 1364\setfont\secsl\slbshape{10}{\magstep2} 1365\setfont\sectt\ttbshape{12}{\magstep1} 1366\setfont\secttsl\ttslshape{10}{\magstep2} 1367\setfont\secsf\sfbshape{12}{\magstep1} 1368\let\secbf\secrm 1369\setfont\secsc\scbshape{10}{\magstep2} 1370\font\seci=cmmi12 scaled \magstep1 1371\font\secsy=cmsy10 scaled \magstep2 1372 1373% Subsection fonts (13.15pt). 1374\setfont\ssecrm\rmbshape{12}{\magstephalf} 1375\setfont\ssecit\itbshape{10}{1315} 1376\setfont\ssecsl\slbshape{10}{1315} 1377\setfont\ssectt\ttbshape{12}{\magstephalf} 1378\setfont\ssecttsl\ttslshape{10}{1315} 1379\setfont\ssecsf\sfbshape{12}{\magstephalf} 1380\let\ssecbf\ssecrm 1381\setfont\ssecsc\scbshape{10}{\magstep1} 1382\font\sseci=cmmi12 scaled \magstephalf 1383\font\ssecsy=cmsy10 scaled 1315 1384% The smallcaps and symbol fonts should actually be scaled \magstep1.5, 1385% but that is not a standard magnification. 1386 1387% In order for the font changes to affect most math symbols and letters, 1388% we have to define the \textfont of the standard families. Since 1389% texinfo doesn't allow for producing subscripts and superscripts except 1390% in the main text, we don't bother to reset \scriptfont and 1391% \scriptscriptfont (which would also require loading a lot more fonts). 1392% 1393\def\resetmathfonts{% 1394 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy 1395 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf 1396 \textfont\ttfam=\tentt \textfont\sffam=\tensf 1397} 1398 1399% The font-changing commands redefine the meanings of \tenSTYLE, instead 1400% of just \STYLE. We do this so that font changes will continue to work 1401% in math mode, where it is the current \fam that is relevant in most 1402% cases, not the current font. Plain TeX does \def\bf{\fam=\bffam 1403% \tenbf}, for example. By redefining \tenbf, we obviate the need to 1404% redefine \bf itself. 1405\def\textfonts{% 1406 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl 1407 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc 1408 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl 1409 \resetmathfonts \setleading{\textleading}} 1410\def\titlefonts{% 1411 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl 1412 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc 1413 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy 1414 \let\tenttsl=\titlettsl 1415 \resetmathfonts \setleading{25pt}} 1416\def\titlefont#1{{\titlefonts\rm #1}} 1417\def\chapfonts{% 1418 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl 1419 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc 1420 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl 1421 \resetmathfonts \setleading{19pt}} 1422\def\secfonts{% 1423 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl 1424 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc 1425 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl 1426 \resetmathfonts \setleading{16pt}} 1427\def\subsecfonts{% 1428 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl 1429 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc 1430 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl 1431 \resetmathfonts \setleading{15pt}} 1432\let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf? 1433\def\smallfonts{% 1434 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl 1435 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc 1436 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy 1437 \let\tenttsl=\smallttsl 1438 \resetmathfonts \setleading{10.5pt}} 1439\def\smallerfonts{% 1440 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl 1441 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc 1442 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy 1443 \let\tenttsl=\smallerttsl 1444 \resetmathfonts \setleading{9.5pt}} 1445 1446% Set the fonts to use with the @small... environments. 1447\let\smallexamplefonts = \smallfonts 1448 1449% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample 1450% can fit this many characters: 1451% 8.5x11=86 smallbook=72 a4=90 a5=69 1452% If we use \smallerfonts (8pt), then we can fit this many characters: 1453% 8.5x11=90+ smallbook=80 a4=90+ a5=77 1454% For me, subjectively, the few extra characters that fit aren't worth 1455% the additional smallness of 8pt. So I'm making the default 9pt. 1456% 1457% By the way, for comparison, here's what fits with @example (10pt): 1458% 8.5x11=71 smallbook=60 a4=75 a5=58 1459% 1460% I wish we used A4 paper on this side of the Atlantic. 1461% 1462% --karl, 24jan03. 1463 1464 1465% Set up the default fonts, so we can use them for creating boxes. 1466% 1467\textfonts 1468 1469% Define these so they can be easily changed for other fonts. 1470\def\angleleft{$\langle$} 1471\def\angleright{$\rangle$} 1472 1473% Count depth in font-changes, for error checks 1474\newcount\fontdepth \fontdepth=0 1475 1476% Fonts for short table of contents. 1477\setfont\shortcontrm\rmshape{12}{1000} 1478\setfont\shortcontbf\bxshape{12}{1000} 1479\setfont\shortcontsl\slshape{12}{1000} 1480\setfont\shortconttt\ttshape{12}{1000} 1481 1482%% Add scribe-like font environments, plus @l for inline lisp (usually sans 1483%% serif) and @ii for TeX italic 1484 1485% \smartitalic{ARG} outputs arg in italics, followed by an italic correction 1486% unless the following character is such as not to need one. 1487\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else 1488 \ptexslash\fi\fi\fi} 1489\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} 1490\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} 1491 1492\let\i=\smartitalic 1493\let\var=\smartslanted 1494\let\dfn=\smartslanted 1495\let\emph=\smartitalic 1496\let\cite=\smartslanted 1497 1498\def\b#1{{\bf #1}} 1499\let\strong=\b 1500 1501% We can't just use \exhyphenpenalty, because that only has effect at 1502% the end of a paragraph. Restore normal hyphenation at the end of the 1503% group within which \nohyphenation is presumably called. 1504% 1505\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} 1506\def\restorehyphenation{\hyphenchar\font = `- } 1507 1508% Set sfcode to normal for the chars that usually have another value. 1509% Can't use plain's \frenchspacing because it uses the `\x notation, and 1510% sometimes \x has an active definition that messes things up. 1511% 1512\catcode`@=11 1513 \def\frenchspacing{% 1514 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m 1515 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m 1516 } 1517\catcode`@=\other 1518 1519\def\t#1{% 1520 {\tt \rawbackslash \frenchspacing #1}% 1521 \null 1522} 1523\let\ttfont=\t 1524\def\samp#1{`\tclose{#1}'\null} 1525\setfont\keyrm\rmshape{8}{1000} 1526\font\keysy=cmsy9 1527\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% 1528 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% 1529 \vbox{\hrule\kern-0.4pt 1530 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% 1531 \kern-0.4pt\hrule}% 1532 \kern-.06em\raise0.4pt\hbox{\angleright}}}} 1533% The old definition, with no lozenge: 1534%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} 1535\def\ctrl #1{{\tt \rawbackslash \hat}#1} 1536 1537% @file, @option are the same as @samp. 1538\let\file=\samp 1539\let\option=\samp 1540 1541% @code is a modification of @t, 1542% which makes spaces the same size as normal in the surrounding text. 1543\def\tclose#1{% 1544 {% 1545 % Change normal interword space to be same as for the current font. 1546 \spaceskip = \fontdimen2\font 1547 % 1548 % Switch to typewriter. 1549 \tt 1550 % 1551 % But `\ ' produces the large typewriter interword space. 1552 \def\ {{\spaceskip = 0pt{} }}% 1553 % 1554 % Turn off hyphenation. 1555 \nohyphenation 1556 % 1557 \rawbackslash 1558 \frenchspacing 1559 #1% 1560 }% 1561 \null 1562} 1563 1564% We *must* turn on hyphenation at `-' and `_' in \code. 1565% Otherwise, it is too hard to avoid overfull hboxes 1566% in the Emacs manual, the Library manual, etc. 1567 1568% Unfortunately, TeX uses one parameter (\hyphenchar) to control 1569% both hyphenation at - and hyphenation within words. 1570% We must therefore turn them both off (\tclose does that) 1571% and arrange explicitly to hyphenate at a dash. 1572% -- rms. 1573{ 1574 \catcode`\-=\active 1575 \catcode`\_=\active 1576 % 1577 \global\def\code{\begingroup 1578 \catcode`\-=\active \let-\codedash 1579 \catcode`\_=\active \let_\codeunder 1580 \codex 1581 } 1582 % 1583 % If we end up with any active - characters when handling the index, 1584 % just treat them as a normal -. 1585 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash} 1586} 1587 1588\def\realdash{-} 1589\def\codedash{-\discretionary{}{}{}} 1590\def\codeunder{% 1591 % this is all so @math{@code{var_name}+1} can work. In math mode, _ 1592 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) 1593 % will therefore expand the active definition of _, which is us 1594 % (inside @code that is), therefore an endless loop. 1595 \ifusingtt{\ifmmode 1596 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. 1597 \else\normalunderscore \fi 1598 \discretionary{}{}{}}% 1599 {\_}% 1600} 1601\def\codex #1{\tclose{#1}\endgroup} 1602 1603% @kbd is like @code, except that if the argument is just one @key command, 1604% then @kbd has no effect. 1605 1606% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), 1607% `example' (@kbd uses ttsl only inside of @example and friends), 1608% or `code' (@kbd uses normal tty font always). 1609\def\kbdinputstyle{\parsearg\kbdinputstylexxx} 1610\def\kbdinputstylexxx#1{% 1611 \def\arg{#1}% 1612 \ifx\arg\worddistinct 1613 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% 1614 \else\ifx\arg\wordexample 1615 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% 1616 \else\ifx\arg\wordcode 1617 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% 1618 \else 1619 \errhelp = \EMsimple 1620 \errmessage{Unknown @kbdinputstyle option `\arg'}% 1621 \fi\fi\fi 1622} 1623\def\worddistinct{distinct} 1624\def\wordexample{example} 1625\def\wordcode{code} 1626 1627% Default is `distinct.' 1628\kbdinputstyle distinct 1629 1630\def\xkey{\key} 1631\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% 1632\ifx\one\xkey\ifx\threex\three \key{#2}% 1633\else{\tclose{\kbdfont\look}}\fi 1634\else{\tclose{\kbdfont\look}}\fi} 1635 1636% For @url, @env, @command quotes seem unnecessary, so use \code. 1637\let\url=\code 1638\let\env=\code 1639\let\command=\code 1640 1641% @uref (abbreviation for `urlref') takes an optional (comma-separated) 1642% second argument specifying the text to display and an optional third 1643% arg as text to display instead of (rather than in addition to) the url 1644% itself. First (mandatory) arg is the url. Perhaps eventually put in 1645% a hypertex \special here. 1646% 1647\def\uref#1{\douref #1,,,\finish} 1648\def\douref#1,#2,#3,#4\finish{\begingroup 1649 \unsepspaces 1650 \pdfurl{#1}% 1651 \setbox0 = \hbox{\ignorespaces #3}% 1652 \ifdim\wd0 > 0pt 1653 \unhbox0 % third arg given, show only that 1654 \else 1655 \setbox0 = \hbox{\ignorespaces #2}% 1656 \ifdim\wd0 > 0pt 1657 \ifpdf 1658 \unhbox0 % PDF: 2nd arg given, show only it 1659 \else 1660 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url 1661 \fi 1662 \else 1663 \code{#1}% only url given, so show it 1664 \fi 1665 \fi 1666 \endlink 1667\endgroup} 1668 1669% rms does not like angle brackets --karl, 17may97. 1670% So now @email is just like @uref, unless we are pdf. 1671% 1672%\def\email#1{\angleleft{\tt #1}\angleright} 1673\ifpdf 1674 \def\email#1{\doemail#1,,\finish} 1675 \def\doemail#1,#2,#3\finish{\begingroup 1676 \unsepspaces 1677 \pdfurl{mailto:#1}% 1678 \setbox0 = \hbox{\ignorespaces #2}% 1679 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi 1680 \endlink 1681 \endgroup} 1682\else 1683 \let\email=\uref 1684\fi 1685 1686% Check if we are currently using a typewriter font. Since all the 1687% Computer Modern typewriter fonts have zero interword stretch (and 1688% shrink), and it is reasonable to expect all typewriter fonts to have 1689% this property, we can check that font parameter. 1690% 1691\def\ifmonospace{\ifdim\fontdimen3\font=0pt } 1692 1693% Typeset a dimension, e.g., `in' or `pt'. The only reason for the 1694% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. 1695% 1696\def\dmn#1{\thinspace #1} 1697 1698\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} 1699 1700% @l was never documented to mean ``switch to the Lisp font'', 1701% and it is not used as such in any manual I can find. We need it for 1702% Polish suppressed-l. --karl, 22sep96. 1703%\def\l#1{{\li #1}\null} 1704 1705% Explicit font changes: @r, @sc, undocumented @ii. 1706\def\r#1{{\rm #1}} % roman font 1707\def\sc#1{{\smallcaps#1}} % smallcaps font 1708\def\ii#1{{\it #1}} % italic font 1709 1710% @acronym downcases the argument and prints in smallcaps. 1711\def\acronym#1{{\smallcaps \lowercase{#1}}} 1712 1713% @pounds{} is a sterling sign. 1714\def\pounds{{\it\$}} 1715 1716% @registeredsymbol - R in a circle. For now, only works in text size; 1717% we'd have to redo the font mechanism to change the \scriptstyle and 1718% \scriptscriptstyle font sizes to make it look right in headings. 1719% Adapted from the plain.tex definition of \copyright. 1720% 1721\def\registeredsymbol{% 1722 $^{{\ooalign{\hfil\raise.07ex\hbox{$\scriptstyle\rm R$}\hfil\crcr\Orb}}% 1723 }$% 1724} 1725 1726 1727\message{page headings,} 1728 1729\newskip\titlepagetopglue \titlepagetopglue = 1.5in 1730\newskip\titlepagebottomglue \titlepagebottomglue = 2pc 1731 1732% First the title page. Must do @settitle before @titlepage. 1733\newif\ifseenauthor 1734\newif\iffinishedtitlepage 1735 1736% Do an implicit @contents or @shortcontents after @end titlepage if the 1737% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. 1738% 1739\newif\ifsetcontentsaftertitlepage 1740 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue 1741\newif\ifsetshortcontentsaftertitlepage 1742 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue 1743 1744\def\shorttitlepage{\parsearg\shorttitlepagezzz} 1745\def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% 1746 \endgroup\page\hbox{}\page} 1747 1748\def\titlepage{\begingroup \parindent=0pt \textfonts 1749 \let\subtitlerm=\tenrm 1750 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}% 1751 % 1752 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines 1753 \let\tt=\authortt}% 1754 % 1755 % Leave some space at the very top of the page. 1756 \vglue\titlepagetopglue 1757 % 1758 % Now you can print the title using @title. 1759 \def\title{\parsearg\titlezzz}% 1760 \def\titlezzz##1{\leftline{\titlefonts\rm ##1} 1761 % print a rule at the page bottom also. 1762 \finishedtitlepagefalse 1763 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}% 1764 % No rule at page bottom unless we print one at the top with @title. 1765 \finishedtitlepagetrue 1766 % 1767 % Now you can put text using @subtitle. 1768 \def\subtitle{\parsearg\subtitlezzz}% 1769 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}% 1770 % 1771 % @author should come last, but may come many times. 1772 \def\author{\parsearg\authorzzz}% 1773 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi 1774 {\authorfont \leftline{##1}}}% 1775 % 1776 % Most title ``pages'' are actually two pages long, with space 1777 % at the top of the second. We don't want the ragged left on the second. 1778 \let\oldpage = \page 1779 \def\page{% 1780 \iffinishedtitlepage\else 1781 \finishtitlepage 1782 \fi 1783 \oldpage 1784 \let\page = \oldpage 1785 \hbox{}}% 1786% \def\page{\oldpage \hbox{}} 1787} 1788 1789\def\Etitlepage{% 1790 \iffinishedtitlepage\else 1791 \finishtitlepage 1792 \fi 1793 % It is important to do the page break before ending the group, 1794 % because the headline and footline are only empty inside the group. 1795 % If we use the new definition of \page, we always get a blank page 1796 % after the title page, which we certainly don't want. 1797 \oldpage 1798 \endgroup 1799 % 1800 % Need this before the \...aftertitlepage checks so that if they are 1801 % in effect the toc pages will come out with page numbers. 1802 \HEADINGSon 1803 % 1804 % If they want short, they certainly want long too. 1805 \ifsetshortcontentsaftertitlepage 1806 \shortcontents 1807 \contents 1808 \global\let\shortcontents = \relax 1809 \global\let\contents = \relax 1810 \fi 1811 % 1812 \ifsetcontentsaftertitlepage 1813 \contents 1814 \global\let\contents = \relax 1815 \global\let\shortcontents = \relax 1816 \fi 1817} 1818 1819\def\finishtitlepage{% 1820 \vskip4pt \hrule height 2pt width \hsize 1821 \vskip\titlepagebottomglue 1822 \finishedtitlepagetrue 1823} 1824 1825%%% Set up page headings and footings. 1826 1827\let\thispage=\folio 1828 1829\newtoks\evenheadline % headline on even pages 1830\newtoks\oddheadline % headline on odd pages 1831\newtoks\evenfootline % footline on even pages 1832\newtoks\oddfootline % footline on odd pages 1833 1834% Now make Tex use those variables 1835\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline 1836 \else \the\evenheadline \fi}} 1837\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline 1838 \else \the\evenfootline \fi}\HEADINGShook} 1839\let\HEADINGShook=\relax 1840 1841% Commands to set those variables. 1842% For example, this is what @headings on does 1843% @evenheading @thistitle|@thispage|@thischapter 1844% @oddheading @thischapter|@thispage|@thistitle 1845% @evenfooting @thisfile|| 1846% @oddfooting ||@thisfile 1847 1848\def\evenheading{\parsearg\evenheadingxxx} 1849\def\oddheading{\parsearg\oddheadingxxx} 1850\def\everyheading{\parsearg\everyheadingxxx} 1851 1852\def\evenfooting{\parsearg\evenfootingxxx} 1853\def\oddfooting{\parsearg\oddfootingxxx} 1854\def\everyfooting{\parsearg\everyfootingxxx} 1855 1856{\catcode`\@=0 % 1857 1858\gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish} 1859\gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{% 1860\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 1861 1862\gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish} 1863\gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{% 1864\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 1865 1866\gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}% 1867 1868\gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish} 1869\gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{% 1870\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} 1871 1872\gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish} 1873\gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{% 1874 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% 1875 % 1876 % Leave some space for the footline. Hopefully ok to assume 1877 % @evenfooting will not be used by itself. 1878 \global\advance\pageheight by -\baselineskip 1879 \global\advance\vsize by -\baselineskip 1880} 1881 1882\gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}} 1883% 1884}% unbind the catcode of @. 1885 1886% @headings double turns headings on for double-sided printing. 1887% @headings single turns headings on for single-sided printing. 1888% @headings off turns them off. 1889% @headings on same as @headings double, retained for compatibility. 1890% @headings after turns on double-sided headings after this page. 1891% @headings doubleafter turns on double-sided headings after this page. 1892% @headings singleafter turns on single-sided headings after this page. 1893% By default, they are off at the start of a document, 1894% and turned `on' after @end titlepage. 1895 1896\def\headings #1 {\csname HEADINGS#1\endcsname} 1897 1898\def\HEADINGSoff{ 1899\global\evenheadline={\hfil} \global\evenfootline={\hfil} 1900\global\oddheadline={\hfil} \global\oddfootline={\hfil}} 1901\HEADINGSoff 1902% When we turn headings on, set the page number to 1. 1903% For double-sided printing, put current file name in lower left corner, 1904% chapter name on inside top of right hand pages, document 1905% title on inside top of left hand pages, and page numbers on outside top 1906% edge of all pages. 1907\def\HEADINGSdouble{ 1908\global\pageno=1 1909\global\evenfootline={\hfil} 1910\global\oddfootline={\hfil} 1911\global\evenheadline={\line{\folio\hfil\thistitle}} 1912\global\oddheadline={\line{\thischapter\hfil\folio}} 1913\global\let\contentsalignmacro = \chapoddpage 1914} 1915\let\contentsalignmacro = \chappager 1916 1917% For single-sided printing, chapter title goes across top left of page, 1918% page number on top right. 1919\def\HEADINGSsingle{ 1920\global\pageno=1 1921\global\evenfootline={\hfil} 1922\global\oddfootline={\hfil} 1923\global\evenheadline={\line{\thischapter\hfil\folio}} 1924\global\oddheadline={\line{\thischapter\hfil\folio}} 1925\global\let\contentsalignmacro = \chappager 1926} 1927\def\HEADINGSon{\HEADINGSdouble} 1928 1929\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} 1930\let\HEADINGSdoubleafter=\HEADINGSafter 1931\def\HEADINGSdoublex{% 1932\global\evenfootline={\hfil} 1933\global\oddfootline={\hfil} 1934\global\evenheadline={\line{\folio\hfil\thistitle}} 1935\global\oddheadline={\line{\thischapter\hfil\folio}} 1936\global\let\contentsalignmacro = \chapoddpage 1937} 1938 1939\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} 1940\def\HEADINGSsinglex{% 1941\global\evenfootline={\hfil} 1942\global\oddfootline={\hfil} 1943\global\evenheadline={\line{\thischapter\hfil\folio}} 1944\global\oddheadline={\line{\thischapter\hfil\folio}} 1945\global\let\contentsalignmacro = \chappager 1946} 1947 1948% Subroutines used in generating headings 1949% This produces Day Month Year style of output. 1950% Only define if not already defined, in case a txi-??.tex file has set 1951% up a different format (e.g., txi-cs.tex does this). 1952\ifx\today\undefined 1953\def\today{% 1954 \number\day\space 1955 \ifcase\month 1956 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr 1957 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug 1958 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec 1959 \fi 1960 \space\number\year} 1961\fi 1962 1963% @settitle line... specifies the title of the document, for headings. 1964% It generates no output of its own. 1965\def\thistitle{\putwordNoTitle} 1966\def\settitle{\parsearg\settitlezzz} 1967\def\settitlezzz #1{\gdef\thistitle{#1}} 1968 1969 1970\message{tables,} 1971% Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x). 1972 1973% default indentation of table text 1974\newdimen\tableindent \tableindent=.8in 1975% default indentation of @itemize and @enumerate text 1976\newdimen\itemindent \itemindent=.3in 1977% margin between end of table item and start of table text. 1978\newdimen\itemmargin \itemmargin=.1in 1979 1980% used internally for \itemindent minus \itemmargin 1981\newdimen\itemmax 1982 1983% Note @table, @vtable, and @vtable define @item, @itemx, etc., with 1984% these defs. 1985% They also define \itemindex 1986% to index the item name in whatever manner is desired (perhaps none). 1987 1988\newif\ifitemxneedsnegativevskip 1989 1990\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} 1991 1992\def\internalBitem{\smallbreak \parsearg\itemzzz} 1993\def\internalBitemx{\itemxpar \parsearg\itemzzz} 1994 1995\def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz} 1996\def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz} 1997 1998\def\internalBkitem{\smallbreak \parsearg\kitemzzz} 1999\def\internalBkitemx{\itemxpar \parsearg\kitemzzz} 2000 2001\def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}% 2002 \itemzzz {#1}} 2003 2004\def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}% 2005 \itemzzz {#1}} 2006 2007\def\itemzzz #1{\begingroup % 2008 \advance\hsize by -\rightskip 2009 \advance\hsize by -\tableindent 2010 \setbox0=\hbox{\itemfont{#1}}% 2011 \itemindex{#1}% 2012 \nobreak % This prevents a break before @itemx. 2013 % 2014 % If the item text does not fit in the space we have, put it on a line 2015 % by itself, and do not allow a page break either before or after that 2016 % line. We do not start a paragraph here because then if the next 2017 % command is, e.g., @kindex, the whatsit would get put into the 2018 % horizontal list on a line by itself, resulting in extra blank space. 2019 \ifdim \wd0>\itemmax 2020 % 2021 % Make this a paragraph so we get the \parskip glue and wrapping, 2022 % but leave it ragged-right. 2023 \begingroup 2024 \advance\leftskip by-\tableindent 2025 \advance\hsize by\tableindent 2026 \advance\rightskip by0pt plus1fil 2027 \leavevmode\unhbox0\par 2028 \endgroup 2029 % 2030 % We're going to be starting a paragraph, but we don't want the 2031 % \parskip glue -- logically it's part of the @item we just started. 2032 \nobreak \vskip-\parskip 2033 % 2034 % Stop a page break at the \parskip glue coming up. (Unfortunately 2035 % we can't prevent a possible page break at the following 2036 % \baselineskip glue.) However, if what follows is an environment 2037 % such as @example, there will be no \parskip glue; then 2038 % the negative vskip we just would cause the example and the item to 2039 % crash together. So we use this bizarre value of 10001 as a signal 2040 % to \aboveenvbreak to insert \parskip glue after all. 2041 % (Possibly there are other commands that could be followed by 2042 % @example which need the same treatment, but not section titles; or 2043 % maybe section titles are the only special case and they should be 2044 % penalty 10001...) 2045 \penalty 10001 2046 \endgroup 2047 \itemxneedsnegativevskipfalse 2048 \else 2049 % The item text fits into the space. Start a paragraph, so that the 2050 % following text (if any) will end up on the same line. 2051 \noindent 2052 % Do this with kerns and \unhbox so that if there is a footnote in 2053 % the item text, it can migrate to the main vertical list and 2054 % eventually be printed. 2055 \nobreak\kern-\tableindent 2056 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 2057 \unhbox0 2058 \nobreak\kern\dimen0 2059 \endgroup 2060 \itemxneedsnegativevskiptrue 2061 \fi 2062} 2063 2064\def\item{\errmessage{@item while not in a table}} 2065\def\itemx{\errmessage{@itemx while not in a table}} 2066\def\kitem{\errmessage{@kitem while not in a table}} 2067\def\kitemx{\errmessage{@kitemx while not in a table}} 2068\def\xitem{\errmessage{@xitem while not in a table}} 2069\def\xitemx{\errmessage{@xitemx while not in a table}} 2070 2071% Contains a kludge to get @end[description] to work. 2072\def\description{\tablez{\dontindex}{1}{}{}{}{}} 2073 2074% @table, @ftable, @vtable. 2075\def\table{\begingroup\inENV\obeylines\obeyspaces\tablex} 2076{\obeylines\obeyspaces% 2077\gdef\tablex #1^^M{% 2078\tabley\dontindex#1 \endtabley}} 2079 2080\def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex} 2081{\obeylines\obeyspaces% 2082\gdef\ftablex #1^^M{% 2083\tabley\fnitemindex#1 \endtabley 2084\def\Eftable{\endgraf\afterenvbreak\endgroup}% 2085\let\Etable=\relax}} 2086 2087\def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex} 2088{\obeylines\obeyspaces% 2089\gdef\vtablex #1^^M{% 2090\tabley\vritemindex#1 \endtabley 2091\def\Evtable{\endgraf\afterenvbreak\endgroup}% 2092\let\Etable=\relax}} 2093 2094\def\dontindex #1{} 2095\def\fnitemindex #1{\doind {fn}{\code{#1}}}% 2096\def\vritemindex #1{\doind {vr}{\code{#1}}}% 2097 2098{\obeyspaces % 2099\gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup% 2100\tablez{#1}{#2}{#3}{#4}{#5}{#6}}} 2101 2102\def\tablez #1#2#3#4#5#6{% 2103\aboveenvbreak % 2104\begingroup % 2105\def\Edescription{\Etable}% Necessary kludge. 2106\let\itemindex=#1% 2107\ifnum 0#3>0 \advance \leftskip by #3\mil \fi % 2108\ifnum 0#4>0 \tableindent=#4\mil \fi % 2109\ifnum 0#5>0 \advance \rightskip by #5\mil \fi % 2110\def\itemfont{#2}% 2111\itemmax=\tableindent % 2112\advance \itemmax by -\itemmargin % 2113\advance \leftskip by \tableindent % 2114\exdentamount=\tableindent 2115\parindent = 0pt 2116\parskip = \smallskipamount 2117\ifdim \parskip=0pt \parskip=2pt \fi% 2118\def\Etable{\endgraf\afterenvbreak\endgroup}% 2119\let\item = \internalBitem % 2120\let\itemx = \internalBitemx % 2121\let\kitem = \internalBkitem % 2122\let\kitemx = \internalBkitemx % 2123\let\xitem = \internalBxitem % 2124\let\xitemx = \internalBxitemx % 2125} 2126 2127% This is the counter used by @enumerate, which is really @itemize 2128 2129\newcount \itemno 2130 2131\def\itemize{\parsearg\itemizezzz} 2132 2133\def\itemizezzz #1{% 2134 \begingroup % ended by the @end itemize 2135 \itemizey {#1}{\Eitemize} 2136} 2137 2138\def\itemizey#1#2{% 2139 \aboveenvbreak 2140 \itemmax=\itemindent 2141 \advance\itemmax by -\itemmargin 2142 \advance\leftskip by \itemindent 2143 \exdentamount=\itemindent 2144 \parindent=0pt 2145 \parskip=\smallskipamount 2146 \ifdim\parskip=0pt \parskip=2pt \fi 2147 \def#2{\endgraf\afterenvbreak\endgroup}% 2148 \def\itemcontents{#1}% 2149 % @itemize with no arg is equivalent to @itemize @bullet. 2150 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi 2151 \let\item=\itemizeitem 2152} 2153 2154% \splitoff TOKENS\endmark defines \first to be the first token in 2155% TOKENS, and \rest to be the remainder. 2156% 2157\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% 2158 2159% Allow an optional argument of an uppercase letter, lowercase letter, 2160% or number, to specify the first label in the enumerated list. No 2161% argument is the same as `1'. 2162% 2163\def\enumerate{\parsearg\enumeratezzz} 2164\def\enumeratezzz #1{\enumeratey #1 \endenumeratey} 2165\def\enumeratey #1 #2\endenumeratey{% 2166 \begingroup % ended by the @end enumerate 2167 % 2168 % If we were given no argument, pretend we were given `1'. 2169 \def\thearg{#1}% 2170 \ifx\thearg\empty \def\thearg{1}\fi 2171 % 2172 % Detect if the argument is a single token. If so, it might be a 2173 % letter. Otherwise, the only valid thing it can be is a number. 2174 % (We will always have one token, because of the test we just made. 2175 % This is a good thing, since \splitoff doesn't work given nothing at 2176 % all -- the first parameter is undelimited.) 2177 \expandafter\splitoff\thearg\endmark 2178 \ifx\rest\empty 2179 % Only one token in the argument. It could still be anything. 2180 % A ``lowercase letter'' is one whose \lccode is nonzero. 2181 % An ``uppercase letter'' is one whose \lccode is both nonzero, and 2182 % not equal to itself. 2183 % Otherwise, we assume it's a number. 2184 % 2185 % We need the \relax at the end of the \ifnum lines to stop TeX from 2186 % continuing to look for a <number>. 2187 % 2188 \ifnum\lccode\expandafter`\thearg=0\relax 2189 \numericenumerate % a number (we hope) 2190 \else 2191 % It's a letter. 2192 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax 2193 \lowercaseenumerate % lowercase letter 2194 \else 2195 \uppercaseenumerate % uppercase letter 2196 \fi 2197 \fi 2198 \else 2199 % Multiple tokens in the argument. We hope it's a number. 2200 \numericenumerate 2201 \fi 2202} 2203 2204% An @enumerate whose labels are integers. The starting integer is 2205% given in \thearg. 2206% 2207\def\numericenumerate{% 2208 \itemno = \thearg 2209 \startenumeration{\the\itemno}% 2210} 2211 2212% The starting (lowercase) letter is in \thearg. 2213\def\lowercaseenumerate{% 2214 \itemno = \expandafter`\thearg 2215 \startenumeration{% 2216 % Be sure we're not beyond the end of the alphabet. 2217 \ifnum\itemno=0 2218 \errmessage{No more lowercase letters in @enumerate; get a bigger 2219 alphabet}% 2220 \fi 2221 \char\lccode\itemno 2222 }% 2223} 2224 2225% The starting (uppercase) letter is in \thearg. 2226\def\uppercaseenumerate{% 2227 \itemno = \expandafter`\thearg 2228 \startenumeration{% 2229 % Be sure we're not beyond the end of the alphabet. 2230 \ifnum\itemno=0 2231 \errmessage{No more uppercase letters in @enumerate; get a bigger 2232 alphabet} 2233 \fi 2234 \char\uccode\itemno 2235 }% 2236} 2237 2238% Call itemizey, adding a period to the first argument and supplying the 2239% common last two arguments. Also subtract one from the initial value in 2240% \itemno, since @item increments \itemno. 2241% 2242\def\startenumeration#1{% 2243 \advance\itemno by -1 2244 \itemizey{#1.}\Eenumerate\flushcr 2245} 2246 2247% @alphaenumerate and @capsenumerate are abbreviations for giving an arg 2248% to @enumerate. 2249% 2250\def\alphaenumerate{\enumerate{a}} 2251\def\capsenumerate{\enumerate{A}} 2252\def\Ealphaenumerate{\Eenumerate} 2253\def\Ecapsenumerate{\Eenumerate} 2254 2255% Definition of @item while inside @itemize. 2256 2257\def\itemizeitem{% 2258\advance\itemno by 1 2259{\let\par=\endgraf \smallbreak}% 2260\ifhmode \errmessage{In hmode at itemizeitem}\fi 2261{\parskip=0in \hskip 0pt 2262\hbox to 0pt{\hss \itemcontents\hskip \itemmargin}% 2263\vadjust{\penalty 1200}}% 2264\flushcr} 2265 2266% @multitable macros 2267% Amy Hendrickson, 8/18/94, 3/6/96 2268% 2269% @multitable ... @end multitable will make as many columns as desired. 2270% Contents of each column will wrap at width given in preamble. Width 2271% can be specified either with sample text given in a template line, 2272% or in percent of \hsize, the current width of text on page. 2273 2274% Table can continue over pages but will only break between lines. 2275 2276% To make preamble: 2277% 2278% Either define widths of columns in terms of percent of \hsize: 2279% @multitable @columnfractions .25 .3 .45 2280% @item ... 2281% 2282% Numbers following @columnfractions are the percent of the total 2283% current hsize to be used for each column. You may use as many 2284% columns as desired. 2285 2286 2287% Or use a template: 2288% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 2289% @item ... 2290% using the widest term desired in each column. 2291% 2292% For those who want to use more than one line's worth of words in 2293% the preamble, break the line within one argument and it 2294% will parse correctly, i.e., 2295% 2296% @multitable {Column 1 template} {Column 2 template} {Column 3 2297% template} 2298% Not: 2299% @multitable {Column 1 template} {Column 2 template} 2300% {Column 3 template} 2301 2302% Each new table line starts with @item, each subsequent new column 2303% starts with @tab. Empty columns may be produced by supplying @tab's 2304% with nothing between them for as many times as empty columns are needed, 2305% ie, @tab@tab@tab will produce two empty columns. 2306 2307% @item, @tab, @multitable or @end multitable do not need to be on their 2308% own lines, but it will not hurt if they are. 2309 2310% Sample multitable: 2311 2312% @multitable {Column 1 template} {Column 2 template} {Column 3 template} 2313% @item first col stuff @tab second col stuff @tab third col 2314% @item 2315% first col stuff 2316% @tab 2317% second col stuff 2318% @tab 2319% third col 2320% @item first col stuff @tab second col stuff 2321% @tab Many paragraphs of text may be used in any column. 2322% 2323% They will wrap at the width determined by the template. 2324% @item@tab@tab This will be in third column. 2325% @end multitable 2326 2327% Default dimensions may be reset by user. 2328% @multitableparskip is vertical space between paragraphs in table. 2329% @multitableparindent is paragraph indent in table. 2330% @multitablecolmargin is horizontal space to be left between columns. 2331% @multitablelinespace is space to leave between table items, baseline 2332% to baseline. 2333% 0pt means it depends on current normal line spacing. 2334% 2335\newskip\multitableparskip 2336\newskip\multitableparindent 2337\newdimen\multitablecolspace 2338\newskip\multitablelinespace 2339\multitableparskip=0pt 2340\multitableparindent=6pt 2341\multitablecolspace=12pt 2342\multitablelinespace=0pt 2343 2344% Macros used to set up halign preamble: 2345% 2346\let\endsetuptable\relax 2347\def\xendsetuptable{\endsetuptable} 2348\let\columnfractions\relax 2349\def\xcolumnfractions{\columnfractions} 2350\newif\ifsetpercent 2351 2352% #1 is the part of the @columnfraction before the decimal point, which 2353% is presumably either 0 or the empty string (but we don't check, we 2354% just throw it away). #2 is the decimal part, which we use as the 2355% percent of \hsize for this column. 2356\def\pickupwholefraction#1.#2 {% 2357 \global\advance\colcount by 1 2358 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}% 2359 \setuptable 2360} 2361 2362\newcount\colcount 2363\def\setuptable#1{% 2364 \def\firstarg{#1}% 2365 \ifx\firstarg\xendsetuptable 2366 \let\go = \relax 2367 \else 2368 \ifx\firstarg\xcolumnfractions 2369 \global\setpercenttrue 2370 \else 2371 \ifsetpercent 2372 \let\go\pickupwholefraction 2373 \else 2374 \global\advance\colcount by 1 2375 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a 2376 % separator; typically that is always in the input, anyway. 2377 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% 2378 \fi 2379 \fi 2380 \ifx\go\pickupwholefraction 2381 % Put the argument back for the \pickupwholefraction call, so 2382 % we'll always have a period there to be parsed. 2383 \def\go{\pickupwholefraction#1}% 2384 \else 2385 \let\go = \setuptable 2386 \fi% 2387 \fi 2388 \go 2389} 2390 2391% @multitable ... @end multitable definitions: 2392% 2393\def\multitable{\parsearg\dotable} 2394\def\dotable#1{\bgroup 2395 \vskip\parskip 2396 \let\item=\crcrwithfootnotes 2397 % A \tab used to include \hskip1sp. But then the space in a template 2398 % line is not enough. That is bad. So let's go back to just & until 2399 % we encounter the problem it was intended to solve again. --karl, 2400 % nathan@acm.org, 20apr99. 2401 \let\tab=&% 2402 \let\startfootins=\startsavedfootnote 2403 \tolerance=9500 2404 \hbadness=9500 2405 \setmultitablespacing 2406 \parskip=\multitableparskip 2407 \parindent=\multitableparindent 2408 \overfullrule=0pt 2409 \global\colcount=0 2410 \def\Emultitable{% 2411 \global\setpercentfalse 2412 \crcrwithfootnotes\crcr 2413 \egroup\egroup 2414 }% 2415 % 2416 % To parse everything between @multitable and @item: 2417 \setuptable#1 \endsetuptable 2418 % 2419 % \everycr will reset column counter, \colcount, at the end of 2420 % each line. Every column entry will cause \colcount to advance by one. 2421 % The table preamble 2422 % looks at the current \colcount to find the correct column width. 2423 \everycr{\noalign{% 2424 % 2425 % \filbreak%% keeps underfull box messages off when table breaks over pages. 2426 % Maybe so, but it also creates really weird page breaks when the table 2427 % breaks over pages. Wouldn't \vfil be better? Wait until the problem 2428 % manifests itself, so it can be fixed for real --karl. 2429 \global\colcount=0\relax}}% 2430 % 2431 % This preamble sets up a generic column definition, which will 2432 % be used as many times as user calls for columns. 2433 % \vtop will set a single line and will also let text wrap and 2434 % continue for many paragraphs if desired. 2435 \halign\bgroup&\global\advance\colcount by 1\relax 2436 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname 2437 % 2438 % In order to keep entries from bumping into each other 2439 % we will add a \leftskip of \multitablecolspace to all columns after 2440 % the first one. 2441 % 2442 % If a template has been used, we will add \multitablecolspace 2443 % to the width of each template entry. 2444 % 2445 % If the user has set preamble in terms of percent of \hsize we will 2446 % use that dimension as the width of the column, and the \leftskip 2447 % will keep entries from bumping into each other. Table will start at 2448 % left margin and final column will justify at right margin. 2449 % 2450 % Make sure we don't inherit \rightskip from the outer environment. 2451 \rightskip=0pt 2452 \ifnum\colcount=1 2453 % The first column will be indented with the surrounding text. 2454 \advance\hsize by\leftskip 2455 \else 2456 \ifsetpercent \else 2457 % If user has not set preamble in terms of percent of \hsize 2458 % we will advance \hsize by \multitablecolspace. 2459 \advance\hsize by \multitablecolspace 2460 \fi 2461 % In either case we will make \leftskip=\multitablecolspace: 2462 \leftskip=\multitablecolspace 2463 \fi 2464 % Ignoring space at the beginning and end avoids an occasional spurious 2465 % blank line, when TeX decides to break the line at the space before the 2466 % box from the multistrut, so the strut ends up on a line by itself. 2467 % For example: 2468 % @multitable @columnfractions .11 .89 2469 % @item @code{#} 2470 % @tab Legal holiday which is valid in major parts of the whole country. 2471 % Is automatically provided with highlighting sequences respectively marking 2472 % characters. 2473 \noindent\ignorespaces##\unskip\multistrut}\cr 2474} 2475 2476\def\setmultitablespacing{% test to see if user has set \multitablelinespace. 2477% If so, do nothing. If not, give it an appropriate dimension based on 2478% current baselineskip. 2479\ifdim\multitablelinespace=0pt 2480\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip 2481\global\advance\multitablelinespace by-\ht0 2482%% strut to put in table in case some entry doesn't have descenders, 2483%% to keep lines equally spaced 2484\let\multistrut = \strut 2485\else 2486%% FIXME: what is \box0 supposed to be? 2487\gdef\multistrut{\vrule height\multitablelinespace depth\dp0 2488width0pt\relax} \fi 2489%% Test to see if parskip is larger than space between lines of 2490%% table. If not, do nothing. 2491%% If so, set to same dimension as multitablelinespace. 2492\ifdim\multitableparskip>\multitablelinespace 2493\global\multitableparskip=\multitablelinespace 2494\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller 2495 %% than skip between lines in the table. 2496\fi% 2497\ifdim\multitableparskip=0pt 2498\global\multitableparskip=\multitablelinespace 2499\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller 2500 %% than skip between lines in the table. 2501\fi} 2502 2503% In case a @footnote appears inside an alignment, save the footnote 2504% text to a box and make the \insert when a row of the table is 2505% finished. Otherwise, the insertion is lost, it never migrates to the 2506% main vertical list. --kasal, 22jan03. 2507% 2508\newbox\savedfootnotes 2509% 2510% \dotable \let's \startfootins to this, so that \dofootnote will call 2511% it instead of starting the insertion right away. 2512\def\startsavedfootnote{% 2513 \global\setbox\savedfootnotes = \vbox\bgroup 2514 \unvbox\savedfootnotes 2515} 2516\def\crcrwithfootnotes{% 2517 \crcr 2518 \ifvoid\savedfootnotes \else 2519 \noalign{\insert\footins{\box\savedfootnotes}}% 2520 \fi 2521} 2522 2523\message{conditionals,} 2524% Prevent errors for section commands. 2525% Used in @ignore and in failing conditionals. 2526\def\ignoresections{% 2527 \let\chapter=\relax 2528 \let\unnumbered=\relax 2529 \let\top=\relax 2530 \let\unnumberedsec=\relax 2531 \let\unnumberedsection=\relax 2532 \let\unnumberedsubsec=\relax 2533 \let\unnumberedsubsection=\relax 2534 \let\unnumberedsubsubsec=\relax 2535 \let\unnumberedsubsubsection=\relax 2536 \let\section=\relax 2537 \let\subsec=\relax 2538 \let\subsubsec=\relax 2539 \let\subsection=\relax 2540 \let\subsubsection=\relax 2541 \let\appendix=\relax 2542 \let\appendixsec=\relax 2543 \let\appendixsection=\relax 2544 \let\appendixsubsec=\relax 2545 \let\appendixsubsection=\relax 2546 \let\appendixsubsubsec=\relax 2547 \let\appendixsubsubsection=\relax 2548 \let\contents=\relax 2549 \let\smallbook=\relax 2550 \let\titlepage=\relax 2551} 2552 2553% Used in nested conditionals, where we have to parse the Texinfo source 2554% and so want to turn off most commands, in case they are used 2555% incorrectly. 2556% 2557% We use \empty instead of \relax for the @def... commands, so that \end 2558% doesn't throw an error. For instance: 2559% @ignore 2560% @deffn ... 2561% @end deffn 2562% @end ignore 2563% 2564% The @end deffn is going to get expanded, because we're trying to allow 2565% nested conditionals. But we don't want to expand the actual @deffn, 2566% since it might be syntactically correct and intended to be ignored. 2567% Since \end checks for \relax, using \empty does not cause an error. 2568% 2569\def\ignoremorecommands{% 2570 \let\defcodeindex = \relax 2571 \let\defcv = \empty 2572 \let\defcvx = \empty 2573 \let\Edefcv = \empty 2574 \let\deffn = \empty 2575 \let\deffnx = \empty 2576 \let\Edeffn = \empty 2577 \let\defindex = \relax 2578 \let\defivar = \empty 2579 \let\defivarx = \empty 2580 \let\Edefivar = \empty 2581 \let\defmac = \empty 2582 \let\defmacx = \empty 2583 \let\Edefmac = \empty 2584 \let\defmethod = \empty 2585 \let\defmethodx = \empty 2586 \let\Edefmethod = \empty 2587 \let\defop = \empty 2588 \let\defopx = \empty 2589 \let\Edefop = \empty 2590 \let\defopt = \empty 2591 \let\defoptx = \empty 2592 \let\Edefopt = \empty 2593 \let\defspec = \empty 2594 \let\defspecx = \empty 2595 \let\Edefspec = \empty 2596 \let\deftp = \empty 2597 \let\deftpx = \empty 2598 \let\Edeftp = \empty 2599 \let\deftypefn = \empty 2600 \let\deftypefnx = \empty 2601 \let\Edeftypefn = \empty 2602 \let\deftypefun = \empty 2603 \let\deftypefunx = \empty 2604 \let\Edeftypefun = \empty 2605 \let\deftypeivar = \empty 2606 \let\deftypeivarx = \empty 2607 \let\Edeftypeivar = \empty 2608 \let\deftypemethod = \empty 2609 \let\deftypemethodx = \empty 2610 \let\Edeftypemethod = \empty 2611 \let\deftypeop = \empty 2612 \let\deftypeopx = \empty 2613 \let\Edeftypeop = \empty 2614 \let\deftypevar = \empty 2615 \let\deftypevarx = \empty 2616 \let\Edeftypevar = \empty 2617 \let\deftypevr = \empty 2618 \let\deftypevrx = \empty 2619 \let\Edeftypevr = \empty 2620 \let\defun = \empty 2621 \let\defunx = \empty 2622 \let\Edefun = \empty 2623 \let\defvar = \empty 2624 \let\defvarx = \empty 2625 \let\Edefvar = \empty 2626 \let\defvr = \empty 2627 \let\defvrx = \empty 2628 \let\Edefvr = \empty 2629 \let\clear = \relax 2630 \let\down = \relax 2631 \let\evenfooting = \relax 2632 \let\evenheading = \relax 2633 \let\everyfooting = \relax 2634 \let\everyheading = \relax 2635 \let\headings = \relax 2636 \let\include = \relax 2637 \let\item = \relax 2638 \let\lowersections = \relax 2639 \let\oddfooting = \relax 2640 \let\oddheading = \relax 2641 \let\printindex = \relax 2642 \let\pxref = \relax 2643 \let\raisesections = \relax 2644 \let\ref = \relax 2645 \let\set = \relax 2646 \let\setchapternewpage = \relax 2647 \let\setchapterstyle = \relax 2648 \let\settitle = \relax 2649 \let\up = \relax 2650 \let\verbatiminclude = \relax 2651 \let\xref = \relax 2652} 2653 2654% Ignore @ignore, @ifhtml, @ifinfo, and the like. 2655% 2656\def\direntry{\doignore{direntry}} 2657\def\documentdescriptionword{documentdescription} 2658\def\documentdescription{\doignore{documentdescription}} 2659\def\html{\doignore{html}} 2660\def\ifhtml{\doignore{ifhtml}} 2661\def\ifinfo{\doignore{ifinfo}} 2662\def\ifnottex{\doignore{ifnottex}} 2663\def\ifplaintext{\doignore{ifplaintext}} 2664\def\ifxml{\doignore{ifxml}} 2665\def\ignore{\doignore{ignore}} 2666\def\menu{\doignore{menu}} 2667\def\xml{\doignore{xml}} 2668 2669% @dircategory CATEGORY -- specify a category of the dir file 2670% which this file should belong to. Ignore this in TeX. 2671\let\dircategory = \comment 2672 2673% Ignore text until a line `@end #1'. 2674% 2675\def\doignore#1{\begingroup 2676 % Don't complain about control sequences we have declared \outer. 2677 \ignoresections 2678 % 2679 % Define a command to swallow text until we reach `@end #1'. 2680 % This @ is a catcode 12 token (that is the normal catcode of @ in 2681 % this texinfo.tex file). We change the catcode of @ below to match. 2682 \long\def\doignoretext##1@end #1{\enddoignore}% 2683 % 2684 % Make sure that spaces turn into tokens that match what \doignoretext wants. 2685 \catcode\spaceChar = 10 2686 % 2687 % Ignore braces, too, so mismatched braces don't cause trouble. 2688 \catcode`\{ = 9 2689 \catcode`\} = 9 2690 % 2691 % We must not have @c interpreted as a control sequence. 2692 \catcode`\@ = 12 2693 % 2694 \def\ignoreword{#1}% 2695 \ifx\ignoreword\documentdescriptionword 2696 % The c kludge breaks documentdescription, since 2697 % `documentdescription' contains a `c'. Means not everything will 2698 % be ignored inside @documentdescription, but oh well... 2699 \else 2700 % Make the letter c a comment character so that the rest of the line 2701 % will be ignored. This way, the document can have (for example) 2702 % @c @end ifinfo 2703 % and the @end ifinfo will be properly ignored. 2704 % (We've just changed @ to catcode 12.) 2705 \catcode`\c = 14 2706 \fi 2707 % 2708 % And now expand the command defined above. 2709 \doignoretext 2710} 2711 2712% What we do to finish off ignored text. 2713% 2714\def\enddoignore{\endgroup\ignorespaces}% 2715 2716\newif\ifwarnedobs\warnedobsfalse 2717\def\obstexwarn{% 2718 \ifwarnedobs\relax\else 2719 % We need to warn folks that they may have trouble with TeX 3.0. 2720 % This uses \immediate\write16 rather than \message to get newlines. 2721 \immediate\write16{} 2722 \immediate\write16{WARNING: for users of Unix TeX 3.0!} 2723 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).} 2724 \immediate\write16{If you are running another version of TeX, relax.} 2725 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.} 2726 \immediate\write16{ Then upgrade your TeX installation if you can.} 2727 \immediate\write16{ (See ftp://ftp.gnu.org/non-gnu/TeX.README.)} 2728 \immediate\write16{If you are stuck with version 3.0, run the} 2729 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution} 2730 \immediate\write16{ to use a workaround.} 2731 \immediate\write16{} 2732 \global\warnedobstrue 2733 \fi 2734} 2735 2736% **In TeX 3.0, setting text in \nullfont hangs tex. For a 2737% workaround (which requires the file ``dummy.tfm'' to be installed), 2738% uncomment the following line: 2739%%%%%\font\nullfont=dummy\let\obstexwarn=\relax 2740 2741% Ignore text, except that we keep track of conditional commands for 2742% purposes of nesting, up to an `@end #1' command. 2743% 2744\def\nestedignore#1{% 2745 \obstexwarn 2746 % We must actually expand the ignored text to look for the @end 2747 % command, so that nested ignore constructs work. Thus, we put the 2748 % text into a \vbox and then do nothing with the result. To minimize 2749 % the chance of memory overflow, we follow the approach outlined on 2750 % page 401 of the TeXbook. 2751 % 2752 \setbox0 = \vbox\bgroup 2753 % Don't complain about control sequences we have declared \outer. 2754 \ignoresections 2755 % 2756 % Define `@end #1' to end the box, which will in turn undefine the 2757 % @end command again. 2758 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}% 2759 % 2760 % We are going to be parsing Texinfo commands. Most cause no 2761 % trouble when they are used incorrectly, but some commands do 2762 % complicated argument parsing or otherwise get confused, so we 2763 % undefine them. 2764 % 2765 % We can't do anything about stray @-signs, unfortunately; 2766 % they'll produce `undefined control sequence' errors. 2767 \ignoremorecommands 2768 % 2769 % Set the current font to be \nullfont, a TeX primitive, and define 2770 % all the font commands to also use \nullfont. We don't use 2771 % dummy.tfm, as suggested in the TeXbook, because some sites 2772 % might not have that installed. Therefore, math mode will still 2773 % produce output, but that should be an extremely small amount of 2774 % stuff compared to the main input. 2775 % 2776 \nullfont 2777 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont 2778 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont 2779 \let\tensf=\nullfont 2780 % Similarly for index fonts. 2781 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont 2782 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont 2783 \let\smallsf=\nullfont 2784 % Similarly for smallexample fonts. 2785 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont 2786 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont 2787 \let\smallersf=\nullfont 2788 % 2789 % Don't complain when characters are missing from the fonts. 2790 \tracinglostchars = 0 2791 % 2792 % Don't bother to do space factor calculations. 2793 \frenchspacing 2794 % 2795 % Don't report underfull hboxes. 2796 \hbadness = 10000 2797 % 2798 % Do minimal line-breaking. 2799 \pretolerance = 10000 2800 % 2801 % Do not execute instructions in @tex. 2802 \def\tex{\doignore{tex}}% 2803 % Do not execute macro definitions. 2804 % `c' is a comment character, so the word `macro' will get cut off. 2805 \def\macro{\doignore{ma}}% 2806} 2807 2808% @set VAR sets the variable VAR to an empty value. 2809% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. 2810% 2811% Since we want to separate VAR from REST-OF-LINE (which might be 2812% empty), we can't just use \parsearg; we have to insert a space of our 2813% own to delimit the rest of the line, and then take it out again if we 2814% didn't need it. Make sure the catcode of space is correct to avoid 2815% losing inside @example, for instance. 2816% 2817\def\set{\begingroup\catcode` =10 2818 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR. 2819 \parsearg\setxxx} 2820\def\setxxx#1{\setyyy#1 \endsetyyy} 2821\def\setyyy#1 #2\endsetyyy{% 2822 \def\temp{#2}% 2823 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty 2824 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted. 2825 \fi 2826 \endgroup 2827} 2828% Can't use \xdef to pre-expand #2 and save some time, since \temp or 2829% \next or other control sequences that we've defined might get us into 2830% an infinite loop. Consider `@set foo @cite{bar}'. 2831\def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}} 2832 2833% @clear VAR clears (i.e., unsets) the variable VAR. 2834% 2835\def\clear{\parsearg\clearxxx} 2836\def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax} 2837 2838% @value{foo} gets the text saved in variable foo. 2839{ 2840 \catcode`\_ = \active 2841 % 2842 % We might end up with active _ or - characters in the argument if 2843 % we're called from @code, as @code{@value{foo-bar_}}. So \let any 2844 % such active characters to their normal equivalents. 2845 \gdef\value{\begingroup 2846 \catcode`\-=\other \catcode`\_=\other 2847 \indexbreaks \let_\normalunderscore 2848 \valuexxx} 2849} 2850\def\valuexxx#1{\expandablevalue{#1}\endgroup} 2851 2852% We have this subroutine so that we can handle at least some @value's 2853% properly in indexes (we \let\value to this in \indexdummies). Ones 2854% whose names contain - or _ still won't work, but we can't do anything 2855% about that. The command has to be fully expandable (if the variable 2856% is set), since the result winds up in the index file. This means that 2857% if the variable's value contains other Texinfo commands, it's almost 2858% certain it will fail (although perhaps we could fix that with 2859% sufficient work to do a one-level expansion on the result, instead of 2860% complete). 2861% 2862\def\expandablevalue#1{% 2863 \expandafter\ifx\csname SET#1\endcsname\relax 2864 {[No value for ``#1'']}% 2865 \message{Variable `#1', used in @value, is not set.}% 2866 \else 2867 \csname SET#1\endcsname 2868 \fi 2869} 2870 2871% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined 2872% with @set. 2873% 2874\def\ifset{\parsearg\doifset} 2875\def\doifset#1{% 2876 \expandafter\ifx\csname SET#1\endcsname\relax 2877 \let\next=\ifsetfail 2878 \else 2879 \let\next=\ifsetsucceed 2880 \fi 2881 \next 2882} 2883\def\ifsetsucceed{\conditionalsucceed{ifset}} 2884\def\ifsetfail{\nestedignore{ifset}} 2885\defineunmatchedend{ifset} 2886 2887% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been 2888% defined with @set, or has been undefined with @clear. 2889% 2890\def\ifclear{\parsearg\doifclear} 2891\def\doifclear#1{% 2892 \expandafter\ifx\csname SET#1\endcsname\relax 2893 \let\next=\ifclearsucceed 2894 \else 2895 \let\next=\ifclearfail 2896 \fi 2897 \next 2898} 2899\def\ifclearsucceed{\conditionalsucceed{ifclear}} 2900\def\ifclearfail{\nestedignore{ifclear}} 2901\defineunmatchedend{ifclear} 2902 2903% @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we 2904% read the text following, through the first @end iftex (etc.). Make 2905% `@end iftex' (etc.) valid only after an @iftex. 2906% 2907\def\iftex{\conditionalsucceed{iftex}} 2908\def\ifnothtml{\conditionalsucceed{ifnothtml}} 2909\def\ifnotinfo{\conditionalsucceed{ifnotinfo}} 2910\def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}} 2911\defineunmatchedend{iftex} 2912\defineunmatchedend{ifnothtml} 2913\defineunmatchedend{ifnotinfo} 2914\defineunmatchedend{ifnotplaintext} 2915 2916% True conditional. Since \set globally defines its variables, we can 2917% just start and end a group (to keep the @end definition undefined at 2918% the outer level). 2919% 2920\def\conditionalsucceed#1{\begingroup 2921 \expandafter\def\csname E#1\endcsname{\endgroup}% 2922} 2923 2924% @defininfoenclose. 2925\let\definfoenclose=\comment 2926 2927 2928\message{indexing,} 2929% Index generation facilities 2930 2931% Define \newwrite to be identical to plain tex's \newwrite 2932% except not \outer, so it can be used within \newindex. 2933{\catcode`\@=11 2934\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}} 2935 2936% \newindex {foo} defines an index named foo. 2937% It automatically defines \fooindex such that 2938% \fooindex ...rest of line... puts an entry in the index foo. 2939% It also defines \fooindfile to be the number of the output channel for 2940% the file that accumulates this index. The file's extension is foo. 2941% The name of an index should be no more than 2 characters long 2942% for the sake of vms. 2943% 2944\def\newindex#1{% 2945 \iflinks 2946 \expandafter\newwrite \csname#1indfile\endcsname 2947 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file 2948 \fi 2949 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index 2950 \noexpand\doindex{#1}} 2951} 2952 2953% @defindex foo == \newindex{foo} 2954% 2955\def\defindex{\parsearg\newindex} 2956 2957% Define @defcodeindex, like @defindex except put all entries in @code. 2958% 2959\def\defcodeindex{\parsearg\newcodeindex} 2960% 2961\def\newcodeindex#1{% 2962 \iflinks 2963 \expandafter\newwrite \csname#1indfile\endcsname 2964 \openout \csname#1indfile\endcsname \jobname.#1 2965 \fi 2966 \expandafter\xdef\csname#1index\endcsname{% 2967 \noexpand\docodeindex{#1}}% 2968} 2969 2970 2971% @synindex foo bar makes index foo feed into index bar. 2972% Do this instead of @defindex foo if you don't want it as a separate index. 2973% 2974% @syncodeindex foo bar similar, but put all entries made for index foo 2975% inside @code. 2976% 2977\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} 2978\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} 2979 2980% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), 2981% #3 the target index (bar). 2982\def\dosynindex#1#2#3{% 2983 % Only do \closeout if we haven't already done it, else we'll end up 2984 % closing the target index. 2985 \expandafter \ifx\csname donesynindex#2\endcsname \undefined 2986 % The \closeout helps reduce unnecessary open files; the limit on the 2987 % Acorn RISC OS is a mere 16 files. 2988 \expandafter\closeout\csname#2indfile\endcsname 2989 \expandafter\let\csname\donesynindex#2\endcsname = 1 2990 \fi 2991 % redefine \fooindfile: 2992 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname 2993 \expandafter\let\csname#2indfile\endcsname=\temp 2994 % redefine \fooindex: 2995 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% 2996} 2997 2998% Define \doindex, the driver for all \fooindex macros. 2999% Argument #1 is generated by the calling \fooindex macro, 3000% and it is "foo", the name of the index. 3001 3002% \doindex just uses \parsearg; it calls \doind for the actual work. 3003% This is because \doind is more useful to call from other macros. 3004 3005% There is also \dosubind {index}{topic}{subtopic} 3006% which makes an entry in a two-level index such as the operation index. 3007 3008\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} 3009\def\singleindexer #1{\doind{\indexname}{#1}} 3010 3011% like the previous two, but they put @code around the argument. 3012\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} 3013\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} 3014 3015% Take care of Texinfo commands that can appear in an index entry. 3016% Since there are some commands we want to expand, and others we don't, 3017% we have to laboriously prevent expansion for those that we don't. 3018% 3019\def\indexdummies{% 3020 \def\@{@}% change to @@ when we switch to @ as escape char in index files. 3021 \def\ {\realbackslash\space }% 3022 % Need these in case \tex is in effect and \{ is a \delimiter again. 3023 % But can't use \lbracecmd and \rbracecmd because texindex assumes 3024 % braces and backslashes are used only as delimiters. 3025 \let\{ = \mylbrace 3026 \let\} = \myrbrace 3027 % 3028 % \definedummyword defines \#1 as \realbackslash #1\space, thus 3029 % effectively preventing its expansion. This is used only for control 3030 % words, not control letters, because the \space would be incorrect 3031 % for control characters, but is needed to separate the control word 3032 % from whatever follows. 3033 % 3034 % For control letters, we have \definedummyletter, which omits the 3035 % space. 3036 % 3037 % These can be used both for control words that take an argument and 3038 % those that do not. If it is followed by {arg} in the input, then 3039 % that will dutifully get written to the index (or wherever). 3040 % 3041 \def\definedummyword##1{% 3042 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}% 3043 }% 3044 \def\definedummyletter##1{% 3045 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}% 3046 }% 3047 % 3048 % Do the redefinitions. 3049 \commondummies 3050} 3051 3052% For the aux file, @ is the escape character. So we want to redefine 3053% everything using @ instead of \realbackslash. When everything uses 3054% @, this will be simpler. 3055% 3056\def\atdummies{% 3057 \def\@{@@}% 3058 \def\ {@ }% 3059 \let\{ = \lbraceatcmd 3060 \let\} = \rbraceatcmd 3061 % 3062 % (See comments in \indexdummies.) 3063 \def\definedummyword##1{% 3064 \expandafter\def\csname ##1\endcsname{@##1\space}% 3065 }% 3066 \def\definedummyletter##1{% 3067 \expandafter\def\csname ##1\endcsname{@##1}% 3068 }% 3069 % 3070 % Do the redefinitions. 3071 \commondummies 3072} 3073 3074% Called from \indexdummies and \atdummies. \definedummyword and 3075% \definedummyletter must be defined first. 3076% 3077\def\commondummies{% 3078 % 3079 \normalturnoffactive 3080 % 3081 % Control letters and accents. 3082 \definedummyletter{_}% 3083 \definedummyletter{,}% 3084 \definedummyletter{"}% 3085 \definedummyletter{`}% 3086 \definedummyletter{'}% 3087 \definedummyletter{^}% 3088 \definedummyletter{~}% 3089 \definedummyletter{=}% 3090 \definedummyword{u}% 3091 \definedummyword{v}% 3092 \definedummyword{H}% 3093 \definedummyword{dotaccent}% 3094 \definedummyword{ringaccent}% 3095 \definedummyword{tieaccent}% 3096 \definedummyword{ubaraccent}% 3097 \definedummyword{udotaccent}% 3098 \definedummyword{dotless}% 3099 % 3100 % Other non-English letters. 3101 \definedummyword{AA}% 3102 \definedummyword{AE}% 3103 \definedummyword{L}% 3104 \definedummyword{OE}% 3105 \definedummyword{O}% 3106 \definedummyword{aa}% 3107 \definedummyword{ae}% 3108 \definedummyword{l}% 3109 \definedummyword{oe}% 3110 \definedummyword{o}% 3111 \definedummyword{ss}% 3112 % 3113 % Although these internal commands shouldn't show up, sometimes they do. 3114 \definedummyword{bf}% 3115 \definedummyword{gtr}% 3116 \definedummyword{hat}% 3117 \definedummyword{less}% 3118 \definedummyword{sf}% 3119 \definedummyword{sl}% 3120 \definedummyword{tclose}% 3121 \definedummyword{tt}% 3122 % 3123 % Texinfo font commands. 3124 \definedummyword{b}% 3125 \definedummyword{i}% 3126 \definedummyword{r}% 3127 \definedummyword{sc}% 3128 \definedummyword{t}% 3129 % 3130 \definedummyword{TeX}% 3131 \definedummyword{acronym}% 3132 \definedummyword{cite}% 3133 \definedummyword{code}% 3134 \definedummyword{command}% 3135 \definedummyword{dfn}% 3136 \definedummyword{dots}% 3137 \definedummyword{emph}% 3138 \definedummyword{env}% 3139 \definedummyword{file}% 3140 \definedummyword{kbd}% 3141 \definedummyword{key}% 3142 \definedummyword{math}% 3143 \definedummyword{option}% 3144 \definedummyword{samp}% 3145 \definedummyword{strong}% 3146 \definedummyword{uref}% 3147 \definedummyword{url}% 3148 \definedummyword{var}% 3149 \definedummyword{w}% 3150 % 3151 % Assorted special characters. 3152 \definedummyword{bullet}% 3153 \definedummyword{copyright}% 3154 \definedummyword{dots}% 3155 \definedummyword{enddots}% 3156 \definedummyword{equiv}% 3157 \definedummyword{error}% 3158 \definedummyword{expansion}% 3159 \definedummyword{minus}% 3160 \definedummyword{pounds}% 3161 \definedummyword{point}% 3162 \definedummyword{print}% 3163 \definedummyword{result}% 3164 % 3165 % Handle some cases of @value -- where the variable name does not 3166 % contain - or _, and the value does not contain any 3167 % (non-fully-expandable) commands. 3168 \let\value = \expandablevalue 3169 % 3170 % Normal spaces, not active ones. 3171 \unsepspaces 3172 % 3173 % No macro expansion. 3174 \turnoffmacros 3175} 3176 3177% If an index command is used in an @example environment, any spaces 3178% therein should become regular spaces in the raw index file, not the 3179% expansion of \tie (\leavevmode \penalty \@M \ ). 3180{\obeyspaces 3181 \gdef\unsepspaces{\obeyspaces\let =\space}} 3182 3183 3184% \indexnofonts is used when outputting the strings to sort the index 3185% by, and when constructing control sequence names. It eliminates all 3186% control sequences and just writes whatever the best ASCII sort string 3187% would be for a given command (usually its argument). 3188% 3189\def\indexdummytex{TeX} 3190\def\indexdummydots{...} 3191% 3192\def\indexnofonts{% 3193 \def\ { }% 3194 \def\@{@}% 3195 % how to handle braces? 3196 \def\_{\normalunderscore}% 3197 % 3198 \let\,=\asis 3199 \let\"=\asis 3200 \let\`=\asis 3201 \let\'=\asis 3202 \let\^=\asis 3203 \let\~=\asis 3204 \let\==\asis 3205 \let\u=\asis 3206 \let\v=\asis 3207 \let\H=\asis 3208 \let\dotaccent=\asis 3209 \let\ringaccent=\asis 3210 \let\tieaccent=\asis 3211 \let\ubaraccent=\asis 3212 \let\udotaccent=\asis 3213 \let\dotless=\asis 3214 % 3215 % Other non-English letters. 3216 \def\AA{AA}% 3217 \def\AE{AE}% 3218 \def\L{L}% 3219 \def\OE{OE}% 3220 \def\O{O}% 3221 \def\aa{aa}% 3222 \def\ae{ae}% 3223 \def\l{l}% 3224 \def\oe{oe}% 3225 \def\o{o}% 3226 \def\ss{ss}% 3227 \def\exclamdown{!}% 3228 \def\questiondown{?}% 3229 % 3230 % Don't no-op \tt, since it isn't a user-level command 3231 % and is used in the definitions of the active chars like <, >, |, etc. 3232 % Likewise with the other plain tex font commands. 3233 %\let\tt=\asis 3234 % 3235 % Texinfo font commands. 3236 \let\b=\asis 3237 \let\i=\asis 3238 \let\r=\asis 3239 \let\sc=\asis 3240 \let\t=\asis 3241 % 3242 \let\TeX=\indexdummytex 3243 \let\acronym=\asis 3244 \let\cite=\asis 3245 \let\code=\asis 3246 \let\command=\asis 3247 \let\dfn=\asis 3248 \let\dots=\indexdummydots 3249 \let\emph=\asis 3250 \let\env=\asis 3251 \let\file=\asis 3252 \let\kbd=\asis 3253 \let\key=\asis 3254 \let\math=\asis 3255 \let\option=\asis 3256 \let\samp=\asis 3257 \let\strong=\asis 3258 \let\uref=\asis 3259 \let\url=\asis 3260 \let\var=\asis 3261 \let\w=\asis 3262} 3263 3264\let\indexbackslash=0 %overridden during \printindex. 3265\let\SETmarginindex=\relax % put index entries in margin (undocumented)? 3266 3267% For \ifx comparisons. 3268\def\emptymacro{\empty} 3269 3270% Most index entries go through here, but \dosubind is the general case. 3271% 3272\def\doind#1#2{\dosubind{#1}{#2}\empty} 3273 3274% Workhorse for all \fooindexes. 3275% #1 is name of index, #2 is stuff to put there, #3 is subentry -- 3276% \empty if called from \doind, as we usually are. The main exception 3277% is with defuns, which call us directly. 3278% 3279\def\dosubind#1#2#3{% 3280 % Put the index entry in the margin if desired. 3281 \ifx\SETmarginindex\relax\else 3282 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}% 3283 \fi 3284 {% 3285 \count255=\lastpenalty 3286 {% 3287 \indexdummies % Must do this here, since \bf, etc expand at this stage 3288 \escapechar=`\\ 3289 {% 3290 \let\folio = 0% We will expand all macros now EXCEPT \folio. 3291 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now 3292 % so it will be output as is; and it will print as backslash. 3293 % 3294 % The main index entry text. 3295 \toks0 = {#2}% 3296 % 3297 % If third arg is present, precede it with space in sort key. 3298 \def\thirdarg{#3}% 3299 \ifx\thirdarg\emptymacro \else 3300 % If the third (subentry) arg is present, add it to the index 3301 % line to write. 3302 \toks0 = \expandafter{\the\toks0 \space #3}% 3303 \fi 3304 % 3305 % Process the index entry with all font commands turned off, to 3306 % get the string to sort by. 3307 {\indexnofonts 3308 \edef\temp{\the\toks0}% need full expansion 3309 \xdef\indexsorttmp{\temp}% 3310 }% 3311 % 3312 % Set up the complete index entry, with both the sort key and 3313 % the original text, including any font commands. We write 3314 % three arguments to \entry to the .?? file (four in the 3315 % subentry case), texindex reduces to two when writing the .??s 3316 % sorted result. 3317 \edef\temp{% 3318 \write\csname#1indfile\endcsname{% 3319 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}% 3320 }% 3321 % 3322 % If a skip is the last thing on the list now, preserve it 3323 % by backing up by \lastskip, doing the \write, then inserting 3324 % the skip again. Otherwise, the whatsit generated by the 3325 % \write will make \lastskip zero. The result is that sequences 3326 % like this: 3327 % @end defun 3328 % @tindex whatever 3329 % @defun ... 3330 % will have extra space inserted, because the \medbreak in the 3331 % start of the @defun won't see the skip inserted by the @end of 3332 % the previous defun. 3333 % 3334 % But don't do any of this if we're not in vertical mode. We 3335 % don't want to do a \vskip and prematurely end a paragraph. 3336 % 3337 % Avoid page breaks due to these extra skips, too. 3338 % 3339 \iflinks 3340 \ifvmode 3341 \skip0 = \lastskip 3342 \ifdim\lastskip = 0pt \else \nobreak\vskip-\skip0 \fi 3343 \fi 3344 % 3345 \temp % do the write 3346 % 3347 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi 3348 \fi 3349 }% 3350 }% 3351 \penalty\count255 3352 }% 3353} 3354 3355% The index entry written in the file actually looks like 3356% \entry {sortstring}{page}{topic} 3357% or 3358% \entry {sortstring}{page}{topic}{subtopic} 3359% The texindex program reads in these files and writes files 3360% containing these kinds of lines: 3361% \initial {c} 3362% before the first topic whose initial is c 3363% \entry {topic}{pagelist} 3364% for a topic that is used without subtopics 3365% \primary {topic} 3366% for the beginning of a topic that is used with subtopics 3367% \secondary {subtopic}{pagelist} 3368% for each subtopic. 3369 3370% Define the user-accessible indexing commands 3371% @findex, @vindex, @kindex, @cindex. 3372 3373\def\findex {\fnindex} 3374\def\kindex {\kyindex} 3375\def\cindex {\cpindex} 3376\def\vindex {\vrindex} 3377\def\tindex {\tpindex} 3378\def\pindex {\pgindex} 3379 3380\def\cindexsub {\begingroup\obeylines\cindexsub} 3381{\obeylines % 3382\gdef\cindexsub "#1" #2^^M{\endgroup % 3383\dosubind{cp}{#2}{#1}}} 3384 3385% Define the macros used in formatting output of the sorted index material. 3386 3387% @printindex causes a particular index (the ??s file) to get printed. 3388% It does not print any chapter heading (usually an @unnumbered). 3389% 3390\def\printindex{\parsearg\doprintindex} 3391\def\doprintindex#1{\begingroup 3392 \dobreak \chapheadingskip{10000}% 3393 % 3394 \smallfonts \rm 3395 \tolerance = 9500 3396 \everypar = {}% don't want the \kern\-parindent from indentation suppression. 3397 \indexbreaks 3398 % 3399 % See if the index file exists and is nonempty. 3400 % Change catcode of @ here so that if the index file contains 3401 % \initial {@} 3402 % as its first line, TeX doesn't complain about mismatched braces 3403 % (because it thinks @} is a control sequence). 3404 \catcode`\@ = 11 3405 \openin 1 \jobname.#1s 3406 \ifeof 1 3407 % \enddoublecolumns gets confused if there is no text in the index, 3408 % and it loses the chapter title and the aux file entries for the 3409 % index. The easiest way to prevent this problem is to make sure 3410 % there is some text. 3411 \putwordIndexNonexistent 3412 \else 3413 % 3414 % If the index file exists but is empty, then \openin leaves \ifeof 3415 % false. We have to make TeX try to read something from the file, so 3416 % it can discover if there is anything in it. 3417 \read 1 to \temp 3418 \ifeof 1 3419 \putwordIndexIsEmpty 3420 \else 3421 % Index files are almost Texinfo source, but we use \ as the escape 3422 % character. It would be better to use @, but that's too big a change 3423 % to make right now. 3424 \def\indexbackslash{\rawbackslashxx}% 3425 \catcode`\\ = 0 3426 \escapechar = `\\ 3427 \begindoublecolumns 3428 \input \jobname.#1s 3429 \enddoublecolumns 3430 \fi 3431 \fi 3432 \closein 1 3433\endgroup} 3434 3435% These macros are used by the sorted index file itself. 3436% Change them to control the appearance of the index. 3437 3438\def\initial#1{{% 3439 % Some minor font changes for the special characters. 3440 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt 3441 % 3442 % Remove any glue we may have, we'll be inserting our own. 3443 \removelastskip 3444 % 3445 % We like breaks before the index initials, so insert a bonus. 3446 \penalty -300 3447 % 3448 % Typeset the initial. Making this add up to a whole number of 3449 % baselineskips increases the chance of the dots lining up from column 3450 % to column. It still won't often be perfect, because of the stretch 3451 % we need before each entry, but it's better. 3452 % 3453 % No shrink because it confuses \balancecolumns. 3454 \vskip 1.67\baselineskip plus .5\baselineskip 3455 \leftline{\secbf #1}% 3456 \vskip .33\baselineskip plus .1\baselineskip 3457 % 3458 % Do our best not to break after the initial. 3459 \nobreak 3460}} 3461 3462% This typesets a paragraph consisting of #1, dot leaders, and then #2 3463% flush to the right margin. It is used for index and table of contents 3464% entries. The paragraph is indented by \leftskip. 3465% 3466\def\entry#1#2{\begingroup 3467 % 3468 % Start a new paragraph if necessary, so our assignments below can't 3469 % affect previous text. 3470 \par 3471 % 3472 % Do not fill out the last line with white space. 3473 \parfillskip = 0in 3474 % 3475 % No extra space above this paragraph. 3476 \parskip = 0in 3477 % 3478 % Do not prefer a separate line ending with a hyphen to fewer lines. 3479 \finalhyphendemerits = 0 3480 % 3481 % \hangindent is only relevant when the entry text and page number 3482 % don't both fit on one line. In that case, bob suggests starting the 3483 % dots pretty far over on the line. Unfortunately, a large 3484 % indentation looks wrong when the entry text itself is broken across 3485 % lines. So we use a small indentation and put up with long leaders. 3486 % 3487 % \hangafter is reset to 1 (which is the value we want) at the start 3488 % of each paragraph, so we need not do anything with that. 3489 \hangindent = 2em 3490 % 3491 % When the entry text needs to be broken, just fill out the first line 3492 % with blank space. 3493 \rightskip = 0pt plus1fil 3494 % 3495 % A bit of stretch before each entry for the benefit of balancing columns. 3496 \vskip 0pt plus1pt 3497 % 3498 % Start a ``paragraph'' for the index entry so the line breaking 3499 % parameters we've set above will have an effect. 3500 \noindent 3501 % 3502 % Insert the text of the index entry. TeX will do line-breaking on it. 3503 #1% 3504 % The following is kludged to not output a line of dots in the index if 3505 % there are no page numbers. The next person who breaks this will be 3506 % cursed by a Unix daemon. 3507 \def\tempa{{\rm }}% 3508 \def\tempb{#2}% 3509 \edef\tempc{\tempa}% 3510 \edef\tempd{\tempb}% 3511 \ifx\tempc\tempd\ \else% 3512 % 3513 % If we must, put the page number on a line of its own, and fill out 3514 % this line with blank space. (The \hfil is overwhelmed with the 3515 % fill leaders glue in \indexdotfill if the page number does fit.) 3516 \hfil\penalty50 3517 \null\nobreak\indexdotfill % Have leaders before the page number. 3518 % 3519 % The `\ ' here is removed by the implicit \unskip that TeX does as 3520 % part of (the primitive) \par. Without it, a spurious underfull 3521 % \hbox ensues. 3522 \ifpdf 3523 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. 3524 \else 3525 \ #2% The page number ends the paragraph. 3526 \fi 3527 \fi% 3528 \par 3529\endgroup} 3530 3531% Like \dotfill except takes at least 1 em. 3532\def\indexdotfill{\cleaders 3533 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill} 3534 3535\def\primary #1{\line{#1\hfil}} 3536 3537\newskip\secondaryindent \secondaryindent=0.5cm 3538\def\secondary#1#2{{% 3539 \parfillskip=0in 3540 \parskip=0in 3541 \hangindent=1in 3542 \hangafter=1 3543 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill 3544 \ifpdf 3545 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. 3546 \else 3547 #2 3548 \fi 3549 \par 3550}} 3551 3552% Define two-column mode, which we use to typeset indexes. 3553% Adapted from the TeXbook, page 416, which is to say, 3554% the manmac.tex format used to print the TeXbook itself. 3555\catcode`\@=11 3556 3557\newbox\partialpage 3558\newdimen\doublecolumnhsize 3559 3560\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns 3561 % Grab any single-column material above us. 3562 \output = {% 3563 % 3564 % Here is a possibility not foreseen in manmac: if we accumulate a 3565 % whole lot of material, we might end up calling this \output 3566 % routine twice in a row (see the doublecol-lose test, which is 3567 % essentially a couple of indexes with @setchapternewpage off). In 3568 % that case we just ship out what is in \partialpage with the normal 3569 % output routine. Generally, \partialpage will be empty when this 3570 % runs and this will be a no-op. See the indexspread.tex test case. 3571 \ifvoid\partialpage \else 3572 \onepageout{\pagecontents\partialpage}% 3573 \fi 3574 % 3575 \global\setbox\partialpage = \vbox{% 3576 % Unvbox the main output page. 3577 \unvbox\PAGE 3578 \kern-\topskip \kern\baselineskip 3579 }% 3580 }% 3581 \eject % run that output routine to set \partialpage 3582 % 3583 % Use the double-column output routine for subsequent pages. 3584 \output = {\doublecolumnout}% 3585 % 3586 % Change the page size parameters. We could do this once outside this 3587 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 3588 % format, but then we repeat the same computation. Repeating a couple 3589 % of assignments once per index is clearly meaningless for the 3590 % execution time, so we may as well do it in one place. 3591 % 3592 % First we halve the line length, less a little for the gutter between 3593 % the columns. We compute the gutter based on the line length, so it 3594 % changes automatically with the paper format. The magic constant 3595 % below is chosen so that the gutter has the same value (well, +-<1pt) 3596 % as it did when we hard-coded it. 3597 % 3598 % We put the result in a separate register, \doublecolumhsize, so we 3599 % can restore it in \pagesofar, after \hsize itself has (potentially) 3600 % been clobbered. 3601 % 3602 \doublecolumnhsize = \hsize 3603 \advance\doublecolumnhsize by -.04154\hsize 3604 \divide\doublecolumnhsize by 2 3605 \hsize = \doublecolumnhsize 3606 % 3607 % Double the \vsize as well. (We don't need a separate register here, 3608 % since nobody clobbers \vsize.) 3609 \vsize = 2\vsize 3610} 3611 3612% The double-column output routine for all double-column pages except 3613% the last. 3614% 3615\def\doublecolumnout{% 3616 \splittopskip=\topskip \splitmaxdepth=\maxdepth 3617 % Get the available space for the double columns -- the normal 3618 % (undoubled) page height minus any material left over from the 3619 % previous page. 3620 \dimen@ = \vsize 3621 \divide\dimen@ by 2 3622 \advance\dimen@ by -\ht\partialpage 3623 % 3624 % box0 will be the left-hand column, box2 the right. 3625 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ 3626 \onepageout\pagesofar 3627 \unvbox255 3628 \penalty\outputpenalty 3629} 3630% 3631% Re-output the contents of the output page -- any previous material, 3632% followed by the two boxes we just split, in box0 and box2. 3633\def\pagesofar{% 3634 \unvbox\partialpage 3635 % 3636 \hsize = \doublecolumnhsize 3637 \wd0=\hsize \wd2=\hsize 3638 \hbox to\pagewidth{\box0\hfil\box2}% 3639} 3640% 3641% All done with double columns. 3642\def\enddoublecolumns{% 3643 \output = {% 3644 % Split the last of the double-column material. Leave it on the 3645 % current page, no automatic page break. 3646 \balancecolumns 3647 % 3648 % If we end up splitting too much material for the current page, 3649 % though, there will be another page break right after this \output 3650 % invocation ends. Having called \balancecolumns once, we do not 3651 % want to call it again. Therefore, reset \output to its normal 3652 % definition right away. (We hope \balancecolumns will never be 3653 % called on to balance too much material, but if it is, this makes 3654 % the output somewhat more palatable.) 3655 \global\output = {\onepageout{\pagecontents\PAGE}}% 3656 }% 3657 \eject 3658 \endgroup % started in \begindoublecolumns 3659 % 3660 % \pagegoal was set to the doubled \vsize above, since we restarted 3661 % the current page. We're now back to normal single-column 3662 % typesetting, so reset \pagegoal to the normal \vsize (after the 3663 % \endgroup where \vsize got restored). 3664 \pagegoal = \vsize 3665} 3666% 3667% Called at the end of the double column material. 3668\def\balancecolumns{% 3669 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. 3670 \dimen@ = \ht0 3671 \advance\dimen@ by \topskip 3672 \advance\dimen@ by-\baselineskip 3673 \divide\dimen@ by 2 % target to split to 3674 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% 3675 \splittopskip = \topskip 3676 % Loop until we get a decent breakpoint. 3677 {% 3678 \vbadness = 10000 3679 \loop 3680 \global\setbox3 = \copy0 3681 \global\setbox1 = \vsplit3 to \dimen@ 3682 \ifdim\ht3>\dimen@ 3683 \global\advance\dimen@ by 1pt 3684 \repeat 3685 }% 3686 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% 3687 \setbox0=\vbox to\dimen@{\unvbox1}% 3688 \setbox2=\vbox to\dimen@{\unvbox3}% 3689 % 3690 \pagesofar 3691} 3692\catcode`\@ = \other 3693 3694 3695\message{sectioning,} 3696% Chapters, sections, etc. 3697 3698\newcount\chapno 3699\newcount\secno \secno=0 3700\newcount\subsecno \subsecno=0 3701\newcount\subsubsecno \subsubsecno=0 3702 3703% This counter is funny since it counts through charcodes of letters A, B, ... 3704\newcount\appendixno \appendixno = `\@ 3705% \def\appendixletter{\char\the\appendixno} 3706% We do the following for the sake of pdftex, which needs the actual 3707% letter in the expansion, not just typeset. 3708\def\appendixletter{% 3709 \ifnum\appendixno=`A A% 3710 \else\ifnum\appendixno=`B B% 3711 \else\ifnum\appendixno=`C C% 3712 \else\ifnum\appendixno=`D D% 3713 \else\ifnum\appendixno=`E E% 3714 \else\ifnum\appendixno=`F F% 3715 \else\ifnum\appendixno=`G G% 3716 \else\ifnum\appendixno=`H H% 3717 \else\ifnum\appendixno=`I I% 3718 \else\ifnum\appendixno=`J J% 3719 \else\ifnum\appendixno=`K K% 3720 \else\ifnum\appendixno=`L L% 3721 \else\ifnum\appendixno=`M M% 3722 \else\ifnum\appendixno=`N N% 3723 \else\ifnum\appendixno=`O O% 3724 \else\ifnum\appendixno=`P P% 3725 \else\ifnum\appendixno=`Q Q% 3726 \else\ifnum\appendixno=`R R% 3727 \else\ifnum\appendixno=`S S% 3728 \else\ifnum\appendixno=`T T% 3729 \else\ifnum\appendixno=`U U% 3730 \else\ifnum\appendixno=`V V% 3731 \else\ifnum\appendixno=`W W% 3732 \else\ifnum\appendixno=`X X% 3733 \else\ifnum\appendixno=`Y Y% 3734 \else\ifnum\appendixno=`Z Z% 3735 % The \the is necessary, despite appearances, because \appendixletter is 3736 % expanded while writing the .toc file. \char\appendixno is not 3737 % expandable, thus it is written literally, thus all appendixes come out 3738 % with the same letter (or @) in the toc without it. 3739 \else\char\the\appendixno 3740 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 3741 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} 3742 3743% Each @chapter defines this as the name of the chapter. 3744% page headings and footings can use it. @section does likewise. 3745\def\thischapter{} 3746\def\thissection{} 3747 3748\newcount\absseclevel % used to calculate proper heading level 3749\newcount\secbase\secbase=0 % @raise/lowersections modify this count 3750 3751% @raisesections: treat @section as chapter, @subsection as section, etc. 3752\def\raisesections{\global\advance\secbase by -1} 3753\let\up=\raisesections % original BFox name 3754 3755% @lowersections: treat @chapter as section, @section as subsection, etc. 3756\def\lowersections{\global\advance\secbase by 1} 3757\let\down=\lowersections % original BFox name 3758 3759% Choose a numbered-heading macro 3760% #1 is heading level if unmodified by @raisesections or @lowersections 3761% #2 is text for heading 3762\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 3763\ifcase\absseclevel 3764 \chapterzzz{#2} 3765\or 3766 \seczzz{#2} 3767\or 3768 \numberedsubseczzz{#2} 3769\or 3770 \numberedsubsubseczzz{#2} 3771\else 3772 \ifnum \absseclevel<0 3773 \chapterzzz{#2} 3774 \else 3775 \numberedsubsubseczzz{#2} 3776 \fi 3777\fi 3778\suppressfirstparagraphindent 3779} 3780 3781% like \numhead, but chooses appendix heading levels 3782\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 3783\ifcase\absseclevel 3784 \appendixzzz{#2} 3785\or 3786 \appendixsectionzzz{#2} 3787\or 3788 \appendixsubseczzz{#2} 3789\or 3790 \appendixsubsubseczzz{#2} 3791\else 3792 \ifnum \absseclevel<0 3793 \appendixzzz{#2} 3794 \else 3795 \appendixsubsubseczzz{#2} 3796 \fi 3797\fi 3798\suppressfirstparagraphindent 3799} 3800 3801% like \numhead, but chooses numberless heading levels 3802\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 3803\ifcase\absseclevel 3804 \unnumberedzzz{#2} 3805\or 3806 \unnumberedseczzz{#2} 3807\or 3808 \unnumberedsubseczzz{#2} 3809\or 3810 \unnumberedsubsubseczzz{#2} 3811\else 3812 \ifnum \absseclevel<0 3813 \unnumberedzzz{#2} 3814 \else 3815 \unnumberedsubsubseczzz{#2} 3816 \fi 3817\fi 3818\suppressfirstparagraphindent 3819} 3820 3821% @chapter, @appendix, @unnumbered. 3822\def\thischaptername{No Chapter Title} 3823\outer\def\chapter{\parsearg\chapteryyy} 3824\def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz 3825\def\chapterzzz #1{% 3826 \secno=0 \subsecno=0 \subsubsecno=0 3827 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}% 3828 \chapmacro {#1}{\the\chapno}% 3829 \gdef\thissection{#1}% 3830 \gdef\thischaptername{#1}% 3831 % We don't substitute the actual chapter name into \thischapter 3832 % because we don't want its macros evaluated now. 3833 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}% 3834 \writetocentry{chap}{#1}{{\the\chapno}} 3835 \donoderef 3836 \global\let\section = \numberedsec 3837 \global\let\subsection = \numberedsubsec 3838 \global\let\subsubsection = \numberedsubsubsec 3839} 3840 3841% we use \chapno to avoid indenting back 3842\def\appendixbox#1{% 3843 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}% 3844 \hbox to \wd0{#1\hss}} 3845 3846\outer\def\appendix{\parsearg\appendixyyy} 3847\def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz 3848\def\appendixzzz #1{% 3849 \secno=0 \subsecno=0 \subsubsecno=0 3850 \global\advance \appendixno by 1 3851 \message{\putwordAppendix\space \appendixletter}% 3852 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}% 3853 \gdef\thissection{#1}% 3854 \gdef\thischaptername{#1}% 3855 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}% 3856 \writetocentry{appendix}{#1}{{\appendixletter}} 3857 \appendixnoderef 3858 \global\let\section = \appendixsec 3859 \global\let\subsection = \appendixsubsec 3860 \global\let\subsubsection = \appendixsubsubsec 3861} 3862 3863% @centerchap is like @unnumbered, but the heading is centered. 3864\outer\def\centerchap{\parsearg\centerchapyyy} 3865\def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}} 3866 3867% @top is like @unnumbered. 3868\outer\def\top{\parsearg\unnumberedyyy} 3869 3870\outer\def\unnumbered{\parsearg\unnumberedyyy} 3871\def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz 3872\def\unnumberedzzz #1{% 3873 \secno=0 \subsecno=0 \subsubsecno=0 3874 % 3875 % This used to be simply \message{#1}, but TeX fully expands the 3876 % argument to \message. Therefore, if #1 contained @-commands, TeX 3877 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX 3878 % expanded @cite (which turns out to cause errors because \cite is meant 3879 % to be executed, not expanded). 3880 % 3881 % Anyway, we don't want the fully-expanded definition of @cite to appear 3882 % as a result of the \message, we just want `@cite' itself. We use 3883 % \the<toks register> to achieve this: TeX expands \the<toks> only once, 3884 % simply yielding the contents of <toks register>. (We also do this for 3885 % the toc entries.) 3886 \toks0 = {#1}\message{(\the\toks0)}% 3887 % 3888 \unnumbchapmacro {#1}% 3889 \gdef\thischapter{#1}\gdef\thissection{#1}% 3890 \writetocentry{unnumbchap}{#1}{{\the\chapno}} 3891 \unnumbnoderef 3892 \global\let\section = \unnumberedsec 3893 \global\let\subsection = \unnumberedsubsec 3894 \global\let\subsubsection = \unnumberedsubsubsec 3895} 3896 3897% Sections. 3898\outer\def\numberedsec{\parsearg\secyyy} 3899\def\secyyy #1{\numhead1{#1}} % normally calls seczzz 3900\def\seczzz #1{% 3901 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % 3902 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}% 3903 \writetocentry{sec}{#1}{{\the\chapno}{\the\secno}} 3904 \donoderef 3905 \nobreak 3906} 3907 3908\outer\def\appendixsection{\parsearg\appendixsecyyy} 3909\outer\def\appendixsec{\parsearg\appendixsecyyy} 3910\def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz 3911\def\appendixsectionzzz #1{% 3912 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % 3913 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}% 3914 \writetocentry{sec}{#1}{{\appendixletter}{\the\secno}} 3915 \appendixnoderef 3916 \nobreak 3917} 3918 3919\outer\def\unnumberedsec{\parsearg\unnumberedsecyyy} 3920\def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz 3921\def\unnumberedseczzz #1{% 3922 \plainsecheading {#1}\gdef\thissection{#1}% 3923 \writetocentry{unnumbsec}{#1}{{\the\chapno}{\the\secno}} 3924 \unnumbnoderef 3925 \nobreak 3926} 3927 3928% Subsections. 3929\outer\def\numberedsubsec{\parsearg\numberedsubsecyyy} 3930\def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz 3931\def\numberedsubseczzz #1{% 3932 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % 3933 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}% 3934 \writetocentry{subsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}} 3935 \donoderef 3936 \nobreak 3937} 3938 3939\outer\def\appendixsubsec{\parsearg\appendixsubsecyyy} 3940\def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz 3941\def\appendixsubseczzz #1{% 3942 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % 3943 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}% 3944 \writetocentry{subsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}} 3945 \appendixnoderef 3946 \nobreak 3947} 3948 3949\outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy} 3950\def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz 3951\def\unnumberedsubseczzz #1{% 3952 \plainsubsecheading {#1}\gdef\thissection{#1}% 3953 \writetocentry{unnumbsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}} 3954 \unnumbnoderef 3955 \nobreak 3956} 3957 3958% Subsubsections. 3959\outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy} 3960\def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz 3961\def\numberedsubsubseczzz #1{% 3962 \gdef\thissection{#1}\global\advance \subsubsecno by 1 % 3963 \subsubsecheading {#1} 3964 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}% 3965 \writetocentry{subsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}} 3966 \donoderef 3967 \nobreak 3968} 3969 3970\outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy} 3971\def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz 3972\def\appendixsubsubseczzz #1{% 3973 \gdef\thissection{#1}\global\advance \subsubsecno by 1 % 3974 \subsubsecheading {#1} 3975 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}% 3976 \writetocentry{subsubsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}} 3977 \appendixnoderef 3978 \nobreak 3979} 3980 3981\outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy} 3982\def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz 3983\def\unnumberedsubsubseczzz #1{% 3984 \plainsubsubsecheading {#1}\gdef\thissection{#1}% 3985 \writetocentry{unnumbsubsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}} 3986 \unnumbnoderef 3987 \nobreak 3988} 3989 3990% These are variants which are not "outer", so they can appear in @ifinfo. 3991% Actually, they should now be obsolete; ordinary section commands should work. 3992\def\infotop{\parsearg\unnumberedzzz} 3993\def\infounnumbered{\parsearg\unnumberedzzz} 3994\def\infounnumberedsec{\parsearg\unnumberedseczzz} 3995\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz} 3996\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz} 3997 3998\def\infoappendix{\parsearg\appendixzzz} 3999\def\infoappendixsec{\parsearg\appendixseczzz} 4000\def\infoappendixsubsec{\parsearg\appendixsubseczzz} 4001\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz} 4002 4003\def\infochapter{\parsearg\chapterzzz} 4004\def\infosection{\parsearg\sectionzzz} 4005\def\infosubsection{\parsearg\subsectionzzz} 4006\def\infosubsubsection{\parsearg\subsubsectionzzz} 4007 4008% These macros control what the section commands do, according 4009% to what kind of chapter we are in (ordinary, appendix, or unnumbered). 4010% Define them by default for a numbered chapter. 4011\global\let\section = \numberedsec 4012\global\let\subsection = \numberedsubsec 4013\global\let\subsubsection = \numberedsubsubsec 4014 4015% Define @majorheading, @heading and @subheading 4016 4017% NOTE on use of \vbox for chapter headings, section headings, and such: 4018% 1) We use \vbox rather than the earlier \line to permit 4019% overlong headings to fold. 4020% 2) \hyphenpenalty is set to 10000 because hyphenation in a 4021% heading is obnoxious; this forbids it. 4022% 3) Likewise, headings look best if no \parindent is used, and 4023% if justification is not attempted. Hence \raggedright. 4024 4025 4026\def\majorheading{\parsearg\majorheadingzzz} 4027\def\majorheadingzzz #1{% 4028 {\advance\chapheadingskip by 10pt \chapbreak }% 4029 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4030 \parindent=0pt\raggedright 4031 \rm #1\hfill}}\bigskip \par\penalty 200} 4032 4033\def\chapheading{\parsearg\chapheadingzzz} 4034\def\chapheadingzzz #1{\chapbreak % 4035 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4036 \parindent=0pt\raggedright 4037 \rm #1\hfill}}\bigskip \par\penalty 200} 4038 4039% @heading, @subheading, @subsubheading. 4040\def\heading{\parsearg\plainsecheading} 4041\def\subheading{\parsearg\plainsubsecheading} 4042\def\subsubheading{\parsearg\plainsubsubsecheading} 4043 4044% These macros generate a chapter, section, etc. heading only 4045% (including whitespace, linebreaking, etc. around it), 4046% given all the information in convenient, parsed form. 4047 4048%%% Args are the skip and penalty (usually negative) 4049\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} 4050 4051\def\setchapterstyle #1 {\csname CHAPF#1\endcsname} 4052 4053%%% Define plain chapter starts, and page on/off switching for it 4054% Parameter controlling skip before chapter headings (if needed) 4055 4056\newskip\chapheadingskip 4057 4058\def\chapbreak{\dobreak \chapheadingskip {-4000}} 4059\def\chappager{\par\vfill\supereject} 4060\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} 4061 4062\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} 4063 4064\def\CHAPPAGoff{% 4065\global\let\contentsalignmacro = \chappager 4066\global\let\pchapsepmacro=\chapbreak 4067\global\let\pagealignmacro=\chappager} 4068 4069\def\CHAPPAGon{% 4070\global\let\contentsalignmacro = \chappager 4071\global\let\pchapsepmacro=\chappager 4072\global\let\pagealignmacro=\chappager 4073\global\def\HEADINGSon{\HEADINGSsingle}} 4074 4075\def\CHAPPAGodd{ 4076\global\let\contentsalignmacro = \chapoddpage 4077\global\let\pchapsepmacro=\chapoddpage 4078\global\let\pagealignmacro=\chapoddpage 4079\global\def\HEADINGSon{\HEADINGSdouble}} 4080 4081\CHAPPAGon 4082 4083\def\CHAPFplain{ 4084\global\let\chapmacro=\chfplain 4085\global\let\unnumbchapmacro=\unnchfplain 4086\global\let\centerchapmacro=\centerchfplain} 4087 4088% Plain chapter opening. 4089% #1 is the text, #2 the chapter number or empty if unnumbered. 4090\def\chfplain#1#2{% 4091 \pchapsepmacro 4092 {% 4093 \chapfonts \rm 4094 \def\chapnum{#2}% 4095 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}% 4096 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 4097 \hangindent = \wd0 \centerparametersmaybe 4098 \unhbox0 #1\par}% 4099 }% 4100 \nobreak\bigskip % no page break after a chapter title 4101 \nobreak 4102} 4103 4104% Plain opening for unnumbered. 4105\def\unnchfplain#1{\chfplain{#1}{}} 4106 4107% @centerchap -- centered and unnumbered. 4108\let\centerparametersmaybe = \relax 4109\def\centerchfplain#1{{% 4110 \def\centerparametersmaybe{% 4111 \advance\rightskip by 3\rightskip 4112 \leftskip = \rightskip 4113 \parfillskip = 0pt 4114 }% 4115 \chfplain{#1}{}% 4116}} 4117 4118\CHAPFplain % The default 4119 4120\def\unnchfopen #1{% 4121\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4122 \parindent=0pt\raggedright 4123 \rm #1\hfill}}\bigskip \par\nobreak 4124} 4125 4126\def\chfopen #1#2{\chapoddpage {\chapfonts 4127\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% 4128\par\penalty 5000 % 4129} 4130 4131\def\centerchfopen #1{% 4132\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 4133 \parindent=0pt 4134 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak 4135} 4136 4137\def\CHAPFopen{ 4138\global\let\chapmacro=\chfopen 4139\global\let\unnumbchapmacro=\unnchfopen 4140\global\let\centerchapmacro=\centerchfopen} 4141 4142 4143% Section titles. 4144\newskip\secheadingskip 4145\def\secheadingbreak{\dobreak \secheadingskip {-1000}} 4146\def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}} 4147\def\plainsecheading#1{\sectionheading{sec}{}{#1}} 4148 4149% Subsection titles. 4150\newskip \subsecheadingskip 4151\def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}} 4152\def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}} 4153\def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}} 4154 4155% Subsubsection titles. 4156\let\subsubsecheadingskip = \subsecheadingskip 4157\let\subsubsecheadingbreak = \subsecheadingbreak 4158\def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}} 4159\def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}} 4160 4161 4162% Print any size section title. 4163% 4164% #1 is the section type (sec/subsec/subsubsec), #2 is the section 4165% number (maybe empty), #3 the text. 4166\def\sectionheading#1#2#3{% 4167 {% 4168 \expandafter\advance\csname #1headingskip\endcsname by \parskip 4169 \csname #1headingbreak\endcsname 4170 }% 4171 {% 4172 % Switch to the right set of fonts. 4173 \csname #1fonts\endcsname \rm 4174 % 4175 % Only insert the separating space if we have a section number. 4176 \def\secnum{#2}% 4177 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}% 4178 % 4179 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 4180 \hangindent = \wd0 % zero if no section number 4181 \unhbox0 #3}% 4182 }% 4183 % Add extra space after the heading -- either a line space or a 4184 % paragraph space, whichever is more. (Some people like to set 4185 % \parskip to large values for some reason.) Don't allow stretch, though. 4186 \nobreak 4187 \ifdim\parskip>\normalbaselineskip 4188 \kern\parskip 4189 \else 4190 \kern\normalbaselineskip 4191 \fi 4192 \nobreak 4193} 4194 4195 4196\message{toc,} 4197% Table of contents. 4198\newwrite\tocfile 4199 4200% Write an entry to the toc file, opening it if necessary. 4201% Called from @chapter, etc. We supply {\folio} at the end of the 4202% argument, which will end up as the last argument to the \...entry macro. 4203% 4204% Usage: \writetocentry{chap}{The Name of The Game}{{\the\chapno}} 4205% We open the .toc file for writing here instead of at @setfilename (or 4206% any other fixed time) so that @contents can be anywhere in the document. 4207% 4208\newif\iftocfileopened 4209\def\writetocentry#1#2#3{% 4210 \iftocfileopened\else 4211 \immediate\openout\tocfile = \jobname.toc 4212 \global\tocfileopenedtrue 4213 \fi 4214 % 4215 \iflinks 4216 \toks0 = {#2}% 4217 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}#3{\folio}}}% 4218 \temp 4219 \fi 4220 % 4221 % Tell \shipout to create a page destination if we're doing pdf, which 4222 % will be the target of the links in the table of contents. We can't 4223 % just do it on every page because the title pages are numbered 1 and 4224 % 2 (the page numbers aren't printed), and so are the first two pages 4225 % of the document. Thus, we'd have two destinations named `1', and 4226 % two named `2'. 4227 \ifpdf \pdfmakepagedesttrue \fi 4228} 4229 4230\newskip\contentsrightmargin \contentsrightmargin=1in 4231\newcount\savepageno 4232\newcount\lastnegativepageno \lastnegativepageno = -1 4233 4234% Finish up the main text and prepare to read what we've written 4235% to \tocfile. 4236% 4237\def\startcontents#1{% 4238 % If @setchapternewpage on, and @headings double, the contents should 4239 % start on an odd page, unlike chapters. Thus, we maintain 4240 % \contentsalignmacro in parallel with \pagealignmacro. 4241 % From: Torbjorn Granlund <tege@matematik.su.se> 4242 \contentsalignmacro 4243 \immediate\closeout\tocfile 4244 % 4245 % Don't need to put `Contents' or `Short Contents' in the headline. 4246 % It is abundantly clear what they are. 4247 \unnumbchapmacro{#1}\def\thischapter{}% 4248 \savepageno = \pageno 4249 \begingroup % Set up to handle contents files properly. 4250 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 4251 % We can't do this, because then an actual ^ in a section 4252 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97. 4253 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi 4254 \raggedbottom % Worry more about breakpoints than the bottom. 4255 \advance\hsize by -\contentsrightmargin % Don't use the full line length. 4256 % 4257 % Roman numerals for page numbers. 4258 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi 4259} 4260 4261 4262% Normal (long) toc. 4263\def\contents{% 4264 \startcontents{\putwordTOC}% 4265 \openin 1 \jobname.toc 4266 \ifeof 1 \else 4267 \closein 1 4268 \input \jobname.toc 4269 \fi 4270 \vfill \eject 4271 \contentsalignmacro % in case @setchapternewpage odd is in effect 4272 \pdfmakeoutlines 4273 \endgroup 4274 \lastnegativepageno = \pageno 4275 \global\pageno = \savepageno 4276} 4277 4278% And just the chapters. 4279\def\summarycontents{% 4280 \startcontents{\putwordShortTOC}% 4281 % 4282 \let\chapentry = \shortchapentry 4283 \let\appendixentry = \shortappendixentry 4284 \let\unnumbchapentry = \shortunnumberedentry 4285 % We want a true roman here for the page numbers. 4286 \secfonts 4287 \let\rm=\shortcontrm \let\bf=\shortcontbf 4288 \let\sl=\shortcontsl \let\tt=\shortconttt 4289 \rm 4290 \hyphenpenalty = 10000 4291 \advance\baselineskip by 1pt % Open it up a little. 4292 \def\secentry ##1##2##3##4{} 4293 \def\subsecentry ##1##2##3##4##5{} 4294 \def\subsubsecentry ##1##2##3##4##5##6{} 4295 \let\unnumbsecentry = \secentry 4296 \let\unnumbsubsecentry = \subsecentry 4297 \let\unnumbsubsubsecentry = \subsubsecentry 4298 \openin 1 \jobname.toc 4299 \ifeof 1 \else 4300 \closein 1 4301 \input \jobname.toc 4302 \fi 4303 \vfill \eject 4304 \contentsalignmacro % in case @setchapternewpage odd is in effect 4305 \endgroup 4306 \lastnegativepageno = \pageno 4307 \global\pageno = \savepageno 4308} 4309\let\shortcontents = \summarycontents 4310 4311\ifpdf 4312 \pdfcatalog{/PageMode /UseOutlines}% 4313\fi 4314 4315% These macros generate individual entries in the table of contents. 4316% The first argument is the chapter or section name. 4317% The last argument is the page number. 4318% The arguments in between are the chapter number, section number, ... 4319 4320% Chapters, in the main contents. 4321\def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}} 4322% 4323% Chapters, in the short toc. 4324% See comments in \dochapentry re vbox and related settings. 4325\def\shortchapentry#1#2#3{% 4326 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}% 4327} 4328 4329% Appendices, in the main contents. 4330\def\appendixentry#1#2#3{% 4331 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}} 4332% 4333% Appendices, in the short toc. 4334\let\shortappendixentry = \shortchapentry 4335 4336% Typeset the label for a chapter or appendix for the short contents. 4337% The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter. 4338% We could simplify the code here by writing out an \appendixentry 4339% command in the toc file for appendices, instead of using \chapentry 4340% for both, but it doesn't seem worth it. 4341% 4342\newdimen\shortappendixwidth 4343% 4344\def\shortchaplabel#1{% 4345 % This space should be enough, since a single number is .5em, and the 4346 % widest letter (M) is 1em, at least in the Computer Modern fonts. 4347 % But use \hss just in case. 4348 % (This space doesn't include the extra space that gets added after 4349 % the label; that gets put in by \shortchapentry above.) 4350 \dimen0 = 1em 4351 \hbox to \dimen0{#1\hss}% 4352} 4353 4354% Unnumbered chapters. 4355\def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}} 4356\def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}} 4357 4358% Sections. 4359\def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}} 4360\def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}} 4361 4362% Subsections. 4363\def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}} 4364\def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}} 4365 4366% And subsubsections. 4367\def\subsubsecentry#1#2#3#4#5#6{% 4368 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}} 4369\def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}} 4370 4371% This parameter controls the indentation of the various levels. 4372\newdimen\tocindent \tocindent = 3pc 4373 4374% Now for the actual typesetting. In all these, #1 is the text and #2 is the 4375% page number. 4376% 4377% If the toc has to be broken over pages, we want it to be at chapters 4378% if at all possible; hence the \penalty. 4379\def\dochapentry#1#2{% 4380 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip 4381 \begingroup 4382 \chapentryfonts 4383 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 4384 \endgroup 4385 \nobreak\vskip .25\baselineskip plus.1\baselineskip 4386} 4387 4388\def\dosecentry#1#2{\begingroup 4389 \secentryfonts \leftskip=\tocindent 4390 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 4391\endgroup} 4392 4393\def\dosubsecentry#1#2{\begingroup 4394 \subsecentryfonts \leftskip=2\tocindent 4395 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 4396\endgroup} 4397 4398\def\dosubsubsecentry#1#2{\begingroup 4399 \subsubsecentryfonts \leftskip=3\tocindent 4400 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 4401\endgroup} 4402 4403% Final typesetting of a toc entry; we use the same \entry macro as for 4404% the index entries, but we want to suppress hyphenation here. (We 4405% can't do that in the \entry macro, since index entries might consist 4406% of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.) 4407\def\tocentry#1#2{\begingroup 4408 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks 4409 % Do not use \turnoffactive in these arguments. Since the toc is 4410 % typeset in cmr, characters such as _ would come out wrong; we 4411 % have to do the usual translation tricks. 4412 \entry{#1}{#2}% 4413\endgroup} 4414 4415% Space between chapter (or whatever) number and the title. 4416\def\labelspace{\hskip1em \relax} 4417 4418\def\dopageno#1{{\rm #1}} 4419\def\doshortpageno#1{{\rm #1}} 4420 4421\def\chapentryfonts{\secfonts \rm} 4422\def\secentryfonts{\textfonts} 4423\let\subsecentryfonts = \textfonts 4424\let\subsubsecentryfonts = \textfonts 4425 4426 4427\message{environments,} 4428% @foo ... @end foo. 4429 4430% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. 4431% 4432% Since these characters are used in examples, it should be an even number of 4433% \tt widths. Each \tt character is 1en, so two makes it 1em. 4434% 4435\def\point{$\star$} 4436\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} 4437\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} 4438\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} 4439\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} 4440 4441% The @error{} command. 4442% Adapted from the TeXbook's \boxit. 4443% 4444\newbox\errorbox 4445% 4446{\tentt \global\dimen0 = 3em}% Width of the box. 4447\dimen2 = .55pt % Thickness of rules 4448% The text. (`r' is open on the right, `e' somewhat less so on the left.) 4449\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} 4450% 4451\global\setbox\errorbox=\hbox to \dimen0{\hfil 4452 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. 4453 \advance\hsize by -2\dimen2 % Rules. 4454 \vbox{ 4455 \hrule height\dimen2 4456 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. 4457 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. 4458 \kern3pt\vrule width\dimen2}% Space to right. 4459 \hrule height\dimen2} 4460 \hfil} 4461% 4462\def\error{\leavevmode\lower.7ex\copy\errorbox} 4463 4464% @tex ... @end tex escapes into raw Tex temporarily. 4465% One exception: @ is still an escape character, so that @end tex works. 4466% But \@ or @@ will get a plain tex @ character. 4467 4468\def\tex{\begingroup 4469 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 4470 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 4471 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie 4472 \catcode `\%=14 4473 \catcode `\+=\other 4474 \catcode `\"=\other 4475 \catcode `\==\other 4476 \catcode `\|=\other 4477 \catcode `\<=\other 4478 \catcode `\>=\other 4479 \escapechar=`\\ 4480 % 4481 \let\b=\ptexb 4482 \let\bullet=\ptexbullet 4483 \let\c=\ptexc 4484 \let\,=\ptexcomma 4485 \let\.=\ptexdot 4486 \let\dots=\ptexdots 4487 \let\equiv=\ptexequiv 4488 \let\!=\ptexexclam 4489 \let\i=\ptexi 4490 \let\indent=\ptexindent 4491 \let\{=\ptexlbrace 4492 \let\+=\tabalign 4493 \let\}=\ptexrbrace 4494 \let\/=\ptexslash 4495 \let\*=\ptexstar 4496 \let\t=\ptext 4497 % 4498 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% 4499 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% 4500 \def\@{@}% 4501\let\Etex=\endgroup} 4502 4503% Define @lisp ... @end lisp. 4504% @lisp does a \begingroup so it can rebind things, 4505% including the definition of @end lisp (which normally is erroneous). 4506 4507% Amount to narrow the margins by for @lisp. 4508\newskip\lispnarrowing \lispnarrowing=0.4in 4509 4510% This is the definition that ^^M gets inside @lisp, @example, and other 4511% such environments. \null is better than a space, since it doesn't 4512% have any width. 4513\def\lisppar{\null\endgraf} 4514 4515% Make each space character in the input produce a normal interword 4516% space in the output. Don't allow a line break at this space, as this 4517% is used only in environments like @example, where each line of input 4518% should produce a line of output anyway. 4519% 4520{\obeyspaces % 4521\gdef\sepspaces{\obeyspaces\let =\tie}} 4522 4523% Define \obeyedspace to be our active space, whatever it is. This is 4524% for use in \parsearg. 4525{\sepspaces% 4526\global\let\obeyedspace= } 4527 4528% This space is always present above and below environments. 4529\newskip\envskipamount \envskipamount = 0pt 4530 4531% Make spacing and below environment symmetrical. We use \parskip here 4532% to help in doing that, since in @example-like environments \parskip 4533% is reset to zero; thus the \afterenvbreak inserts no space -- but the 4534% start of the next paragraph will insert \parskip. 4535% 4536\def\aboveenvbreak{{% 4537 % =10000 instead of <10000 because of a special case in \itemzzz, q.v. 4538 \ifnum \lastpenalty=10000 \else 4539 \advance\envskipamount by \parskip 4540 \endgraf 4541 \ifdim\lastskip<\envskipamount 4542 \removelastskip 4543 % it's not a good place to break if the last penalty was \nobreak 4544 % or better ... 4545 \ifnum\lastpenalty>10000 \else \penalty-50 \fi 4546 \vskip\envskipamount 4547 \fi 4548 \fi 4549}} 4550 4551\let\afterenvbreak = \aboveenvbreak 4552 4553% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins. 4554\let\nonarrowing=\relax 4555 4556% @cartouche ... @end cartouche: draw rectangle w/rounded corners around 4557% environment contents. 4558\font\circle=lcircle10 4559\newdimen\circthick 4560\newdimen\cartouter\newdimen\cartinner 4561\newskip\normbskip\newskip\normpskip\newskip\normlskip 4562\circthick=\fontdimen8\circle 4563% 4564\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth 4565\def\ctr{{\hskip 6pt\circle\char'010}} 4566\def\cbl{{\circle\char'012\hskip -6pt}} 4567\def\cbr{{\hskip 6pt\circle\char'011}} 4568\def\carttop{\hbox to \cartouter{\hskip\lskip 4569 \ctl\leaders\hrule height\circthick\hfil\ctr 4570 \hskip\rskip}} 4571\def\cartbot{\hbox to \cartouter{\hskip\lskip 4572 \cbl\leaders\hrule height\circthick\hfil\cbr 4573 \hskip\rskip}} 4574% 4575\newskip\lskip\newskip\rskip 4576 4577\def\cartouche{% 4578\par % can't be in the midst of a paragraph. 4579\begingroup 4580 \lskip=\leftskip \rskip=\rightskip 4581 \leftskip=0pt\rightskip=0pt %we want these *outside*. 4582 \cartinner=\hsize \advance\cartinner by-\lskip 4583 \advance\cartinner by-\rskip 4584 \cartouter=\hsize 4585 \advance\cartouter by 18.4pt % allow for 3pt kerns on either 4586% side, and for 6pt waste from 4587% each corner char, and rule thickness 4588 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip 4589 % Flag to tell @lisp, etc., not to narrow margin. 4590 \let\nonarrowing=\comment 4591 \vbox\bgroup 4592 \baselineskip=0pt\parskip=0pt\lineskip=0pt 4593 \carttop 4594 \hbox\bgroup 4595 \hskip\lskip 4596 \vrule\kern3pt 4597 \vbox\bgroup 4598 \hsize=\cartinner 4599 \kern3pt 4600 \begingroup 4601 \baselineskip=\normbskip 4602 \lineskip=\normlskip 4603 \parskip=\normpskip 4604 \vskip -\parskip 4605\def\Ecartouche{% 4606 \endgroup 4607 \kern3pt 4608 \egroup 4609 \kern3pt\vrule 4610 \hskip\rskip 4611 \egroup 4612 \cartbot 4613 \egroup 4614\endgroup 4615}} 4616 4617 4618% This macro is called at the beginning of all the @example variants, 4619% inside a group. 4620\def\nonfillstart{% 4621 \aboveenvbreak 4622 \inENV % This group ends at the end of the body 4623 \hfuzz = 12pt % Don't be fussy 4624 \sepspaces % Make spaces be word-separators rather than space tokens. 4625 \let\par = \lisppar % don't ignore blank lines 4626 \obeylines % each line of input is a line of output 4627 \parskip = 0pt 4628 \parindent = 0pt 4629 \emergencystretch = 0pt % don't try to avoid overfull boxes 4630 % @cartouche defines \nonarrowing to inhibit narrowing 4631 % at next level down. 4632 \ifx\nonarrowing\relax 4633 \advance \leftskip by \lispnarrowing 4634 \exdentamount=\lispnarrowing 4635 \let\exdent=\nofillexdent 4636 \let\nonarrowing=\relax 4637 \fi 4638} 4639 4640% Define the \E... control sequence only if we are inside the particular 4641% environment, so the error checking in \end will work. 4642% 4643% To end an @example-like environment, we first end the paragraph (via 4644% \afterenvbreak's vertical glue), and then the group. That way we keep 4645% the zero \parskip that the environments set -- \parskip glue will be 4646% inserted at the beginning of the next paragraph in the document, after 4647% the environment. 4648% 4649\def\nonfillfinish{\afterenvbreak\endgroup} 4650 4651% @lisp: indented, narrowed, typewriter font. 4652\def\lisp{\begingroup 4653 \nonfillstart 4654 \let\Elisp = \nonfillfinish 4655 \tt 4656 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. 4657 \gobble % eat return 4658} 4659 4660% @example: Same as @lisp. 4661\def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp} 4662 4663% @smallexample and @smalllisp: use smaller fonts. 4664% Originally contributed by Pavel@xerox. 4665\def\smalllisp{\begingroup 4666 \def\Esmalllisp{\nonfillfinish\endgroup}% 4667 \def\Esmallexample{\nonfillfinish\endgroup}% 4668 \smallexamplefonts 4669 \lisp 4670} 4671\let\smallexample = \smalllisp 4672 4673 4674% @display: same as @lisp except keep current font. 4675% 4676\def\display{\begingroup 4677 \nonfillstart 4678 \let\Edisplay = \nonfillfinish 4679 \gobble 4680} 4681% 4682% @smalldisplay: @display plus smaller fonts. 4683% 4684\def\smalldisplay{\begingroup 4685 \def\Esmalldisplay{\nonfillfinish\endgroup}% 4686 \smallexamplefonts \rm 4687 \display 4688} 4689 4690% @format: same as @display except don't narrow margins. 4691% 4692\def\format{\begingroup 4693 \let\nonarrowing = t 4694 \nonfillstart 4695 \let\Eformat = \nonfillfinish 4696 \gobble 4697} 4698% 4699% @smallformat: @format plus smaller fonts. 4700% 4701\def\smallformat{\begingroup 4702 \def\Esmallformat{\nonfillfinish\endgroup}% 4703 \smallexamplefonts \rm 4704 \format 4705} 4706 4707% @flushleft (same as @format). 4708% 4709\def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format} 4710 4711% @flushright. 4712% 4713\def\flushright{\begingroup 4714 \let\nonarrowing = t 4715 \nonfillstart 4716 \let\Eflushright = \nonfillfinish 4717 \advance\leftskip by 0pt plus 1fill 4718 \gobble 4719} 4720 4721 4722% @quotation does normal linebreaking (hence we can't use \nonfillstart) 4723% and narrows the margins. 4724% 4725\def\quotation{% 4726 \begingroup\inENV %This group ends at the end of the @quotation body 4727 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip 4728 \parindent=0pt 4729 % We have retained a nonzero parskip for the environment, since we're 4730 % doing normal filling. So to avoid extra space below the environment... 4731 \def\Equotation{\parskip = 0pt \nonfillfinish}% 4732 % 4733 % @cartouche defines \nonarrowing to inhibit narrowing at next level down. 4734 \ifx\nonarrowing\relax 4735 \advance\leftskip by \lispnarrowing 4736 \advance\rightskip by \lispnarrowing 4737 \exdentamount = \lispnarrowing 4738 \let\nonarrowing = \relax 4739 \fi 4740} 4741 4742 4743% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} 4744% If we want to allow any <char> as delimiter, 4745% we need the curly braces so that makeinfo sees the @verb command, eg: 4746% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org 4747% 4748% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. 4749% 4750% [Knuth] p.344; only we need to do the other characters Texinfo sets 4751% active too. Otherwise, they get lost as the first character on a 4752% verbatim line. 4753\def\dospecials{% 4754 \do\ \do\\\do\{\do\}\do\$\do\&% 4755 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% 4756 \do\<\do\>\do\|\do\@\do+\do\"% 4757} 4758% 4759% [Knuth] p. 380 4760\def\uncatcodespecials{% 4761 \def\do##1{\catcode`##1=12}\dospecials} 4762% 4763% [Knuth] pp. 380,381,391 4764% Disable Spanish ligatures ?` and !` of \tt font 4765\begingroup 4766 \catcode`\`=\active\gdef`{\relax\lq} 4767\endgroup 4768% 4769% Setup for the @verb command. 4770% 4771% Eight spaces for a tab 4772\begingroup 4773 \catcode`\^^I=\active 4774 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} 4775\endgroup 4776% 4777\def\setupverb{% 4778 \tt % easiest (and conventionally used) font for verbatim 4779 \def\par{\leavevmode\endgraf}% 4780 \catcode`\`=\active 4781 \tabeightspaces 4782 % Respect line breaks, 4783 % print special symbols as themselves, and 4784 % make each space count 4785 % must do in this order: 4786 \obeylines \uncatcodespecials \sepspaces 4787} 4788 4789% Setup for the @verbatim environment 4790% 4791% Real tab expansion 4792\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount 4793% 4794\def\starttabbox{\setbox0=\hbox\bgroup} 4795\begingroup 4796 \catcode`\^^I=\active 4797 \gdef\tabexpand{% 4798 \catcode`\^^I=\active 4799 \def^^I{\leavevmode\egroup 4800 \dimen0=\wd0 % the width so far, or since the previous tab 4801 \divide\dimen0 by\tabw 4802 \multiply\dimen0 by\tabw % compute previous multiple of \tabw 4803 \advance\dimen0 by\tabw % advance to next multiple of \tabw 4804 \wd0=\dimen0 \box0 \starttabbox 4805 }% 4806 } 4807\endgroup 4808\def\setupverbatim{% 4809 % Easiest (and conventionally used) font for verbatim 4810 \tt 4811 \def\par{\leavevmode\egroup\box0\endgraf}% 4812 \catcode`\`=\active 4813 \tabexpand 4814 % Respect line breaks, 4815 % print special symbols as themselves, and 4816 % make each space count 4817 % must do in this order: 4818 \obeylines \uncatcodespecials \sepspaces 4819 \everypar{\starttabbox}% 4820} 4821 4822% Do the @verb magic: verbatim text is quoted by unique 4823% delimiter characters. Before first delimiter expect a 4824% right brace, after last delimiter expect closing brace: 4825% 4826% \def\doverb'{'<char>#1<char>'}'{#1} 4827% 4828% [Knuth] p. 382; only eat outer {} 4829\begingroup 4830 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12 4831 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] 4832\endgroup 4833% 4834\def\verb{\begingroup\setupverb\doverb} 4835% 4836% 4837% Do the @verbatim magic: define the macro \doverbatim so that 4838% the (first) argument ends when '@end verbatim' is reached, ie: 4839% 4840% \def\doverbatim#1@end verbatim{#1} 4841% 4842% For Texinfo it's a lot easier than for LaTeX, 4843% because texinfo's \verbatim doesn't stop at '\end{verbatim}': 4844% we need not redefine '\', '{' and '}'. 4845% 4846% Inspired by LaTeX's verbatim command set [latex.ltx] 4847%% Include LaTeX hack for completeness -- never know 4848%% \begingroup 4849%% \catcode`|=0 \catcode`[=1 4850%% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active 4851%% \catcode`\\=12|gdef|doverbatim#1@end verbatim[ 4852%% #1|endgroup|def|Everbatim[]|end[verbatim]] 4853%% |endgroup 4854% 4855\begingroup 4856 \catcode`\ =\active 4857 \obeylines % 4858 % ignore everything up to the first ^^M, that's the newline at the end 4859 % of the @verbatim input line itself. Otherwise we get an extra blank 4860 % line in the output. 4861 \gdef\doverbatim#1^^M#2@end verbatim{#2\end{verbatim}}% 4862\endgroup 4863% 4864\def\verbatim{% 4865 \def\Everbatim{\nonfillfinish\endgroup}% 4866 \begingroup 4867 \nonfillstart 4868 \advance\leftskip by -\defbodyindent 4869 \begingroup\setupverbatim\doverbatim 4870} 4871 4872% @verbatiminclude FILE - insert text of file in verbatim environment. 4873% 4874% Allow normal characters that we make active in the argument (a file name). 4875\def\verbatiminclude{% 4876 \begingroup 4877 \catcode`\\=\other 4878 \catcode`~=\other 4879 \catcode`^=\other 4880 \catcode`_=\other 4881 \catcode`|=\other 4882 \catcode`<=\other 4883 \catcode`>=\other 4884 \catcode`+=\other 4885 \parsearg\doverbatiminclude 4886} 4887\def\setupverbatiminclude{% 4888 \begingroup 4889 \nonfillstart 4890 \advance\leftskip by -\defbodyindent 4891 \begingroup\setupverbatim 4892} 4893% 4894\def\doverbatiminclude#1{% 4895 % Restore active chars for included file. 4896 \endgroup 4897 \begingroup 4898 \let\value=\expandablevalue 4899 \def\thisfile{#1}% 4900 \expandafter\expandafter\setupverbatiminclude\input\thisfile 4901 \endgroup 4902 \nonfillfinish 4903 \endgroup 4904} 4905 4906% @copying ... @end copying. 4907% Save the text away for @insertcopying later. Many commands won't be 4908% allowed in this context, but that's ok. 4909% 4910% We save the uninterpreted tokens, rather than creating a box. 4911% Saving the text in a box would be much easier, but then all the 4912% typesetting commands (@smallbook, font changes, etc.) have to be done 4913% beforehand -- and a) we want @copying to be done first in the source 4914% file; b) letting users define the frontmatter in as flexible order as 4915% possible is very desirable. 4916% 4917\def\copying{\begingroup 4918 % Define a command to swallow text until we reach `@end copying'. 4919 % \ is the escape char in this texinfo.tex file, so it is the 4920 % delimiter for the command; @ will be the escape char when we read 4921 % it, but that doesn't matter. 4922 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}% 4923 % 4924 % We must preserve ^^M's in the input file; see \insertcopying below. 4925 \catcode`\^^M = \active 4926 \docopying 4927} 4928 4929% What we do to finish off the copying text. 4930% 4931\def\enddocopying{\endgroup\ignorespaces} 4932 4933% @insertcopying. Here we must play games with ^^M's. On the one hand, 4934% we need them to delimit commands such as `@end quotation', so they 4935% must be active. On the other hand, we certainly don't want every 4936% end-of-line to be a \par, as would happen with the normal active 4937% definition of ^^M. On the third hand, two ^^M's in a row should still 4938% generate a \par. 4939% 4940% Our approach is to make ^^M insert a space and a penalty1 normally; 4941% then it can also check if \lastpenalty=1. If it does, then manually 4942% do \par. 4943% 4944% This messes up the normal definitions of @c[omment], so we redefine 4945% it. Similarly for @ignore. (These commands are used in the gcc 4946% manual for man page generation.) 4947% 4948% Seems pretty fragile, most line-oriented commands will presumably 4949% fail, but for the limited use of getting the copying text (which 4950% should be quite simple) inserted, we can hope it's ok. 4951% 4952{\catcode`\^^M=\active % 4953\gdef\insertcopying{\begingroup % 4954 \parindent = 0pt % looks wrong on title page 4955 \def^^M{% 4956 \ifnum \lastpenalty=1 % 4957 \par % 4958 \else % 4959 \space \penalty 1 % 4960 \fi % 4961 }% 4962 % 4963 % Fix @c[omment] for catcode 13 ^^M's. 4964 \def\c##1^^M{\ignorespaces}% 4965 \let\comment = \c % 4966 % 4967 % Don't bother jumping through all the hoops that \doignore does, it 4968 % would be very hard since the catcodes are already set. 4969 \long\def\ignore##1\end ignore{\ignorespaces}% 4970 % 4971 \copyingtext % 4972\endgroup}% 4973} 4974 4975\message{defuns,} 4976% @defun etc. 4977 4978% Allow user to change definition object font (\df) internally 4979\def\setdeffont#1 {\csname DEF#1\endcsname} 4980 4981\newskip\defbodyindent \defbodyindent=.4in 4982\newskip\defargsindent \defargsindent=50pt 4983\newskip\deflastargmargin \deflastargmargin=18pt 4984 4985\newcount\parencount 4986 4987% We want ()&[] to print specially on the defun line. 4988% 4989\def\activeparens{% 4990 \catcode`\(=\active \catcode`\)=\active 4991 \catcode`\&=\active 4992 \catcode`\[=\active \catcode`\]=\active 4993} 4994 4995% Make control sequences which act like normal parenthesis chars. 4996\let\lparen = ( \let\rparen = ) 4997 4998{\activeparens % Now, smart parens don't turn on until &foo (see \amprm) 4999 5000% Be sure that we always have a definition for `(', etc. For example, 5001% if the fn name has parens in it, \boldbrax will not be in effect yet, 5002% so TeX would otherwise complain about undefined control sequence. 5003\global\let(=\lparen \global\let)=\rparen 5004\global\let[=\lbrack \global\let]=\rbrack 5005 5006\gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 } 5007\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} 5008% This is used to turn on special parens 5009% but make & act ordinary (given that it's active). 5010\gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr} 5011 5012% Definitions of (, ) and & used in args for functions. 5013% This is the definition of ( outside of all parentheses. 5014\gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested 5015 \global\advance\parencount by 1 5016} 5017% 5018% This is the definition of ( when already inside a level of parens. 5019\gdef\opnested{\char`\(\global\advance\parencount by 1 } 5020% 5021\gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0. 5022 % also in that case restore the outer-level definition of (. 5023 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi 5024 \global\advance \parencount by -1 } 5025% If we encounter &foo, then turn on ()-hacking afterwards 5026\gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ } 5027% 5028\gdef\normalparens{\boldbrax\let&=\ampnr} 5029} % End of definition inside \activeparens 5030%% These parens (in \boldbrax) actually are a little bolder than the 5031%% contained text. This is especially needed for [ and ] 5032\def\opnr{{\sf\char`\(}\global\advance\parencount by 1 } 5033\def\clnr{{\sf\char`\)}\global\advance\parencount by -1 } 5034\let\ampnr = \& 5035\def\lbrb{{\bf\char`\[}} 5036\def\rbrb{{\bf\char`\]}} 5037 5038% Active &'s sneak into the index arguments, so make sure it's defined. 5039{ 5040 \catcode`& = \active 5041 \global\let& = \ampnr 5042} 5043 5044% \defname, which formats the name of the @def (not the args). 5045% #1 is the function name. 5046% #2 is the type of definition, such as "Function". 5047% 5048\def\defname#1#2{% 5049 % How we'll output the type name. Putting it in brackets helps 5050 % distinguish it from the body text that may end up on the next line 5051 % just below it. 5052 \ifempty{#2}% 5053 \def\defnametype{}% 5054 \else 5055 \def\defnametype{[\rm #2]}% 5056 \fi 5057 % 5058 % Get the values of \leftskip and \rightskip as they were outside the @def... 5059 \dimen2=\leftskip 5060 \advance\dimen2 by -\defbodyindent 5061 % 5062 % Figure out values for the paragraph shape. 5063 \setbox0=\hbox{\hskip \deflastargmargin{\defnametype}}% 5064 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line 5065 \dimen1=\hsize \advance \dimen1 by -\defargsindent % size for continuations 5066 \parshape 2 0in \dimen0 \defargsindent \dimen1 5067 % 5068 % Output arg 2 ("Function" or some such) but stuck inside a box of 5069 % width 0 so it does not interfere with linebreaking. 5070 \noindent 5071 % 5072 {% Adjust \hsize to exclude the ambient margins, 5073 % so that \rightline will obey them. 5074 \advance \hsize by -\dimen2 5075 \dimen3 = 0pt % was -1.25pc 5076 \rlap{\rightline{\defnametype\kern\dimen3}}% 5077 }% 5078 % 5079 % Allow all lines to be underfull without complaint: 5080 \tolerance=10000 \hbadness=10000 5081 \advance\leftskip by -\defbodyindent 5082 \exdentamount=\defbodyindent 5083 {\df #1}\enskip % output function name 5084 % \defunargs will be called next to output the arguments, if any. 5085} 5086 5087% Common pieces to start any @def... 5088% #1 is the \E... control sequence to end the definition (which we define). 5089% #2 is the \...x control sequence (which our caller defines). 5090% #3 is the control sequence to process the header, such as \defunheader. 5091% 5092\def\parsebodycommon#1#2#3{% 5093 \begingroup\inENV 5094 % If there are two @def commands in a row, we'll have a \nobreak, 5095 % which is there to keep the function description together with its 5096 % header. But if there's nothing but headers, we want to allow a 5097 % break after all. Check for penalty 10002 (inserted by 5098 % \defargscommonending) instead of 10000, since the sectioning 5099 % commands insert a \penalty10000, and we don't want to allow a break 5100 % between a section heading and a defun. 5101 \ifnum\lastpenalty=10002 \penalty0 \fi 5102 \medbreak 5103 % 5104 % Define the \E... end token that this defining construct specifies 5105 % so that it will exit this group. 5106 \def#1{\endgraf\endgroup\medbreak}% 5107 % 5108 \parindent=0in 5109 \advance\leftskip by \defbodyindent 5110 \exdentamount=\defbodyindent 5111} 5112 5113% Common part of the \...x definitions. 5114% 5115\def\defxbodycommon{% 5116 % As with \parsebodycommon above, allow line break if we have multiple 5117 % x headers in a row. It's not a great place, though. 5118 \ifnum\lastpenalty=10000 \penalty1000 \fi 5119 % 5120 \begingroup\obeylines 5121} 5122 5123% Process body of @defun, @deffn, @defmac, etc. 5124% 5125\def\defparsebody#1#2#3{% 5126 \parsebodycommon{#1}{#2}{#3}% 5127 \def#2{\defxbodycommon \activeparens \spacesplit#3}% 5128 \catcode\equalChar=\active 5129 \begingroup\obeylines\activeparens 5130 \spacesplit#3% 5131} 5132 5133% #1, #2, #3 are the common arguments (see \parsebodycommon above). 5134% #4, delimited by the space, is the class name. 5135% 5136\def\defmethparsebody#1#2#3#4 {% 5137 \parsebodycommon{#1}{#2}{#3}% 5138 \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}% 5139 \begingroup\obeylines\activeparens 5140 % The \empty here prevents misinterpretation of a construct such as 5141 % @deffn {whatever} {Enharmonic comma} 5142 % See comments at \deftpparsebody, although in our case we don't have 5143 % to remove the \empty afterwards, since it is empty. 5144 \spacesplit{#3{#4}}\empty 5145} 5146 5147% Used for @deftypemethod and @deftypeivar. 5148% #1, #2, #3 are the common arguments (see \defparsebody). 5149% #4, delimited by a space, is the class name. 5150% #5 is the method's return type. 5151% 5152\def\deftypemethparsebody#1#2#3#4 #5 {% 5153 \parsebodycommon{#1}{#2}{#3}% 5154 \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}% 5155 \begingroup\obeylines\activeparens 5156 \spacesplit{#3{#4}{#5}}% 5157} 5158 5159% Used for @deftypeop. The change from \deftypemethparsebody is an 5160% extra argument at the beginning which is the `category', instead of it 5161% being the hardwired string `Method' or `Instance Variable'. We have 5162% to account for this both in the \...x definition and in parsing the 5163% input at hand. Thus also need a control sequence (passed as #5) for 5164% the \E... definition to assign the category name to. 5165% 5166\def\deftypeopparsebody#1#2#3#4#5 #6 {% 5167 \parsebodycommon{#1}{#2}{#3}% 5168 \def#2##1 ##2 ##3 {\def#4{##1}% 5169 \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}% 5170 \begingroup\obeylines\activeparens 5171 \spacesplit{#3{#5}{#6}}% 5172} 5173 5174% For @defop. 5175\def\defopparsebody #1#2#3#4#5 {% 5176 \parsebodycommon{#1}{#2}{#3}% 5177 \def#2##1 ##2 {\def#4{##1}% 5178 \defxbodycommon \activeparens \spacesplit{#3{##2}}}% 5179 \begingroup\obeylines\activeparens 5180 \spacesplit{#3{#5}}% 5181} 5182 5183% These parsing functions are similar to the preceding ones 5184% except that they do not make parens into active characters. 5185% These are used for "variables" since they have no arguments. 5186% 5187\def\defvarparsebody #1#2#3{% 5188 \parsebodycommon{#1}{#2}{#3}% 5189 \def#2{\defxbodycommon \spacesplit#3}% 5190 \catcode\equalChar=\active 5191 \begingroup\obeylines 5192 \spacesplit#3% 5193} 5194 5195% @defopvar. 5196\def\defopvarparsebody #1#2#3#4#5 {% 5197 \parsebodycommon{#1}{#2}{#3}% 5198 \def#2##1 ##2 {\def#4{##1}% 5199 \defxbodycommon \spacesplit{#3{##2}}}% 5200 \begingroup\obeylines 5201 \spacesplit{#3{#5}}% 5202} 5203 5204\def\defvrparsebody#1#2#3#4 {% 5205 \parsebodycommon{#1}{#2}{#3}% 5206 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}% 5207 \begingroup\obeylines 5208 \spacesplit{#3{#4}}% 5209} 5210 5211% This loses on `@deftp {Data Type} {struct termios}' -- it thinks the 5212% type is just `struct', because we lose the braces in `{struct 5213% termios}' when \spacesplit reads its undelimited argument. Sigh. 5214% \let\deftpparsebody=\defvrparsebody 5215% 5216% So, to get around this, we put \empty in with the type name. That 5217% way, TeX won't find exactly `{...}' as an undelimited argument, and 5218% won't strip off the braces. 5219% 5220\def\deftpparsebody #1#2#3#4 {% 5221 \parsebodycommon{#1}{#2}{#3}% 5222 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}% 5223 \begingroup\obeylines 5224 \spacesplit{\parsetpheaderline{#3{#4}}}\empty 5225} 5226 5227% Fine, but then we have to eventually remove the \empty *and* the 5228% braces (if any). That's what this does. 5229% 5230\def\removeemptybraces\empty#1\relax{#1} 5231 5232% After \spacesplit has done its work, this is called -- #1 is the final 5233% thing to call, #2 the type name (which starts with \empty), and #3 5234% (which might be empty) the arguments. 5235% 5236\def\parsetpheaderline#1#2#3{% 5237 #1{\removeemptybraces#2\relax}{#3}% 5238}% 5239 5240% Split up #2 (the rest of the input line) at the first space token. 5241% call #1 with two arguments: 5242% the first is all of #2 before the space token, 5243% the second is all of #2 after that space token. 5244% If #2 contains no space token, all of it is passed as the first arg 5245% and the second is passed as empty. 5246% 5247{\obeylines % 5248 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}% 5249 \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{% 5250 \ifx\relax #3% 5251 #1{#2}{}% 5252 \else % 5253 #1{#2}{#3#4}% 5254 \fi}% 5255} 5256 5257% Define @defun. 5258 5259% This is called to end the arguments processing for all the @def... commands. 5260% 5261\def\defargscommonending{% 5262 \interlinepenalty = 10000 5263 \advance\rightskip by 0pt plus 1fil 5264 \endgraf 5265 \nobreak\vskip -\parskip 5266 \penalty 10002 % signal to \parsebodycommon. 5267} 5268 5269% This expands the args and terminates the paragraph they comprise. 5270% 5271\def\defunargs#1{\functionparens \sl 5272% Expand, preventing hyphenation at `-' chars. 5273% Note that groups don't affect changes in \hyphenchar. 5274% Set the font temporarily and use \font in case \setfont made \tensl a macro. 5275{\tensl\hyphenchar\font=0}% 5276#1% 5277{\tensl\hyphenchar\font=45}% 5278\ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi% 5279 \defargscommonending 5280} 5281 5282\def\deftypefunargs #1{% 5283% Expand, preventing hyphenation at `-' chars. 5284% Note that groups don't affect changes in \hyphenchar. 5285% Use \boldbraxnoamp, not \functionparens, so that & is not special. 5286\boldbraxnoamp 5287\tclose{#1}% avoid \code because of side effects on active chars 5288 \defargscommonending 5289} 5290 5291% Do complete processing of one @defun or @defunx line already parsed. 5292 5293% @deffn Command forward-char nchars 5294 5295\def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader} 5296 5297\def\deffnheader #1#2#3{\doind {fn}{\code{#2}}% 5298\begingroup\defname {#2}{#1}\defunargs{#3}\endgroup % 5299\catcode\equalChar=\other % Turn off change made in \defparsebody 5300} 5301 5302% @defun == @deffn Function 5303 5304\def\defun{\defparsebody\Edefun\defunx\defunheader} 5305 5306\def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index 5307\begingroup\defname {#1}{\putwordDeffunc}% 5308\defunargs {#2}\endgroup % 5309\catcode\equalChar=\other % Turn off change made in \defparsebody 5310} 5311 5312% @deftypefun int foobar (int @var{foo}, float @var{bar}) 5313 5314\def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader} 5315 5316% #1 is the data type. #2 is the name and args. 5317\def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax} 5318% #1 is the data type, #2 the name, #3 the args. 5319\def\deftypefunheaderx #1#2 #3\relax{% 5320\doind {fn}{\code{#2}}% Make entry in function index 5321\begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}% 5322\deftypefunargs {#3}\endgroup % 5323\catcode\equalChar=\other % Turn off change made in \defparsebody 5324} 5325 5326% @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar}) 5327 5328\def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader} 5329 5330% \defheaderxcond#1\relax$.$ 5331% puts #1 in @code, followed by a space, but does nothing if #1 is null. 5332\def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi} 5333 5334% #1 is the classification. #2 is the data type. #3 is the name and args. 5335\def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax} 5336% #1 is the classification, #2 the data type, #3 the name, #4 the args. 5337\def\deftypefnheaderx #1#2#3 #4\relax{% 5338\doind {fn}{\code{#3}}% Make entry in function index 5339\begingroup 5340\normalparens % notably, turn off `&' magic, which prevents 5341% at least some C++ text from working 5342\defname {\defheaderxcond#2\relax$.$#3}{#1}% 5343\deftypefunargs {#4}\endgroup % 5344\catcode\equalChar=\other % Turn off change made in \defparsebody 5345} 5346 5347% @defmac == @deffn Macro 5348 5349\def\defmac{\defparsebody\Edefmac\defmacx\defmacheader} 5350 5351\def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index 5352\begingroup\defname {#1}{\putwordDefmac}% 5353\defunargs {#2}\endgroup % 5354\catcode\equalChar=\other % Turn off change made in \defparsebody 5355} 5356 5357% @defspec == @deffn Special Form 5358 5359\def\defspec{\defparsebody\Edefspec\defspecx\defspecheader} 5360 5361\def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index 5362\begingroup\defname {#1}{\putwordDefspec}% 5363\defunargs {#2}\endgroup % 5364\catcode\equalChar=\other % Turn off change made in \defparsebody 5365} 5366 5367% @defop CATEGORY CLASS OPERATION ARG... 5368% 5369\def\defop #1 {\def\defoptype{#1}% 5370\defopparsebody\Edefop\defopx\defopheader\defoptype} 5371% 5372\def\defopheader#1#2#3{% 5373 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% function index entry 5374 \begingroup 5375 \defname{#2}{\defoptype\ \putwordon\ #1}% 5376 \defunargs{#3}% 5377 \endgroup 5378} 5379 5380% @deftypeop CATEGORY CLASS TYPE OPERATION ARG... 5381% 5382\def\deftypeop #1 {\def\deftypeopcategory{#1}% 5383 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader 5384 \deftypeopcategory} 5385% 5386% #1 is the class name, #2 the data type, #3 the operation name, #4 the args. 5387\def\deftypeopheader#1#2#3#4{% 5388 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index 5389 \begingroup 5390 \defname{\defheaderxcond#2\relax$.$#3} 5391 {\deftypeopcategory\ \putwordon\ \code{#1}}% 5392 \deftypefunargs{#4}% 5393 \endgroup 5394} 5395 5396% @deftypemethod CLASS TYPE METHOD ARG... 5397% 5398\def\deftypemethod{% 5399 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader} 5400% 5401% #1 is the class name, #2 the data type, #3 the method name, #4 the args. 5402\def\deftypemethodheader#1#2#3#4{% 5403 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index 5404 \begingroup 5405 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}% 5406 \deftypefunargs{#4}% 5407 \endgroup 5408} 5409 5410% @deftypeivar CLASS TYPE VARNAME 5411% 5412\def\deftypeivar{% 5413 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader} 5414% 5415% #1 is the class name, #2 the data type, #3 the variable name. 5416\def\deftypeivarheader#1#2#3{% 5417 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index 5418 \begingroup 5419 \defname{\defheaderxcond#2\relax$.$#3} 5420 {\putwordInstanceVariableof\ \code{#1}}% 5421 \defvarargs{#3}% 5422 \endgroup 5423} 5424 5425% @defmethod == @defop Method 5426% 5427\def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader} 5428% 5429% #1 is the class name, #2 the method name, #3 the args. 5430\def\defmethodheader#1#2#3{% 5431 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index 5432 \begingroup 5433 \defname{#2}{\putwordMethodon\ \code{#1}}% 5434 \defunargs{#3}% 5435 \endgroup 5436} 5437 5438% @defcv {Class Option} foo-class foo-flag 5439 5440\def\defcv #1 {\def\defcvtype{#1}% 5441\defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype} 5442 5443\def\defcvarheader #1#2#3{% 5444 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% variable index entry 5445 \begingroup 5446 \defname{#2}{\defcvtype\ \putwordof\ #1}% 5447 \defvarargs{#3}% 5448 \endgroup 5449} 5450 5451% @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME 5452% 5453\def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader} 5454% 5455\def\defivarheader#1#2#3{% 5456 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% entry in var index 5457 \begingroup 5458 \defname{#2}{\putwordInstanceVariableof\ #1}% 5459 \defvarargs{#3}% 5460 \endgroup 5461} 5462 5463% @defvar 5464% First, define the processing that is wanted for arguments of @defvar. 5465% This is actually simple: just print them in roman. 5466% This must expand the args and terminate the paragraph they make up 5467\def\defvarargs #1{\normalparens #1% 5468 \defargscommonending 5469} 5470 5471% @defvr Counter foo-count 5472 5473\def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader} 5474 5475\def\defvrheader #1#2#3{\doind {vr}{\code{#2}}% 5476\begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup} 5477 5478% @defvar == @defvr Variable 5479 5480\def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader} 5481 5482\def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index 5483\begingroup\defname {#1}{\putwordDefvar}% 5484\defvarargs {#2}\endgroup % 5485} 5486 5487% @defopt == @defvr {User Option} 5488 5489\def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader} 5490 5491\def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index 5492\begingroup\defname {#1}{\putwordDefopt}% 5493\defvarargs {#2}\endgroup % 5494} 5495 5496% @deftypevar int foobar 5497 5498\def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader} 5499 5500% #1 is the data type. #2 is the name, perhaps followed by text that 5501% is actually part of the data type, which should not be put into the index. 5502\def\deftypevarheader #1#2{% 5503\dovarind#2 \relax% Make entry in variables index 5504\begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}% 5505 \defargscommonending 5506\endgroup} 5507\def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}} 5508 5509% @deftypevr {Global Flag} int enable 5510 5511\def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader} 5512 5513\def\deftypevrheader #1#2#3{\dovarind#3 \relax% 5514\begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1} 5515 \defargscommonending 5516\endgroup} 5517 5518% Now define @deftp 5519% Args are printed in bold, a slight difference from @defvar. 5520 5521\def\deftpargs #1{\bf \defvarargs{#1}} 5522 5523% @deftp Class window height width ... 5524 5525\def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader} 5526 5527\def\deftpheader #1#2#3{\doind {tp}{\code{#2}}% 5528\begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup} 5529 5530% These definitions are used if you use @defunx (etc.) 5531% anywhere other than immediately after a @defun or @defunx. 5532% 5533\def\defcvx#1 {\errmessage{@defcvx in invalid context}} 5534\def\deffnx#1 {\errmessage{@deffnx in invalid context}} 5535\def\defivarx#1 {\errmessage{@defivarx in invalid context}} 5536\def\defmacx#1 {\errmessage{@defmacx in invalid context}} 5537\def\defmethodx#1 {\errmessage{@defmethodx in invalid context}} 5538\def\defoptx #1 {\errmessage{@defoptx in invalid context}} 5539\def\defopx#1 {\errmessage{@defopx in invalid context}} 5540\def\defspecx#1 {\errmessage{@defspecx in invalid context}} 5541\def\deftpx#1 {\errmessage{@deftpx in invalid context}} 5542\def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}} 5543\def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}} 5544\def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}} 5545\def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}} 5546\def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}} 5547\def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}} 5548\def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}} 5549\def\defunx#1 {\errmessage{@defunx in invalid context}} 5550\def\defvarx#1 {\errmessage{@defvarx in invalid context}} 5551\def\defvrx#1 {\errmessage{@defvrx in invalid context}} 5552 5553 5554\message{macros,} 5555% @macro. 5556 5557% To do this right we need a feature of e-TeX, \scantokens, 5558% which we arrange to emulate with a temporary file in ordinary TeX. 5559\ifx\eTeXversion\undefined 5560 \newwrite\macscribble 5561 \def\scanmacro#1{% 5562 \begingroup \newlinechar`\^^M 5563 % Undo catcode changes of \startcontents and \doprintindex 5564 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@ 5565 % Append \endinput to make sure that TeX does not see the ending newline. 5566 \toks0={#1\endinput}% 5567 \immediate\openout\macscribble=\jobname.tmp 5568 \immediate\write\macscribble{\the\toks0}% 5569 \immediate\closeout\macscribble 5570 \let\xeatspaces\eatspaces 5571 \input \jobname.tmp 5572 \endgroup 5573} 5574\else 5575\def\scanmacro#1{% 5576\begingroup \newlinechar`\^^M 5577% Undo catcode changes of \startcontents and \doprintindex 5578\catcode`\@=0 \catcode`\\=\other \escapechar=`\@ 5579\let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup} 5580\fi 5581 5582\newcount\paramno % Count of parameters 5583\newtoks\macname % Macro name 5584\newif\ifrecursive % Is it recursive? 5585\def\macrolist{} % List of all defined macros in the form 5586 % \do\macro1\do\macro2... 5587 5588% Utility routines. 5589% Thisdoes \let #1 = #2, except with \csnames. 5590\def\cslet#1#2{% 5591\expandafter\expandafter 5592\expandafter\let 5593\expandafter\expandafter 5594\csname#1\endcsname 5595\csname#2\endcsname} 5596 5597% Trim leading and trailing spaces off a string. 5598% Concepts from aro-bend problem 15 (see CTAN). 5599{\catcode`\@=11 5600\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} 5601\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} 5602\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} 5603\def\unbrace#1{#1} 5604\unbrace{\gdef\trim@@@ #1 } #2@{#1} 5605} 5606 5607% Trim a single trailing ^^M off a string. 5608{\catcode`\^^M=\other \catcode`\Q=3% 5609\gdef\eatcr #1{\eatcra #1Q^^MQ}% 5610\gdef\eatcra#1^^MQ{\eatcrb#1Q}% 5611\gdef\eatcrb#1Q#2Q{#1}% 5612} 5613 5614% Macro bodies are absorbed as an argument in a context where 5615% all characters are catcode 10, 11 or 12, except \ which is active 5616% (as in normal texinfo). It is necessary to change the definition of \. 5617 5618% It's necessary to have hard CRs when the macro is executed. This is 5619% done by making ^^M (\endlinechar) catcode 12 when reading the macro 5620% body, and then making it the \newlinechar in \scanmacro. 5621 5622\def\macrobodyctxt{% 5623 \catcode`\~=\other 5624 \catcode`\^=\other 5625 \catcode`\_=\other 5626 \catcode`\|=\other 5627 \catcode`\<=\other 5628 \catcode`\>=\other 5629 \catcode`\+=\other 5630 \catcode`\{=\other 5631 \catcode`\}=\other 5632 \catcode`\@=\other 5633 \catcode`\^^M=\other 5634 \usembodybackslash} 5635 5636\def\macroargctxt{% 5637 \catcode`\~=\other 5638 \catcode`\^=\other 5639 \catcode`\_=\other 5640 \catcode`\|=\other 5641 \catcode`\<=\other 5642 \catcode`\>=\other 5643 \catcode`\+=\other 5644 \catcode`\@=\other 5645 \catcode`\\=\other} 5646 5647% \mbodybackslash is the definition of \ in @macro bodies. 5648% It maps \foo\ => \csname macarg.foo\endcsname => #N 5649% where N is the macro parameter number. 5650% We define \csname macarg.\endcsname to be \realbackslash, so 5651% \\ in macro replacement text gets you a backslash. 5652 5653{\catcode`@=0 @catcode`@\=@active 5654 @gdef@usembodybackslash{@let\=@mbodybackslash} 5655 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} 5656} 5657\expandafter\def\csname macarg.\endcsname{\realbackslash} 5658 5659\def\macro{\recursivefalse\parsearg\macroxxx} 5660\def\rmacro{\recursivetrue\parsearg\macroxxx} 5661 5662\def\macroxxx#1{% 5663 \getargs{#1}% now \macname is the macname and \argl the arglist 5664 \ifx\argl\empty % no arguments 5665 \paramno=0% 5666 \else 5667 \expandafter\parsemargdef \argl;% 5668 \fi 5669 \if1\csname ismacro.\the\macname\endcsname 5670 \message{Warning: redefining \the\macname}% 5671 \else 5672 \expandafter\ifx\csname \the\macname\endcsname \relax 5673 \else \errmessage{Macro name \the\macname\space already defined}\fi 5674 \global\cslet{macsave.\the\macname}{\the\macname}% 5675 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% 5676 % Add the macroname to \macrolist 5677 \toks0 = \expandafter{\macrolist\do}% 5678 \xdef\macrolist{\the\toks0 5679 \expandafter\noexpand\csname\the\macname\endcsname}% 5680 \fi 5681 \begingroup \macrobodyctxt 5682 \ifrecursive \expandafter\parsermacbody 5683 \else \expandafter\parsemacbody 5684 \fi} 5685 5686\def\unmacro{\parsearg\dounmacro} 5687\def\dounmacro#1{% 5688 \if1\csname ismacro.#1\endcsname 5689 \global\cslet{#1}{macsave.#1}% 5690 \global\expandafter\let \csname ismacro.#1\endcsname=0% 5691 % Remove the macro name from \macrolist: 5692 \begingroup 5693 \expandafter\let\csname#1\endcsname \relax 5694 \let\do\unmacrodo 5695 \xdef\macrolist{\macrolist}% 5696 \endgroup 5697 \else 5698 \errmessage{Macro #1 not defined}% 5699 \fi 5700} 5701 5702% Called by \do from \dounmacro on each macro. The idea is to omit any 5703% macro definitions that have been changed to \relax. 5704% 5705\def\unmacrodo#1{% 5706 \ifx#1\relax 5707 % remove this 5708 \else 5709 \noexpand\do \noexpand #1% 5710 \fi 5711} 5712 5713% This makes use of the obscure feature that if the last token of a 5714% <parameter list> is #, then the preceding argument is delimited by 5715% an opening brace, and that opening brace is not consumed. 5716\def\getargs#1{\getargsxxx#1{}} 5717\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} 5718\def\getmacname #1 #2\relax{\macname={#1}} 5719\def\getmacargs#1{\def\argl{#1}} 5720 5721% Parse the optional {params} list. Set up \paramno and \paramlist 5722% so \defmacro knows what to do. Define \macarg.blah for each blah 5723% in the params list, to be ##N where N is the position in that list. 5724% That gets used by \mbodybackslash (above). 5725 5726% We need to get `macro parameter char #' into several definitions. 5727% The technique used is stolen from LaTeX: let \hash be something 5728% unexpandable, insert that wherever you need a #, and then redefine 5729% it to # just before using the token list produced. 5730% 5731% The same technique is used to protect \eatspaces till just before 5732% the macro is used. 5733 5734\def\parsemargdef#1;{\paramno=0\def\paramlist{}% 5735 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} 5736\def\parsemargdefxxx#1,{% 5737 \if#1;\let\next=\relax 5738 \else \let\next=\parsemargdefxxx 5739 \advance\paramno by 1% 5740 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname 5741 {\xeatspaces{\hash\the\paramno}}% 5742 \edef\paramlist{\paramlist\hash\the\paramno,}% 5743 \fi\next} 5744 5745% These two commands read recursive and nonrecursive macro bodies. 5746% (They're different since rec and nonrec macros end differently.) 5747 5748\long\def\parsemacbody#1@end macro% 5749{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 5750\long\def\parsermacbody#1@end rmacro% 5751{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% 5752 5753% This defines the macro itself. There are six cases: recursive and 5754% nonrecursive macros of zero, one, and many arguments. 5755% Much magic with \expandafter here. 5756% \xdef is used so that macro definitions will survive the file 5757% they're defined in; @include reads the file inside a group. 5758\def\defmacro{% 5759 \let\hash=##% convert placeholders to macro parameter chars 5760 \ifrecursive 5761 \ifcase\paramno 5762 % 0 5763 \expandafter\xdef\csname\the\macname\endcsname{% 5764 \noexpand\scanmacro{\temp}}% 5765 \or % 1 5766 \expandafter\xdef\csname\the\macname\endcsname{% 5767 \bgroup\noexpand\macroargctxt 5768 \noexpand\braceorline 5769 \expandafter\noexpand\csname\the\macname xxx\endcsname}% 5770 \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 5771 \egroup\noexpand\scanmacro{\temp}}% 5772 \else % many 5773 \expandafter\xdef\csname\the\macname\endcsname{% 5774 \bgroup\noexpand\macroargctxt 5775 \noexpand\csname\the\macname xx\endcsname}% 5776 \expandafter\xdef\csname\the\macname xx\endcsname##1{% 5777 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 5778 \expandafter\expandafter 5779 \expandafter\xdef 5780 \expandafter\expandafter 5781 \csname\the\macname xxx\endcsname 5782 \paramlist{\egroup\noexpand\scanmacro{\temp}}% 5783 \fi 5784 \else 5785 \ifcase\paramno 5786 % 0 5787 \expandafter\xdef\csname\the\macname\endcsname{% 5788 \noexpand\norecurse{\the\macname}% 5789 \noexpand\scanmacro{\temp}\egroup}% 5790 \or % 1 5791 \expandafter\xdef\csname\the\macname\endcsname{% 5792 \bgroup\noexpand\macroargctxt 5793 \noexpand\braceorline 5794 \expandafter\noexpand\csname\the\macname xxx\endcsname}% 5795 \expandafter\xdef\csname\the\macname xxx\endcsname##1{% 5796 \egroup 5797 \noexpand\norecurse{\the\macname}% 5798 \noexpand\scanmacro{\temp}\egroup}% 5799 \else % many 5800 \expandafter\xdef\csname\the\macname\endcsname{% 5801 \bgroup\noexpand\macroargctxt 5802 \expandafter\noexpand\csname\the\macname xx\endcsname}% 5803 \expandafter\xdef\csname\the\macname xx\endcsname##1{% 5804 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% 5805 \expandafter\expandafter 5806 \expandafter\xdef 5807 \expandafter\expandafter 5808 \csname\the\macname xxx\endcsname 5809 \paramlist{% 5810 \egroup 5811 \noexpand\norecurse{\the\macname}% 5812 \noexpand\scanmacro{\temp}\egroup}% 5813 \fi 5814 \fi} 5815 5816\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} 5817 5818% \braceorline decides whether the next nonwhitespace character is a 5819% {. If so it reads up to the closing }, if not, it reads the whole 5820% line. Whatever was read is then fed to the next control sequence 5821% as an argument (by \parsebrace or \parsearg) 5822\def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx} 5823\def\braceorlinexxx{% 5824 \ifx\nchar\bgroup\else 5825 \expandafter\parsearg 5826 \fi \next} 5827 5828% We mant to disable all macros during \shipout so that they are not 5829% expanded by \write. 5830\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}% 5831 \edef\next{\macrolist}\expandafter\endgroup\next} 5832 5833 5834% @alias. 5835% We need some trickery to remove the optional spaces around the equal 5836% sign. Just make them active and then expand them all to nothing. 5837\def\alias{\begingroup\obeyspaces\parsearg\aliasxxx} 5838\def\aliasxxx #1{\aliasyyy#1\relax} 5839\def\aliasyyy #1=#2\relax{\ignoreactivespaces 5840\edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=% 5841 \expandafter\noexpand\csname#2\endcsname}% 5842\expandafter\endgroup\next} 5843 5844 5845\message{cross references,} 5846% @xref etc. 5847 5848\newwrite\auxfile 5849 5850\newif\ifhavexrefs % True if xref values are known. 5851\newif\ifwarnedxrefs % True if we warned once that they aren't known. 5852 5853% @inforef is relatively simple. 5854\def\inforef #1{\inforefzzz #1,,,,**} 5855\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, 5856 node \samp{\ignorespaces#1{}}} 5857 5858% @node's job is to define \lastnode. 5859\def\node{\ENVcheck\parsearg\nodezzz} 5860\def\nodezzz#1{\nodexxx #1,\finishnodeparse} 5861\def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}} 5862\let\nwnode=\node 5863\let\lastnode=\relax 5864 5865% The sectioning commands (@chapter, etc.) call these. 5866\def\donoderef{% 5867 \ifx\lastnode\relax\else 5868 \expandafter\expandafter\expandafter\setref{\lastnode}% 5869 {Ysectionnumberandtype}% 5870 \global\let\lastnode=\relax 5871 \fi 5872} 5873\def\unnumbnoderef{% 5874 \ifx\lastnode\relax\else 5875 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}% 5876 \global\let\lastnode=\relax 5877 \fi 5878} 5879\def\appendixnoderef{% 5880 \ifx\lastnode\relax\else 5881 \expandafter\expandafter\expandafter\setref{\lastnode}% 5882 {Yappendixletterandtype}% 5883 \global\let\lastnode=\relax 5884 \fi 5885} 5886 5887 5888% @anchor{NAME} -- define xref target at arbitrary point. 5889% 5890\newcount\savesfregister 5891\gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} 5892\gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} 5893\gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} 5894 5895% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an 5896% anchor), namely NAME-title (the corresponding @chapter/etc. name), 5897% NAME-pg (the page number), and NAME-snt (section number and type). 5898% Called from \foonoderef. 5899% 5900% We have to set \indexdummies so commands such as @code in a section 5901% title aren't expanded. It would be nicer not to expand the titles in 5902% the first place, but there's so many layers that that is hard to do. 5903% 5904% Likewise, use \turnoffactive so that punctuation chars such as underscore 5905% and backslash work in node names. 5906% 5907\def\setref#1#2{{% 5908 \atdummies 5909 \pdfmkdest{#1}% 5910 % 5911 \turnoffactive 5912 \dosetq{#1-title}{Ytitle}% 5913 \dosetq{#1-pg}{Ypagenumber}% 5914 \dosetq{#1-snt}{#2}% 5915}} 5916 5917% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is 5918% the node name, #2 the name of the Info cross-reference, #3 the printed 5919% node name, #4 the name of the Info file, #5 the name of the printed 5920% manual. All but the node name can be omitted. 5921% 5922\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} 5923\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} 5924\def\ref#1{\xrefX[#1,,,,,,,]} 5925\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup 5926 \unsepspaces 5927 \def\printedmanual{\ignorespaces #5}% 5928 \def\printednodename{\ignorespaces #3}% 5929 \setbox1=\hbox{\printedmanual}% 5930 \setbox0=\hbox{\printednodename}% 5931 \ifdim \wd0 = 0pt 5932 % No printed node name was explicitly given. 5933 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax 5934 % Use the node name inside the square brackets. 5935 \def\printednodename{\ignorespaces #1}% 5936 \else 5937 % Use the actual chapter/section title appear inside 5938 % the square brackets. Use the real section title if we have it. 5939 \ifdim \wd1 > 0pt 5940 % It is in another manual, so we don't have it. 5941 \def\printednodename{\ignorespaces #1}% 5942 \else 5943 \ifhavexrefs 5944 % We know the real title if we have the xref values. 5945 \def\printednodename{\refx{#1-title}{}}% 5946 \else 5947 % Otherwise just copy the Info node name. 5948 \def\printednodename{\ignorespaces #1}% 5949 \fi% 5950 \fi 5951 \fi 5952 \fi 5953 % 5954 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not 5955 % insert empty discretionaries after hyphens, which means that it will 5956 % not find a line break at a hyphen in a node names. Since some manuals 5957 % are best written with fairly long node names, containing hyphens, this 5958 % is a loss. Therefore, we give the text of the node name again, so it 5959 % is as if TeX is seeing it for the first time. 5960 \ifpdf 5961 \leavevmode 5962 \getfilename{#4}% 5963 {\turnoffactive \otherbackslash 5964 \ifnum\filenamelength>0 5965 \startlink attr{/Border [0 0 0]}% 5966 goto file{\the\filename.pdf} name{#1}% 5967 \else 5968 \startlink attr{/Border [0 0 0]}% 5969 goto name{#1}% 5970 \fi 5971 }% 5972 \linkcolor 5973 \fi 5974 % 5975 \ifdim \wd1 > 0pt 5976 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}% 5977 \else 5978 % _ (for example) has to be the character _ for the purposes of the 5979 % control sequence corresponding to the node, but it has to expand 5980 % into the usual \leavevmode...\vrule stuff for purposes of 5981 % printing. So we \turnoffactive for the \refx-snt, back on for the 5982 % printing, back off for the \refx-pg. 5983 {\turnoffactive \otherbackslash 5984 % Only output a following space if the -snt ref is nonempty; for 5985 % @unnumbered and @anchor, it won't be. 5986 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% 5987 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi 5988 }% 5989 % output the `[mynode]' via a macro. 5990 \xrefprintnodename\printednodename 5991 % 5992 % But we always want a comma and a space: 5993 ,\space 5994 % 5995 % output the `page 3'. 5996 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}% 5997 \fi 5998 \endlink 5999\endgroup} 6000 6001% This macro is called from \xrefX for the `[nodename]' part of xref 6002% output. It's a separate macro only so it can be changed more easily, 6003% since not square brackets don't work in some documents. Particularly 6004% one that Bob is working on :). 6005% 6006\def\xrefprintnodename#1{[#1]} 6007 6008% \dosetq is called from \setref to do the actual \write (\iflinks). 6009% 6010\def\dosetq#1#2{% 6011 {\let\folio=0% 6012 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}% 6013 \iflinks \next \fi 6014 }% 6015} 6016 6017% \internalsetq{foo}{page} expands into 6018% CHARACTERS @xrdef{foo}{...expansion of \page...} 6019\def\internalsetq#1#2{@xrdef{#1}{\csname #2\endcsname}} 6020 6021% Things to be expanded by \internalsetq. 6022% 6023\def\Ypagenumber{\folio} 6024\def\Ytitle{\thissection} 6025\def\Ynothing{} 6026\def\Ysectionnumberandtype{% 6027 \ifnum\secno=0 6028 \putwordChapter@tie \the\chapno 6029 \else \ifnum\subsecno=0 6030 \putwordSection@tie \the\chapno.\the\secno 6031 \else \ifnum\subsubsecno=0 6032 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno 6033 \else 6034 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno 6035 \fi\fi\fi 6036} 6037 6038\def\Yappendixletterandtype{% 6039 \ifnum\secno=0 6040 \putwordAppendix@tie @char\the\appendixno{}% 6041 \else \ifnum\subsecno=0 6042 \putwordSection@tie @char\the\appendixno.\the\secno 6043 \else \ifnum\subsubsecno=0 6044 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno 6045 \else 6046 \putwordSection@tie 6047 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno 6048 \fi\fi\fi 6049} 6050 6051% Use TeX 3.0's \inputlineno to get the line number, for better error 6052% messages, but if we're using an old version of TeX, don't do anything. 6053% 6054\ifx\inputlineno\thisisundefined 6055 \let\linenumber = \empty % Pre-3.0. 6056\else 6057 \def\linenumber{\the\inputlineno:\space} 6058\fi 6059 6060% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. 6061% If its value is nonempty, SUFFIX is output afterward. 6062% 6063\def\refx#1#2{% 6064 {% 6065 \indexnofonts 6066 \otherbackslash 6067 \expandafter\global\expandafter\let\expandafter\thisrefX 6068 \csname X#1\endcsname 6069 }% 6070 \ifx\thisrefX\relax 6071 % If not defined, say something at least. 6072 \angleleft un\-de\-fined\angleright 6073 \iflinks 6074 \ifhavexrefs 6075 \message{\linenumber Undefined cross reference `#1'.}% 6076 \else 6077 \ifwarnedxrefs\else 6078 \global\warnedxrefstrue 6079 \message{Cross reference values unknown; you must run TeX again.}% 6080 \fi 6081 \fi 6082 \fi 6083 \else 6084 % It's defined, so just use it. 6085 \thisrefX 6086 \fi 6087 #2% Output the suffix in any case. 6088} 6089 6090% This is the macro invoked by entries in the aux file. 6091% 6092\def\xrdef#1{\expandafter\gdef\csname X#1\endcsname} 6093 6094% Read the last existing aux file, if any. No error if none exists. 6095\def\readauxfile{\begingroup 6096 \catcode`\^^@=\other 6097 \catcode`\^^A=\other 6098 \catcode`\^^B=\other 6099 \catcode`\^^C=\other 6100 \catcode`\^^D=\other 6101 \catcode`\^^E=\other 6102 \catcode`\^^F=\other 6103 \catcode`\^^G=\other 6104 \catcode`\^^H=\other 6105 \catcode`\^^K=\other 6106 \catcode`\^^L=\other 6107 \catcode`\^^N=\other 6108 \catcode`\^^P=\other 6109 \catcode`\^^Q=\other 6110 \catcode`\^^R=\other 6111 \catcode`\^^S=\other 6112 \catcode`\^^T=\other 6113 \catcode`\^^U=\other 6114 \catcode`\^^V=\other 6115 \catcode`\^^W=\other 6116 \catcode`\^^X=\other 6117 \catcode`\^^Z=\other 6118 \catcode`\^^[=\other 6119 \catcode`\^^\=\other 6120 \catcode`\^^]=\other 6121 \catcode`\^^^=\other 6122 \catcode`\^^_=\other 6123 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. 6124 % in xref tags, i.e., node names. But since ^^e4 notation isn't 6125 % supported in the main text, it doesn't seem desirable. Furthermore, 6126 % that is not enough: for node names that actually contain a ^ 6127 % character, we would end up writing a line like this: 'xrdef {'hat 6128 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first 6129 % argument, and \hat is not an expandable control sequence. It could 6130 % all be worked out, but why? Either we support ^^ or we don't. 6131 % 6132 % The other change necessary for this was to define \auxhat: 6133 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter 6134 % and then to call \auxhat in \setq. 6135 % 6136 \catcode`\^=\other 6137 % 6138 % Special characters. Should be turned off anyway, but... 6139 \catcode`\~=\other 6140 \catcode`\[=\other 6141 \catcode`\]=\other 6142 \catcode`\"=\other 6143 \catcode`\_=\other 6144 \catcode`\|=\other 6145 \catcode`\<=\other 6146 \catcode`\>=\other 6147 \catcode`\$=\other 6148 \catcode`\#=\other 6149 \catcode`\&=\other 6150 \catcode`\%=\other 6151 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off 6152 % 6153 % Make the characters 128-255 be printing characters 6154 {% 6155 \count 1=128 6156 \def\loop{% 6157 \catcode\count 1=\other 6158 \advance\count 1 by 1 6159 \ifnum \count 1<256 \loop \fi 6160 }% 6161 }% 6162 % 6163 % Turn off \ as an escape so we do not lose on 6164 % entries which were dumped with control sequences in their names. 6165 % For example, @xrdef{$\leq $-fun}{page ...} made by @defun ^^ 6166 % Reference to such entries still does not work the way one would wish, 6167 % but at least they do not bomb out when the aux file is read in. 6168 \catcode`\\=\other 6169 % 6170 % @ is our escape character in .aux files. 6171 \catcode`\{=1 6172 \catcode`\}=2 6173 \catcode`\@=0 6174 % 6175 \openin 1 \jobname.aux 6176 \ifeof 1 \else 6177 \closein 1 6178 \input \jobname.aux 6179 \global\havexrefstrue 6180 \global\warnedobstrue 6181 \fi 6182 % Open the new aux file. TeX will close it automatically at exit. 6183 \openout\auxfile=\jobname.aux 6184\endgroup} 6185 6186 6187% Footnotes. 6188 6189\newcount \footnoteno 6190 6191% The trailing space in the following definition for supereject is 6192% vital for proper filling; pages come out unaligned when you do a 6193% pagealignmacro call if that space before the closing brace is 6194% removed. (Generally, numeric constants should always be followed by a 6195% space to prevent strange expansion errors.) 6196\def\supereject{\par\penalty -20000\footnoteno =0 } 6197 6198% @footnotestyle is meaningful for info output only. 6199\let\footnotestyle=\comment 6200 6201\let\ptexfootnote=\footnote 6202 6203{\catcode `\@=11 6204% 6205% Auto-number footnotes. Otherwise like plain. 6206\gdef\footnote{% 6207 \let\indent=\ptexindent 6208 \global\advance\footnoteno by \@ne 6209 \edef\thisfootno{$^{\the\footnoteno}$}% 6210 % 6211 % In case the footnote comes at the end of a sentence, preserve the 6212 % extra spacing after we do the footnote number. 6213 \let\@sf\empty 6214 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi 6215 % 6216 % Remove inadvertent blank space before typesetting the footnote number. 6217 \unskip 6218 \thisfootno\@sf 6219 \dofootnote 6220}% 6221 6222% Don't bother with the trickery in plain.tex to not require the 6223% footnote text as a parameter. Our footnotes don't need to be so general. 6224% 6225% Oh yes, they do; otherwise, @ifset and anything else that uses 6226% \parseargline fail inside footnotes because the tokens are fixed when 6227% the footnote is read. --karl, 16nov96. 6228% 6229% The start of the footnote looks usually like this: 6230\gdef\startfootins{\insert\footins\bgroup} 6231% 6232% ... but this macro is redefined inside @multitable. 6233% 6234\gdef\dofootnote{% 6235 \startfootins 6236 % We want to typeset this text as a normal paragraph, even if the 6237 % footnote reference occurs in (for example) a display environment. 6238 % So reset some parameters. 6239 \hsize=\pagewidth 6240 \interlinepenalty\interfootnotelinepenalty 6241 \splittopskip\ht\strutbox % top baseline for broken footnotes 6242 \splitmaxdepth\dp\strutbox 6243 \floatingpenalty\@MM 6244 \leftskip\z@skip 6245 \rightskip\z@skip 6246 \spaceskip\z@skip 6247 \xspaceskip\z@skip 6248 \parindent\defaultparindent 6249 % 6250 \smallfonts \rm 6251 % 6252 % Because we use hanging indentation in footnotes, a @noindent appears 6253 % to exdent this text, so make it be a no-op. makeinfo does not use 6254 % hanging indentation so @noindent can still be needed within footnote 6255 % text after an @example or the like (not that this is good style). 6256 \let\noindent = \relax 6257 % 6258 % Hang the footnote text off the number. Use \everypar in case the 6259 % footnote extends for more than one paragraph. 6260 \everypar = {\hang}% 6261 \textindent{\thisfootno}% 6262 % 6263 % Don't crash into the line above the footnote text. Since this 6264 % expands into a box, it must come within the paragraph, lest it 6265 % provide a place where TeX can split the footnote. 6266 \footstrut 6267 \futurelet\next\fo@t 6268} 6269}%end \catcode `\@=11 6270 6271% @| inserts a changebar to the left of the current line. It should 6272% surround any changed text. This approach does *not* work if the 6273% change spans more than two lines of output. To handle that, we would 6274% have adopt a much more difficult approach (putting marks into the main 6275% vertical list for the beginning and end of each change). 6276% 6277\def\|{% 6278 % \vadjust can only be used in horizontal mode. 6279 \leavevmode 6280 % 6281 % Append this vertical mode material after the current line in the output. 6282 \vadjust{% 6283 % We want to insert a rule with the height and depth of the current 6284 % leading; that is exactly what \strutbox is supposed to record. 6285 \vskip-\baselineskip 6286 % 6287 % \vadjust-items are inserted at the left edge of the type. So 6288 % the \llap here moves out into the left-hand margin. 6289 \llap{% 6290 % 6291 % For a thicker or thinner bar, change the `1pt'. 6292 \vrule height\baselineskip width1pt 6293 % 6294 % This is the space between the bar and the text. 6295 \hskip 12pt 6296 }% 6297 }% 6298} 6299 6300% For a final copy, take out the rectangles 6301% that mark overfull boxes (in case you have decided 6302% that the text looks ok even though it passes the margin). 6303% 6304\def\finalout{\overfullrule=0pt} 6305 6306% @image. We use the macros from epsf.tex to support this. 6307% If epsf.tex is not installed and @image is used, we complain. 6308% 6309% Check for and read epsf.tex up front. If we read it only at @image 6310% time, we might be inside a group, and then its definitions would get 6311% undone and the next image would fail. 6312\openin 1 = epsf.tex 6313\ifeof 1 \else 6314 \closein 1 6315 % Do not bother showing banner with epsf.tex v2.7k (available in 6316 % doc/epsf.tex and on ctan). 6317 \def\epsfannounce{\toks0 = }% 6318 \input epsf.tex 6319\fi 6320% 6321% We will only complain once about lack of epsf.tex. 6322\newif\ifwarnednoepsf 6323\newhelp\noepsfhelp{epsf.tex must be installed for images to 6324 work. It is also included in the Texinfo distribution, or you can get 6325 it from ftp://tug.org/tex/epsf.tex.} 6326% 6327\def\image#1{% 6328 \ifx\epsfbox\undefined 6329 \ifwarnednoepsf \else 6330 \errhelp = \noepsfhelp 6331 \errmessage{epsf.tex not found, images will be ignored}% 6332 \global\warnednoepsftrue 6333 \fi 6334 \else 6335 \imagexxx #1,,,,,\finish 6336 \fi 6337} 6338% 6339% Arguments to @image: 6340% #1 is (mandatory) image filename; we tack on .eps extension. 6341% #2 is (optional) width, #3 is (optional) height. 6342% #4 is (ignored optional) html alt text. 6343% #5 is (ignored optional) extension. 6344% #6 is just the usual extra ignored arg for parsing this stuff. 6345\newif\ifimagevmode 6346\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup 6347 \catcode`\^^M = 5 % in case we're inside an example 6348 \normalturnoffactive % allow _ et al. in names 6349 % If the image is by itself, center it. 6350 \ifvmode 6351 \imagevmodetrue 6352 \nobreak\bigskip 6353 % Usually we'll have text after the image which will insert 6354 % \parskip glue, so insert it here too to equalize the space 6355 % above and below. 6356 \nobreak\vskip\parskip 6357 \nobreak 6358 \line\bgroup\hss 6359 \fi 6360 % 6361 % Output the image. 6362 \ifpdf 6363 \dopdfimage{#1}{#2}{#3}% 6364 \else 6365 % \epsfbox itself resets \epsf?size at each figure. 6366 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi 6367 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi 6368 \epsfbox{#1.eps}% 6369 \fi 6370 % 6371 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image 6372\endgroup} 6373 6374 6375\message{localization,} 6376% and i18n. 6377 6378% @documentlanguage is usually given very early, just after 6379% @setfilename. If done too late, it may not override everything 6380% properly. Single argument is the language abbreviation. 6381% It would be nice if we could set up a hyphenation file here. 6382% 6383\def\documentlanguage{\parsearg\dodocumentlanguage} 6384\def\dodocumentlanguage#1{% 6385 \tex % read txi-??.tex file in plain TeX. 6386 % Read the file if it exists. 6387 \openin 1 txi-#1.tex 6388 \ifeof1 6389 \errhelp = \nolanghelp 6390 \errmessage{Cannot read language file txi-#1.tex}% 6391 \let\temp = \relax 6392 \else 6393 \def\temp{\input txi-#1.tex }% 6394 \fi 6395 \temp 6396 \endgroup 6397} 6398\newhelp\nolanghelp{The given language definition file cannot be found or 6399is empty. Maybe you need to install it? In the current directory 6400should work if nowhere else does.} 6401 6402 6403% @documentencoding should change something in TeX eventually, most 6404% likely, but for now just recognize it. 6405\let\documentencoding = \comment 6406 6407 6408% Page size parameters. 6409% 6410\newdimen\defaultparindent \defaultparindent = 15pt 6411 6412\chapheadingskip = 15pt plus 4pt minus 2pt 6413\secheadingskip = 12pt plus 3pt minus 2pt 6414\subsecheadingskip = 9pt plus 2pt minus 2pt 6415 6416% Prevent underfull vbox error messages. 6417\vbadness = 10000 6418 6419% Don't be so finicky about underfull hboxes, either. 6420\hbadness = 2000 6421 6422% Following George Bush, just get rid of widows and orphans. 6423\widowpenalty=10000 6424\clubpenalty=10000 6425 6426% Use TeX 3.0's \emergencystretch to help line breaking, but if we're 6427% using an old version of TeX, don't do anything. We want the amount of 6428% stretch added to depend on the line length, hence the dependence on 6429% \hsize. We call this whenever the paper size is set. 6430% 6431\def\setemergencystretch{% 6432 \ifx\emergencystretch\thisisundefined 6433 % Allow us to assign to \emergencystretch anyway. 6434 \def\emergencystretch{\dimen0}% 6435 \else 6436 \emergencystretch = .15\hsize 6437 \fi 6438} 6439 6440% Parameters in order: 1) textheight; 2) textwidth; 3) voffset; 6441% 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8) 6442% physical page width. 6443% 6444% We also call \setleading{\textleading}, so the caller should define 6445% \textleading. The caller should also set \parskip. 6446% 6447\def\internalpagesizes#1#2#3#4#5#6#7#8{% 6448 \voffset = #3\relax 6449 \topskip = #6\relax 6450 \splittopskip = \topskip 6451 % 6452 \vsize = #1\relax 6453 \advance\vsize by \topskip 6454 \outervsize = \vsize 6455 \advance\outervsize by 2\topandbottommargin 6456 \pageheight = \vsize 6457 % 6458 \hsize = #2\relax 6459 \outerhsize = \hsize 6460 \advance\outerhsize by 0.5in 6461 \pagewidth = \hsize 6462 % 6463 \normaloffset = #4\relax 6464 \bindingoffset = #5\relax 6465 % 6466 \ifpdf 6467 \pdfpageheight #7\relax 6468 \pdfpagewidth #8\relax 6469 \fi 6470 % 6471 \setleading{\textleading} 6472 % 6473 \parindent = \defaultparindent 6474 \setemergencystretch 6475} 6476 6477% @letterpaper (the default). 6478\def\letterpaper{{\globaldefs = 1 6479 \parskip = 3pt plus 2pt minus 1pt 6480 \textleading = 13.2pt 6481 % 6482 % If page is nothing but text, make it come out even. 6483 \internalpagesizes{46\baselineskip}{6in}% 6484 {\voffset}{.25in}% 6485 {\bindingoffset}{36pt}% 6486 {11in}{8.5in}% 6487}} 6488 6489% Use @smallbook to reset parameters for 7x9.5 (or so) format. 6490\def\smallbook{{\globaldefs = 1 6491 \parskip = 2pt plus 1pt 6492 \textleading = 12pt 6493 % 6494 \internalpagesizes{7.5in}{5in}% 6495 {\voffset}{.25in}% 6496 {\bindingoffset}{16pt}% 6497 {9.25in}{7in}% 6498 % 6499 \lispnarrowing = 0.3in 6500 \tolerance = 700 6501 \hfuzz = 1pt 6502 \contentsrightmargin = 0pt 6503 \defbodyindent = .5cm 6504}} 6505 6506% Use @afourpaper to print on European A4 paper. 6507\def\afourpaper{{\globaldefs = 1 6508 \parskip = 3pt plus 2pt minus 1pt 6509 \textleading = 13.2pt 6510 % 6511 % Double-side printing via postscript on Laserjet 4050 6512 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. 6513 % To change the settings for a different printer or situation, adjust 6514 % \normaloffset until the front-side and back-side texts align. Then 6515 % do the same for \bindingoffset. You can set these for testing in 6516 % your texinfo source file like this: 6517 % @tex 6518 % \global\normaloffset = -6mm 6519 % \global\bindingoffset = 10mm 6520 % @end tex 6521 \internalpagesizes{51\baselineskip}{160mm} 6522 {\voffset}{\hoffset}% 6523 {\bindingoffset}{44pt}% 6524 {297mm}{210mm}% 6525 % 6526 \tolerance = 700 6527 \hfuzz = 1pt 6528 \contentsrightmargin = 0pt 6529 \defbodyindent = 5mm 6530}} 6531 6532% Use @afivepaper to print on European A5 paper. 6533% From romildo@urano.iceb.ufop.br, 2 July 2000. 6534% He also recommends making @example and @lisp be small. 6535\def\afivepaper{{\globaldefs = 1 6536 \parskip = 2pt plus 1pt minus 0.1pt 6537 \textleading = 12.5pt 6538 % 6539 \internalpagesizes{160mm}{120mm}% 6540 {\voffset}{\hoffset}% 6541 {\bindingoffset}{8pt}% 6542 {210mm}{148mm}% 6543 % 6544 \lispnarrowing = 0.2in 6545 \tolerance = 800 6546 \hfuzz = 1.2pt 6547 \contentsrightmargin = 0pt 6548 \defbodyindent = 2mm 6549 \tableindent = 12mm 6550}} 6551 6552% A specific text layout, 24x15cm overall, intended for A4 paper. 6553\def\afourlatex{{\globaldefs = 1 6554 \afourpaper 6555 \internalpagesizes{237mm}{150mm}% 6556 {\voffset}{4.6mm}% 6557 {\bindingoffset}{7mm}% 6558 {297mm}{210mm}% 6559 % 6560 % Must explicitly reset to 0 because we call \afourpaper. 6561 \globaldefs = 0 6562}} 6563 6564% Use @afourwide to print on A4 paper in landscape format. 6565\def\afourwide{{\globaldefs = 1 6566 \afourpaper 6567 \internalpagesizes{241mm}{165mm}% 6568 {\voffset}{-2.95mm}% 6569 {\bindingoffset}{7mm}% 6570 {297mm}{210mm}% 6571 \globaldefs = 0 6572}} 6573 6574% @pagesizes TEXTHEIGHT[,TEXTWIDTH] 6575% Perhaps we should allow setting the margins, \topskip, \parskip, 6576% and/or leading, also. Or perhaps we should compute them somehow. 6577% 6578\def\pagesizes{\parsearg\pagesizesxxx} 6579\def\pagesizesxxx#1{\pagesizesyyy #1,,\finish} 6580\def\pagesizesyyy#1,#2,#3\finish{{% 6581 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi 6582 \globaldefs = 1 6583 % 6584 \parskip = 3pt plus 2pt minus 1pt 6585 \setleading{\textleading}% 6586 % 6587 \dimen0 = #1 6588 \advance\dimen0 by \voffset 6589 % 6590 \dimen2 = \hsize 6591 \advance\dimen2 by \normaloffset 6592 % 6593 \internalpagesizes{#1}{\hsize}% 6594 {\voffset}{\normaloffset}% 6595 {\bindingoffset}{44pt}% 6596 {\dimen0}{\dimen2}% 6597}} 6598 6599% Set default to letter. 6600% 6601\letterpaper 6602 6603 6604\message{and turning on texinfo input format.} 6605 6606% Define macros to output various characters with catcode for normal text. 6607\catcode`\"=\other 6608\catcode`\~=\other 6609\catcode`\^=\other 6610\catcode`\_=\other 6611\catcode`\|=\other 6612\catcode`\<=\other 6613\catcode`\>=\other 6614\catcode`\+=\other 6615\catcode`\$=\other 6616\def\normaldoublequote{"} 6617\def\normaltilde{~} 6618\def\normalcaret{^} 6619\def\normalunderscore{_} 6620\def\normalverticalbar{|} 6621\def\normalless{<} 6622\def\normalgreater{>} 6623\def\normalplus{+} 6624\def\normaldollar{$}%$ font-lock fix 6625 6626% This macro is used to make a character print one way in ttfont 6627% where it can probably just be output, and another way in other fonts, 6628% where something hairier probably needs to be done. 6629% 6630% #1 is what to print if we are indeed using \tt; #2 is what to print 6631% otherwise. Since all the Computer Modern typewriter fonts have zero 6632% interword stretch (and shrink), and it is reasonable to expect all 6633% typewriter fonts to have this, we can check that font parameter. 6634% 6635\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} 6636 6637% Same as above, but check for italic font. Actually this also catches 6638% non-italic slanted fonts since it is impossible to distinguish them from 6639% italic fonts. But since this is only used by $ and it uses \sl anyway 6640% this is not a problem. 6641\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} 6642 6643% Turn off all special characters except @ 6644% (and those which the user can use as if they were ordinary). 6645% Most of these we simply print from the \tt font, but for some, we can 6646% use math or other variants that look better in normal text. 6647 6648\catcode`\"=\active 6649\def\activedoublequote{{\tt\char34}} 6650\let"=\activedoublequote 6651\catcode`\~=\active 6652\def~{{\tt\char126}} 6653\chardef\hat=`\^ 6654\catcode`\^=\active 6655\def^{{\tt \hat}} 6656 6657\catcode`\_=\active 6658\def_{\ifusingtt\normalunderscore\_} 6659% Subroutine for the previous macro. 6660\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } 6661 6662\catcode`\|=\active 6663\def|{{\tt\char124}} 6664\chardef \less=`\< 6665\catcode`\<=\active 6666\def<{{\tt \less}} 6667\chardef \gtr=`\> 6668\catcode`\>=\active 6669\def>{{\tt \gtr}} 6670\catcode`\+=\active 6671\def+{{\tt \char 43}} 6672\catcode`\$=\active 6673\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix 6674 6675% Set up an active definition for =, but don't enable it most of the time. 6676{\catcode`\==\active 6677\global\def={{\tt \char 61}}} 6678 6679\catcode`+=\active 6680\catcode`\_=\active 6681 6682% If a .fmt file is being used, characters that might appear in a file 6683% name cannot be active until we have parsed the command line. 6684% So turn them off again, and have \everyjob (or @setfilename) turn them on. 6685% \otherifyactive is called near the end of this file. 6686\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} 6687 6688\catcode`\@=0 6689 6690% \rawbackslashxx outputs one backslash character in current font, 6691% as in \char`\\. 6692\global\chardef\rawbackslashxx=`\\ 6693 6694% \rawbackslash defines an active \ to do \rawbackslashxx. 6695% \otherbackslash defines an active \ to be a literal `\' character with 6696% catcode other. 6697{\catcode`\\=\active 6698 @gdef@rawbackslash{@let\=@rawbackslashxx} 6699 @gdef@otherbackslash{@let\=@realbackslash} 6700} 6701 6702% \realbackslash is an actual character `\' with catcode other. 6703{\catcode`\\=\other @gdef@realbackslash{\}} 6704 6705% \normalbackslash outputs one backslash in fixed width font. 6706\def\normalbackslash{{\tt\rawbackslashxx}} 6707 6708\catcode`\\=\active 6709 6710% Used sometimes to turn off (effectively) the active characters 6711% even after parsing them. 6712@def@turnoffactive{% 6713 @let"=@normaldoublequote 6714 @let\=@realbackslash 6715 @let~=@normaltilde 6716 @let^=@normalcaret 6717 @let_=@normalunderscore 6718 @let|=@normalverticalbar 6719 @let<=@normalless 6720 @let>=@normalgreater 6721 @let+=@normalplus 6722 @let$=@normaldollar %$ font-lock fix 6723} 6724 6725% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of 6726% the literal character `\'. (Thus, \ is not expandable when this is in 6727% effect.) 6728% 6729@def@normalturnoffactive{@turnoffactive @let\=@normalbackslash} 6730 6731% Make _ and + \other characters, temporarily. 6732% This is canceled by @fixbackslash. 6733@otherifyactive 6734 6735% If a .fmt file is being used, we don't want the `\input texinfo' to show up. 6736% That is what \eatinput is for; after that, the `\' should revert to printing 6737% a backslash. 6738% 6739@gdef@eatinput input texinfo{@fixbackslash} 6740@global@let\ = @eatinput 6741 6742% On the other hand, perhaps the file did not have a `\input texinfo'. Then 6743% the first `\{ in the file would cause an error. This macro tries to fix 6744% that, assuming it is called before the first `\' could plausibly occur. 6745% Also back turn on active characters that might appear in the input 6746% file name, in case not using a pre-dumped format. 6747% 6748@gdef@fixbackslash{% 6749 @ifx\@eatinput @let\ = @normalbackslash @fi 6750 @catcode`+=@active 6751 @catcode`@_=@active 6752} 6753 6754% Say @foo, not \foo, in error messages. 6755@escapechar = `@@ 6756 6757% These look ok in all fonts, so just make them not special. 6758@catcode`@& = @other 6759@catcode`@# = @other 6760@catcode`@% = @other 6761 6762@c Set initial fonts. 6763@textfonts 6764@rm 6765 6766 6767@c Local variables: 6768@c eval: (add-hook 'write-file-hooks 'time-stamp) 6769@c page-delimiter: "^\\\\message" 6770@c time-stamp-start: "def\\\\texinfoversion{" 6771@c time-stamp-format: "%:y-%02m-%02d.%02H" 6772@c time-stamp-end: "}" 6773@c End: 6774