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