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