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