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