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