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