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