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