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