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