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