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