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