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