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