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