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