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