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