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