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