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