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