COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/texinfo.tex @ 462:0ab31578af67

Last change on this file since 462:0ab31578af67 was 18:7c88989ea45b, checked in by Alpar Juttner, 16 years ago

A documentation proposal using texinfo.

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