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