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