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