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