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