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