update from automake
[gnulib.git] / config / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2003-10-29.10}
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 % @multitable ... @end multitable definitions:
2430 %
2431 \def\multitable{\parsearg\dotable}
2432 \def\dotable#1{\bgroup
2433   \vskip\parskip
2434   \let\item=\crcrwithfootnotes
2435   % A \tab used to include \hskip1sp.  But then the space in a template
2436   % line is not enough.  That is bad.  So let's go back to just & until
2437   % we encounter the problem it was intended to solve again.  --karl,
2438   % nathan@acm.org, 20apr99.
2439   \let\tab=&%
2440   \let\startfootins=\startsavedfootnote
2441   \tolerance=9500
2442   \hbadness=9500
2443   \setmultitablespacing
2444   \parskip=\multitableparskip
2445   \parindent=\multitableparindent
2446   \overfullrule=0pt
2447   \global\colcount=0
2448   \def\Emultitable{%
2449     \global\setpercentfalse
2450     \crcrwithfootnotes\crcr
2451     \egroup\egroup
2452   }%
2453   %
2454   % To parse everything between @multitable and @item:
2455   \setuptable#1 \endsetuptable
2456   %
2457   % \everycr will reset column counter, \colcount, at the end of
2458   % each line. Every column entry will cause \colcount to advance by one.
2459   % The table preamble
2460   % looks at the current \colcount to find the correct column width.
2461   \everycr{\noalign{%
2462   %
2463   % \filbreak%% keeps underfull box messages off when table breaks over pages.
2464   % Maybe so, but it also creates really weird page breaks when the table
2465   % breaks over pages. Wouldn't \vfil be better?  Wait until the problem
2466   % manifests itself, so it can be fixed for real --karl.
2467     \global\colcount=0\relax}}%
2468   %
2469   % This preamble sets up a generic column definition, which will
2470   % be used as many times as user calls for columns.
2471   % \vtop will set a single line and will also let text wrap and
2472   % continue for many paragraphs if desired.
2473   \halign\bgroup&\global\advance\colcount by 1\relax
2474     \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2475   %
2476   % In order to keep entries from bumping into each other
2477   % we will add a \leftskip of \multitablecolspace to all columns after
2478   % the first one.
2479   %
2480   % If a template has been used, we will add \multitablecolspace
2481   % to the width of each template entry.
2482   %
2483   % If the user has set preamble in terms of percent of \hsize we will
2484   % use that dimension as the width of the column, and the \leftskip
2485   % will keep entries from bumping into each other.  Table will start at
2486   % left margin and final column will justify at right margin.
2487   %
2488   % Make sure we don't inherit \rightskip from the outer environment.
2489   \rightskip=0pt
2490   \ifnum\colcount=1
2491     % The first column will be indented with the surrounding text.
2492     \advance\hsize by\leftskip
2493   \else
2494     \ifsetpercent \else
2495       % If user has not set preamble in terms of percent of \hsize
2496       % we will advance \hsize by \multitablecolspace.
2497       \advance\hsize by \multitablecolspace
2498     \fi
2499    % In either case we will make \leftskip=\multitablecolspace:
2500   \leftskip=\multitablecolspace
2501   \fi
2502   % Ignoring space at the beginning and end avoids an occasional spurious
2503   % blank line, when TeX decides to break the line at the space before the
2504   % box from the multistrut, so the strut ends up on a line by itself.
2505   % For example:
2506   % @multitable @columnfractions .11 .89
2507   % @item @code{#}
2508   % @tab Legal holiday which is valid in major parts of the whole country.
2509   % Is automatically provided with highlighting sequences respectively marking
2510   % characters.
2511   \noindent\ignorespaces##\unskip\multistrut}\cr
2512 }
2513
2514 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2515 % If so, do nothing. If not, give it an appropriate dimension based on
2516 % current baselineskip.
2517 \ifdim\multitablelinespace=0pt
2518 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2519 \global\advance\multitablelinespace by-\ht0
2520 %% strut to put in table in case some entry doesn't have descenders,
2521 %% to keep lines equally spaced
2522 \let\multistrut = \strut
2523 \else
2524 %% FIXME: what is \box0 supposed to be?
2525 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2526 width0pt\relax} \fi
2527 %% Test to see if parskip is larger than space between lines of
2528 %% table. If not, do nothing.
2529 %%        If so, set to same dimension as multitablelinespace.
2530 \ifdim\multitableparskip>\multitablelinespace
2531 \global\multitableparskip=\multitablelinespace
2532 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2533                                       %% than skip between lines in the table.
2534 \fi%
2535 \ifdim\multitableparskip=0pt
2536 \global\multitableparskip=\multitablelinespace
2537 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2538                                       %% than skip between lines in the table.
2539 \fi}
2540
2541 % In case a @footnote appears inside an alignment, save the footnote
2542 % text to a box and make the \insert when a row of the table is
2543 % finished.  Otherwise, the insertion is lost, it never migrates to the
2544 % main vertical list.  --kasal, 22jan03.
2545 %
2546 \newbox\savedfootnotes
2547 %
2548 % \dotable \let's \startfootins to this, so that \dofootnote will call
2549 % it instead of starting the insertion right away.
2550 \def\startsavedfootnote{%
2551   \global\setbox\savedfootnotes = \vbox\bgroup
2552     \unvbox\savedfootnotes
2553 }
2554 \def\crcrwithfootnotes{%
2555   \crcr
2556   \ifvoid\savedfootnotes \else
2557     \noalign{\insert\footins{\box\savedfootnotes}}%
2558   \fi
2559 }
2560
2561 \message{conditionals,}
2562 % Prevent errors for section commands.
2563 % Used in @ignore and in failing conditionals.
2564 \def\ignoresections{%
2565   \let\appendix=\relax
2566   \let\appendixsec=\relax
2567   \let\appendixsection=\relax
2568   \let\appendixsubsec=\relax
2569   \let\appendixsubsection=\relax
2570   \let\appendixsubsubsec=\relax
2571   \let\appendixsubsubsection=\relax
2572   %\let\begin=\relax
2573   %\let\bye=\relax
2574   \let\centerchap=\relax
2575   \let\chapter=\relax
2576   \let\contents=\relax
2577   \let\section=\relax
2578   \let\smallbook=\relax
2579   \let\subsec=\relax
2580   \let\subsection=\relax
2581   \let\subsubsec=\relax
2582   \let\subsubsection=\relax
2583   \let\titlepage=\relax
2584   \let\top=\relax
2585   \let\unnumbered=\relax
2586   \let\unnumberedsec=\relax
2587   \let\unnumberedsection=\relax
2588   \let\unnumberedsubsec=\relax
2589   \let\unnumberedsubsection=\relax
2590   \let\unnumberedsubsubsec=\relax
2591   \let\unnumberedsubsubsection=\relax
2592 }
2593
2594 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2595 %
2596 \def\direntry{\doignore{direntry}}
2597 \def\documentdescriptionword{documentdescription}
2598 \def\documentdescription{\doignore{documentdescription}}
2599 \def\docbook{\doignore{docbook}}
2600 \def\html{\doignore{html}}
2601 \def\ifdocbook{\doignore{ifdocbook}}
2602 \def\ifhtml{\doignore{ifhtml}}
2603 \def\ifinfo{\doignore{ifinfo}}
2604 \def\ifnottex{\doignore{ifnottex}}
2605 \def\ifplaintext{\doignore{ifplaintext}}
2606 \def\ifxml{\doignore{ifxml}}
2607 \def\ignore{\doignore{ignore}}
2608 \def\menu{\doignore{menu}}
2609 \def\xml{\doignore{xml}}
2610
2611 % @dircategory CATEGORY  -- specify a category of the dir file
2612 % which this file should belong to.  Ignore this in TeX.
2613 \let\dircategory = \comment
2614
2615 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2616 %
2617 % A count to remember the depth of nesting.
2618 \newcount\doignorecount
2619
2620 \def\doignore#1{\begingroup
2621   % Don't complain about control sequences we have declared \outer.
2622   \ignoresections
2623   %
2624   % Make sure that spaces turn into tokens that match what \doignoretext wants.
2625   \catcode\spaceChar = 10
2626   %
2627   % Ignore braces, so mismatched braces don't cause trouble.
2628   \catcode`\{ = 9
2629   \catcode`\} = 9
2630   %
2631   % Count number of #1's that we've seen.
2632   \doignorecount = 0
2633   %
2634   % Swallow text until we reach the matching `@end #1'.
2635   \expandafter \dodoignore \csname#1\endcsname {#1}%
2636 }
2637
2638 { \catcode`@=11 % We want to use \ST@P which cannot appear in texinfo source.
2639   \obeylines %
2640   %
2641   \gdef\dodoignore#1#2{%
2642     % #1 contains, e.g., \ifinfo, a.k.a. @ifinfo.
2643     % #2 contains the string `ifinfo'.
2644     %
2645     % Define a command to find the next `@end #2', which must be on a line
2646     % by itself.
2647     \long\def\doignoretext##1^^M\end #2{\doignoretextyyy##1^^M#1\ST@P}%
2648     % And this command to find another #1 command, at the beginning of a
2649     % line.  (Otherwise, we would consider a line `@c @ifset', for
2650     % example, to count as an @ifset for nesting.)
2651     \long\def\doignoretextyyy##1^^M#1##2\ST@P{\doignoreyyy{##2}\ST@P}%
2652     %
2653     % And now expand that command.
2654     \obeylines %
2655     \doignoretext ^^M%
2656   }%
2657 }
2658
2659 \def\doignoreyyy#1{%
2660   \def\temp{#1}%
2661   \ifx\temp\empty                       % Nothing found.
2662     \let\next\doignoretextzzz
2663   \else                                 % Found a nested condition, ...
2664     \advance\doignorecount by 1
2665     \let\next\doignoretextyyy           % ..., look for another.
2666     % If we're here, #1 ends with ^^M\ifinfo (for example).
2667   \fi
2668   \next #1% the token \ST@P is present just after this macro.
2669 }
2670
2671 % We have to swallow the remaining "\ST@P".
2672
2673 \def\doignoretextzzz#1{%
2674   \ifnum\doignorecount = 0      % We have just found the outermost @end.
2675     \let\next\enddoignore
2676   \else                         % Still inside a nested condition.
2677     \advance\doignorecount by -1
2678     \let\next\doignoretext      % Look for the next @end.
2679   \fi
2680   \next
2681 }
2682
2683 % Finish off ignored text.
2684 \def\enddoignore{\endgroup\ignorespaces}
2685
2686
2687 % @set VAR sets the variable VAR to an empty value.
2688 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2689 %
2690 % Since we want to separate VAR from REST-OF-LINE (which might be
2691 % empty), we can't just use \parsearg; we have to insert a space of our
2692 % own to delimit the rest of the line, and then take it out again if we
2693 % didn't need it.  Make sure the catcode of space is correct to avoid
2694 % losing inside @example, for instance.
2695 %
2696 \def\set{\begingroup\catcode` =10
2697   \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2698   \parsearg\setxxx}
2699 \def\setxxx#1{\setyyy#1 \endsetyyy}
2700 \def\setyyy#1 #2\endsetyyy{%
2701   \def\temp{#2}%
2702   \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2703   \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2704   \fi
2705   \endgroup
2706 }
2707 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2708 % \next or other control sequences that we've defined might get us into
2709 % an infinite loop. Consider `@set foo @cite{bar}'.
2710 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2711
2712 % @clear VAR clears (i.e., unsets) the variable VAR.
2713 %
2714 \def\clear{\parsearg\clearxxx}
2715 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2716
2717 % @value{foo} gets the text saved in variable foo.
2718 {
2719   \catcode`\_ = \active
2720   %
2721   % We might end up with active _ or - characters in the argument if
2722   % we're called from @code, as @code{@value{foo-bar_}}.  So \let any
2723   % such active characters to their normal equivalents.
2724   \gdef\value{\begingroup
2725     \catcode`\-=\other \catcode`\_=\other
2726     \indexbreaks \let_\normalunderscore
2727     \valuexxx}
2728 }
2729 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2730
2731 % We have this subroutine so that we can handle at least some @value's
2732 % properly in indexes (we \let\value to this in \indexdummies).  Ones
2733 % whose names contain - or _ still won't work, but we can't do anything
2734 % about that.  The command has to be fully expandable (if the variable
2735 % is set), since the result winds up in the index file.  This means that
2736 % if the variable's value contains other Texinfo commands, it's almost
2737 % certain it will fail (although perhaps we could fix that with
2738 % sufficient work to do a one-level expansion on the result, instead of
2739 % complete).
2740 %
2741 \def\expandablevalue#1{%
2742   \expandafter\ifx\csname SET#1\endcsname\relax
2743     {[No value for ``#1'']}%
2744     \message{Variable `#1', used in @value, is not set.}%
2745   \else
2746     \csname SET#1\endcsname
2747   \fi
2748 }
2749
2750 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2751 % with @set.
2752 %
2753 \def\ifset{\parsearg\doifset}
2754 \def\doifset#1{%
2755   \expandafter\ifx\csname SET#1\endcsname\relax
2756     \let\next=\ifsetfail
2757   \else
2758     \let\next=\ifsetsucceed
2759   \fi
2760   \next
2761 }
2762 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2763 \def\ifsetfail{\doignore{ifset}}
2764 \defineunmatchedend{ifset}
2765
2766 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2767 % defined with @set, or has been undefined with @clear.
2768 %
2769 \def\ifclear{\parsearg\doifclear}
2770 \def\doifclear#1{%
2771   \expandafter\ifx\csname SET#1\endcsname\relax
2772     \let\next=\ifclearsucceed
2773   \else
2774     \let\next=\ifclearfail
2775   \fi
2776   \next
2777 }
2778 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2779 \def\ifclearfail{\doignore{ifclear}}
2780 \defineunmatchedend{ifclear}
2781
2782 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2783 % read the text following, through the first @end iftex (etc.).  Make
2784 % `@end iftex' (etc.) valid only after an @iftex.
2785 %
2786 \def\iftex{\conditionalsucceed{iftex}}
2787 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2788 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2789 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2790 \defineunmatchedend{iftex}
2791 \defineunmatchedend{ifnothtml}
2792 \defineunmatchedend{ifnotinfo}
2793 \defineunmatchedend{ifnotplaintext}
2794
2795 % True conditional.  Since \set globally defines its variables, we can
2796 % just start and end a group (to keep the @end definition undefined at
2797 % the outer level).
2798 %
2799 \def\conditionalsucceed#1{\begingroup
2800   \expandafter\def\csname E#1\endcsname{\endgroup}%
2801 }
2802
2803 % @defininfoenclose.
2804 \let\definfoenclose=\comment
2805
2806
2807 \message{indexing,}
2808 % Index generation facilities
2809
2810 % Define \newwrite to be identical to plain tex's \newwrite
2811 % except not \outer, so it can be used within \newindex.
2812 {\catcode`\@=11
2813 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2814
2815 % \newindex {foo} defines an index named foo.
2816 % It automatically defines \fooindex such that
2817 % \fooindex ...rest of line... puts an entry in the index foo.
2818 % It also defines \fooindfile to be the number of the output channel for
2819 % the file that accumulates this index.  The file's extension is foo.
2820 % The name of an index should be no more than 2 characters long
2821 % for the sake of vms.
2822 %
2823 \def\newindex#1{%
2824   \iflinks
2825     \expandafter\newwrite \csname#1indfile\endcsname
2826     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2827   \fi
2828   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
2829     \noexpand\doindex{#1}}
2830 }
2831
2832 % @defindex foo  ==  \newindex{foo}
2833 %
2834 \def\defindex{\parsearg\newindex}
2835
2836 % Define @defcodeindex, like @defindex except put all entries in @code.
2837 %
2838 \def\defcodeindex{\parsearg\newcodeindex}
2839 %
2840 \def\newcodeindex#1{%
2841   \iflinks
2842     \expandafter\newwrite \csname#1indfile\endcsname
2843     \openout \csname#1indfile\endcsname \jobname.#1
2844   \fi
2845   \expandafter\xdef\csname#1index\endcsname{%
2846     \noexpand\docodeindex{#1}}%
2847 }
2848
2849
2850 % @synindex foo bar    makes index foo feed into index bar.
2851 % Do this instead of @defindex foo if you don't want it as a separate index.
2852 %
2853 % @syncodeindex foo bar   similar, but put all entries made for index foo
2854 % inside @code.
2855 %
2856 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2857 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2858
2859 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2860 % #3 the target index (bar).
2861 \def\dosynindex#1#2#3{%
2862   % Only do \closeout if we haven't already done it, else we'll end up
2863   % closing the target index.
2864   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2865     % The \closeout helps reduce unnecessary open files; the limit on the
2866     % Acorn RISC OS is a mere 16 files.
2867     \expandafter\closeout\csname#2indfile\endcsname
2868     \expandafter\let\csname\donesynindex#2\endcsname = 1
2869   \fi
2870   % redefine \fooindfile:
2871   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2872   \expandafter\let\csname#2indfile\endcsname=\temp
2873   % redefine \fooindex:
2874   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2875 }
2876
2877 % Define \doindex, the driver for all \fooindex macros.
2878 % Argument #1 is generated by the calling \fooindex macro,
2879 %  and it is "foo", the name of the index.
2880
2881 % \doindex just uses \parsearg; it calls \doind for the actual work.
2882 % This is because \doind is more useful to call from other macros.
2883
2884 % There is also \dosubind {index}{topic}{subtopic}
2885 % which makes an entry in a two-level index such as the operation index.
2886
2887 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2888 \def\singleindexer #1{\doind{\indexname}{#1}}
2889
2890 % like the previous two, but they put @code around the argument.
2891 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2892 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2893
2894 % Take care of Texinfo commands that can appear in an index entry.
2895 % Since there are some commands we want to expand, and others we don't,
2896 % we have to laboriously prevent expansion for those that we don't.
2897 %
2898 \def\indexdummies{%
2899   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
2900   \def\ {\realbackslash\space }%
2901   % Need these in case \tex is in effect and \{ is a \delimiter again.
2902   % But can't use \lbracecmd and \rbracecmd because texindex assumes
2903   % braces and backslashes are used only as delimiters.
2904   \let\{ = \mylbrace
2905   \let\} = \myrbrace
2906   %
2907   % \definedummyword defines \#1 as \realbackslash #1\space, thus
2908   % effectively preventing its expansion.  This is used only for control
2909   % words, not control letters, because the \space would be incorrect
2910   % for control characters, but is needed to separate the control word
2911   % from whatever follows.
2912   %
2913   % For control letters, we have \definedummyletter, which omits the
2914   % space.
2915   %
2916   % These can be used both for control words that take an argument and
2917   % those that do not.  If it is followed by {arg} in the input, then
2918   % that will dutifully get written to the index (or wherever).
2919   %
2920   \def\definedummyword##1{%
2921     \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
2922   }%
2923   \def\definedummyletter##1{%
2924     \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
2925   }%
2926   %
2927   % Do the redefinitions.
2928   \commondummies
2929 }
2930
2931 % For the aux file, @ is the escape character.  So we want to redefine
2932 % everything using @ instead of \realbackslash.  When everything uses
2933 % @, this will be simpler.
2934 %
2935 \def\atdummies{%
2936   \def\@{@@}%
2937   \def\ {@ }%
2938   \let\{ = \lbraceatcmd
2939   \let\} = \rbraceatcmd
2940   %
2941   % (See comments in \indexdummies.)
2942   \def\definedummyword##1{%
2943     \expandafter\def\csname ##1\endcsname{@##1\space}%
2944   }%
2945   \def\definedummyletter##1{%
2946     \expandafter\def\csname ##1\endcsname{@##1}%
2947   }%
2948   %
2949   % Do the redefinitions.
2950   \commondummies
2951 }
2952
2953 % Called from \indexdummies and \atdummies.  \definedummyword and
2954 % \definedummyletter must be defined first.
2955 %
2956 \def\commondummies{%
2957   %
2958   \normalturnoffactive
2959   %
2960   % Control letters and accents.
2961   \definedummyletter{_}%
2962   \definedummyletter{,}%
2963   \definedummyletter{"}%
2964   \definedummyletter{`}%
2965   \definedummyletter{'}%
2966   \definedummyletter{^}%
2967   \definedummyletter{~}%
2968   \definedummyletter{=}%
2969   \definedummyword{u}%
2970   \definedummyword{v}%
2971   \definedummyword{H}%
2972   \definedummyword{dotaccent}%
2973   \definedummyword{ringaccent}%
2974   \definedummyword{tieaccent}%
2975   \definedummyword{ubaraccent}%
2976   \definedummyword{udotaccent}%
2977   \definedummyword{dotless}%
2978   %
2979   % Other non-English letters.
2980   \definedummyword{AA}%
2981   \definedummyword{AE}%
2982   \definedummyword{L}%
2983   \definedummyword{OE}%
2984   \definedummyword{O}%
2985   \definedummyword{aa}%
2986   \definedummyword{ae}%
2987   \definedummyword{l}%
2988   \definedummyword{oe}%
2989   \definedummyword{o}%
2990   \definedummyword{ss}%
2991   %
2992   % Although these internal commands shouldn't show up, sometimes they do.
2993   \definedummyword{bf}%
2994   \definedummyword{gtr}%
2995   \definedummyword{hat}%
2996   \definedummyword{less}%
2997   \definedummyword{sf}%
2998   \definedummyword{sl}%
2999   \definedummyword{tclose}%
3000   \definedummyword{tt}%
3001   %
3002   % Texinfo font commands.
3003   \definedummyword{b}%
3004   \definedummyword{i}%
3005   \definedummyword{r}%
3006   \definedummyword{sc}%
3007   \definedummyword{t}%
3008   %
3009   \definedummyword{TeX}%
3010   \definedummyword{acronym}%
3011   \definedummyword{cite}%
3012   \definedummyword{code}%
3013   \definedummyword{command}%
3014   \definedummyword{dfn}%
3015   \definedummyword{dots}%
3016   \definedummyword{emph}%
3017   \definedummyword{env}%
3018   \definedummyword{file}%
3019   \definedummyword{kbd}%
3020   \definedummyword{key}%
3021   \definedummyword{math}%
3022   \definedummyword{option}%
3023   \definedummyword{samp}%
3024   \definedummyword{strong}%
3025   \definedummyword{uref}%
3026   \definedummyword{url}%
3027   \definedummyword{var}%
3028   \definedummyword{verb}%
3029   \definedummyword{w}%
3030   %
3031   % Assorted special characters.
3032   \definedummyword{bullet}%
3033   \definedummyword{copyright}%
3034   \definedummyword{dots}%
3035   \definedummyword{enddots}%
3036   \definedummyword{equiv}%
3037   \definedummyword{error}%
3038   \definedummyword{expansion}%
3039   \definedummyword{minus}%
3040   \definedummyword{pounds}%
3041   \definedummyword{point}%
3042   \definedummyword{print}%
3043   \definedummyword{result}%
3044   %
3045   % Handle some cases of @value -- where the variable name does not
3046   % contain - or _, and the value does not contain any
3047   % (non-fully-expandable) commands.
3048   \let\value = \expandablevalue
3049   %
3050   % Normal spaces, not active ones.
3051   \unsepspaces
3052   %
3053   % No macro expansion.
3054   \turnoffmacros
3055 }
3056
3057
3058 % \indexnofonts is used when outputting the strings to sort the index
3059 % by, and when constructing control sequence names.  It eliminates all
3060 % control sequences and just writes whatever the best ASCII sort string
3061 % would be for a given command (usually its argument).
3062 %
3063 \def\indexdummytex{TeX}
3064 \def\indexdummydots{...}
3065 %
3066 \def\indexnofonts{%
3067   \def\ { }%
3068   \def\@{@}%
3069   % how to handle braces?
3070   \def\_{\normalunderscore}%
3071   %
3072   \let\,=\asis
3073   \let\"=\asis
3074   \let\`=\asis
3075   \let\'=\asis
3076   \let\^=\asis
3077   \let\~=\asis
3078   \let\==\asis
3079   \let\u=\asis
3080   \let\v=\asis
3081   \let\H=\asis
3082   \let\dotaccent=\asis
3083   \let\ringaccent=\asis
3084   \let\tieaccent=\asis
3085   \let\ubaraccent=\asis
3086   \let\udotaccent=\asis
3087   \let\dotless=\asis
3088   %
3089   % Other non-English letters.
3090   \def\AA{AA}%
3091   \def\AE{AE}%
3092   \def\L{L}%
3093   \def\OE{OE}%
3094   \def\O{O}%
3095   \def\aa{aa}%
3096   \def\ae{ae}%
3097   \def\l{l}%
3098   \def\oe{oe}%
3099   \def\o{o}%
3100   \def\ss{ss}%
3101   \def\exclamdown{!}%
3102   \def\questiondown{?}%
3103   %
3104   % Don't no-op \tt, since it isn't a user-level command
3105   % and is used in the definitions of the active chars like <, >, |, etc.
3106   % Likewise with the other plain tex font commands.
3107   %\let\tt=\asis
3108   %
3109   % Texinfo font commands.
3110   \let\b=\asis
3111   \let\i=\asis
3112   \let\r=\asis
3113   \let\sc=\asis
3114   \let\t=\asis
3115   %
3116   \let\TeX=\indexdummytex
3117   \let\acronym=\asis
3118   \let\cite=\asis
3119   \let\code=\asis
3120   \let\command=\asis
3121   \let\dfn=\asis
3122   \let\dots=\indexdummydots
3123   \let\emph=\asis
3124   \let\env=\asis
3125   \let\file=\asis
3126   \let\kbd=\asis
3127   \let\key=\asis
3128   \let\math=\asis
3129   \let\option=\asis
3130   \let\samp=\asis
3131   \let\strong=\asis
3132   \let\uref=\asis
3133   \let\url=\asis
3134   \let\var=\asis
3135   \let\verb=\asis
3136   \let\w=\asis
3137 }
3138
3139 \let\indexbackslash=0  %overridden during \printindex.
3140 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3141
3142 % Most index entries go through here, but \dosubind is the general case.
3143 %
3144 \def\doind#1#2{\dosubind{#1}{#2}{}}
3145
3146 % Workhorse for all \fooindexes.
3147 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3148 % \empty if called from \doind, as we usually are.  The main exception
3149 % is with defuns, which call us directly.
3150 %
3151 \def\dosubind#1#2#3{%
3152   \iflinks
3153   {%
3154     % Store the main index entry text (including the third arg).
3155     \toks0 = {#2}%
3156     % If third arg is present, precede it with space.
3157     \def\thirdarg{#3}%
3158     \ifx\thirdarg\empty \else
3159       \toks0 = \expandafter{\the\toks0 \space #3}%
3160     \fi
3161     %
3162     \edef\writeto{\csname#1indfile\endcsname}%
3163     %
3164     \ifvmode
3165       \dosubindsanitize
3166     \else
3167       \dosubindwrite
3168     \fi
3169   }%
3170   \fi
3171 }
3172
3173 % Write the entry to the index file:
3174 %
3175 \def\dosubindwrite{%
3176   % Put the index entry in the margin if desired.
3177   \ifx\SETmarginindex\relax\else
3178     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3179   \fi
3180   %
3181   % Remember, we are within a group.
3182   \indexdummies % Must do this here, since \bf, etc expand at this stage
3183   \escapechar=`\\
3184   \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3185       % so it will be output as is; and it will print as backslash.
3186   %
3187   % Process the index entry with all font commands turned off, to
3188   % get the string to sort by.
3189   {\indexnofonts
3190    \edef\temp{\the\toks0}% need full expansion
3191    \xdef\indexsorttmp{\temp}%
3192   }%
3193   %
3194   % Set up the complete index entry, with both the sort key and
3195   % the original text, including any font commands.  We write
3196   % three arguments to \entry to the .?? file (four in the
3197   % subentry case), texindex reduces to two when writing the .??s
3198   % sorted result.
3199   \edef\temp{%
3200     \write\writeto{%
3201       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3202   }%
3203   \temp
3204 }
3205
3206 % Take care of unwanted page breaks:
3207 %
3208 % If a skip is the last thing on the list now, preserve it
3209 % by backing up by \lastskip, doing the \write, then inserting
3210 % the skip again.  Otherwise, the whatsit generated by the
3211 % \write will make \lastskip zero.  The result is that sequences
3212 % like this:
3213 % @end defun
3214 % @tindex whatever
3215 % @defun ...
3216 % will have extra space inserted, because the \medbreak in the
3217 % start of the @defun won't see the skip inserted by the @end of
3218 % the previous defun.
3219 %
3220 % But don't do any of this if we're not in vertical mode.  We
3221 % don't want to do a \vskip and prematurely end a paragraph.
3222 %
3223 % Avoid page breaks due to these extra skips, too.
3224 %
3225 \def\dosubindsanitize{%
3226   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3227   \skip0 = \lastskip
3228   \count255 = \lastpenalty
3229   %
3230   % If \lastskip is nonzero, that means the last item was a
3231   % skip.  And since a skip is discardable, that means this
3232   % -\skip0 glue we're inserting is preceded by a
3233   % non-discardable item, therefore it is not a potential
3234   % breakpoint, therefore no \nobreak needed.
3235   \ifdim\lastskip = 0pt \else \vskip-\skip0 \fi
3236   %
3237   \dosubindwrite
3238   %
3239   \ifdim\skip0 = 0pt
3240     % if \lastskip was zero, perhaps the last item was a
3241     % penalty, and perhaps it was >=10000, e.g., a \nobreak.
3242     % In that case, we want to re-insert the penalty; since we
3243     % just inserted a non-discardable item, any following glue
3244     % (such as a \parskip) would be a breakpoint.  For example:
3245     %   @deffn deffn-whatever
3246     %   @vindex index-whatever
3247     %   Description.
3248     % would allow a break between the index-whatever whatsit
3249     % and the "Description." paragraph.
3250     \ifnum\count255>9999 \nobreak \fi
3251   \else
3252     % On the other hand, if we had a nonzero \lastskip,
3253     % this make-up glue would be preceded by a non-discardable item
3254     % (the whatsit from the \write), so we must insert a \nobreak.
3255     \nobreak\vskip\skip0
3256   \fi
3257 }
3258
3259 % The index entry written in the file actually looks like
3260 %  \entry {sortstring}{page}{topic}
3261 % or
3262 %  \entry {sortstring}{page}{topic}{subtopic}
3263 % The texindex program reads in these files and writes files
3264 % containing these kinds of lines:
3265 %  \initial {c}
3266 %     before the first topic whose initial is c
3267 %  \entry {topic}{pagelist}
3268 %     for a topic that is used without subtopics
3269 %  \primary {topic}
3270 %     for the beginning of a topic that is used with subtopics
3271 %  \secondary {subtopic}{pagelist}
3272 %     for each subtopic.
3273
3274 % Define the user-accessible indexing commands
3275 % @findex, @vindex, @kindex, @cindex.
3276
3277 \def\findex {\fnindex}
3278 \def\kindex {\kyindex}
3279 \def\cindex {\cpindex}
3280 \def\vindex {\vrindex}
3281 \def\tindex {\tpindex}
3282 \def\pindex {\pgindex}
3283
3284 \def\cindexsub {\begingroup\obeylines\cindexsub}
3285 {\obeylines %
3286 \gdef\cindexsub "#1" #2^^M{\endgroup %
3287 \dosubind{cp}{#2}{#1}}}
3288
3289 % Define the macros used in formatting output of the sorted index material.
3290
3291 % @printindex causes a particular index (the ??s file) to get printed.
3292 % It does not print any chapter heading (usually an @unnumbered).
3293 %
3294 \def\printindex{\parsearg\doprintindex}
3295 \def\doprintindex#1{\begingroup
3296   \dobreak \chapheadingskip{10000}%
3297   %
3298   \smallfonts \rm
3299   \tolerance = 9500
3300   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3301   \indexbreaks
3302   %
3303   % See if the index file exists and is nonempty.
3304   % Change catcode of @ here so that if the index file contains
3305   % \initial {@}
3306   % as its first line, TeX doesn't complain about mismatched braces
3307   % (because it thinks @} is a control sequence).
3308   \catcode`\@ = 11
3309   \openin 1 \jobname.#1s
3310   \ifeof 1
3311     % \enddoublecolumns gets confused if there is no text in the index,
3312     % and it loses the chapter title and the aux file entries for the
3313     % index.  The easiest way to prevent this problem is to make sure
3314     % there is some text.
3315     \putwordIndexNonexistent
3316   \else
3317     %
3318     % If the index file exists but is empty, then \openin leaves \ifeof
3319     % false.  We have to make TeX try to read something from the file, so
3320     % it can discover if there is anything in it.
3321     \read 1 to \temp
3322     \ifeof 1
3323       \putwordIndexIsEmpty
3324     \else
3325       % Index files are almost Texinfo source, but we use \ as the escape
3326       % character.  It would be better to use @, but that's too big a change
3327       % to make right now.
3328       \def\indexbackslash{\rawbackslashxx}%
3329       \catcode`\\ = 0
3330       \escapechar = `\\
3331       \begindoublecolumns
3332       \input \jobname.#1s
3333       \enddoublecolumns
3334     \fi
3335   \fi
3336   \closein 1
3337 \endgroup}
3338
3339 % These macros are used by the sorted index file itself.
3340 % Change them to control the appearance of the index.
3341
3342 \def\initial#1{{%
3343   % Some minor font changes for the special characters.
3344   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3345   %
3346   % Remove any glue we may have, we'll be inserting our own.
3347   \removelastskip
3348   %
3349   % We like breaks before the index initials, so insert a bonus.
3350   \penalty -300
3351   %
3352   % Typeset the initial.  Making this add up to a whole number of
3353   % baselineskips increases the chance of the dots lining up from column
3354   % to column.  It still won't often be perfect, because of the stretch
3355   % we need before each entry, but it's better.
3356   %
3357   % No shrink because it confuses \balancecolumns.
3358   \vskip 1.67\baselineskip plus .5\baselineskip
3359   \leftline{\secbf #1}%
3360   \vskip .33\baselineskip plus .1\baselineskip
3361   %
3362   % Do our best not to break after the initial.
3363   \nobreak
3364 }}
3365
3366 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3367 % flush to the right margin.  It is used for index and table of contents
3368 % entries.  The paragraph is indented by \leftskip.
3369 %
3370 \def\entry#1#2{\begingroup
3371   %
3372   % Start a new paragraph if necessary, so our assignments below can't
3373   % affect previous text.
3374   \par
3375   %
3376   % Do not fill out the last line with white space.
3377   \parfillskip = 0in
3378   %
3379   % No extra space above this paragraph.
3380   \parskip = 0in
3381   %
3382   % Do not prefer a separate line ending with a hyphen to fewer lines.
3383   \finalhyphendemerits = 0
3384   %
3385   % \hangindent is only relevant when the entry text and page number
3386   % don't both fit on one line.  In that case, bob suggests starting the
3387   % dots pretty far over on the line.  Unfortunately, a large
3388   % indentation looks wrong when the entry text itself is broken across
3389   % lines.  So we use a small indentation and put up with long leaders.
3390   %
3391   % \hangafter is reset to 1 (which is the value we want) at the start
3392   % of each paragraph, so we need not do anything with that.
3393   \hangindent = 2em
3394   %
3395   % When the entry text needs to be broken, just fill out the first line
3396   % with blank space.
3397   \rightskip = 0pt plus1fil
3398   %
3399   % A bit of stretch before each entry for the benefit of balancing columns.
3400   \vskip 0pt plus1pt
3401   %
3402   % Start a ``paragraph'' for the index entry so the line breaking
3403   % parameters we've set above will have an effect.
3404   \noindent
3405   %
3406   % Insert the text of the index entry.  TeX will do line-breaking on it.
3407   #1%
3408   % The following is kludged to not output a line of dots in the index if
3409   % there are no page numbers.  The next person who breaks this will be
3410   % cursed by a Unix daemon.
3411   \def\tempa{{\rm }}%
3412   \def\tempb{#2}%
3413   \edef\tempc{\tempa}%
3414   \edef\tempd{\tempb}%
3415   \ifx\tempc\tempd\ \else%
3416     %
3417     % If we must, put the page number on a line of its own, and fill out
3418     % this line with blank space.  (The \hfil is overwhelmed with the
3419     % fill leaders glue in \indexdotfill if the page number does fit.)
3420     \hfil\penalty50
3421     \null\nobreak\indexdotfill % Have leaders before the page number.
3422     %
3423     % The `\ ' here is removed by the implicit \unskip that TeX does as
3424     % part of (the primitive) \par.  Without it, a spurious underfull
3425     % \hbox ensues.
3426     \ifpdf
3427       \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3428     \else
3429       \ #2% The page number ends the paragraph.
3430     \fi
3431   \fi%
3432   \par
3433 \endgroup}
3434
3435 % Like \dotfill except takes at least 1 em.
3436 \def\indexdotfill{\cleaders
3437   \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3438
3439 \def\primary #1{\line{#1\hfil}}
3440
3441 \newskip\secondaryindent \secondaryindent=0.5cm
3442 \def\secondary#1#2{{%
3443   \parfillskip=0in
3444   \parskip=0in
3445   \hangindent=1in
3446   \hangafter=1
3447   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3448   \ifpdf
3449     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3450   \else
3451     #2
3452   \fi
3453   \par
3454 }}
3455
3456 % Define two-column mode, which we use to typeset indexes.
3457 % Adapted from the TeXbook, page 416, which is to say,
3458 % the manmac.tex format used to print the TeXbook itself.
3459 \catcode`\@=11
3460
3461 \newbox\partialpage
3462 \newdimen\doublecolumnhsize
3463
3464 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3465   % Grab any single-column material above us.
3466   \output = {%
3467     %
3468     % Here is a possibility not foreseen in manmac: if we accumulate a
3469     % whole lot of material, we might end up calling this \output
3470     % routine twice in a row (see the doublecol-lose test, which is
3471     % essentially a couple of indexes with @setchapternewpage off).  In
3472     % that case we just ship out what is in \partialpage with the normal
3473     % output routine.  Generally, \partialpage will be empty when this
3474     % runs and this will be a no-op.  See the indexspread.tex test case.
3475     \ifvoid\partialpage \else
3476       \onepageout{\pagecontents\partialpage}%
3477     \fi
3478     %
3479     \global\setbox\partialpage = \vbox{%
3480       % Unvbox the main output page.
3481       \unvbox\PAGE
3482       \kern-\topskip \kern\baselineskip
3483     }%
3484   }%
3485   \eject % run that output routine to set \partialpage
3486   %
3487   % Use the double-column output routine for subsequent pages.
3488   \output = {\doublecolumnout}%
3489   %
3490   % Change the page size parameters.  We could do this once outside this
3491   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3492   % format, but then we repeat the same computation.  Repeating a couple
3493   % of assignments once per index is clearly meaningless for the
3494   % execution time, so we may as well do it in one place.
3495   %
3496   % First we halve the line length, less a little for the gutter between
3497   % the columns.  We compute the gutter based on the line length, so it
3498   % changes automatically with the paper format.  The magic constant
3499   % below is chosen so that the gutter has the same value (well, +-<1pt)
3500   % as it did when we hard-coded it.
3501   %
3502   % We put the result in a separate register, \doublecolumhsize, so we
3503   % can restore it in \pagesofar, after \hsize itself has (potentially)
3504   % been clobbered.
3505   %
3506   \doublecolumnhsize = \hsize
3507     \advance\doublecolumnhsize by -.04154\hsize
3508     \divide\doublecolumnhsize by 2
3509   \hsize = \doublecolumnhsize
3510   %
3511   % Double the \vsize as well.  (We don't need a separate register here,
3512   % since nobody clobbers \vsize.)
3513   \vsize = 2\vsize
3514 }
3515
3516 % The double-column output routine for all double-column pages except
3517 % the last.
3518 %
3519 \def\doublecolumnout{%
3520   \splittopskip=\topskip \splitmaxdepth=\maxdepth
3521   % Get the available space for the double columns -- the normal
3522   % (undoubled) page height minus any material left over from the
3523   % previous page.
3524   \dimen@ = \vsize
3525   \divide\dimen@ by 2
3526   \advance\dimen@ by -\ht\partialpage
3527   %
3528   % box0 will be the left-hand column, box2 the right.
3529   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3530   \onepageout\pagesofar
3531   \unvbox255
3532   \penalty\outputpenalty
3533 }
3534 %
3535 % Re-output the contents of the output page -- any previous material,
3536 % followed by the two boxes we just split, in box0 and box2.
3537 \def\pagesofar{%
3538   \unvbox\partialpage
3539   %
3540   \hsize = \doublecolumnhsize
3541   \wd0=\hsize \wd2=\hsize
3542   \hbox to\pagewidth{\box0\hfil\box2}%
3543 }
3544 %
3545 % All done with double columns.
3546 \def\enddoublecolumns{%
3547   \output = {%
3548     % Split the last of the double-column material.  Leave it on the
3549     % current page, no automatic page break.
3550     \balancecolumns
3551     %
3552     % If we end up splitting too much material for the current page,
3553     % though, there will be another page break right after this \output
3554     % invocation ends.  Having called \balancecolumns once, we do not
3555     % want to call it again.  Therefore, reset \output to its normal
3556     % definition right away.  (We hope \balancecolumns will never be
3557     % called on to balance too much material, but if it is, this makes
3558     % the output somewhat more palatable.)
3559     \global\output = {\onepageout{\pagecontents\PAGE}}%
3560   }%
3561   \eject
3562   \endgroup % started in \begindoublecolumns
3563   %
3564   % \pagegoal was set to the doubled \vsize above, since we restarted
3565   % the current page.  We're now back to normal single-column
3566   % typesetting, so reset \pagegoal to the normal \vsize (after the
3567   % \endgroup where \vsize got restored).
3568   \pagegoal = \vsize
3569 }
3570 %
3571 % Called at the end of the double column material.
3572 \def\balancecolumns{%
3573   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3574   \dimen@ = \ht0
3575   \advance\dimen@ by \topskip
3576   \advance\dimen@ by-\baselineskip
3577   \divide\dimen@ by 2 % target to split to
3578   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3579   \splittopskip = \topskip
3580   % Loop until we get a decent breakpoint.
3581   {%
3582     \vbadness = 10000
3583     \loop
3584       \global\setbox3 = \copy0
3585       \global\setbox1 = \vsplit3 to \dimen@
3586     \ifdim\ht3>\dimen@
3587       \global\advance\dimen@ by 1pt
3588     \repeat
3589   }%
3590   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3591   \setbox0=\vbox to\dimen@{\unvbox1}%
3592   \setbox2=\vbox to\dimen@{\unvbox3}%
3593   %
3594   \pagesofar
3595 }
3596 \catcode`\@ = \other
3597
3598
3599 \message{sectioning,}
3600 % Chapters, sections, etc.
3601
3602 % \unnumberedno is an oxymoron, of course.  But we count the unnumbered
3603 % sections so that we can refer to them unambiguously in the pdf
3604 % outlines by their "section number".  We avoid collisions with chapter
3605 % numbers by starting them at 10000.  (If a document ever has 10000
3606 % chapters, we're in trouble anyway, I'm sure.)
3607 \newcount\unnumberedno \unnumberedno = 10000
3608 \newcount\chapno
3609 \newcount\secno        \secno=0
3610 \newcount\subsecno     \subsecno=0
3611 \newcount\subsubsecno  \subsubsecno=0
3612
3613 % This counter is funny since it counts through charcodes of letters A, B, ...
3614 \newcount\appendixno  \appendixno = `\@
3615 %
3616 % \def\appendixletter{\char\the\appendixno}
3617 % We do the following ugly conditional instead of the above simple
3618 % construct for the sake of pdftex, which needs the actual
3619 % letter in the expansion, not just typeset.
3620
3621 \def\appendixletter{%
3622   \ifnum\appendixno=`A A%
3623   \else\ifnum\appendixno=`B B%
3624   \else\ifnum\appendixno=`C C%
3625   \else\ifnum\appendixno=`D D%
3626   \else\ifnum\appendixno=`E E%
3627   \else\ifnum\appendixno=`F F%
3628   \else\ifnum\appendixno=`G G%
3629   \else\ifnum\appendixno=`H H%
3630   \else\ifnum\appendixno=`I I%
3631   \else\ifnum\appendixno=`J J%
3632   \else\ifnum\appendixno=`K K%
3633   \else\ifnum\appendixno=`L L%
3634   \else\ifnum\appendixno=`M M%
3635   \else\ifnum\appendixno=`N N%
3636   \else\ifnum\appendixno=`O O%
3637   \else\ifnum\appendixno=`P P%
3638   \else\ifnum\appendixno=`Q Q%
3639   \else\ifnum\appendixno=`R R%
3640   \else\ifnum\appendixno=`S S%
3641   \else\ifnum\appendixno=`T T%
3642   \else\ifnum\appendixno=`U U%
3643   \else\ifnum\appendixno=`V V%
3644   \else\ifnum\appendixno=`W W%
3645   \else\ifnum\appendixno=`X X%
3646   \else\ifnum\appendixno=`Y Y%
3647   \else\ifnum\appendixno=`Z Z%
3648   % The \the is necessary, despite appearances, because \appendixletter is
3649   % expanded while writing the .toc file.  \char\appendixno is not
3650   % expandable, thus it is written literally, thus all appendixes come out
3651   % with the same letter (or @) in the toc without it.
3652   \else\char\the\appendixno
3653   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3654   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3655
3656 % Each @chapter defines this as the name of the chapter.
3657 % page headings and footings can use it.  @section does likewise.
3658 % However, they are not reliable, because we don't use marks.
3659 \def\thischapter{}
3660 \def\thissection{}
3661
3662 \newcount\absseclevel % used to calculate proper heading level
3663 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3664
3665 % @raisesections: treat @section as chapter, @subsection as section, etc.
3666 \def\raisesections{\global\advance\secbase by -1}
3667 \let\up=\raisesections % original BFox name
3668
3669 % @lowersections: treat @chapter as section, @section as subsection, etc.
3670 \def\lowersections{\global\advance\secbase by 1}
3671 \let\down=\lowersections % original BFox name
3672
3673 % Choose a numbered-heading macro
3674 % #1 is heading level if unmodified by @raisesections or @lowersections
3675 % #2 is text for heading
3676 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3677 \ifcase\absseclevel
3678       \chapterzzz{#2}%
3679   \or \seczzz{#2}%
3680   \or \numberedsubseczzz{#2}%
3681   \or \numberedsubsubseczzz{#2}%
3682   \else
3683     \ifnum \absseclevel<0 \chapterzzz{#2}%
3684     \else \numberedsubsubseczzz{#2}%
3685     \fi
3686   \fi
3687   \suppressfirstparagraphindent
3688 }
3689
3690 % like \numhead, but chooses appendix heading levels
3691 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3692 \ifcase\absseclevel
3693       \appendixzzz{#2}%
3694   \or \appendixsectionzzz{#2}%
3695   \or \appendixsubseczzz{#2}%
3696   \or \appendixsubsubseczzz{#2}%
3697   \else
3698     \ifnum \absseclevel<0 \appendixzzz{#2}%
3699     \else \appendixsubsubseczzz{#2}%
3700     \fi
3701   \fi
3702   \suppressfirstparagraphindent
3703 }
3704
3705 % like \numhead, but chooses numberless heading levels
3706 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3707   \ifcase\absseclevel
3708       \unnumberedzzz{#2}%
3709   \or \unnumberedseczzz{#2}%
3710   \or \unnumberedsubseczzz{#2}%
3711   \or \unnumberedsubsubseczzz{#2}%
3712   \else
3713     \ifnum \absseclevel<0 \unnumberedzzz{#2}%
3714     \else \unnumberedsubsubseczzz{#2}%
3715     \fi
3716   \fi
3717   \suppressfirstparagraphindent
3718 }
3719
3720 % @chapter, @appendix, @unnumbered.
3721 %
3722 \outer\def\chapter{\parsearg\chapteryyy}
3723 \def\chapteryyy#1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3724 \def\chapterzzz#1{%
3725   % section resetting is \global in case the chapter is in a group, such
3726   % as an @include file.
3727   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3728     \global\advance\chapno by 1
3729   \message{\putwordChapter\space \the\chapno}%
3730   %
3731   % Write the actual heading.
3732   \chapmacro{#1}{Ynumbered}{\the\chapno}%
3733   %
3734   % So @section and the like are numbered underneath this chapter.
3735   \global\let\section = \numberedsec
3736   \global\let\subsection = \numberedsubsec
3737   \global\let\subsubsection = \numberedsubsubsec
3738 }
3739
3740 \outer\def\appendix{\parsearg\appendixyyy}
3741 \def\appendixyyy#1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3742 \def\appendixzzz#1{%
3743   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3744     \global\advance\appendixno by 1
3745   \def\appendixnum{\putwordAppendix\space \appendixletter}%
3746   \message{\appendixnum}%
3747   \chapmacro{#1}{Yappendix}{\appendixletter}%
3748   \global\let\section = \appendixsec
3749   \global\let\subsection = \appendixsubsec
3750   \global\let\subsubsection = \appendixsubsubsec
3751 }
3752
3753 % @centerchap is like @unnumbered, but the heading is centered.
3754 \outer\def\centerchap{\parsearg\centerchapyyy}
3755 \def\centerchapyyy#1{{\unnumberedyyy{#1}}}
3756
3757 % @top is like @unnumbered.
3758 \outer\def\top{\parsearg\unnumberedyyy}
3759
3760 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3761 \def\unnumberedyyy#1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3762 \def\unnumberedzzz#1{%
3763   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3764     \global\advance\unnumberedno by 1
3765   %
3766   % This used to be simply \message{#1}, but TeX fully expands the
3767   % argument to \message.  Therefore, if #1 contained @-commands, TeX
3768   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
3769   % expanded @cite (which turns out to cause errors because \cite is meant
3770   % to be executed, not expanded).
3771   %
3772   % Anyway, we don't want the fully-expanded definition of @cite to appear
3773   % as a result of the \message, we just want `@cite' itself.  We use
3774   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3775   % simply yielding the contents of <toks register>.  (We also do this for
3776   % the toc entries.)
3777   \toks0 = {#1}\message{(\the\toks0)}%
3778   %
3779   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
3780   %
3781   \global\let\section = \unnumberedsec
3782   \global\let\subsection = \unnumberedsubsec
3783   \global\let\subsubsection = \unnumberedsubsubsec
3784 }
3785
3786 % Sections.
3787 \outer\def\numberedsec{\parsearg\secyyy}
3788 \def\secyyy#1{\numhead1{#1}} % normally calls seczzz
3789 \def\seczzz#1{%
3790   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3791   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
3792 }
3793
3794 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3795 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3796 \def\appendixsecyyy#1{\apphead1{#1}} % normally calls appendixsectionzzz
3797 \def\appendixsectionzzz#1{%
3798   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3799   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
3800 }
3801
3802 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3803 \def\unnumberedsecyyy#1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3804 \def\unnumberedseczzz#1{%
3805   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3806   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
3807 }
3808
3809 % Subsections.
3810 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3811 \def\numberedsubsecyyy#1{\numhead2{#1}} % normally calls numberedsubseczzz
3812 \def\numberedsubseczzz#1{%
3813   \global\subsubsecno=0  \global\advance\subsecno by 1
3814   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
3815 }
3816
3817 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3818 \def\appendixsubsecyyy#1{\apphead2{#1}} % normally calls appendixsubseczzz
3819 \def\appendixsubseczzz#1{%
3820   \global\subsubsecno=0  \global\advance\subsecno by 1
3821   \sectionheading{#1}{subsec}{Yappendix}%
3822                  {\appendixletter.\the\secno.\the\subsecno}%
3823 }
3824
3825 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3826 \def\unnumberedsubsecyyy#1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3827 \def\unnumberedsubseczzz#1{%
3828   \global\subsubsecno=0  \global\advance\subsecno by 1
3829   \sectionheading{#1}{subsec}{Ynothing}%
3830                  {\the\unnumberedno.\the\secno.\the\subsecno}%
3831 }
3832
3833 % Subsubsections.
3834 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3835 \def\numberedsubsubsecyyy#1{\numhead3{#1}} % normally numberedsubsubseczzz
3836 \def\numberedsubsubseczzz#1{%
3837   \global\advance\subsubsecno by 1
3838   \sectionheading{#1}{subsubsec}{Ynumbered}%
3839                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
3840 }
3841
3842 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3843 \def\appendixsubsubsecyyy#1{\apphead3{#1}} % normally appendixsubsubseczzz
3844 \def\appendixsubsubseczzz#1{%
3845   \global\advance\subsubsecno by 1
3846   \sectionheading{#1}{subsubsec}{Yappendix}%
3847                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
3848 }
3849
3850 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3851 \def\unnumberedsubsubsecyyy#1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3852 \def\unnumberedsubsubseczzz#1{%
3853   \global\advance\subsubsecno by 1
3854   \sectionheading{#1}{subsubsec}{Ynothing}%
3855                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
3856 }
3857
3858 % These are variants which are not "outer", so they can appear in @ifinfo.
3859 % Actually, they are now be obsolete; ordinary section commands should work.
3860 \def\infotop{\parsearg\unnumberedzzz}
3861 \def\infounnumbered{\parsearg\unnumberedzzz}
3862 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3863 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3864 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3865
3866 \def\infoappendix{\parsearg\appendixzzz}
3867 \def\infoappendixsec{\parsearg\appendixseczzz}
3868 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3869 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3870
3871 \def\infochapter{\parsearg\chapterzzz}
3872 \def\infosection{\parsearg\sectionzzz}
3873 \def\infosubsection{\parsearg\subsectionzzz}
3874 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3875
3876 % These macros control what the section commands do, according
3877 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3878 % Define them by default for a numbered chapter.
3879 \let\section = \numberedsec
3880 \let\subsection = \numberedsubsec
3881 \let\subsubsection = \numberedsubsubsec
3882
3883 % Define @majorheading, @heading and @subheading
3884
3885 % NOTE on use of \vbox for chapter headings, section headings, and such:
3886 %       1) We use \vbox rather than the earlier \line to permit
3887 %          overlong headings to fold.
3888 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
3889 %          heading is obnoxious; this forbids it.
3890 %       3) Likewise, headings look best if no \parindent is used, and
3891 %          if justification is not attempted.  Hence \raggedright.
3892
3893
3894 \def\majorheading{%
3895   {\advance\chapheadingskip by 10pt \chapbreak }%
3896   \parsearg\chapheadingzzz
3897 }
3898
3899 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
3900 \def\chapheadingzzz#1{%
3901   {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3902                     \parindent=0pt\raggedright
3903                     \rm #1\hfill}}%
3904   \bigskip \par\penalty 200\relax
3905   \suppressfirstparagraphindent
3906 }
3907
3908 % @heading, @subheading, @subsubheading.
3909 \def\heading{\parsearg\doheading}
3910 \def\subheading{\parsearg\dosubheading}
3911 \def\subsubheading{\parsearg\dosubsubheading}
3912 \def\doheading#1{\sectionheading{#1}{sec}{Yomitfromtoc}{}
3913   \suppressfirstparagraphindent}
3914 \def\dosubheading#1{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
3915   \suppressfirstparagraphindent}
3916 \def\dosubsubheading#1{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
3917   \suppressfirstparagraphindent}
3918
3919 % These macros generate a chapter, section, etc. heading only
3920 % (including whitespace, linebreaking, etc. around it),
3921 % given all the information in convenient, parsed form.
3922
3923 %%% Args are the skip and penalty (usually negative)
3924 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3925
3926 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3927
3928 %%% Define plain chapter starts, and page on/off switching for it
3929 % Parameter controlling skip before chapter headings (if needed)
3930
3931 \newskip\chapheadingskip
3932
3933 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3934 \def\chappager{\par\vfill\supereject}
3935 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3936
3937 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3938
3939 \def\CHAPPAGoff{%
3940 \global\let\contentsalignmacro = \chappager
3941 \global\let\pchapsepmacro=\chapbreak
3942 \global\let\pagealignmacro=\chappager}
3943
3944 \def\CHAPPAGon{%
3945 \global\let\contentsalignmacro = \chappager
3946 \global\let\pchapsepmacro=\chappager
3947 \global\let\pagealignmacro=\chappager
3948 \global\def\HEADINGSon{\HEADINGSsingle}}
3949
3950 \def\CHAPPAGodd{%
3951 \global\let\contentsalignmacro = \chapoddpage
3952 \global\let\pchapsepmacro=\chapoddpage
3953 \global\let\pagealignmacro=\chapoddpage
3954 \global\def\HEADINGSon{\HEADINGSdouble}}
3955
3956 \CHAPPAGon
3957
3958 \def\CHAPFplain{%
3959 \global\let\chapmacro=\chfplain
3960 \global\let\centerchapmacro=\centerchfplain}
3961
3962 % Normal chapter opening.
3963
3964 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
3965 % Yappendix, Yomitfromtoc), #3 the chapter number.
3966
3967 % To test against our argument.
3968 \def\Ynothingkeyword{Ynothing}
3969 \def\Yomitfromtockeyword{Yomitfromtoc}
3970 \def\Yappendixkeyword{Yappendix}
3971 %
3972 \def\chfplain#1#2#3{%
3973   \pchapsepmacro
3974   {%
3975     \chapfonts \rm
3976     %
3977     % Have to define \thissection before calling \donoderef, because the
3978     % xref code eventually uses it.  On the other hand, it has to be called
3979     % after \pchapsepmacro, or the headline will change too soon.
3980     \gdef\thissection{#1}%
3981     \gdef\thischaptername{#1}%
3982     %
3983     % Only insert the separating space if we have a chapter/appendix
3984     % number, and don't print the unnumbered ``number''.
3985     \def\temptype{#2}%
3986     \ifx\temptype\Ynothingkeyword
3987       \setbox0 = \hbox{}%
3988       \def\toctype{unnchap}%
3989       \def\thischapter{#1}%
3990     \else\ifx\temptype\Yomitfromtockeyword
3991       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
3992       \def\toctype{omit}%
3993       \xdef\thischapter{}%
3994     \else\ifx\temptype\Yappendixkeyword
3995       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
3996       \def\toctype{app}%
3997       % We don't substitute the actual chapter name into \thischapter
3998       % because we don't want its macros evaluated now.  And we don't
3999       % use \thissection because that changes with each section.
4000       %
4001       \xdef\thischapter{\putwordAppendix{} \appendixletter:
4002                         \noexpand\thischaptername}%
4003     \else
4004       \setbox0 = \hbox{#3\enspace}%
4005       \def\toctype{numchap}%
4006       \xdef\thischapter{\putwordChapter{} \the\chapno:
4007                         \noexpand\thischaptername}%
4008     \fi\fi\fi
4009     %
4010     % Write the toc entry for this chapter.  Must come before the
4011     % \donoderef, because we include the current node name in the toc
4012     % entry, and \donoderef resets it to empty.
4013     \writetocentry{\toctype}{#1}{#3}%
4014     %
4015     % For pdftex, we have to write out the node definition (aka, make
4016     % the pdfdest) after any page break, but before the actual text has
4017     % been typeset.  If the destination for the pdf outline is after the
4018     % text, then jumping from the outline may wind up with the text not
4019     % being visible, for instance under high magnification.
4020     \donoderef{#2}%
4021     %
4022     % Typeset the actual heading.
4023     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4024           \hangindent=\wd0 \centerparametersmaybe
4025           \unhbox0 #1\par}%
4026   }%
4027   \nobreak\bigskip % no page break after a chapter title
4028   \nobreak
4029 }
4030
4031 % @centerchap -- centered and unnumbered.
4032 \let\centerparametersmaybe = \relax
4033 \def\centerchfplain#1{{%
4034   \def\centerparametersmaybe{%
4035     \advance\rightskip by 3\rightskip
4036     \leftskip = \rightskip
4037     \parfillskip = 0pt
4038   }%
4039   \chfplain{#1}{Ynothing}{}%
4040 }}
4041
4042 \CHAPFplain % The default
4043
4044 % I don't think this chapter style is supported any more, so I'm not
4045 % updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
4046
4047 \def\unnchfopen #1{%
4048 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4049                        \parindent=0pt\raggedright
4050                        \rm #1\hfill}}\bigskip \par\nobreak
4051 }
4052
4053 \def\chfopen #1#2{\chapoddpage {\chapfonts
4054 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4055 \par\penalty 5000 %
4056 }
4057
4058 \def\centerchfopen #1{%
4059 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4060                        \parindent=0pt
4061                        \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4062 }
4063
4064 \def\CHAPFopen{%
4065 \global\let\chapmacro=\chfopen
4066 \global\let\centerchapmacro=\centerchfopen}
4067
4068
4069 % Section titles.  These macros combine the section number parts and
4070 % call the generic \sectionheading to do the printing.
4071
4072 \newskip\secheadingskip
4073 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4074
4075 % Subsection titles.
4076 \newskip\subsecheadingskip
4077 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4078
4079 % Subsubsection titles.
4080 \def\subsubsecheadingskip{\subsecheadingskip}
4081 \def\subsubsecheadingbreak{\subsecheadingbreak}
4082
4083
4084 % Print any size, any type, section title.
4085
4086 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4087 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4088 % section number.
4089
4090 \def\sectionheading#1#2#3#4{%
4091   {%
4092     % Switch to the right set of fonts.
4093     \csname #2fonts\endcsname \rm
4094     %
4095     % Insert space above the heading.
4096     \csname #2headingbreak\endcsname
4097     %
4098     % Only insert the space after the number if we have a section number.
4099     \def\sectionlevel{#2}%
4100     \def\temptype{#3}%
4101     %
4102     \ifx\temptype\Ynothingkeyword
4103       \setbox0 = \hbox{}%
4104       \def\toctype{unn}%
4105       \gdef\thissection{#1}%
4106     \else\ifx\temptype\Yomitfromtockeyword
4107       % for @headings -- no section number, don't include in toc,
4108       % and don't redefine \thissection.
4109       \setbox0 = \hbox{}%
4110       \def\toctype{omit}%
4111       \let\sectionlevel=\empty
4112     \else\ifx\temptype\Yappendixkeyword
4113       \setbox0 = \hbox{#4\enspace}%
4114       \def\toctype{app}%
4115       \gdef\thissection{#1}%
4116     \else
4117       \setbox0 = \hbox{#4\enspace}%
4118       \def\toctype{num}%
4119       \gdef\thissection{#1}%
4120     \fi\fi\fi
4121     %
4122     % Write the toc entry (before \donoderef).  See comments in \chfplain.
4123     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4124     %
4125     % Write the node reference (= pdf destination for pdftex).
4126     % Again, see comments in \chfplain.
4127     \donoderef{#3}%
4128     %
4129     % Output the actual section heading.
4130     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4131           \hangindent=\wd0  % zero if no section number
4132           \unhbox0 #1}%
4133   }%
4134   % Add extra space after the heading -- half of whatever came above it.
4135   % Don't allow stretch, though.
4136   \kern .5 \csname #2headingskip\endcsname
4137   %
4138   % Do not let the kern be a potential breakpoint, as it would be if it
4139   % was followed by glue.
4140   \nobreak
4141   %
4142   % We'll almost certainly start a paragraph next, so don't let that
4143   % glue accumulate.  (Not a breakpoint because it's preceded by a
4144   % discardable item.)
4145   \vskip-\parskip
4146   %
4147   % This \nobreak is purely so the last item on the list is a \penalty
4148   % of 10000.  This is so other code, for instance \parsebodycommon, can
4149   % check for and avoid allowing breakpoints.  Otherwise, it would
4150   % insert a valid breakpoint between:
4151   %   @section sec-whatever
4152   %   @deffn def-whatever
4153   \nobreak
4154 }
4155
4156
4157 \message{toc,}
4158 % Table of contents.
4159 \newwrite\tocfile
4160
4161 % Write an entry to the toc file, opening it if necessary.
4162 % Called from @chapter, etc.  
4163
4164 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4165 % We append the current node name (if any) and page number as additional
4166 % arguments for the \{chap,sec,...}entry macros which will eventually
4167 % read this.  The node name is used in the pdf outlines as the
4168 % destination to jump to.
4169
4170 % We open the .toc file for writing here instead of at @setfilename (or
4171 % any other fixed time) so that @contents can be anywhere in the document.
4172 % But if #1 is `omit', then we don't do anything.  This is used for the
4173 % table of contents chapter openings themselves.
4174 %
4175 \newif\iftocfileopened
4176 \def\omitkeyword{omit}%
4177 %
4178 \def\writetocentry#1#2#3{%
4179   \edef\writetoctype{#1}%
4180   \ifx\writetoctype\omitkeyword \else
4181     \iftocfileopened\else
4182       \immediate\openout\tocfile = \jobname.toc
4183       \global\tocfileopenedtrue
4184     \fi
4185     %
4186     \iflinks
4187       \toks0 = {#2}%
4188       \toks2 = \expandafter{\lastnode}%
4189       \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4190                                {\the\toks2}{\noexpand\folio}}}%
4191       \temp
4192     \fi
4193   \fi
4194   %
4195   % Tell \shipout to create a pdf destination on each page, if we're
4196   % writing pdf.  These are used in the table of contents.  We can't
4197   % just write one on every page because the title pages are numbered
4198   % 1 and 2 (the page numbers aren't printed), and so are the first
4199   % two pages of the document.  Thus, we'd have two destinations named
4200   % `1', and two named `2'.
4201   \ifpdf \global\pdfmakepagedesttrue \fi
4202 }
4203
4204 \newskip\contentsrightmargin \contentsrightmargin=1in
4205 \newcount\savepageno
4206 \newcount\lastnegativepageno \lastnegativepageno = -1
4207
4208 % Prepare to read what we've written to \tocfile.
4209 %
4210 \def\startcontents#1{%
4211    % If @setchapternewpage on, and @headings double, the contents should
4212    % start on an odd page, unlike chapters.  Thus, we maintain
4213    % \contentsalignmacro in parallel with \pagealignmacro.
4214    % From: Torbjorn Granlund <tege@matematik.su.se>
4215    \contentsalignmacro
4216    \immediate\closeout\tocfile
4217    %
4218    % Don't need to put `Contents' or `Short Contents' in the headline.
4219    % It is abundantly clear what they are.
4220    \def\thischapter{}%
4221    \chapmacro{#1}{Yomitfromtoc}{}%
4222    %
4223    \savepageno = \pageno
4224    \begingroup                  % Set up to handle contents files properly.
4225       \catcode`\\=0  \catcode`\{=1  \catcode`\}=2  \catcode`\@=11
4226       % We can't do this, because then an actual ^ in a section
4227       % title fails, e.g., @chapter ^ -- exponentiation.  --karl, 9jul97.
4228       %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4229       \raggedbottom             % Worry more about breakpoints than the bottom.
4230       \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4231       %
4232       % Roman numerals for page numbers.
4233       \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4234 }
4235
4236
4237 % Normal (long) toc.
4238 \def\contents{%
4239    \startcontents{\putwordTOC}%
4240      \openin 1 \jobname.toc
4241      \ifeof 1 \else
4242        \closein 1
4243        \input \jobname.toc
4244      \fi
4245      \vfill \eject
4246      \contentsalignmacro % in case @setchapternewpage odd is in effect
4247      \pdfmakeoutlines
4248    \endgroup
4249    \lastnegativepageno = \pageno
4250    \global\pageno = \savepageno
4251 }
4252
4253 % And just the chapters.
4254 \def\summarycontents{%
4255    \startcontents{\putwordShortTOC}%
4256       %
4257       \let\numchapentry = \shortchapentry
4258       \let\appentry = \shortchapentry
4259       \let\unnchapentry = \shortunnchapentry
4260       % We want a true roman here for the page numbers.
4261       \secfonts
4262       \let\rm=\shortcontrm \let\bf=\shortcontbf
4263       \let\sl=\shortcontsl \let\tt=\shortconttt
4264       \rm
4265       \hyphenpenalty = 10000
4266       \advance\baselineskip by 1pt % Open it up a little.
4267       \def\numsecentry##1##2##3##4{}
4268       \let\appsecentry = \numsecentry
4269       \let\unnsecentry = \numsecentry
4270       \let\numsubsecentry = \numsecentry
4271       \let\appsubsecentry = \numsecentry
4272       \let\unnsubsecentry = \numsecentry
4273       \let\numsubsubsecentry = \numsecentry
4274       \let\appsubsubsecentry = \numsecentry
4275       \let\unnsubsubsecentry = \numsecentry
4276       \openin 1 \jobname.toc
4277       \ifeof 1 \else
4278         \closein 1
4279         \input \jobname.toc
4280       \fi
4281      \vfill \eject
4282      \contentsalignmacro % in case @setchapternewpage odd is in effect
4283    \endgroup
4284    \lastnegativepageno = \pageno
4285    \global\pageno = \savepageno
4286 }
4287 \let\shortcontents = \summarycontents
4288
4289 % Typeset the label for a chapter or appendix for the short contents.
4290 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4291 %
4292 \def\shortchaplabel#1{%
4293   % This space should be enough, since a single number is .5em, and the
4294   % widest letter (M) is 1em, at least in the Computer Modern fonts.
4295   % But use \hss just in case.
4296   % (This space doesn't include the extra space that gets added after
4297   % the label; that gets put in by \shortchapentry above.)
4298   % 
4299   % We'd like to right-justify chapter numbers, but that looks strange
4300   % with appendix letters.  And right-justifying numbers and
4301   % left-justifying letters looks strange when there is less than 10
4302   % chapters.  Have to read the whole toc once to know how many chapters
4303   % there are before deciding ...
4304   \hbox to 1em{#1\hss}%
4305 }
4306
4307 % These macros generate individual entries in the table of contents.
4308 % The first argument is the chapter or section name.
4309 % The last argument is the page number.
4310 % The arguments in between are the chapter number, section number, ...
4311
4312 % Chapters, in the main contents.
4313 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4314 %
4315 % Chapters, in the short toc.
4316 % See comments in \dochapentry re vbox and related settings.
4317 \def\shortchapentry#1#2#3#4{%
4318   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4319 }
4320
4321 % Appendices, in the main contents.
4322 % Need the word Appendix, and a fixed-size box.
4323
4324 \def\appendixbox#1{%
4325   % We use M since it's probably the widest letter.
4326   \setbox0 = \hbox{\putwordAppendix{} M}%
4327   \hbox to \wd0{\putwordAppendix{} #1\hss}}
4328 %
4329 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4330
4331 % Unnumbered chapters.
4332 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4333 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4334
4335 % Sections.
4336 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4337 \let\appsecentry=\numsecentry
4338 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4339
4340 % Subsections.
4341 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4342 \let\appsubsecentry=\numsubsecentry
4343 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4344
4345 % And subsubsections.
4346 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4347 \let\appsubsubsecentry=\numsubsubsecentry
4348 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4349
4350 % This parameter controls the indentation of the various levels.
4351 \newdimen\tocindent \tocindent = 2pc
4352
4353 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4354 % page number.
4355 %
4356 % If the toc has to be broken over pages, we want it to be at chapters
4357 % if at all possible; hence the \penalty.
4358 \def\dochapentry#1#2{%
4359    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4360    \begingroup
4361      \chapentryfonts
4362      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4363    \endgroup
4364    \nobreak\vskip .25\baselineskip plus.1\baselineskip
4365 }
4366
4367 \def\dosecentry#1#2{\begingroup
4368   \secentryfonts \leftskip=\tocindent
4369   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4370 \endgroup}
4371
4372 \def\dosubsecentry#1#2{\begingroup
4373   \subsecentryfonts \leftskip=2\tocindent
4374   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4375 \endgroup}
4376
4377 \def\dosubsubsecentry#1#2{\begingroup
4378   \subsubsecentryfonts \leftskip=3\tocindent
4379   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4380 \endgroup}
4381
4382 % Final typesetting of a toc entry; we use the same \entry macro as for
4383 % the index entries, but we want to suppress hyphenation here.  (We
4384 % can't do that in the \entry macro, since index entries might consist
4385 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4386 \def\tocentry#1#2{\begingroup
4387   \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4388   % Do not use \turnoffactive in these arguments.  Since the toc is
4389   % typeset in cmr, characters such as _ would come out wrong; we
4390   % have to do the usual translation tricks.
4391   \entry{#1}{#2}%
4392 \endgroup}
4393
4394 % Space between chapter (or whatever) number and the title.
4395 \def\labelspace{\hskip1em \relax}
4396
4397 \def\dopageno#1{{\rm #1}}
4398 \def\doshortpageno#1{{\rm #1}}
4399
4400 \def\chapentryfonts{\secfonts \rm}
4401 \def\secentryfonts{\textfonts}
4402 \def\subsecentryfonts{\textfonts}
4403 \def\subsubsecentryfonts{\textfonts}
4404
4405
4406 \message{environments,}
4407 % @foo ... @end foo.
4408
4409 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4410 %
4411 % Since these characters are used in examples, it should be an even number of
4412 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4413 %
4414 \def\point{$\star$}
4415 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4416 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4417 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4418 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4419
4420 % The @error{} command.
4421 % Adapted from the TeXbook's \boxit.
4422 %
4423 \newbox\errorbox
4424 %
4425 {\tentt \global\dimen0 = 3em}% Width of the box.
4426 \dimen2 = .55pt % Thickness of rules
4427 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4428 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4429 %
4430 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4431    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4432    \advance\hsize by -2\dimen2 % Rules.
4433    \vbox{
4434       \hrule height\dimen2
4435       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
4436          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4437          \kern3pt\vrule width\dimen2}% Space to right.
4438       \hrule height\dimen2}
4439     \hfil}
4440 %
4441 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4442
4443 % @tex ... @end tex    escapes into raw Tex temporarily.
4444 % One exception: @ is still an escape character, so that @end tex works.
4445 % But \@ or @@ will get a plain tex @ character.
4446
4447 \def\tex{\begingroup
4448   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4449   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4450   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4451   \catcode `\%=14
4452   \catcode `\+=\other
4453   \catcode `\"=\other
4454   \catcode `\==\other
4455   \catcode `\|=\other
4456   \catcode `\<=\other
4457   \catcode `\>=\other
4458   \escapechar=`\\
4459   %
4460   \let\b=\ptexb
4461   \let\bullet=\ptexbullet
4462   \let\c=\ptexc
4463   \let\,=\ptexcomma
4464   \let\.=\ptexdot
4465   \let\dots=\ptexdots
4466   \let\equiv=\ptexequiv
4467   \let\!=\ptexexclam
4468   \let\i=\ptexi
4469   \let\indent=\ptexindent
4470   \let\noindent=\ptexnoindent
4471   \let\{=\ptexlbrace
4472   \let\+=\tabalign
4473   \let\}=\ptexrbrace
4474   \let\/=\ptexslash
4475   \let\*=\ptexstar
4476   \let\t=\ptext
4477   %
4478   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4479   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4480   \def\@{@}%
4481 \let\Etex=\endgroup}
4482
4483 % Define @lisp ... @end lisp.
4484 % @lisp does a \begingroup so it can rebind things,
4485 % including the definition of @end lisp (which normally is erroneous).
4486
4487 % Amount to narrow the margins by for @lisp.
4488 \newskip\lispnarrowing \lispnarrowing=0.4in
4489
4490 % This is the definition that ^^M gets inside @lisp, @example, and other
4491 % such environments.  \null is better than a space, since it doesn't
4492 % have any width.
4493 \def\lisppar{\null\endgraf}
4494
4495 % This space is always present above and below environments.
4496 \newskip\envskipamount \envskipamount = 0pt
4497
4498 % Make spacing and below environment symmetrical.  We use \parskip here
4499 % to help in doing that, since in @example-like environments \parskip
4500 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4501 % start of the next paragraph will insert \parskip.
4502 %
4503 \def\aboveenvbreak{{%
4504   % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4505   \ifnum \lastpenalty=10000 \else
4506     \advance\envskipamount by \parskip
4507     \endgraf
4508     \ifdim\lastskip<\envskipamount
4509       \removelastskip
4510       % it's not a good place to break if the last penalty was \nobreak
4511       % or better ...
4512       \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4513       \vskip\envskipamount
4514     \fi
4515   \fi
4516 }}
4517
4518 \let\afterenvbreak = \aboveenvbreak
4519
4520 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
4521 \let\nonarrowing=\relax
4522
4523 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4524 % environment contents.
4525 \font\circle=lcircle10
4526 \newdimen\circthick
4527 \newdimen\cartouter\newdimen\cartinner
4528 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4529 \circthick=\fontdimen8\circle
4530 %
4531 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4532 \def\ctr{{\hskip 6pt\circle\char'010}}
4533 \def\cbl{{\circle\char'012\hskip -6pt}}
4534 \def\cbr{{\hskip 6pt\circle\char'011}}
4535 \def\carttop{\hbox to \cartouter{\hskip\lskip
4536         \ctl\leaders\hrule height\circthick\hfil\ctr
4537         \hskip\rskip}}
4538 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4539         \cbl\leaders\hrule height\circthick\hfil\cbr
4540         \hskip\rskip}}
4541 %
4542 \newskip\lskip\newskip\rskip
4543
4544 \def\cartouche{%
4545 \par  % can't be in the midst of a paragraph.
4546 \begingroup
4547         \lskip=\leftskip \rskip=\rightskip
4548         \leftskip=0pt\rightskip=0pt %we want these *outside*.
4549         \cartinner=\hsize \advance\cartinner by-\lskip
4550                           \advance\cartinner by-\rskip
4551         \cartouter=\hsize
4552         \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4553 %                                    side, and for 6pt waste from
4554 %                                    each corner char, and rule thickness
4555         \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4556         % Flag to tell @lisp, etc., not to narrow margin.
4557         \let\nonarrowing=\comment
4558         \vbox\bgroup
4559                 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4560                 \carttop
4561                 \hbox\bgroup
4562                         \hskip\lskip
4563                         \vrule\kern3pt
4564                         \vbox\bgroup
4565                                 \hsize=\cartinner
4566                                 \kern3pt
4567                                 \begingroup
4568                                         \baselineskip=\normbskip
4569                                         \lineskip=\normlskip
4570                                         \parskip=\normpskip
4571                                         \vskip -\parskip
4572 \def\Ecartouche{%
4573                                 \endgroup
4574                                 \kern3pt
4575                         \egroup
4576                         \kern3pt\vrule
4577                         \hskip\rskip
4578                 \egroup
4579                 \cartbot
4580         \egroup
4581 \endgroup
4582 }}
4583
4584
4585 % This macro is called at the beginning of all the @example variants,
4586 % inside a group.
4587 \def\nonfillstart{%
4588   \aboveenvbreak
4589   \inENV % This group ends at the end of the body
4590   \hfuzz = 12pt % Don't be fussy
4591   \sepspaces % Make spaces be word-separators rather than space tokens.
4592   \let\par = \lisppar % don't ignore blank lines
4593   \obeylines % each line of input is a line of output
4594   \parskip = 0pt
4595   \parindent = 0pt
4596   \emergencystretch = 0pt % don't try to avoid overfull boxes
4597   % @cartouche defines \nonarrowing to inhibit narrowing
4598   % at next level down.
4599   \ifx\nonarrowing\relax
4600     \advance \leftskip by \lispnarrowing
4601     \exdentamount=\lispnarrowing
4602     \let\exdent=\nofillexdent
4603     \let\nonarrowing=\relax
4604   \fi
4605 }
4606
4607 % Define the \E... control sequence only if we are inside the particular
4608 % environment, so the error checking in \end will work.
4609 %
4610 % To end an @example-like environment, we first end the paragraph (via
4611 % \afterenvbreak's vertical glue), and then the group.  That way we keep
4612 % the zero \parskip that the environments set -- \parskip glue will be
4613 % inserted at the beginning of the next paragraph in the document, after
4614 % the environment.
4615 %
4616 \def\nonfillfinish{\afterenvbreak\endgroup}
4617
4618 % @lisp: indented, narrowed, typewriter font.
4619 \def\lisp{\begingroup
4620   \nonfillstart
4621   \let\Elisp = \nonfillfinish
4622   \tt
4623   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4624   \gobble       % eat return
4625 }
4626
4627 % @example: Same as @lisp.
4628 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4629
4630 % @smallexample and @smalllisp: use smaller fonts.
4631 % Originally contributed by Pavel@xerox.
4632 \def\smalllisp{\begingroup
4633   \def\Esmalllisp{\nonfillfinish\endgroup}%
4634   \def\Esmallexample{\nonfillfinish\endgroup}%
4635   \smallexamplefonts
4636   \lisp
4637 }
4638 \let\smallexample = \smalllisp
4639
4640
4641 % @display: same as @lisp except keep current font.
4642 %
4643 \def\display{\begingroup
4644   \nonfillstart
4645   \let\Edisplay = \nonfillfinish
4646   \gobble
4647 }
4648 %
4649 % @smalldisplay: @display plus smaller fonts.
4650 %
4651 \def\smalldisplay{\begingroup
4652   \def\Esmalldisplay{\nonfillfinish\endgroup}%
4653   \smallexamplefonts \rm
4654   \display
4655 }
4656
4657 % @format: same as @display except don't narrow margins.
4658 %
4659 \def\format{\begingroup
4660   \let\nonarrowing = t
4661   \nonfillstart
4662   \let\Eformat = \nonfillfinish
4663   \gobble
4664 }
4665 %
4666 % @smallformat: @format plus smaller fonts.
4667 %
4668 \def\smallformat{\begingroup
4669   \def\Esmallformat{\nonfillfinish\endgroup}%
4670   \smallexamplefonts \rm
4671   \format
4672 }
4673
4674 % @flushleft (same as @format).
4675 %
4676 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4677
4678 % @flushright.
4679 %
4680 \def\flushright{\begingroup
4681   \let\nonarrowing = t
4682   \nonfillstart
4683   \let\Eflushright = \nonfillfinish
4684   \advance\leftskip by 0pt plus 1fill
4685   \gobble
4686 }
4687
4688
4689 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4690 % and narrows the margins.
4691 %
4692 \def\quotation{%
4693   \begingroup\inENV %This group ends at the end of the @quotation body
4694   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4695   \parindent=0pt
4696   % We have retained a nonzero parskip for the environment, since we're
4697   % doing normal filling. So to avoid extra space below the environment...
4698   \def\Equotation{\parskip = 0pt \nonfillfinish}%
4699   %
4700   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4701   \ifx\nonarrowing\relax
4702     \advance\leftskip by \lispnarrowing
4703     \advance\rightskip by \lispnarrowing
4704     \exdentamount = \lispnarrowing
4705     \let\nonarrowing = \relax
4706   \fi
4707 }
4708
4709
4710 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4711 % If we want to allow any <char> as delimiter,
4712 % we need the curly braces so that makeinfo sees the @verb command, eg:
4713 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
4714 %
4715 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
4716 %
4717 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4718 % active too.  Otherwise, they get lost as the first character on a
4719 % verbatim line.
4720 \def\dospecials{%
4721   \do\ \do\\\do\{\do\}\do\$\do\&%
4722   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4723   \do\<\do\>\do\|\do\@\do+\do\"%
4724 }
4725 %
4726 % [Knuth] p. 380
4727 \def\uncatcodespecials{%
4728   \def\do##1{\catcode`##1=12}\dospecials}
4729 %
4730 % [Knuth] pp. 380,381,391
4731 % Disable Spanish ligatures ?` and !` of \tt font
4732 \begingroup
4733   \catcode`\`=\active\gdef`{\relax\lq}
4734 \endgroup
4735 %
4736 % Setup for the @verb command.
4737 %
4738 % Eight spaces for a tab
4739 \begingroup
4740   \catcode`\^^I=\active
4741   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4742 \endgroup
4743 %
4744 \def\setupverb{%
4745   \tt  % easiest (and conventionally used) font for verbatim
4746   \def\par{\leavevmode\endgraf}%
4747   \catcode`\`=\active
4748   \tabeightspaces
4749   % Respect line breaks,
4750   % print special symbols as themselves, and
4751   % make each space count
4752   % must do in this order:
4753   \obeylines \uncatcodespecials \sepspaces
4754 }
4755
4756 % Setup for the @verbatim environment
4757 %
4758 % Real tab expansion
4759 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4760 %
4761 \def\starttabbox{\setbox0=\hbox\bgroup}
4762 \begingroup
4763   \catcode`\^^I=\active
4764   \gdef\tabexpand{%
4765     \catcode`\^^I=\active
4766     \def^^I{\leavevmode\egroup
4767       \dimen0=\wd0 % the width so far, or since the previous tab
4768       \divide\dimen0 by\tabw
4769       \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4770       \advance\dimen0 by\tabw  % advance to next multiple of \tabw
4771       \wd0=\dimen0 \box0 \starttabbox
4772     }%
4773   }
4774 \endgroup
4775 \def\setupverbatim{%
4776   % Easiest (and conventionally used) font for verbatim
4777   \tt
4778   \def\par{\leavevmode\egroup\box0\endgraf}%
4779   \catcode`\`=\active
4780   \tabexpand
4781   % Respect line breaks,
4782   % print special symbols as themselves, and
4783   % make each space count
4784   % must do in this order:
4785   \obeylines \uncatcodespecials \sepspaces
4786   \everypar{\starttabbox}%
4787 }
4788
4789 % Do the @verb magic: verbatim text is quoted by unique
4790 % delimiter characters.  Before first delimiter expect a
4791 % right brace, after last delimiter expect closing brace:
4792 %
4793 %    \def\doverb'{'<char>#1<char>'}'{#1}
4794 %
4795 % [Knuth] p. 382; only eat outer {}
4796 \begingroup
4797   \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4798   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4799 \endgroup
4800 %
4801 \def\verb{\begingroup\setupverb\doverb}
4802 %
4803 %
4804 % Do the @verbatim magic: define the macro \doverbatim so that
4805 % the (first) argument ends when '@end verbatim' is reached, ie:
4806 %
4807 %     \def\doverbatim#1@end verbatim{#1}
4808 %
4809 % For Texinfo it's a lot easier than for LaTeX,
4810 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4811 % we need not redefine '\', '{' and '}'.
4812 %
4813 % Inspired by LaTeX's verbatim command set [latex.ltx]
4814 %% Include LaTeX hack for completeness -- never know
4815 %% \begingroup
4816 %% \catcode`|=0 \catcode`[=1
4817 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4818 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4819 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4820 %% |endgroup
4821 %
4822 \begingroup
4823   \catcode`\ =\active
4824   \obeylines %
4825   % ignore everything up to the first ^^M, that's the newline at the end
4826   % of the @verbatim input line itself.  Otherwise we get an extra blank
4827   % line in the output.
4828   \gdef\doverbatim#1^^M#2@end verbatim{#2\end verbatim}%
4829 \endgroup
4830 %
4831 \def\verbatim{%
4832   \def\Everbatim{\nonfillfinish\endgroup}%
4833   \begingroup
4834     \nonfillstart
4835     \advance\leftskip by -\defbodyindent
4836     \begingroup\setupverbatim\doverbatim
4837 }
4838
4839 % @verbatiminclude FILE - insert text of file in verbatim environment.
4840 %
4841 % Allow normal characters that we make active in the argument (a file name).
4842 \def\verbatiminclude{%
4843   \begingroup
4844     \catcode`\\=\other
4845     \catcode`~=\other
4846     \catcode`^=\other
4847     \catcode`_=\other
4848     \catcode`|=\other
4849     \catcode`<=\other
4850     \catcode`>=\other
4851     \catcode`+=\other
4852     \parsearg\doverbatiminclude
4853 }
4854 \def\setupverbatiminclude{%
4855   \begingroup
4856     \nonfillstart
4857     \advance\leftskip by -\defbodyindent
4858     \begingroup\setupverbatim
4859 }
4860 %
4861 \def\doverbatiminclude#1{%
4862      % Restore active chars for included file.
4863   \endgroup
4864   \begingroup
4865     \let\value=\expandablevalue
4866     \def\thisfile{#1}%
4867     \expandafter\expandafter\setupverbatiminclude\input\thisfile
4868   \endgroup
4869   \nonfillfinish
4870   \endgroup
4871 }
4872
4873 % @copying ... @end copying.
4874 % Save the text away for @insertcopying later.  Many commands won't be
4875 % allowed in this context, but that's ok.
4876 %
4877 % We save the uninterpreted tokens, rather than creating a box.
4878 % Saving the text in a box would be much easier, but then all the
4879 % typesetting commands (@smallbook, font changes, etc.) have to be done
4880 % beforehand -- and a) we want @copying to be done first in the source
4881 % file; b) letting users define the frontmatter in as flexible order as
4882 % possible is very desirable.
4883 %
4884 \def\copying{\begingroup
4885   % Define a command to swallow text until we reach `@end copying'.
4886   % \ is the escape char in this texinfo.tex file, so it is the
4887   % delimiter for the command; @ will be the escape char when we read
4888   % it, but that doesn't matter.
4889   \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4890   %
4891   % We must preserve ^^M's in the input file; see \insertcopying below.
4892   \catcode`\^^M = \active
4893   \docopying
4894 }
4895
4896 % What we do to finish off the copying text.
4897 %
4898 \def\enddocopying{\endgroup\ignorespaces}
4899
4900 % @insertcopying.  Here we must play games with ^^M's.  On the one hand,
4901 % we need them to delimit commands such as `@end quotation', so they
4902 % must be active.  On the other hand, we certainly don't want every
4903 % end-of-line to be a \par, as would happen with the normal active
4904 % definition of ^^M.  On the third hand, two ^^M's in a row should still
4905 % generate a \par.
4906 %
4907 % Our approach is to make ^^M insert a space and a penalty1 normally;
4908 % then it can also check if \lastpenalty=1.  If it does, then manually
4909 % do \par.
4910 %
4911 % This messes up the normal definitions of @c[omment], so we redefine
4912 % it.  Similarly for @ignore.  (These commands are used in the gcc
4913 % manual for man page generation.)
4914 %
4915 % Seems pretty fragile, most line-oriented commands will presumably
4916 % fail, but for the limited use of getting the copying text (which
4917 % should be quite simple) inserted, we can hope it's ok.
4918 %
4919 {\catcode`\^^M=\active %
4920 \gdef\insertcopying{\begingroup %
4921   \parindent = 0pt  % looks wrong on title page
4922   \def^^M{%
4923     \ifnum \lastpenalty=1 %
4924       \par %
4925     \else %
4926       \space \penalty 1 %
4927     \fi %
4928   }%
4929   %
4930   % Fix @c[omment] for catcode 13 ^^M's.
4931   \def\c##1^^M{\ignorespaces}%
4932   \let\comment = \c %
4933   %
4934   % Don't bother jumping through all the hoops that \doignore does, it
4935   % would be very hard since the catcodes are already set.
4936   \long\def\ignore##1\end ignore{\ignorespaces}%
4937   %
4938   \copyingtext %
4939 \endgroup}%
4940 }
4941
4942 \message{defuns,}
4943 % @defun etc.
4944
4945 \newskip\defbodyindent \defbodyindent=.4in
4946 \newskip\defargsindent \defargsindent=50pt
4947 \newskip\deflastargmargin \deflastargmargin=18pt
4948
4949 % We want ()&[] to print specially on the defun line.
4950 %
4951 \def\activeparens{%
4952   \catcode`\(=\active \catcode`\)=\active
4953   \catcode`\[=\active \catcode`\]=\active
4954   \catcode`\&=\active
4955 }
4956
4957 % Make control sequences which act like normal parenthesis chars.
4958 \let\lparen = ( \let\rparen = )
4959
4960 % Be sure that we always have a definition for `(', etc.  For example,
4961 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4962 % so TeX would otherwise complain about undefined control sequence.
4963 {
4964   \activeparens
4965   \global\let(=\lparen \global\let)=\rparen
4966   \global\let[=\lbrack \global\let]=\rbrack
4967   \global\let& = \&
4968
4969   \gdef\functionparens{\boldbrax\let&=\amprm}
4970   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4971 }
4972
4973 \newcount\parencount
4974
4975 % If we encounter &foo, then turn on ()-hacking afterwards
4976 \newif\ifampseen
4977 \def\amprm#1 {\ampseentrue{\rm\&#1} }
4978
4979 \def\parenfont{%
4980   \ifampseen
4981     % At the first level, print parens in roman,
4982     % otherwise use the default font.
4983     \ifnum \parencount=1 \rm \fi
4984   \else
4985     % The \sf parens (in \boldbrax) actually are a little bolder than
4986     % the contained text.  This is especially needed for [ and ] .
4987     \sf
4988   \fi
4989 }
4990 \def\infirstlevel#1{%
4991   \ifampseen
4992     \ifnum\parencount=1
4993       #1%
4994     \fi
4995   \fi
4996 }
4997 \def\bfafterword#1 {#1 \bf}
4998
4999 \def\opnr{%
5000   \global\advance\parencount by 1
5001   {\parenfont(}%
5002   \infirstlevel \bfafterword
5003 }
5004 \def\clnr{%
5005   {\parenfont)}%
5006   \infirstlevel \sl
5007   \global\advance\parencount by -1
5008 }
5009
5010 \newcount\brackcount
5011 \def\lbrb{%
5012   \global\advance\brackcount by 1
5013   {\bf[}%
5014 }
5015 \def\rbrb{%
5016   {\bf]}%
5017   \global\advance\brackcount by -1
5018 }
5019
5020 \def\checkparencounts{%
5021   \ifnum\parencount=0 \else \badparencount \fi
5022   \ifnum\brackcount=0 \else \badbrackcount \fi
5023 }
5024 \def\badparencount{%
5025   \errmessage{Unbalanced parentheses in @def}%
5026   \global\parencount=0
5027 }
5028 \def\badbrackcount{%
5029   \errmessage{Unbalanced square braces in @def}%
5030   \global\brackcount=0
5031 }
5032
5033 % \defname, which formats the name of the @def (not the args).
5034 % #1 is the function name.
5035 % #2 is the type of definition, such as "Function".
5036 %
5037 \def\defname#1#2{%
5038   % Get the values of \leftskip and \rightskip as they were outside the @def...
5039   \advance\leftskip by -\defbodyindent
5040   %
5041   % How we'll format the type name.  Putting it in brackets helps
5042   % distinguish it from the body text that may end up on the next line
5043   % just below it.
5044   \def\temp{#2}%
5045   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5046   %
5047   % Figure out line sizes for the paragraph shape.
5048   % The first line needs space for \box0; but if \rightskip is nonzero,
5049   % we need only space for the part of \box0 which exceeds it:
5050   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
5051   % The continuations:
5052   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
5053   % (plain.tex says that \dimen1 should be used only as global.)
5054   \parshape 2 0in \dimen0 \defargsindent \dimen2
5055   %
5056   % Put the type name to the right margin.
5057   \noindent
5058   \hbox to 0pt{%
5059     \hfil\box0 \kern-\hsize
5060     % \hsize has to be shortened this way:
5061     \kern\leftskip
5062     % Intentionally do not respect \rightskip, since we need the space.
5063   }%
5064   %
5065   % Allow all lines to be underfull without complaint:
5066   \tolerance=10000 \hbadness=10000
5067   \exdentamount=\defbodyindent
5068   {\df #1}\enskip        % output function name
5069   % \defunargs will be called next to output the arguments, if any.
5070 }
5071
5072 % Common pieces to start any @def...
5073 % #1 is the \E... control sequence to end the definition (which we define).
5074 % #2 is the \...x control sequence (which our caller defines).
5075 % #3 is the control sequence to process the header, such as \defunheader.
5076 %
5077 \def\parsebodycommon#1#2#3{%
5078   \begingroup\inENV
5079   \ifnum\lastpenalty<10000
5080     \medbreak
5081   \else
5082     % If there are two @def commands in a row, we'll have a \nobreak,
5083     % which is there to keep the function description together with its
5084     % header.  But if there's nothing but headers, we need to allow a
5085     % break somewhere.  Check for penalty 10002 (inserted by
5086     % \defargscommonending) instead of 10000, since the sectioning
5087     % commands insert a \penalty10000, and we don't want to allow a break
5088     % between a section heading and a defun.
5089     \ifnum\lastpenalty=10002 \penalty2000 \fi
5090     %
5091     % Similarly, after a section heading, do not allow a break.
5092     % But do insert the glue.
5093     \medskip  % preceded by discardable penalty, so not a breakpoint
5094   \fi
5095   %
5096   % Define the \E... end token that this defining construct specifies
5097   % so that it will exit this group.
5098   \def#1{\endgraf\endgroup\medbreak}%
5099   %
5100   \parindent=0in
5101   \advance\leftskip by \defbodyindent
5102   \exdentamount=\defbodyindent
5103 }
5104
5105 % Common part of the \...x definitions.
5106 %
5107 \def\defxbodycommon{%
5108   % As with \parsebodycommon above, allow line break if we have multiple
5109   % x headers in a row.  It's not a great place, though.
5110   \ifnum\lastpenalty=10002 \penalty3000 \fi
5111   %
5112   \begingroup\obeylines
5113 }
5114
5115 % Process body of @defun, @deffn, @defmac, etc.
5116 %
5117 \def\defparsebody#1#2#3{%
5118   \parsebodycommon{#1}{#2}{#3}%
5119   \def#2{\defxbodycommon \activeparens \spacesplit#3}%
5120   \catcode\equalChar=\active
5121   \begingroup\obeylines\activeparens
5122   \spacesplit#3%
5123 }
5124
5125 % #1, #2, #3 are the common arguments (see \parsebodycommon above).
5126 % #4, delimited by the space, is the class name.
5127 %
5128 \def\defmethparsebody#1#2#3#4 {%
5129   \parsebodycommon{#1}{#2}{#3}%
5130   \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}%
5131   \begingroup\obeylines\activeparens
5132   % The \empty here prevents misinterpretation of a construct such as
5133   %   @deffn {whatever} {Enharmonic comma}
5134   % See comments at \deftpparsebody, although in our case we don't have
5135   % to remove the \empty afterwards, since it is empty.
5136   \spacesplit{#3{#4}}\empty
5137 }
5138
5139 % Used for @deftypemethod and @deftypeivar.
5140 % #1, #2, #3 are the common arguments (see \defparsebody).
5141 % #4, delimited by a space, is the class name.
5142 % #5 is the method's return type.
5143 %
5144 \def\deftypemethparsebody#1#2#3#4 #5 {%
5145   \parsebodycommon{#1}{#2}{#3}%
5146   \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}%
5147   \begingroup\obeylines\activeparens
5148   \spacesplit{#3{#4}{#5}}%
5149 }
5150
5151 % Used for @deftypeop.  The change from \deftypemethparsebody is an
5152 % extra argument at the beginning which is the `category', instead of it
5153 % being the hardwired string `Method' or `Instance Variable'.  We have
5154 % to account for this both in the \...x definition and in parsing the
5155 % input at hand.  Thus also need a control sequence (passed as #5) for
5156 % the \E... definition to assign the category name to.
5157 %
5158 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
5159   \parsebodycommon{#1}{#2}{#3}%
5160   \def#2##1 ##2 ##3 {\def#4{##1}%
5161     \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}%
5162   \begingroup\obeylines\activeparens
5163   \spacesplit{#3{#5}{#6}}%
5164 }
5165
5166 % For @defop.
5167 \def\defopparsebody #1#2#3#4#5 {%
5168   \parsebodycommon{#1}{#2}{#3}%
5169   \def#2##1 ##2 {\def#4{##1}%
5170     \defxbodycommon \activeparens \spacesplit{#3{##2}}}%
5171   \begingroup\obeylines\activeparens
5172   \spacesplit{#3{#5}}%
5173 }
5174
5175 % These parsing functions are similar to the preceding ones
5176 % except that they do not make parens into active characters.
5177 % These are used for "variables" since they have no arguments.
5178 %
5179 \def\defvarparsebody #1#2#3{%
5180   \parsebodycommon{#1}{#2}{#3}%
5181   \def#2{\defxbodycommon \spacesplit#3}%
5182   \catcode\equalChar=\active
5183   \begingroup\obeylines
5184   \spacesplit#3%
5185 }
5186
5187 % @defopvar.
5188 \def\defopvarparsebody #1#2#3#4#5 {%
5189   \parsebodycommon{#1}{#2}{#3}%
5190   \def#2##1 ##2 {\def#4{##1}%
5191     \defxbodycommon \spacesplit{#3{##2}}}%
5192   \begingroup\obeylines
5193   \spacesplit{#3{#5}}%
5194 }
5195
5196 \def\defvrparsebody#1#2#3#4 {%
5197   \parsebodycommon{#1}{#2}{#3}%
5198   \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5199   \begingroup\obeylines
5200   \spacesplit{#3{#4}}%
5201 }
5202
5203 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
5204 % type is just `struct', because we lose the braces in `{struct
5205 % termios}' when \spacesplit reads its undelimited argument.  Sigh.
5206 % \let\deftpparsebody=\defvrparsebody
5207 %
5208 % So, to get around this, we put \empty in with the type name.  That
5209 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5210 % won't strip off the braces.
5211 %
5212 \def\deftpparsebody #1#2#3#4 {%
5213   \parsebodycommon{#1}{#2}{#3}%
5214   \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5215   \begingroup\obeylines
5216   \spacesplit{\parsetpheaderline{#3{#4}}}\empty
5217 }
5218
5219 % Fine, but then we have to eventually remove the \empty *and* the
5220 % braces (if any).  That's what this does.
5221 %
5222 \def\removeemptybraces\empty#1\relax{#1}
5223
5224 % After \spacesplit has done its work, this is called -- #1 is the final
5225 % thing to call, #2 the type name (which starts with \empty), and #3
5226 % (which might be empty) the arguments.
5227 %
5228 \def\parsetpheaderline#1#2#3{%
5229   #1{\removeemptybraces#2\relax}{#3}%
5230 }%
5231
5232 % Split up #2 (the rest of the input line) at the first space token.
5233 % call #1 with two arguments:
5234 %  the first is all of #2 before the space token,
5235 %  the second is all of #2 after that space token.
5236 % If #2 contains no space token, all of it is passed as the first arg
5237 % and the second is passed as empty.
5238 %
5239 {\obeylines %
5240  \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}%
5241  \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{%
5242    \ifx\relax #3%
5243      #1{#2}{}%
5244    \else %
5245      #1{#2}{#3#4}%
5246    \fi}%
5247 }
5248
5249 % Define @defun.
5250
5251 % This is called to end the arguments processing for all the @def... commands.
5252 %
5253 \def\defargscommonending{%
5254   \interlinepenalty = 10000
5255   \advance\rightskip by 0pt plus 1fil
5256   \endgraf
5257   \nobreak\vskip -\parskip
5258   \penalty 10002  % signal to \parsebodycommon and \defxbodycommon.
5259 }
5260
5261 % This expands the args and terminates the paragraph they comprise.
5262 %
5263 \def\defunargs#1{\functionparens \sl
5264 % Expand, preventing hyphenation at `-' chars.
5265 % Note that groups don't affect changes in \hyphenchar.
5266 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5267 {\tensl\hyphenchar\font=0}%
5268 #1%
5269 {\tensl\hyphenchar\font=45}%
5270   \checkparencounts
5271   \defargscommonending
5272 }
5273
5274 \def\deftypefunargs #1{%
5275 % Expand, preventing hyphenation at `-' chars.
5276 % Note that groups don't affect changes in \hyphenchar.
5277 % Use \boldbrax, not \functionparens, so that & is not special.
5278 \boldbrax
5279 \tclose{#1}% avoid \code because of side effects on active chars
5280   \defargscommonending
5281 }
5282
5283 % Do complete processing of one @defun or @defunx line already parsed.
5284
5285 % @deffn Command forward-char nchars
5286
5287 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
5288
5289 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
5290 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
5291 \catcode\equalChar=\other % Turn off change made in \defparsebody
5292 }
5293
5294 % @defun == @deffn Function
5295
5296 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5297
5298 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5299 \begingroup\defname {#1}{\putwordDeffunc}%
5300 \defunargs {#2}\endgroup %
5301 \catcode\equalChar=\other % Turn off change made in \defparsebody
5302 }
5303
5304 % @deftypefun int foobar (int @var{foo}, float @var{bar})
5305
5306 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
5307
5308 % #1 is the data type.  #2 is the name and args.
5309 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
5310 % #1 is the data type, #2 the name, #3 the args.
5311 \def\deftypefunheaderx #1#2 #3\relax{%
5312 \doind {fn}{\code{#2}}% Make entry in function index
5313 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
5314 \deftypefunargs {#3}\endgroup %
5315 \catcode\equalChar=\other % Turn off change made in \defparsebody
5316 }
5317
5318 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
5319
5320 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
5321
5322 % \defheaderxcond#1\relax$.$
5323 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
5324 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
5325
5326 % #1 is the classification.  #2 is the data type.  #3 is the name and args.
5327 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
5328 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5329 \def\deftypefnheaderx #1#2#3 #4\relax{%
5330 \doind {fn}{\code{#3}}% Make entry in function index
5331 \begingroup
5332 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
5333 \deftypefunargs {#4}\endgroup %
5334 \catcode\equalChar=\other % Turn off change made in \defparsebody
5335 }
5336
5337 % @defmac == @deffn Macro
5338
5339 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5340
5341 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5342 \begingroup\defname {#1}{\putwordDefmac}%
5343 \defunargs {#2}\endgroup %
5344 \catcode\equalChar=\other % Turn off change made in \defparsebody
5345 }
5346
5347 % @defspec == @deffn Special Form
5348
5349 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5350
5351 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5352 \begingroup\defname {#1}{\putwordDefspec}%
5353 \defunargs {#2}\endgroup %
5354 \catcode\equalChar=\other % Turn off change made in \defparsebody
5355 }
5356
5357 % @defop CATEGORY CLASS OPERATION ARG...
5358 %
5359 \def\defop #1 {\def\defoptype{#1}%
5360 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5361 %
5362 \def\defopheader#1#2#3{%
5363   \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% function index entry
5364   \begingroup
5365     \defname{#2}{\defoptype\ \putwordon\ #1}%
5366     \defunargs{#3}%
5367   \endgroup
5368 }
5369
5370 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5371 %
5372 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5373   \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5374                        \deftypeopcategory}
5375 %
5376 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5377 \def\deftypeopheader#1#2#3#4{%
5378   \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5379   \begingroup
5380     \defname{\defheaderxcond#2\relax$.$#3}
5381             {\deftypeopcategory\ \putwordon\ \code{#1}}%
5382     \deftypefunargs{#4}%
5383   \endgroup
5384 }
5385
5386 % @deftypemethod CLASS TYPE METHOD ARG...
5387 %
5388 \def\deftypemethod{%
5389   \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5390 %
5391 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5392 \def\deftypemethodheader#1#2#3#4{%
5393   \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5394   \begingroup
5395     \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5396     \deftypefunargs{#4}%
5397   \endgroup
5398 }
5399
5400 % @deftypeivar CLASS TYPE VARNAME
5401 %
5402 \def\deftypeivar{%
5403   \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5404 %
5405 % #1 is the class name, #2 the data type, #3 the variable name.
5406 \def\deftypeivarheader#1#2#3{%
5407   \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5408   \begingroup
5409     \defname{\defheaderxcond#2\relax$.$#3}
5410             {\putwordInstanceVariableof\ \code{#1}}%
5411     \defvarargs{#3}%
5412   \endgroup
5413 }
5414
5415 % @defmethod == @defop Method
5416 %
5417 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5418 %
5419 % #1 is the class name, #2 the method name, #3 the args.
5420 \def\defmethodheader#1#2#3{%
5421   \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5422   \begingroup
5423     \defname{#2}{\putwordMethodon\ \code{#1}}%
5424     \defunargs{#3}%
5425   \endgroup
5426 }
5427
5428 % @defcv {Class Option} foo-class foo-flag
5429
5430 \def\defcv #1 {\def\defcvtype{#1}%
5431 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5432
5433 \def\defcvarheader #1#2#3{%
5434   \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% variable index entry
5435   \begingroup
5436     \defname{#2}{\defcvtype\ \putwordof\ #1}%
5437     \defvarargs{#3}%
5438   \endgroup
5439 }
5440
5441 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5442 %
5443 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5444 %
5445 \def\defivarheader#1#2#3{%
5446   \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% entry in var index
5447   \begingroup
5448     \defname{#2}{\putwordInstanceVariableof\ #1}%
5449     \defvarargs{#3}%
5450   \endgroup
5451 }
5452
5453 % @defvar
5454 % First, define the processing that is wanted for arguments of @defvar.
5455 % This is actually simple: just print them in roman.
5456 % This must expand the args and terminate the paragraph they make up
5457 \def\defvarargs #1{%
5458   \boldbrax
5459   #1%
5460   \defargscommonending
5461 }
5462
5463 % @defvr Counter foo-count
5464
5465 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5466
5467 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5468 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5469
5470 % @defvar == @defvr Variable
5471
5472 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5473
5474 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5475 \begingroup\defname {#1}{\putwordDefvar}%
5476 \defvarargs {#2}\endgroup %
5477 }
5478
5479 % @defopt == @defvr {User Option}
5480
5481 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5482
5483 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5484 \begingroup\defname {#1}{\putwordDefopt}%
5485 \defvarargs {#2}\endgroup %
5486 }
5487
5488 % @deftypevar int foobar
5489
5490 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5491
5492 % #1 is the data type.  #2 is the name, perhaps followed by text that
5493 % is actually part of the data type, which should not be put into the index.
5494 \def\deftypevarheader #1#2{%
5495 \dovarind#2 \relax% Make entry in variables index
5496 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5497   \defargscommonending
5498 \endgroup}
5499 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5500
5501 % @deftypevr {Global Flag} int enable
5502
5503 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5504
5505 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5506 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5507   \defargscommonending
5508 \endgroup}
5509
5510 % Now define @deftp
5511 % Args are printed in bold, a slight difference from @defvar.
5512
5513 \def\deftpargs #1{\bf \defvarargs{#1}}
5514
5515 % @deftp Class window height width ...
5516
5517 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5518
5519 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5520 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5521
5522 % These definitions are used if you use @defunx (etc.)
5523 % anywhere other than immediately after a @defun or @defunx.
5524 %
5525 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5526 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5527 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5528 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5529 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5530 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5531 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5532 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5533 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5534 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5535 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5536 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5537 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5538 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5539 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5540 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5541 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5542 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5543 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5544
5545
5546 \message{macros,}
5547 % @macro.
5548
5549 % To do this right we need a feature of e-TeX, \scantokens,
5550 % which we arrange to emulate with a temporary file in ordinary TeX.
5551 \ifx\eTeXversion\undefined
5552  \newwrite\macscribble
5553  \def\scanmacro#1{%
5554    \begingroup \newlinechar`\^^M
5555    % Undo catcode changes of \startcontents and \doprintindex
5556    \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5557    % Append \endinput to make sure that TeX does not see the ending newline.
5558    \toks0={#1\endinput}%
5559    \immediate\openout\macscribble=\jobname.tmp
5560    \immediate\write\macscribble{\the\toks0}%
5561    \immediate\closeout\macscribble
5562    \let\xeatspaces\eatspaces
5563    \input \jobname.tmp
5564    \endgroup
5565 }
5566 \else
5567 \def\scanmacro#1{%
5568 \begingroup \newlinechar`\^^M
5569 % Undo catcode changes of \startcontents and \doprintindex
5570 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5571 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5572 \fi
5573
5574 \newcount\paramno   % Count of parameters
5575 \newtoks\macname    % Macro name
5576 \newif\ifrecursive  % Is it recursive?
5577 \def\macrolist{}    % List of all defined macros in the form
5578                     % \do\macro1\do\macro2...
5579
5580 % Utility routines.
5581 % Thisdoes \let #1 = #2, except with \csnames.
5582 \def\cslet#1#2{%
5583 \expandafter\expandafter
5584 \expandafter\let
5585 \expandafter\expandafter
5586 \csname#1\endcsname
5587 \csname#2\endcsname}
5588
5589 % Trim leading and trailing spaces off a string.
5590 % Concepts from aro-bend problem 15 (see CTAN).
5591 {\catcode`\@=11
5592 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5593 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5594 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5595 \def\unbrace#1{#1}
5596 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5597 }
5598
5599 % Trim a single trailing ^^M off a string.
5600 {\catcode`\^^M=\other \catcode`\Q=3%
5601 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5602 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5603 \gdef\eatcrb#1Q#2Q{#1}%
5604 }
5605
5606 % Macro bodies are absorbed as an argument in a context where
5607 % all characters are catcode 10, 11 or 12, except \ which is active
5608 % (as in normal texinfo). It is necessary to change the definition of \.
5609
5610 % It's necessary to have hard CRs when the macro is executed. This is
5611 % done by  making ^^M (\endlinechar) catcode 12 when reading the macro
5612 % body, and then making it the \newlinechar in \scanmacro.
5613
5614 \def\macrobodyctxt{%
5615   \catcode`\~=\other
5616   \catcode`\^=\other
5617   \catcode`\_=\other
5618   \catcode`\|=\other
5619   \catcode`\<=\other
5620   \catcode`\>=\other
5621   \catcode`\+=\other
5622   \catcode`\{=\other
5623   \catcode`\}=\other
5624   \catcode`\@=\other
5625   \catcode`\^^M=\other
5626   \usembodybackslash}
5627
5628 \def\macroargctxt{%
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`\\=\other}
5638
5639 % \mbodybackslash is the definition of \ in @macro bodies.
5640 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5641 % where N is the macro parameter number.
5642 % We define \csname macarg.\endcsname to be \realbackslash, so
5643 % \\ in macro replacement text gets you a backslash.
5644
5645 {\catcode`@=0 @catcode`@\=@active
5646  @gdef@usembodybackslash{@let\=@mbodybackslash}
5647  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5648 }
5649 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5650
5651 \def\macro{\recursivefalse\parsearg\macroxxx}
5652 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5653
5654 \def\macroxxx#1{%
5655   \getargs{#1}%           now \macname is the macname and \argl the arglist
5656   \ifx\argl\empty       % no arguments
5657      \paramno=0%
5658   \else
5659      \expandafter\parsemargdef \argl;%
5660   \fi
5661   \if1\csname ismacro.\the\macname\endcsname
5662      \message{Warning: redefining \the\macname}%
5663   \else
5664      \expandafter\ifx\csname \the\macname\endcsname \relax
5665      \else \errmessage{Macro name \the\macname\space already defined}\fi
5666      \global\cslet{macsave.\the\macname}{\the\macname}%
5667      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5668      % Add the macroname to \macrolist
5669      \toks0 = \expandafter{\macrolist\do}%
5670      \xdef\macrolist{\the\toks0
5671        \expandafter\noexpand\csname\the\macname\endcsname}%
5672   \fi
5673   \begingroup \macrobodyctxt
5674   \ifrecursive \expandafter\parsermacbody
5675   \else \expandafter\parsemacbody
5676   \fi}
5677
5678 \def\unmacro{\parsearg\dounmacro}
5679 \def\dounmacro#1{%
5680   \if1\csname ismacro.#1\endcsname
5681     \global\cslet{#1}{macsave.#1}%
5682     \global\expandafter\let \csname ismacro.#1\endcsname=0%
5683     % Remove the macro name from \macrolist:
5684     \begingroup
5685       \expandafter\let\csname#1\endcsname \relax
5686       \let\do\unmacrodo
5687       \xdef\macrolist{\macrolist}%
5688     \endgroup
5689   \else
5690     \errmessage{Macro #1 not defined}%
5691   \fi
5692 }
5693
5694 % Called by \do from \dounmacro on each macro.  The idea is to omit any
5695 % macro definitions that have been changed to \relax.
5696 %
5697 \def\unmacrodo#1{%
5698   \ifx#1\relax
5699     % remove this
5700   \else
5701     \noexpand\do \noexpand #1%
5702   \fi
5703 }
5704
5705 % This makes use of the obscure feature that if the last token of a
5706 % <parameter list> is #, then the preceding argument is delimited by
5707 % an opening brace, and that opening brace is not consumed.
5708 \def\getargs#1{\getargsxxx#1{}}
5709 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5710 \def\getmacname #1 #2\relax{\macname={#1}}
5711 \def\getmacargs#1{\def\argl{#1}}
5712
5713 % Parse the optional {params} list.  Set up \paramno and \paramlist
5714 % so \defmacro knows what to do.  Define \macarg.blah for each blah
5715 % in the params list, to be ##N where N is the position in that list.
5716 % That gets used by \mbodybackslash (above).
5717
5718 % We need to get `macro parameter char #' into several definitions.
5719 % The technique used is stolen from LaTeX:  let \hash be something
5720 % unexpandable, insert that wherever you need a #, and then redefine
5721 % it to # just before using the token list produced.
5722 %
5723 % The same technique is used to protect \eatspaces till just before
5724 % the macro is used.
5725
5726 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5727         \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5728 \def\parsemargdefxxx#1,{%
5729   \if#1;\let\next=\relax
5730   \else \let\next=\parsemargdefxxx
5731     \advance\paramno by 1%
5732     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5733         {\xeatspaces{\hash\the\paramno}}%
5734     \edef\paramlist{\paramlist\hash\the\paramno,}%
5735   \fi\next}
5736
5737 % These two commands read recursive and nonrecursive macro bodies.
5738 % (They're different since rec and nonrec macros end differently.)
5739
5740 \long\def\parsemacbody#1@end macro%
5741 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5742 \long\def\parsermacbody#1@end rmacro%
5743 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5744
5745 % This defines the macro itself. There are six cases: recursive and
5746 % nonrecursive macros of zero, one, and many arguments.
5747 % Much magic with \expandafter here.
5748 % \xdef is used so that macro definitions will survive the file
5749 % they're defined in; @include reads the file inside a group.
5750 \def\defmacro{%
5751   \let\hash=##% convert placeholders to macro parameter chars
5752   \ifrecursive
5753     \ifcase\paramno
5754     % 0
5755       \expandafter\xdef\csname\the\macname\endcsname{%
5756         \noexpand\scanmacro{\temp}}%
5757     \or % 1
5758       \expandafter\xdef\csname\the\macname\endcsname{%
5759          \bgroup\noexpand\macroargctxt
5760          \noexpand\braceorline
5761          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5762       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5763          \egroup\noexpand\scanmacro{\temp}}%
5764     \else % many
5765       \expandafter\xdef\csname\the\macname\endcsname{%
5766          \bgroup\noexpand\macroargctxt
5767          \noexpand\csname\the\macname xx\endcsname}%
5768       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5769           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5770       \expandafter\expandafter
5771       \expandafter\xdef
5772       \expandafter\expandafter
5773         \csname\the\macname xxx\endcsname
5774           \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5775     \fi
5776   \else
5777     \ifcase\paramno
5778     % 0
5779       \expandafter\xdef\csname\the\macname\endcsname{%
5780         \noexpand\norecurse{\the\macname}%
5781         \noexpand\scanmacro{\temp}\egroup}%
5782     \or % 1
5783       \expandafter\xdef\csname\the\macname\endcsname{%
5784          \bgroup\noexpand\macroargctxt
5785          \noexpand\braceorline
5786          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5787       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5788         \egroup
5789         \noexpand\norecurse{\the\macname}%
5790         \noexpand\scanmacro{\temp}\egroup}%
5791     \else % many
5792       \expandafter\xdef\csname\the\macname\endcsname{%
5793          \bgroup\noexpand\macroargctxt
5794          \expandafter\noexpand\csname\the\macname xx\endcsname}%
5795       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5796           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5797       \expandafter\expandafter
5798       \expandafter\xdef
5799       \expandafter\expandafter
5800       \csname\the\macname xxx\endcsname
5801       \paramlist{%
5802           \egroup
5803           \noexpand\norecurse{\the\macname}%
5804           \noexpand\scanmacro{\temp}\egroup}%
5805     \fi
5806   \fi}
5807
5808 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5809
5810 % \braceorline decides whether the next nonwhitespace character is a
5811 % {.  If so it reads up to the closing }, if not, it reads the whole
5812 % line.  Whatever was read is then fed to the next control sequence
5813 % as an argument (by \parsebrace or \parsearg)
5814 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5815 \def\braceorlinexxx{%
5816   \ifx\nchar\bgroup\else
5817     \expandafter\parsearg
5818   \fi \next}
5819
5820 % We mant to disable all macros during \shipout so that they are not
5821 % expanded by \write.
5822 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5823   \edef\next{\macrolist}\expandafter\endgroup\next}
5824
5825
5826 % @alias.
5827 % We need some trickery to remove the optional spaces around the equal
5828 % sign.  Just make them active and then expand them all to nothing.
5829 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5830 \def\aliasxxx #1{\aliasyyy#1\relax}
5831 \def\aliasyyy #1=#2\relax{%
5832   {%
5833     \expandafter\let\obeyedspace=\empty
5834     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5835   }%
5836   \next
5837 }
5838 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
5839
5840
5841 \message{cross references,}
5842
5843 \newwrite\auxfile
5844
5845 \newif\ifhavexrefs    % True if xref values are known.
5846 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
5847
5848 % @inforef is relatively simple.
5849 \def\inforef #1{\inforefzzz #1,,,,**}
5850 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5851   node \samp{\ignorespaces#1{}}}
5852
5853 % @node's only job in TeX is to define \lastnode, which is used in
5854 % cross-references.
5855 \def\node{\ENVcheck\parsearg\nodezzz}
5856 \def\nodezzz#1{\nodexxx #1,\finishnodeparse}
5857 \def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5858 \let\nwnode=\node
5859 \let\lastnode=\empty
5860
5861 % Write a cross-reference definition for the current node.  #1 is the
5862 % type (Ynumbered, Yappendix, Ynothing).
5863
5864 \def\donoderef#1{%
5865   \ifx\lastnode\empty\else
5866     \setref{\lastnode}{#1}%
5867     \global\let\lastnode=\empty
5868   \fi
5869 }
5870
5871 % @anchor{NAME} -- define xref target at arbitrary point.
5872 %
5873 \newcount\savesfregister
5874 %
5875 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5876 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5877 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5878
5879 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5880 % anchor), namely NAME-title (the corresponding @chapter/etc. name),
5881 % NAME-pg (the page number), and NAME-snt (section number and type).
5882 % Called from \donoderef and \anchor.
5883
5884 % We take care not to fully expand the title, since it may contain
5885 % arbitrary macros.
5886 %
5887 % Use \turnoffactive so that punctuation chars such as underscore
5888 % and backslash work in node names.
5889 %
5890 \def\setref#1#2{%
5891   \pdfmkdest{#1}%
5892   \iflinks
5893     {%
5894       \turnoffactive
5895       \edef\writexrdef##1##2{%
5896         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5897           ##1}{##2}}% these are parameters of \writexrdef
5898       }%
5899       \toks0 = \expandafter{\thissection}%
5900       \immediate \writexrdef{title}{\the\toks0 }%
5901       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5902       \writexrdef{pg}{\folio}% will be written later, during \shipout
5903     }%
5904   \fi
5905 }
5906
5907 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
5908 % the node name, #2 the name of the Info cross-reference, #3 the printed
5909 % node name, #4 the name of the Info file, #5 the name of the printed
5910 % manual.  All but the node name can be omitted.
5911 %
5912 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5913 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5914 \def\ref#1{\xrefX[#1,,,,,,,]}
5915 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5916   \unsepspaces
5917   \def\printedmanual{\ignorespaces #5}%
5918   \def\printednodename{\ignorespaces #3}%
5919   \setbox1=\hbox{\printedmanual}%
5920   \setbox0=\hbox{\printednodename}%
5921   \ifdim \wd0 = 0pt
5922     % No printed node name was explicitly given.
5923     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5924       % Use the node name inside the square brackets.
5925       \def\printednodename{\ignorespaces #1}%
5926     \else
5927       % Use the actual chapter/section title appear inside
5928       % the square brackets.  Use the real section title if we have it.
5929       \ifdim \wd1 > 0pt
5930         % It is in another manual, so we don't have it.
5931         \def\printednodename{\ignorespaces #1}%
5932       \else
5933         \ifhavexrefs
5934           % We know the real title if we have the xref values.
5935           \def\printednodename{\refx{#1-title}{}}%
5936         \else
5937           % Otherwise just copy the Info node name.
5938           \def\printednodename{\ignorespaces #1}%
5939         \fi%
5940       \fi
5941     \fi
5942   \fi
5943   %
5944   % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5945   % insert empty discretionaries after hyphens, which means that it will
5946   % not find a line break at a hyphen in a node names.  Since some manuals
5947   % are best written with fairly long node names, containing hyphens, this
5948   % is a loss.  Therefore, we give the text of the node name again, so it
5949   % is as if TeX is seeing it for the first time.
5950   \ifpdf
5951     \leavevmode
5952     \getfilename{#4}%
5953     {\turnoffactive \otherbackslash
5954      \ifnum\filenamelength>0
5955        \startlink attr{/Border [0 0 0]}%
5956          goto file{\the\filename.pdf} name{#1}%
5957      \else
5958        \startlink attr{/Border [0 0 0]}%
5959          goto name{\pdfmkpgn{#1}}%
5960      \fi
5961     }%
5962     \linkcolor
5963   \fi
5964   %
5965   \ifdim \wd1 > 0pt
5966     \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5967   \else
5968     % _ (for example) has to be the character _ for the purposes of the
5969     % control sequence corresponding to the node, but it has to expand
5970     % into the usual \leavevmode...\vrule stuff for purposes of
5971     % printing. So we \turnoffactive for the \refx-snt, back on for the
5972     % printing, back off for the \refx-pg.
5973     {\turnoffactive \otherbackslash
5974      % Only output a following space if the -snt ref is nonempty; for
5975      % @unnumbered and @anchor, it won't be.
5976      \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5977      \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5978     }%
5979     % output the `[mynode]' via a macro.
5980     \xrefprintnodename\printednodename
5981     %
5982     % But we always want a comma and a space:
5983     ,\space
5984     %
5985     % output the `page 3'.
5986     \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5987   \fi
5988   \endlink
5989 \endgroup}
5990
5991 % This macro is called from \xrefX for the `[nodename]' part of xref
5992 % output.  It's a separate macro only so it can be changed more easily,
5993 % since not square brackets don't work in some documents.  Particularly
5994 % one that Bob is working on :).
5995 %
5996 \def\xrefprintnodename#1{[#1]}
5997
5998 % Things referred to by \setref.
5999 %
6000 \def\Ynothing{}
6001 \def\Yomitfromtoc{}
6002 \def\Ynumbered{%
6003   \ifnum\secno=0
6004     \putwordChapter@tie \the\chapno
6005   \else \ifnum\subsecno=0
6006     \putwordSection@tie \the\chapno.\the\secno
6007   \else \ifnum\subsubsecno=0
6008     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6009   \else
6010     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6011   \fi\fi\fi
6012 }
6013 \def\Yappendix{%
6014   \ifnum\secno=0
6015      \putwordAppendix@tie @char\the\appendixno{}%
6016   \else \ifnum\subsecno=0
6017      \putwordSection@tie @char\the\appendixno.\the\secno
6018   \else \ifnum\subsubsecno=0
6019     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6020   \else
6021     \putwordSection@tie
6022       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6023   \fi\fi\fi
6024 }
6025
6026 % Use TeX 3.0's \inputlineno to get the line number, for better error
6027 % messages, but if we're using an old version of TeX, don't do anything.
6028 %
6029 \ifx\inputlineno\thisisundefined
6030   \let\linenumber = \empty % Pre-3.0.
6031 \else
6032   \def\linenumber{\the\inputlineno:\space}
6033 \fi
6034
6035 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6036 % If its value is nonempty, SUFFIX is output afterward.
6037 %
6038 \def\refx#1#2{%
6039   {%
6040     \indexnofonts
6041     \otherbackslash
6042     \expandafter\global\expandafter\let\expandafter\thisrefX
6043       \csname X#1\endcsname
6044   }%
6045   \ifx\thisrefX\relax
6046     % If not defined, say something at least.
6047     \angleleft un\-de\-fined\angleright
6048     \iflinks
6049       \ifhavexrefs
6050         \message{\linenumber Undefined cross reference `#1'.}%
6051       \else
6052         \ifwarnedxrefs\else
6053           \global\warnedxrefstrue
6054           \message{Cross reference values unknown; you must run TeX again.}%
6055         \fi
6056       \fi
6057     \fi
6058   \else
6059     % It's defined, so just use it.
6060     \thisrefX
6061   \fi
6062   #2% Output the suffix in any case.
6063 }
6064
6065 % This is the macro invoked by entries in the aux file.
6066 %
6067 \def\xrdef#1{\expandafter\gdef\csname X#1\endcsname}
6068
6069 % Read the last existing aux file, if any.  No error if none exists.
6070 % Open the new one.
6071
6072 \def\readauxfile{\begingroup
6073   \catcode`\^^@=\other
6074   \catcode`\^^A=\other
6075   \catcode`\^^B=\other
6076   \catcode`\^^C=\other
6077   \catcode`\^^D=\other
6078   \catcode`\^^E=\other
6079   \catcode`\^^F=\other
6080   \catcode`\^^G=\other
6081   \catcode`\^^H=\other
6082   \catcode`\^^K=\other
6083   \catcode`\^^L=\other
6084   \catcode`\^^N=\other
6085   \catcode`\^^P=\other
6086   \catcode`\^^Q=\other
6087   \catcode`\^^R=\other
6088   \catcode`\^^S=\other
6089   \catcode`\^^T=\other
6090   \catcode`\^^U=\other
6091   \catcode`\^^V=\other
6092   \catcode`\^^W=\other
6093   \catcode`\^^X=\other
6094   \catcode`\^^Z=\other
6095   \catcode`\^^[=\other
6096   \catcode`\^^\=\other
6097   \catcode`\^^]=\other
6098   \catcode`\^^^=\other
6099   \catcode`\^^_=\other
6100   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6101   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
6102   % supported in the main text, it doesn't seem desirable.  Furthermore,
6103   % that is not enough: for node names that actually contain a ^
6104   % character, we would end up writing a line like this: 'xrdef {'hat
6105   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6106   % argument, and \hat is not an expandable control sequence.  It could
6107   % all be worked out, but why?  Either we support ^^ or we don't.
6108   %
6109   % The other change necessary for this was to define \auxhat:
6110   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6111   % and then to call \auxhat in \setq.
6112   %
6113   \catcode`\^=\other
6114   %
6115   % Special characters.  Should be turned off anyway, but...
6116   \catcode`\~=\other
6117   \catcode`\[=\other
6118   \catcode`\]=\other
6119   \catcode`\"=\other
6120   \catcode`\_=\other
6121   \catcode`\|=\other
6122   \catcode`\<=\other
6123   \catcode`\>=\other
6124   \catcode`\$=\other
6125   \catcode`\#=\other
6126   \catcode`\&=\other
6127   \catcode`\%=\other
6128   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6129   %
6130   % Make the characters 128-255 be printing characters
6131   {%
6132     \count 1=128
6133     \def\loop{%
6134       \catcode\count 1=\other
6135       \advance\count 1 by 1
6136       \ifnum \count 1<256 \loop \fi
6137     }%
6138   }%
6139   %
6140   % Turn off \ as an escape so we do not lose on
6141   % entries which were dumped with control sequences in their names.
6142   % For example, @xrdef{$\leq $-fun}{page ...} made by @defun ^^
6143   % Reference to such entries still does not work the way one would wish,
6144   % but at least they do not bomb out when the aux file is read in.
6145   \catcode`\\=\other
6146   %
6147   % @ is our escape character in .aux files.
6148   \catcode`\{=1
6149   \catcode`\}=2
6150   \catcode`\@=0
6151   %
6152   \openin 1 \jobname.aux
6153   \ifeof 1 \else
6154     \closein 1
6155     \input \jobname.aux
6156     \global\havexrefstrue
6157   \fi
6158   % Open the new aux file right away (otherwise the \immediate's in
6159   % \setref cause spurious terminal output).  TeX will close it
6160   % automatically at exit.
6161   \immediate\openout\auxfile=\jobname.aux
6162 \endgroup}
6163
6164
6165 % Footnotes.
6166
6167 \newcount \footnoteno
6168
6169 % The trailing space in the following definition for supereject is
6170 % vital for proper filling; pages come out unaligned when you do a
6171 % pagealignmacro call if that space before the closing brace is
6172 % removed. (Generally, numeric constants should always be followed by a
6173 % space to prevent strange expansion errors.)
6174 \def\supereject{\par\penalty -20000\footnoteno =0 }
6175
6176 % @footnotestyle is meaningful for info output only.
6177 \let\footnotestyle=\comment
6178
6179 \let\ptexfootnote=\footnote
6180
6181 {\catcode `\@=11
6182 %
6183 % Auto-number footnotes.  Otherwise like plain.
6184 \gdef\footnote{%
6185   \let\indent=\ptexindent
6186   \let\noindent=\ptexnoindent
6187   \global\advance\footnoteno by \@ne
6188   \edef\thisfootno{$^{\the\footnoteno}$}%
6189   %
6190   % In case the footnote comes at the end of a sentence, preserve the
6191   % extra spacing after we do the footnote number.
6192   \let\@sf\empty
6193   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6194   %
6195   % Remove inadvertent blank space before typesetting the footnote number.
6196   \unskip
6197   \thisfootno\@sf
6198   \dofootnote
6199 }%
6200
6201 % Don't bother with the trickery in plain.tex to not require the
6202 % footnote text as a parameter.  Our footnotes don't need to be so general.
6203 %
6204 % Oh yes, they do; otherwise, @ifset and anything else that uses
6205 % \parseargline fail inside footnotes because the tokens are fixed when
6206 % the footnote is read.  --karl, 16nov96.
6207 %
6208 % The start of the footnote looks usually like this:
6209 \gdef\startfootins{\insert\footins\bgroup}
6210 %
6211 % ... but this macro is redefined inside @multitable.
6212 %
6213 \gdef\dofootnote{%
6214   \startfootins
6215   % We want to typeset this text as a normal paragraph, even if the
6216   % footnote reference occurs in (for example) a display environment.
6217   % So reset some parameters.
6218   \hsize=\pagewidth
6219   \interlinepenalty\interfootnotelinepenalty
6220   \splittopskip\ht\strutbox % top baseline for broken footnotes
6221   \splitmaxdepth\dp\strutbox
6222   \floatingpenalty\@MM
6223   \leftskip\z@skip
6224   \rightskip\z@skip
6225   \spaceskip\z@skip
6226   \xspaceskip\z@skip
6227   \parindent\defaultparindent
6228   %
6229   \smallfonts \rm
6230   %
6231   % Because we use hanging indentation in footnotes, a @noindent appears
6232   % to exdent this text, so make it be a no-op.  makeinfo does not use
6233   % hanging indentation so @noindent can still be needed within footnote
6234   % text after an @example or the like (not that this is good style).
6235   \let\noindent = \relax
6236   %
6237   % Hang the footnote text off the number.  Use \everypar in case the
6238   % footnote extends for more than one paragraph.
6239   \everypar = {\hang}%
6240   \textindent{\thisfootno}%
6241   %
6242   % Don't crash into the line above the footnote text.  Since this
6243   % expands into a box, it must come within the paragraph, lest it
6244   % provide a place where TeX can split the footnote.
6245   \footstrut
6246   \futurelet\next\fo@t
6247 }
6248 }%end \catcode `\@=11
6249
6250 % @| inserts a changebar to the left of the current line.  It should
6251 % surround any changed text.  This approach does *not* work if the
6252 % change spans more than two lines of output.  To handle that, we would
6253 % have adopt a much more difficult approach (putting marks into the main
6254 % vertical list for the beginning and end of each change).
6255 %
6256 \def\|{%
6257   % \vadjust can only be used in horizontal mode.
6258   \leavevmode
6259   %
6260   % Append this vertical mode material after the current line in the output.
6261   \vadjust{%
6262     % We want to insert a rule with the height and depth of the current
6263     % leading; that is exactly what \strutbox is supposed to record.
6264     \vskip-\baselineskip
6265     %
6266     % \vadjust-items are inserted at the left edge of the type.  So
6267     % the \llap here moves out into the left-hand margin.
6268     \llap{%
6269       %
6270       % For a thicker or thinner bar, change the `1pt'.
6271       \vrule height\baselineskip width1pt
6272       %
6273       % This is the space between the bar and the text.
6274       \hskip 12pt
6275     }%
6276   }%
6277 }
6278
6279 % For a final copy, take out the rectangles
6280 % that mark overfull boxes (in case you have decided
6281 % that the text looks ok even though it passes the margin).
6282 %
6283 \def\finalout{\overfullrule=0pt}
6284
6285 % @image.  We use the macros from epsf.tex to support this.
6286 % If epsf.tex is not installed and @image is used, we complain.
6287 %
6288 % Check for and read epsf.tex up front.  If we read it only at @image
6289 % time, we might be inside a group, and then its definitions would get
6290 % undone and the next image would fail.
6291 \openin 1 = epsf.tex
6292 \ifeof 1 \else
6293   \closein 1
6294   % Do not bother showing banner with epsf.tex v2.7k (available in
6295   % doc/epsf.tex and on ctan).
6296   \def\epsfannounce{\toks0 = }%
6297   \input epsf.tex
6298 \fi
6299 %
6300 % We will only complain once about lack of epsf.tex.
6301 \newif\ifwarnednoepsf
6302 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6303   work.  It is also included in the Texinfo distribution, or you can get
6304   it from ftp://tug.org/tex/epsf.tex.}
6305 %
6306 \def\image#1{%
6307   \ifx\epsfbox\undefined
6308     \ifwarnednoepsf \else
6309       \errhelp = \noepsfhelp
6310       \errmessage{epsf.tex not found, images will be ignored}%
6311       \global\warnednoepsftrue
6312     \fi
6313   \else
6314     \imagexxx #1,,,,,\finish
6315   \fi
6316 }
6317 %
6318 % Arguments to @image:
6319 % #1 is (mandatory) image filename; we tack on .eps extension.
6320 % #2 is (optional) width, #3 is (optional) height.
6321 % #4 is (ignored optional) html alt text.
6322 % #5 is (ignored optional) extension.
6323 % #6 is just the usual extra ignored arg for parsing this stuff.
6324 \newif\ifimagevmode
6325 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6326   \catcode`\^^M = 5     % in case we're inside an example
6327   \normalturnoffactive  % allow _ et al. in names
6328   % If the image is by itself, center it.
6329   \ifvmode
6330     \imagevmodetrue
6331     \nobreak\bigskip
6332     % Usually we'll have text after the image which will insert
6333     % \parskip glue, so insert it here too to equalize the space
6334     % above and below.
6335     \nobreak\vskip\parskip
6336     \nobreak
6337     \line\bgroup\hss
6338   \fi
6339   %
6340   % Output the image.
6341   \ifpdf
6342     \dopdfimage{#1}{#2}{#3}%
6343   \else
6344     % \epsfbox itself resets \epsf?size at each figure.
6345     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6346     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6347     \epsfbox{#1.eps}%
6348   \fi
6349   %
6350   \ifimagevmode \hss \egroup \bigbreak \fi  % space after the image
6351 \endgroup}
6352
6353
6354 \message{localization,}
6355 % and i18n.
6356
6357 % @documentlanguage is usually given very early, just after
6358 % @setfilename.  If done too late, it may not override everything
6359 % properly.  Single argument is the language abbreviation.
6360 % It would be nice if we could set up a hyphenation file here.
6361 %
6362 \def\documentlanguage{\parsearg\dodocumentlanguage}
6363 \def\dodocumentlanguage#1{%
6364   \tex % read txi-??.tex file in plain TeX.
6365   % Read the file if it exists.
6366   \openin 1 txi-#1.tex
6367   \ifeof1
6368     \errhelp = \nolanghelp
6369     \errmessage{Cannot read language file txi-#1.tex}%
6370     \let\temp = \relax
6371   \else
6372     \def\temp{\input txi-#1.tex }%
6373   \fi
6374   \temp
6375   \endgroup
6376 }
6377 \newhelp\nolanghelp{The given language definition file cannot be found or
6378 is empty.  Maybe you need to install it?  In the current directory
6379 should work if nowhere else does.}
6380
6381
6382 % @documentencoding should change something in TeX eventually, most
6383 % likely, but for now just recognize it.
6384 \let\documentencoding = \comment
6385
6386
6387 % Page size parameters.
6388 %
6389 \newdimen\defaultparindent \defaultparindent = 15pt
6390
6391 \chapheadingskip = 15pt plus 4pt minus 2pt
6392 \secheadingskip = 12pt plus 3pt minus 2pt
6393 \subsecheadingskip = 9pt plus 2pt minus 2pt
6394
6395 % Prevent underfull vbox error messages.
6396 \vbadness = 10000
6397
6398 % Don't be so finicky about underfull hboxes, either.
6399 \hbadness = 2000
6400
6401 % Following George Bush, just get rid of widows and orphans.
6402 \widowpenalty=10000
6403 \clubpenalty=10000
6404
6405 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6406 % using an old version of TeX, don't do anything.  We want the amount of
6407 % stretch added to depend on the line length, hence the dependence on
6408 % \hsize.  We call this whenever the paper size is set.
6409 %
6410 \def\setemergencystretch{%
6411   \ifx\emergencystretch\thisisundefined
6412     % Allow us to assign to \emergencystretch anyway.
6413     \def\emergencystretch{\dimen0}%
6414   \else
6415     \emergencystretch = .15\hsize
6416   \fi
6417 }
6418
6419 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6420 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6421 % physical page width.
6422 %
6423 % We also call \setleading{\textleading}, so the caller should define
6424 % \textleading.  The caller should also set \parskip.
6425 %
6426 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6427   \voffset = #3\relax
6428   \topskip = #6\relax
6429   \splittopskip = \topskip
6430   %
6431   \vsize = #1\relax
6432   \advance\vsize by \topskip
6433   \outervsize = \vsize
6434   \advance\outervsize by 2\topandbottommargin
6435   \pageheight = \vsize
6436   %
6437   \hsize = #2\relax
6438   \outerhsize = \hsize
6439   \advance\outerhsize by 0.5in
6440   \pagewidth = \hsize
6441   %
6442   \normaloffset = #4\relax
6443   \bindingoffset = #5\relax
6444   %
6445   \ifpdf
6446     \pdfpageheight #7\relax
6447     \pdfpagewidth #8\relax
6448   \fi
6449   %
6450   \setleading{\textleading}
6451   %
6452   \parindent = \defaultparindent
6453   \setemergencystretch
6454 }
6455
6456 % @letterpaper (the default).
6457 \def\letterpaper{{\globaldefs = 1
6458   \parskip = 3pt plus 2pt minus 1pt
6459   \textleading = 13.2pt
6460   %
6461   % If page is nothing but text, make it come out even.
6462   \internalpagesizes{46\baselineskip}{6in}%
6463                     {\voffset}{.25in}%
6464                     {\bindingoffset}{36pt}%
6465                     {11in}{8.5in}%
6466 }}
6467
6468 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6469 \def\smallbook{{\globaldefs = 1
6470   \parskip = 2pt plus 1pt
6471   \textleading = 12pt
6472   %
6473   \internalpagesizes{7.5in}{5in}%
6474                     {\voffset}{.25in}%
6475                     {\bindingoffset}{16pt}%
6476                     {9.25in}{7in}%
6477   %
6478   \lispnarrowing = 0.3in
6479   \tolerance = 700
6480   \hfuzz = 1pt
6481   \contentsrightmargin = 0pt
6482   \defbodyindent = .5cm
6483 }}
6484
6485 % Use @afourpaper to print on European A4 paper.
6486 \def\afourpaper{{\globaldefs = 1
6487   \parskip = 3pt plus 2pt minus 1pt
6488   \textleading = 13.2pt
6489   %
6490   % Double-side printing via postscript on Laserjet 4050
6491   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6492   % To change the settings for a different printer or situation, adjust
6493   % \normaloffset until the front-side and back-side texts align.  Then
6494   % do the same for \bindingoffset.  You can set these for testing in
6495   % your texinfo source file like this:
6496   % @tex
6497   % \global\normaloffset = -6mm
6498   % \global\bindingoffset = 10mm
6499   % @end tex
6500   \internalpagesizes{51\baselineskip}{160mm}
6501                     {\voffset}{\hoffset}%
6502                     {\bindingoffset}{44pt}%
6503                     {297mm}{210mm}%
6504   %
6505   \tolerance = 700
6506   \hfuzz = 1pt
6507   \contentsrightmargin = 0pt
6508   \defbodyindent = 5mm
6509 }}
6510
6511 % Use @afivepaper to print on European A5 paper.
6512 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6513 % He also recommends making @example and @lisp be small.
6514 \def\afivepaper{{\globaldefs = 1
6515   \parskip = 2pt plus 1pt minus 0.1pt
6516   \textleading = 12.5pt
6517   %
6518   \internalpagesizes{160mm}{120mm}%
6519                     {\voffset}{\hoffset}%
6520                     {\bindingoffset}{8pt}%
6521                     {210mm}{148mm}%
6522   %
6523   \lispnarrowing = 0.2in
6524   \tolerance = 800
6525   \hfuzz = 1.2pt
6526   \contentsrightmargin = 0pt
6527   \defbodyindent = 2mm
6528   \tableindent = 12mm
6529 }}
6530
6531 % A specific text layout, 24x15cm overall, intended for A4 paper.
6532 \def\afourlatex{{\globaldefs = 1
6533   \afourpaper
6534   \internalpagesizes{237mm}{150mm}%
6535                     {\voffset}{4.6mm}%
6536                     {\bindingoffset}{7mm}%
6537                     {297mm}{210mm}%
6538   %
6539   % Must explicitly reset to 0 because we call \afourpaper.
6540   \globaldefs = 0
6541 }}
6542
6543 % Use @afourwide to print on A4 paper in landscape format.
6544 \def\afourwide{{\globaldefs = 1
6545   \afourpaper
6546   \internalpagesizes{241mm}{165mm}%
6547                     {\voffset}{-2.95mm}%
6548                     {\bindingoffset}{7mm}%
6549                     {297mm}{210mm}%
6550   \globaldefs = 0
6551 }}
6552
6553 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6554 % Perhaps we should allow setting the margins, \topskip, \parskip,
6555 % and/or leading, also. Or perhaps we should compute them somehow.
6556 %
6557 \def\pagesizes{\parsearg\pagesizesxxx}
6558 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6559 \def\pagesizesyyy#1,#2,#3\finish{{%
6560   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6561   \globaldefs = 1
6562   %
6563   \parskip = 3pt plus 2pt minus 1pt
6564   \setleading{\textleading}%
6565   %
6566   \dimen0 = #1
6567   \advance\dimen0 by \voffset
6568   %
6569   \dimen2 = \hsize
6570   \advance\dimen2 by \normaloffset
6571   %
6572   \internalpagesizes{#1}{\hsize}%
6573                     {\voffset}{\normaloffset}%
6574                     {\bindingoffset}{44pt}%
6575                     {\dimen0}{\dimen2}%
6576 }}
6577
6578 % Set default to letter.
6579 %
6580 \letterpaper
6581
6582
6583 \message{and turning on texinfo input format.}
6584
6585 % Define macros to output various characters with catcode for normal text.
6586 \catcode`\"=\other
6587 \catcode`\~=\other
6588 \catcode`\^=\other
6589 \catcode`\_=\other
6590 \catcode`\|=\other
6591 \catcode`\<=\other
6592 \catcode`\>=\other
6593 \catcode`\+=\other
6594 \catcode`\$=\other
6595 \def\normaldoublequote{"}
6596 \def\normaltilde{~}
6597 \def\normalcaret{^}
6598 \def\normalunderscore{_}
6599 \def\normalverticalbar{|}
6600 \def\normalless{<}
6601 \def\normalgreater{>}
6602 \def\normalplus{+}
6603 \def\normaldollar{$}%$ font-lock fix
6604
6605 % This macro is used to make a character print one way in ttfont
6606 % where it can probably just be output, and another way in other fonts,
6607 % where something hairier probably needs to be done.
6608 %
6609 % #1 is what to print if we are indeed using \tt; #2 is what to print
6610 % otherwise.  Since all the Computer Modern typewriter fonts have zero
6611 % interword stretch (and shrink), and it is reasonable to expect all
6612 % typewriter fonts to have this, we can check that font parameter.
6613 %
6614 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6615
6616 % Same as above, but check for italic font.  Actually this also catches
6617 % non-italic slanted fonts since it is impossible to distinguish them from
6618 % italic fonts.  But since this is only used by $ and it uses \sl anyway
6619 % this is not a problem.
6620 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6621
6622 % Turn off all special characters except @
6623 % (and those which the user can use as if they were ordinary).
6624 % Most of these we simply print from the \tt font, but for some, we can
6625 % use math or other variants that look better in normal text.
6626
6627 \catcode`\"=\active
6628 \def\activedoublequote{{\tt\char34}}
6629 \let"=\activedoublequote
6630 \catcode`\~=\active
6631 \def~{{\tt\char126}}
6632 \chardef\hat=`\^
6633 \catcode`\^=\active
6634 \def^{{\tt \hat}}
6635
6636 \catcode`\_=\active
6637 \def_{\ifusingtt\normalunderscore\_}
6638 % Subroutine for the previous macro.
6639 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6640
6641 \catcode`\|=\active
6642 \def|{{\tt\char124}}
6643 \chardef \less=`\<
6644 \catcode`\<=\active
6645 \def<{{\tt \less}}
6646 \chardef \gtr=`\>
6647 \catcode`\>=\active
6648 \def>{{\tt \gtr}}
6649 \catcode`\+=\active
6650 \def+{{\tt \char 43}}
6651 \catcode`\$=\active
6652 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6653
6654 % Set up an active definition for =, but don't enable it most of the time.
6655 {\catcode`\==\active
6656 \global\def={{\tt \char 61}}}
6657
6658 \catcode`+=\active
6659 \catcode`\_=\active
6660
6661 % If a .fmt file is being used, characters that might appear in a file
6662 % name cannot be active until we have parsed the command line.
6663 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6664 % \otherifyactive is called near the end of this file.
6665 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6666
6667 \catcode`\@=0
6668
6669 % \rawbackslashxx outputs one backslash character in current font,
6670 % as in \char`\\.
6671 \global\chardef\rawbackslashxx=`\\
6672
6673 % \rawbackslash defines an active \ to do \rawbackslashxx.
6674 % \otherbackslash defines an active \ to be a literal `\' character with
6675 % catcode other.
6676 {\catcode`\\=\active
6677  @gdef@rawbackslash{@let\=@rawbackslashxx}
6678  @gdef@otherbackslash{@let\=@realbackslash}
6679 }
6680
6681 % \realbackslash is an actual character `\' with catcode other.
6682 {\catcode`\\=\other @gdef@realbackslash{\}}
6683
6684 % \normalbackslash outputs one backslash in fixed width font.
6685 \def\normalbackslash{{\tt\rawbackslashxx}}
6686
6687 \catcode`\\=\active
6688
6689 % Used sometimes to turn off (effectively) the active characters
6690 % even after parsing them.
6691 @def@turnoffactive{%
6692   @let"=@normaldoublequote
6693   @let\=@realbackslash
6694   @let~=@normaltilde
6695   @let^=@normalcaret
6696   @let_=@normalunderscore
6697   @let|=@normalverticalbar
6698   @let<=@normalless
6699   @let>=@normalgreater
6700   @let+=@normalplus
6701   @let$=@normaldollar %$ font-lock fix
6702 }
6703
6704 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6705 % the literal character `\'.  (Thus, \ is not expandable when this is in
6706 % effect.)
6707 %
6708 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6709
6710 % Make _ and + \other characters, temporarily.
6711 % This is canceled by @fixbackslash.
6712 @otherifyactive
6713
6714 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6715 % That is what \eatinput is for; after that, the `\' should revert to printing
6716 % a backslash.
6717 %
6718 @gdef@eatinput input texinfo{@fixbackslash}
6719 @global@let\ = @eatinput
6720
6721 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6722 % the first `\{ in the file would cause an error. This macro tries to fix
6723 % that, assuming it is called before the first `\' could plausibly occur.
6724 % Also back turn on active characters that might appear in the input
6725 % file name, in case not using a pre-dumped format.
6726 %
6727 @gdef@fixbackslash{%
6728   @ifx\@eatinput @let\ = @normalbackslash @fi
6729   @catcode`+=@active
6730   @catcode`@_=@active
6731 }
6732
6733 % Say @foo, not \foo, in error messages.
6734 @escapechar = `@@
6735
6736 % These look ok in all fonts, so just make them not special.
6737 @catcode`@& = @other
6738 @catcode`@# = @other
6739 @catcode`@% = @other
6740
6741 @c Set initial fonts.
6742 @textfonts
6743 @rm
6744
6745
6746 @c Local variables:
6747 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6748 @c page-delimiter: "^\\\\message"
6749 @c time-stamp-start: "def\\\\texinfoversion{"
6750 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6751 @c time-stamp-end: "}"
6752 @c End:
6753
6754 @c vim:sw=2:
6755
6756 @ignore
6757    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
6758 @end ignore