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