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