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