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