Version number is increased to 2.5.0.
[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-27.17}
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\defcodeindex{\parsearg\newcodeindex}
2611 %
2612 \def\newcodeindex#1{%
2613   \iflinks
2614     \expandafter\newwrite \csname#1indfile\endcsname
2615     \openout \csname#1indfile\endcsname \jobname.#1
2616   \fi
2617   \expandafter\xdef\csname#1index\endcsname{%
2618     \noexpand\docodeindex{#1}}%
2619 }
2620
2621
2622 % @synindex foo bar    makes index foo feed into index bar.
2623 % Do this instead of @defindex foo if you don't want it as a separate index.
2624
2625 % @syncodeindex foo bar   similar, but put all entries made for index foo
2626 % inside @code.
2627
2628 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2629 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2630
2631 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2632 % #3 the target index (bar).
2633 \def\dosynindex#1#2#3{%
2634   % Only do \closeout if we haven't already done it, else we'll end up
2635   % closing the target index.
2636   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2637     % The \closeout helps reduce unnecessary open files; the limit on the
2638     % Acorn RISC OS is a mere 16 files.
2639     \expandafter\closeout\csname#2indfile\endcsname
2640     \expandafter\let\csname\donesynindex#2\endcsname = 1
2641   \fi
2642   % redefine \fooindfile:
2643   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2644   \expandafter\let\csname#2indfile\endcsname=\temp
2645   % redefine \fooindex:
2646   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2647 }
2648
2649 % Define \doindex, the driver for all \fooindex macros.
2650 % Argument #1 is generated by the calling \fooindex macro,
2651 %  and it is "foo", the name of the index.
2652
2653 % \doindex just uses \parsearg; it calls \doind for the actual work.
2654 % This is because \doind is more useful to call from other macros.
2655
2656 % There is also \dosubind {index}{topic}{subtopic}
2657 % which makes an entry in a two-level index such as the operation index.
2658
2659 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2660 \def\singleindexer #1{\doind{\indexname}{#1}}
2661
2662 % like the previous two, but they put @code around the argument.
2663 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2664 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2665
2666 \def\indexdummies{%
2667 \def\ { }%
2668 % Take care of the plain tex accent commands.
2669 \def\"{\realbackslash "}%
2670 \def\`{\realbackslash `}%
2671 \def\'{\realbackslash '}%
2672 \def\^{\realbackslash ^}%
2673 \def\~{\realbackslash ~}%
2674 \def\={\realbackslash =}%
2675 \def\b{\realbackslash b}%
2676 \def\c{\realbackslash c}%
2677 \def\d{\realbackslash d}%
2678 \def\u{\realbackslash u}%
2679 \def\v{\realbackslash v}%
2680 \def\H{\realbackslash H}%
2681 % Take care of the plain tex special European modified letters.
2682 \def\oe{\realbackslash oe}%
2683 \def\ae{\realbackslash ae}%
2684 \def\aa{\realbackslash aa}%
2685 \def\OE{\realbackslash OE}%
2686 \def\AE{\realbackslash AE}%
2687 \def\AA{\realbackslash AA}%
2688 \def\o{\realbackslash o}%
2689 \def\O{\realbackslash O}%
2690 \def\l{\realbackslash l}%
2691 \def\L{\realbackslash L}%
2692 \def\ss{\realbackslash ss}%
2693 % Take care of texinfo commands likely to appear in an index entry.
2694 % (Must be a way to avoid doing expansion at all, and thus not have to
2695 % laboriously list every single command here.)
2696 \def\@{@}% will be @@ when we switch to @ as escape char.
2697 % Need these in case \tex is in effect and \{ is a \delimiter again.
2698 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2699 % braces and backslashes are used only as delimiters.  
2700 \let\{ = \mylbrace
2701 \let\} = \myrbrace
2702 \def\_{{\realbackslash _}}%
2703 \def\w{\realbackslash w }%
2704 \def\bf{\realbackslash bf }%
2705 %\def\rm{\realbackslash rm }%
2706 \def\sl{\realbackslash sl }%
2707 \def\sf{\realbackslash sf}%
2708 \def\tt{\realbackslash tt}%
2709 \def\gtr{\realbackslash gtr}%
2710 \def\less{\realbackslash less}%
2711 \def\hat{\realbackslash hat}%
2712 \def\TeX{\realbackslash TeX}%
2713 \def\dots{\realbackslash dots }%
2714 \def\result{\realbackslash result}%
2715 \def\equiv{\realbackslash equiv}%
2716 \def\expansion{\realbackslash expansion}%
2717 \def\print{\realbackslash print}%
2718 \def\error{\realbackslash error}%
2719 \def\point{\realbackslash point}%
2720 \def\copyright{\realbackslash copyright}%
2721 \def\tclose##1{\realbackslash tclose {##1}}%
2722 \def\code##1{\realbackslash code {##1}}%
2723 \def\uref##1{\realbackslash uref {##1}}%
2724 \def\url##1{\realbackslash url {##1}}%
2725 \def\env##1{\realbackslash env {##1}}%
2726 \def\command##1{\realbackslash command {##1}}%
2727 \def\option##1{\realbackslash option {##1}}%
2728 \def\dotless##1{\realbackslash dotless {##1}}%
2729 \def\samp##1{\realbackslash samp {##1}}%
2730 \def\,##1{\realbackslash ,{##1}}%
2731 \def\t##1{\realbackslash t {##1}}%
2732 \def\r##1{\realbackslash r {##1}}%
2733 \def\i##1{\realbackslash i {##1}}%
2734 \def\b##1{\realbackslash b {##1}}%
2735 \def\sc##1{\realbackslash sc {##1}}%
2736 \def\cite##1{\realbackslash cite {##1}}%
2737 \def\key##1{\realbackslash key {##1}}%
2738 \def\file##1{\realbackslash file {##1}}%
2739 \def\var##1{\realbackslash var {##1}}%
2740 \def\kbd##1{\realbackslash kbd {##1}}%
2741 \def\dfn##1{\realbackslash dfn {##1}}%
2742 \def\emph##1{\realbackslash emph {##1}}%
2743 \def\acronym##1{\realbackslash acronym {##1}}%
2744 %
2745 % Handle some cases of @value -- where the variable name does not
2746 % contain - or _, and the value does not contain any
2747 % (non-fully-expandable) commands.
2748 \let\value = \expandablevalue
2749 %
2750 \unsepspaces
2751 % Turn off macro expansion
2752 \turnoffmacros
2753 }
2754
2755 % If an index command is used in an @example environment, any spaces
2756 % therein should become regular spaces in the raw index file, not the
2757 % expansion of \tie (\\leavevmode \penalty \@M \ ).
2758 {\obeyspaces
2759  \gdef\unsepspaces{\obeyspaces\let =\space}}
2760
2761 % \indexnofonts no-ops all font-change commands.
2762 % This is used when outputting the strings to sort the index by.
2763 \def\indexdummyfont#1{#1}
2764 \def\indexdummytex{TeX}
2765 \def\indexdummydots{...}
2766
2767 \def\indexnofonts{%
2768 % Just ignore accents.
2769 \let\,=\indexdummyfont
2770 \let\"=\indexdummyfont
2771 \let\`=\indexdummyfont
2772 \let\'=\indexdummyfont
2773 \let\^=\indexdummyfont
2774 \let\~=\indexdummyfont
2775 \let\==\indexdummyfont
2776 \let\b=\indexdummyfont
2777 \let\c=\indexdummyfont
2778 \let\d=\indexdummyfont
2779 \let\u=\indexdummyfont
2780 \let\v=\indexdummyfont
2781 \let\H=\indexdummyfont
2782 \let\dotless=\indexdummyfont
2783 % Take care of the plain tex special European modified letters.
2784 \def\oe{oe}%
2785 \def\ae{ae}%
2786 \def\aa{aa}%
2787 \def\OE{OE}%
2788 \def\AE{AE}%
2789 \def\AA{AA}%
2790 \def\o{o}%
2791 \def\O{O}%
2792 \def\l{l}%
2793 \def\L{L}%
2794 \def\ss{ss}%
2795 \let\w=\indexdummyfont
2796 \let\t=\indexdummyfont
2797 \let\r=\indexdummyfont
2798 \let\i=\indexdummyfont
2799 \let\b=\indexdummyfont
2800 \let\emph=\indexdummyfont
2801 \let\strong=\indexdummyfont
2802 \let\cite=\indexdummyfont
2803 \let\sc=\indexdummyfont
2804 %Don't no-op \tt, since it isn't a user-level command
2805 % and is used in the definitions of the active chars like <, >, |...
2806 %\let\tt=\indexdummyfont
2807 \let\tclose=\indexdummyfont
2808 \let\code=\indexdummyfont
2809 \let\url=\indexdummyfont
2810 \let\uref=\indexdummyfont
2811 \let\env=\indexdummyfont
2812 \let\acronym=\indexdummyfont
2813 \let\command=\indexdummyfont
2814 \let\option=\indexdummyfont
2815 \let\file=\indexdummyfont
2816 \let\samp=\indexdummyfont
2817 \let\kbd=\indexdummyfont
2818 \let\key=\indexdummyfont
2819 \let\var=\indexdummyfont
2820 \let\TeX=\indexdummytex
2821 \let\dots=\indexdummydots
2822 \def\@{@}%
2823 }
2824
2825 % To define \realbackslash, we must make \ not be an escape.
2826 % We must first make another character (@) an escape
2827 % so we do not become unable to do a definition.
2828
2829 {\catcode`\@=0 \catcode`\\=\other
2830  @gdef@realbackslash{\}}
2831
2832 \let\indexbackslash=0  %overridden during \printindex.
2833 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2834
2835 % For \ifx comparisons.
2836 \def\emptymacro{\empty}
2837
2838 % Most index entries go through here, but \dosubind is the general case.
2839 %
2840 \def\doind#1#2{\dosubind{#1}{#2}\empty}
2841
2842 % Workhorse for all \fooindexes.
2843 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2844 % \empty if called from \doind, as we usually are.  The main exception
2845 % is with defuns, which call us directly.
2846 %
2847 \def\dosubind#1#2#3{%
2848   % Put the index entry in the margin if desired.
2849   \ifx\SETmarginindex\relax\else
2850     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2851   \fi
2852   {%
2853     \count255=\lastpenalty
2854     {%
2855       \indexdummies % Must do this here, since \bf, etc expand at this stage
2856       \escapechar=`\\
2857       {%
2858         \let\folio = 0% We will expand all macros now EXCEPT \folio.
2859         \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2860         % so it will be output as is; and it will print as backslash.
2861         %
2862         \def\thirdarg{#3}%
2863         %
2864         % If third arg is present, precede it with space in sort key.
2865         \ifx\thirdarg\emptymacro
2866           \let\subentry = \empty
2867         \else
2868           \def\subentry{ #3}%
2869         \fi
2870         %
2871         % First process the index entry with all font commands turned
2872         % off to get the string to sort by.
2873         {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
2874         %
2875         % Now the real index entry with the fonts.
2876         \toks0 = {#2}%
2877         %
2878         % If third (subentry) arg is present, add it to the index
2879         % string.  And include a space.
2880         \ifx\thirdarg\emptymacro \else
2881           \toks0 = \expandafter{\the\toks0 \space #3}%
2882         \fi
2883         %
2884         % Set up the complete index entry, with both the sort key
2885         % and the original text, including any font commands.  We write
2886         % three arguments to \entry to the .?? file, texindex reduces to
2887         % two when writing the .??s sorted result.
2888         \edef\temp{%
2889           \write\csname#1indfile\endcsname{%
2890             \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2891         }%
2892         %
2893         % If a skip is the last thing on the list now, preserve it
2894         % by backing up by \lastskip, doing the \write, then inserting
2895         % the skip again.  Otherwise, the whatsit generated by the
2896         % \write will make \lastskip zero.  The result is that sequences
2897         % like this:
2898         % @end defun
2899         % @tindex whatever
2900         % @defun ...
2901         % will have extra space inserted, because the \medbreak in the
2902         % start of the @defun won't see the skip inserted by the @end of
2903         % the previous defun.
2904         %
2905         % But don't do any of this if we're not in vertical mode.  We
2906         % don't want to do a \vskip and prematurely end a paragraph.
2907         %
2908         % Avoid page breaks due to these extra skips, too.
2909         %
2910         \iflinks
2911           \ifvmode
2912             \skip0 = \lastskip
2913             \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
2914           \fi
2915           %
2916           \temp % do the write
2917           %
2918           %
2919           \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
2920         \fi
2921       }%
2922     }%
2923     \penalty\count255
2924   }%
2925 }
2926
2927 % The index entry written in the file actually looks like
2928 %  \entry {sortstring}{page}{topic}
2929 % or
2930 %  \entry {sortstring}{page}{topic}{subtopic}
2931 % The texindex program reads in these files and writes files
2932 % containing these kinds of lines:
2933 %  \initial {c}
2934 %     before the first topic whose initial is c
2935 %  \entry {topic}{pagelist}
2936 %     for a topic that is used without subtopics
2937 %  \primary {topic}
2938 %     for the beginning of a topic that is used with subtopics
2939 %  \secondary {subtopic}{pagelist}
2940 %     for each subtopic.
2941
2942 % Define the user-accessible indexing commands
2943 % @findex, @vindex, @kindex, @cindex.
2944
2945 \def\findex {\fnindex}
2946 \def\kindex {\kyindex}
2947 \def\cindex {\cpindex}
2948 \def\vindex {\vrindex}
2949 \def\tindex {\tpindex}
2950 \def\pindex {\pgindex}
2951
2952 \def\cindexsub {\begingroup\obeylines\cindexsub}
2953 {\obeylines %
2954 \gdef\cindexsub "#1" #2^^M{\endgroup %
2955 \dosubind{cp}{#2}{#1}}}
2956
2957 % Define the macros used in formatting output of the sorted index material.
2958
2959 % @printindex causes a particular index (the ??s file) to get printed.
2960 % It does not print any chapter heading (usually an @unnumbered).
2961 %
2962 \def\printindex{\parsearg\doprintindex}
2963 \def\doprintindex#1{\begingroup
2964   \dobreak \chapheadingskip{10000}%
2965   %
2966   \smallfonts \rm
2967   \tolerance = 9500
2968   \indexbreaks
2969   %
2970   % See if the index file exists and is nonempty.
2971   % Change catcode of @ here so that if the index file contains
2972   % \initial {@}
2973   % as its first line, TeX doesn't complain about mismatched braces
2974   % (because it thinks @} is a control sequence).
2975   \catcode`\@ = 11
2976   \openin 1 \jobname.#1s
2977   \ifeof 1
2978     % \enddoublecolumns gets confused if there is no text in the index,
2979     % and it loses the chapter title and the aux file entries for the
2980     % index.  The easiest way to prevent this problem is to make sure
2981     % there is some text.
2982     \putwordIndexNonexistent
2983   \else
2984     %
2985     % If the index file exists but is empty, then \openin leaves \ifeof
2986     % false.  We have to make TeX try to read something from the file, so
2987     % it can discover if there is anything in it.
2988     \read 1 to \temp
2989     \ifeof 1
2990       \putwordIndexIsEmpty
2991     \else
2992       % Index files are almost Texinfo source, but we use \ as the escape
2993       % character.  It would be better to use @, but that's too big a change
2994       % to make right now.
2995       \def\indexbackslash{\rawbackslashxx}%
2996       \catcode`\\ = 0
2997       \escapechar = `\\
2998       \begindoublecolumns
2999       \input \jobname.#1s
3000       \enddoublecolumns
3001     \fi
3002   \fi
3003   \closein 1
3004 \endgroup}
3005
3006 % These macros are used by the sorted index file itself.
3007 % Change them to control the appearance of the index.
3008
3009 \def\initial#1{{%
3010   % Some minor font changes for the special characters.
3011   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3012   %
3013   % Remove any glue we may have, we'll be inserting our own.
3014   \removelastskip
3015   %
3016   % We like breaks before the index initials, so insert a bonus.
3017   \penalty -300
3018   %
3019   % Typeset the initial.  Making this add up to a whole number of
3020   % baselineskips increases the chance of the dots lining up from column
3021   % to column.  It still won't often be perfect, because of the stretch
3022   % we need before each entry, but it's better.
3023   %
3024   % No shrink because it confuses \balancecolumns.
3025   \vskip 1.67\baselineskip plus .5\baselineskip
3026   \leftline{\secbf #1}%
3027   \vskip .33\baselineskip plus .1\baselineskip
3028   %
3029   % Do our best not to break after the initial.
3030   \nobreak
3031 }}
3032
3033 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3034 % flush to the right margin.  It is used for index and table of contents
3035 % entries.  The paragraph is indented by \leftskip.
3036 %
3037 \def\entry#1#2{\begingroup
3038   %
3039   % Start a new paragraph if necessary, so our assignments below can't
3040   % affect previous text.
3041   \par
3042   %
3043   % Do not fill out the last line with white space.
3044   \parfillskip = 0in
3045   %
3046   % No extra space above this paragraph.
3047   \parskip = 0in
3048   %
3049   % Do not prefer a separate line ending with a hyphen to fewer lines.
3050   \finalhyphendemerits = 0
3051   %
3052   % \hangindent is only relevant when the entry text and page number
3053   % don't both fit on one line.  In that case, bob suggests starting the
3054   % dots pretty far over on the line.  Unfortunately, a large
3055   % indentation looks wrong when the entry text itself is broken across
3056   % lines.  So we use a small indentation and put up with long leaders.
3057   %
3058   % \hangafter is reset to 1 (which is the value we want) at the start
3059   % of each paragraph, so we need not do anything with that.
3060   \hangindent = 2em
3061   %
3062   % When the entry text needs to be broken, just fill out the first line
3063   % with blank space.
3064   \rightskip = 0pt plus1fil
3065   %
3066   % A bit of stretch before each entry for the benefit of balancing columns.
3067   \vskip 0pt plus1pt
3068   %
3069   % Start a ``paragraph'' for the index entry so the line breaking
3070   % parameters we've set above will have an effect.
3071   \noindent
3072   %
3073   % Insert the text of the index entry.  TeX will do line-breaking on it.
3074   #1%
3075   % The following is kludged to not output a line of dots in the index if
3076   % there are no page numbers.  The next person who breaks this will be
3077   % cursed by a Unix daemon.
3078   \def\tempa{{\rm }}%
3079   \def\tempb{#2}%
3080   \edef\tempc{\tempa}%
3081   \edef\tempd{\tempb}%
3082   \ifx\tempc\tempd\ \else%
3083     %
3084     % If we must, put the page number on a line of its own, and fill out
3085     % this line with blank space.  (The \hfil is overwhelmed with the
3086     % fill leaders glue in \indexdotfill if the page number does fit.)
3087     \hfil\penalty50
3088     \null\nobreak\indexdotfill % Have leaders before the page number.
3089     %
3090     % The `\ ' here is removed by the implicit \unskip that TeX does as
3091     % part of (the primitive) \par.  Without it, a spurious underfull
3092     % \hbox ensues.
3093     \ifpdf
3094       \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3095     \else
3096       \ #2% The page number ends the paragraph.
3097     \fi
3098   \fi%
3099   \par
3100 \endgroup}
3101
3102 % Like \dotfill except takes at least 1 em.
3103 \def\indexdotfill{\cleaders
3104   \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3105
3106 \def\primary #1{\line{#1\hfil}}
3107
3108 \newskip\secondaryindent \secondaryindent=0.5cm
3109
3110 \def\secondary #1#2{
3111 {\parfillskip=0in \parskip=0in
3112 \hangindent =1in \hangafter=1
3113 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
3114 }}
3115
3116 % Define two-column mode, which we use to typeset indexes.
3117 % Adapted from the TeXbook, page 416, which is to say,
3118 % the manmac.tex format used to print the TeXbook itself.
3119 \catcode`\@=11
3120
3121 \newbox\partialpage
3122 \newdimen\doublecolumnhsize
3123
3124 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3125   % Grab any single-column material above us.
3126   \output = {%
3127     %
3128     % Here is a possibility not foreseen in manmac: if we accumulate a
3129     % whole lot of material, we might end up calling this \output
3130     % routine twice in a row (see the doublecol-lose test, which is
3131     % essentially a couple of indexes with @setchapternewpage off).  In
3132     % that case we just ship out what is in \partialpage with the normal
3133     % output routine.  Generally, \partialpage will be empty when this
3134     % runs and this will be a no-op.  See the indexspread.tex test case.
3135     \ifvoid\partialpage \else
3136       \onepageout{\pagecontents\partialpage}%
3137     \fi
3138     %
3139     \global\setbox\partialpage = \vbox{%
3140       % Unvbox the main output page.
3141       \unvbox\PAGE
3142       \kern-\topskip \kern\baselineskip
3143     }%
3144   }%
3145   \eject % run that output routine to set \partialpage
3146   %
3147   % Use the double-column output routine for subsequent pages.
3148   \output = {\doublecolumnout}%
3149   %
3150   % Change the page size parameters.  We could do this once outside this
3151   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3152   % format, but then we repeat the same computation.  Repeating a couple
3153   % of assignments once per index is clearly meaningless for the
3154   % execution time, so we may as well do it in one place.
3155   %
3156   % First we halve the line length, less a little for the gutter between
3157   % the columns.  We compute the gutter based on the line length, so it
3158   % changes automatically with the paper format.  The magic constant
3159   % below is chosen so that the gutter has the same value (well, +-<1pt)
3160   % as it did when we hard-coded it.
3161   %
3162   % We put the result in a separate register, \doublecolumhsize, so we
3163   % can restore it in \pagesofar, after \hsize itself has (potentially)
3164   % been clobbered.
3165   %
3166   \doublecolumnhsize = \hsize
3167     \advance\doublecolumnhsize by -.04154\hsize
3168     \divide\doublecolumnhsize by 2
3169   \hsize = \doublecolumnhsize
3170   %
3171   % Double the \vsize as well.  (We don't need a separate register here,
3172   % since nobody clobbers \vsize.)
3173   \vsize = 2\vsize
3174 }
3175
3176 % The double-column output routine for all double-column pages except
3177 % the last.
3178 %
3179 \def\doublecolumnout{%
3180   \splittopskip=\topskip \splitmaxdepth=\maxdepth
3181   % Get the available space for the double columns -- the normal
3182   % (undoubled) page height minus any material left over from the
3183   % previous page.
3184   \dimen@ = \vsize
3185   \divide\dimen@ by 2
3186   \advance\dimen@ by -\ht\partialpage
3187   %
3188   % box0 will be the left-hand column, box2 the right.
3189   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3190   \onepageout\pagesofar
3191   \unvbox255
3192   \penalty\outputpenalty
3193 }
3194 %
3195 % Re-output the contents of the output page -- any previous material,
3196 % followed by the two boxes we just split, in box0 and box2.
3197 \def\pagesofar{%
3198   \unvbox\partialpage
3199   %
3200   \hsize = \doublecolumnhsize
3201   \wd0=\hsize \wd2=\hsize
3202   \hbox to\pagewidth{\box0\hfil\box2}%
3203 }
3204
3205 % All done with double columns.
3206 \def\enddoublecolumns{%
3207   \output = {%
3208     % Split the last of the double-column material.  Leave it on the
3209     % current page, no automatic page break.
3210     \balancecolumns
3211     %
3212     % If we end up splitting too much material for the current page,
3213     % though, there will be another page break right after this \output
3214     % invocation ends.  Having called \balancecolumns once, we do not
3215     % want to call it again.  Therefore, reset \output to its normal
3216     % definition right away.  (We hope \balancecolumns will never be
3217     % called on to balance too much material, but if it is, this makes
3218     % the output somewhat more palatable.)
3219     \global\output = {\onepageout{\pagecontents\PAGE}}%
3220   }%
3221   \eject
3222   \endgroup % started in \begindoublecolumns
3223   %
3224   % \pagegoal was set to the doubled \vsize above, since we restarted
3225   % the current page.  We're now back to normal single-column
3226   % typesetting, so reset \pagegoal to the normal \vsize (after the
3227   % \endgroup where \vsize got restored).
3228   \pagegoal = \vsize
3229 }
3230 %
3231 % Called at the end of the double column material.
3232 \def\balancecolumns{%
3233   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3234   \dimen@ = \ht0
3235   \advance\dimen@ by \topskip
3236   \advance\dimen@ by-\baselineskip
3237   \divide\dimen@ by 2 % target to split to
3238   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3239   \splittopskip = \topskip
3240   % Loop until we get a decent breakpoint.
3241   {%
3242     \vbadness = 10000
3243     \loop
3244       \global\setbox3 = \copy0
3245       \global\setbox1 = \vsplit3 to \dimen@
3246     \ifdim\ht3>\dimen@
3247       \global\advance\dimen@ by 1pt
3248     \repeat
3249   }%
3250   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3251   \setbox0=\vbox to\dimen@{\unvbox1}%
3252   \setbox2=\vbox to\dimen@{\unvbox3}%
3253   %
3254   \pagesofar
3255 }
3256 \catcode`\@ = \other
3257
3258
3259 \message{sectioning,}
3260 % Chapters, sections, etc.
3261
3262 \newcount\chapno
3263 \newcount\secno        \secno=0
3264 \newcount\subsecno     \subsecno=0
3265 \newcount\subsubsecno  \subsubsecno=0
3266
3267 % This counter is funny since it counts through charcodes of letters A, B, ...
3268 \newcount\appendixno  \appendixno = `\@
3269 % \def\appendixletter{\char\the\appendixno}
3270 % We do the following for the sake of pdftex, which needs the actual
3271 % letter in the expansion, not just typeset.
3272 \def\appendixletter{%
3273   \ifnum\appendixno=`A A%
3274   \else\ifnum\appendixno=`B B%
3275   \else\ifnum\appendixno=`C C%
3276   \else\ifnum\appendixno=`D D%
3277   \else\ifnum\appendixno=`E E%
3278   \else\ifnum\appendixno=`F F%
3279   \else\ifnum\appendixno=`G G%
3280   \else\ifnum\appendixno=`H H%
3281   \else\ifnum\appendixno=`I I%
3282   \else\ifnum\appendixno=`J J%
3283   \else\ifnum\appendixno=`K K%
3284   \else\ifnum\appendixno=`L L%
3285   \else\ifnum\appendixno=`M M%
3286   \else\ifnum\appendixno=`N N%
3287   \else\ifnum\appendixno=`O O%
3288   \else\ifnum\appendixno=`P P%
3289   \else\ifnum\appendixno=`Q Q%
3290   \else\ifnum\appendixno=`R R%
3291   \else\ifnum\appendixno=`S S%
3292   \else\ifnum\appendixno=`T T%
3293   \else\ifnum\appendixno=`U U%
3294   \else\ifnum\appendixno=`V V%
3295   \else\ifnum\appendixno=`W W%
3296   \else\ifnum\appendixno=`X X%
3297   \else\ifnum\appendixno=`Y Y%
3298   \else\ifnum\appendixno=`Z Z%
3299   % The \the is necessary, despite appearances, because \appendixletter is
3300   % expanded while writing the .toc file.  \char\appendixno is not
3301   % expandable, thus it is written literally, thus all appendixes come out
3302   % with the same letter (or @) in the toc without it.
3303   \else\char\the\appendixno
3304   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3305   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3306
3307 % Each @chapter defines this as the name of the chapter.
3308 % page headings and footings can use it.  @section does likewise.
3309 \def\thischapter{}
3310 \def\thissection{}
3311
3312 \newcount\absseclevel % used to calculate proper heading level
3313 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3314
3315 % @raisesections: treat @section as chapter, @subsection as section, etc.
3316 \def\raisesections{\global\advance\secbase by -1}
3317 \let\up=\raisesections % original BFox name
3318
3319 % @lowersections: treat @chapter as section, @section as subsection, etc.
3320 \def\lowersections{\global\advance\secbase by 1}
3321 \let\down=\lowersections % original BFox name
3322
3323 % Choose a numbered-heading macro
3324 % #1 is heading level if unmodified by @raisesections or @lowersections
3325 % #2 is text for heading
3326 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3327 \ifcase\absseclevel
3328   \chapterzzz{#2}
3329 \or
3330   \seczzz{#2}
3331 \or
3332   \numberedsubseczzz{#2}
3333 \or
3334   \numberedsubsubseczzz{#2}
3335 \else
3336   \ifnum \absseclevel<0
3337     \chapterzzz{#2}
3338   \else
3339     \numberedsubsubseczzz{#2}
3340   \fi
3341 \fi
3342 }
3343
3344 % like \numhead, but chooses appendix heading levels
3345 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3346 \ifcase\absseclevel
3347   \appendixzzz{#2}
3348 \or
3349   \appendixsectionzzz{#2}
3350 \or
3351   \appendixsubseczzz{#2}
3352 \or
3353   \appendixsubsubseczzz{#2}
3354 \else
3355   \ifnum \absseclevel<0
3356     \appendixzzz{#2}
3357   \else
3358     \appendixsubsubseczzz{#2}
3359   \fi
3360 \fi
3361 }
3362
3363 % like \numhead, but chooses numberless heading levels
3364 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3365 \ifcase\absseclevel
3366   \unnumberedzzz{#2}
3367 \or
3368   \unnumberedseczzz{#2}
3369 \or
3370   \unnumberedsubseczzz{#2}
3371 \or
3372   \unnumberedsubsubseczzz{#2}
3373 \else
3374   \ifnum \absseclevel<0
3375     \unnumberedzzz{#2}
3376   \else
3377     \unnumberedsubsubseczzz{#2}
3378   \fi
3379 \fi
3380 }
3381
3382 % @chapter, @appendix, @unnumbered.
3383 \def\thischaptername{No Chapter Title}
3384 \outer\def\chapter{\parsearg\chapteryyy}
3385 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3386 \def\chapterzzz #1{%
3387 \secno=0 \subsecno=0 \subsubsecno=0
3388 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3389 \chapmacro {#1}{\the\chapno}%
3390 \gdef\thissection{#1}%
3391 \gdef\thischaptername{#1}%
3392 % We don't substitute the actual chapter name into \thischapter
3393 % because we don't want its macros evaluated now.
3394 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3395 \toks0 = {#1}%
3396 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3397                                   {\the\chapno}}}%
3398 \temp
3399 \donoderef
3400 \global\let\section = \numberedsec
3401 \global\let\subsection = \numberedsubsec
3402 \global\let\subsubsection = \numberedsubsubsec
3403 }
3404
3405 \outer\def\appendix{\parsearg\appendixyyy}
3406 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3407 \def\appendixzzz #1{%
3408 \secno=0 \subsecno=0 \subsubsecno=0
3409 \global\advance \appendixno by 1
3410 \message{\putwordAppendix\space \appendixletter}%
3411 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3412 \gdef\thissection{#1}%
3413 \gdef\thischaptername{#1}%
3414 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3415 \toks0 = {#1}%
3416 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3417                        {\putwordAppendix{} \appendixletter}}}%
3418 \temp
3419 \appendixnoderef
3420 \global\let\section = \appendixsec
3421 \global\let\subsection = \appendixsubsec
3422 \global\let\subsubsection = \appendixsubsubsec
3423 }
3424
3425 % @centerchap is like @unnumbered, but the heading is centered.
3426 \outer\def\centerchap{\parsearg\centerchapyyy}
3427 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3428
3429 % @top is like @unnumbered.
3430 \outer\def\top{\parsearg\unnumberedyyy}
3431
3432 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3433 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3434 \def\unnumberedzzz #1{%
3435 \secno=0 \subsecno=0 \subsubsecno=0
3436 %
3437 % This used to be simply \message{#1}, but TeX fully expands the
3438 % argument to \message.  Therefore, if #1 contained @-commands, TeX
3439 % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
3440 % expanded @cite (which turns out to cause errors because \cite is meant
3441 % to be executed, not expanded).
3442 %
3443 % Anyway, we don't want the fully-expanded definition of @cite to appear
3444 % as a result of the \message, we just want `@cite' itself.  We use
3445 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3446 % simply yielding the contents of <toks register>.  (We also do this for
3447 % the toc entries.)
3448 \toks0 = {#1}\message{(\the\toks0)}%
3449 %
3450 \unnumbchapmacro {#1}%
3451 \gdef\thischapter{#1}\gdef\thissection{#1}%
3452 \toks0 = {#1}%
3453 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3454 \temp
3455 \unnumbnoderef
3456 \global\let\section = \unnumberedsec
3457 \global\let\subsection = \unnumberedsubsec
3458 \global\let\subsubsection = \unnumberedsubsubsec
3459 }
3460
3461 % Sections.
3462 \outer\def\numberedsec{\parsearg\secyyy}
3463 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3464 \def\seczzz #1{%
3465 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3466 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3467 \toks0 = {#1}%
3468 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3469                                   {\the\chapno}{\the\secno}}}%
3470 \temp
3471 \donoderef
3472 \nobreak
3473 }
3474
3475 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3476 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3477 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3478 \def\appendixsectionzzz #1{%
3479 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3480 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3481 \toks0 = {#1}%
3482 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3483                                   {\appendixletter}{\the\secno}}}%
3484 \temp
3485 \appendixnoderef
3486 \nobreak
3487 }
3488
3489 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3490 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3491 \def\unnumberedseczzz #1{%
3492 \plainsecheading {#1}\gdef\thissection{#1}%
3493 \toks0 = {#1}%
3494 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}%
3495 \temp
3496 \unnumbnoderef
3497 \nobreak
3498 }
3499
3500 % Subsections.
3501 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3502 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3503 \def\numberedsubseczzz #1{%
3504 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3505 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3506 \toks0 = {#1}%
3507 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3508                                     {\the\chapno}{\the\secno}{\the\subsecno}}}%
3509 \temp
3510 \donoderef
3511 \nobreak
3512 }
3513
3514 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3515 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3516 \def\appendixsubseczzz #1{%
3517 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3518 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3519 \toks0 = {#1}%
3520 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3521                                 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3522 \temp
3523 \appendixnoderef
3524 \nobreak
3525 }
3526
3527 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3528 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3529 \def\unnumberedsubseczzz #1{%
3530 \plainsubsecheading {#1}\gdef\thissection{#1}%
3531 \toks0 = {#1}%
3532 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3533                                     {\the\toks0}}}%
3534 \temp
3535 \unnumbnoderef
3536 \nobreak
3537 }
3538
3539 % Subsubsections.
3540 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3541 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3542 \def\numberedsubsubseczzz #1{%
3543 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3544 \subsubsecheading {#1}
3545   {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3546 \toks0 = {#1}%
3547 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3548   {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3549 \temp
3550 \donoderef
3551 \nobreak
3552 }
3553
3554 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3555 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3556 \def\appendixsubsubseczzz #1{%
3557 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3558 \subsubsecheading {#1}
3559   {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3560 \toks0 = {#1}%
3561 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3562   {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3563 \temp
3564 \appendixnoderef
3565 \nobreak
3566 }
3567
3568 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3569 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3570 \def\unnumberedsubsubseczzz #1{%
3571 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3572 \toks0 = {#1}%
3573 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3574                                     {\the\toks0}}}%
3575 \temp
3576 \unnumbnoderef
3577 \nobreak
3578 }
3579
3580 % These are variants which are not "outer", so they can appear in @ifinfo.
3581 % Actually, they should now be obsolete; ordinary section commands should work.
3582 \def\infotop{\parsearg\unnumberedzzz}
3583 \def\infounnumbered{\parsearg\unnumberedzzz}
3584 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3585 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3586 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3587
3588 \def\infoappendix{\parsearg\appendixzzz}
3589 \def\infoappendixsec{\parsearg\appendixseczzz}
3590 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3591 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3592
3593 \def\infochapter{\parsearg\chapterzzz}
3594 \def\infosection{\parsearg\sectionzzz}
3595 \def\infosubsection{\parsearg\subsectionzzz}
3596 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3597
3598 % These macros control what the section commands do, according
3599 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3600 % Define them by default for a numbered chapter.
3601 \global\let\section = \numberedsec
3602 \global\let\subsection = \numberedsubsec
3603 \global\let\subsubsection = \numberedsubsubsec
3604
3605 % Define @majorheading, @heading and @subheading
3606
3607 % NOTE on use of \vbox for chapter headings, section headings, and such:
3608 %       1) We use \vbox rather than the earlier \line to permit
3609 %          overlong headings to fold.
3610 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
3611 %          heading is obnoxious; this forbids it.
3612 %       3) Likewise, headings look best if no \parindent is used, and
3613 %          if justification is not attempted.  Hence \raggedright.
3614
3615
3616 \def\majorheading{\parsearg\majorheadingzzz}
3617 \def\majorheadingzzz #1{%
3618 {\advance\chapheadingskip by 10pt \chapbreak }%
3619 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3620                   \parindent=0pt\raggedright
3621                   \rm #1\hfill}}\bigskip \par\penalty 200}
3622
3623 \def\chapheading{\parsearg\chapheadingzzz}
3624 \def\chapheadingzzz #1{\chapbreak %
3625 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3626                   \parindent=0pt\raggedright
3627                   \rm #1\hfill}}\bigskip \par\penalty 200}
3628
3629 % @heading, @subheading, @subsubheading.
3630 \def\heading{\parsearg\plainsecheading}
3631 \def\subheading{\parsearg\plainsubsecheading}
3632 \def\subsubheading{\parsearg\plainsubsubsecheading}
3633
3634 % These macros generate a chapter, section, etc. heading only
3635 % (including whitespace, linebreaking, etc. around it),
3636 % given all the information in convenient, parsed form.
3637
3638 %%% Args are the skip and penalty (usually negative)
3639 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3640
3641 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3642
3643 %%% Define plain chapter starts, and page on/off switching for it
3644 % Parameter controlling skip before chapter headings (if needed)
3645
3646 \newskip\chapheadingskip
3647
3648 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3649 \def\chappager{\par\vfill\supereject}
3650 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3651
3652 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3653
3654 \def\CHAPPAGoff{%
3655 \global\let\contentsalignmacro = \chappager
3656 \global\let\pchapsepmacro=\chapbreak
3657 \global\let\pagealignmacro=\chappager}
3658
3659 \def\CHAPPAGon{%
3660 \global\let\contentsalignmacro = \chappager
3661 \global\let\pchapsepmacro=\chappager
3662 \global\let\pagealignmacro=\chappager
3663 \global\def\HEADINGSon{\HEADINGSsingle}}
3664
3665 \def\CHAPPAGodd{
3666 \global\let\contentsalignmacro = \chapoddpage
3667 \global\let\pchapsepmacro=\chapoddpage
3668 \global\let\pagealignmacro=\chapoddpage
3669 \global\def\HEADINGSon{\HEADINGSdouble}}
3670
3671 \CHAPPAGon
3672
3673 \def\CHAPFplain{
3674 \global\let\chapmacro=\chfplain
3675 \global\let\unnumbchapmacro=\unnchfplain
3676 \global\let\centerchapmacro=\centerchfplain}
3677
3678 % Plain chapter opening.
3679 % #1 is the text, #2 the chapter number or empty if unnumbered.
3680 \def\chfplain#1#2{%
3681   \pchapsepmacro
3682   {%
3683     \chapfonts \rm
3684     \def\chapnum{#2}%
3685     \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3686     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3687           \hangindent = \wd0 \centerparametersmaybe
3688           \unhbox0 #1\par}%
3689   }%
3690   \nobreak\bigskip % no page break after a chapter title
3691   \nobreak
3692 }
3693
3694 % Plain opening for unnumbered.
3695 \def\unnchfplain#1{\chfplain{#1}{}}
3696
3697 % @centerchap -- centered and unnumbered.
3698 \let\centerparametersmaybe = \relax
3699 \def\centerchfplain#1{{%
3700   \def\centerparametersmaybe{%
3701     \advance\rightskip by 3\rightskip
3702     \leftskip = \rightskip
3703     \parfillskip = 0pt
3704   }%
3705   \chfplain{#1}{}%
3706 }}
3707
3708 \CHAPFplain % The default
3709
3710 \def\unnchfopen #1{%
3711 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3712                        \parindent=0pt\raggedright
3713                        \rm #1\hfill}}\bigskip \par\nobreak
3714 }
3715
3716 \def\chfopen #1#2{\chapoddpage {\chapfonts
3717 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3718 \par\penalty 5000 %
3719 }
3720
3721 \def\centerchfopen #1{%
3722 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3723                        \parindent=0pt
3724                        \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3725 }
3726
3727 \def\CHAPFopen{
3728 \global\let\chapmacro=\chfopen
3729 \global\let\unnumbchapmacro=\unnchfopen
3730 \global\let\centerchapmacro=\centerchfopen}
3731
3732
3733 % Section titles.
3734 \newskip\secheadingskip
3735 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3736 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3737 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3738
3739 % Subsection titles.
3740 \newskip \subsecheadingskip
3741 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3742 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3743 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3744
3745 % Subsubsection titles.
3746 \let\subsubsecheadingskip = \subsecheadingskip
3747 \let\subsubsecheadingbreak = \subsecheadingbreak
3748 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3749 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3750
3751
3752 % Print any size section title.
3753 %
3754 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3755 % number (maybe empty), #3 the text.
3756 \def\sectionheading#1#2#3{%
3757   {%
3758     \expandafter\advance\csname #1headingskip\endcsname by \parskip
3759     \csname #1headingbreak\endcsname
3760   }%
3761   {%
3762     % Switch to the right set of fonts.
3763     \csname #1fonts\endcsname \rm
3764     %
3765     % Only insert the separating space if we have a section number.
3766     \def\secnum{#2}%
3767     \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3768     %
3769     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3770           \hangindent = \wd0 % zero if no section number
3771           \unhbox0 #3}%
3772   }%
3773   \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3774 }
3775
3776
3777 \message{toc,}
3778 % Table of contents.
3779 \newwrite\tocfile
3780
3781 % Write an entry to the toc file, opening it if necessary.
3782 % Called from @chapter, etc.  We supply {\folio} at the end of the
3783 % argument, which will end up as the last argument to the \...entry macro.
3784 %
3785 % We open the .toc file here instead of at @setfilename or any other
3786 % given time so that @contents can be put in the document anywhere.
3787 %
3788 \newif\iftocfileopened
3789 \def\writetocentry#1{%
3790   \iftocfileopened\else
3791     \immediate\openout\tocfile = \jobname.toc
3792     \global\tocfileopenedtrue
3793   \fi
3794   \iflinks \write\tocfile{#1{\folio}}\fi
3795 }
3796
3797 \newskip\contentsrightmargin \contentsrightmargin=1in
3798 \newcount\savepageno
3799 \newcount\lastnegativepageno \lastnegativepageno = -1
3800
3801 % Finish up the main text and prepare to read what we've written
3802 % to \tocfile.
3803 %
3804 \def\startcontents#1{%
3805    % If @setchapternewpage on, and @headings double, the contents should
3806    % start on an odd page, unlike chapters.  Thus, we maintain
3807    % \contentsalignmacro in parallel with \pagealignmacro.
3808    % From: Torbjorn Granlund <tege@matematik.su.se>
3809    \contentsalignmacro
3810    \immediate\closeout\tocfile
3811    %
3812    % Don't need to put `Contents' or `Short Contents' in the headline.
3813    % It is abundantly clear what they are.
3814    \unnumbchapmacro{#1}\def\thischapter{}%
3815    \savepageno = \pageno
3816    \begingroup                  % Set up to handle contents files properly.
3817       \catcode`\\=0  \catcode`\{=1  \catcode`\}=2  \catcode`\@=11
3818       % We can't do this, because then an actual ^ in a section
3819       % title fails, e.g., @chapter ^ -- exponentiation.  --karl, 9jul97.
3820       %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3821       \raggedbottom             % Worry more about breakpoints than the bottom.
3822       \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3823       %
3824       % Roman numerals for page numbers.
3825       \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3826 }
3827
3828
3829 % Normal (long) toc.
3830 \def\contents{%
3831    \startcontents{\putwordTOC}%
3832      \openin 1 \jobname.toc
3833      \ifeof 1 \else
3834        \closein 1
3835        \input \jobname.toc
3836      \fi
3837      \vfill \eject
3838      \contentsalignmacro % in case @setchapternewpage odd is in effect
3839      \pdfmakeoutlines
3840    \endgroup
3841    \lastnegativepageno = \pageno
3842    \pageno = \savepageno
3843 }
3844
3845 % And just the chapters.
3846 \def\summarycontents{%
3847    \startcontents{\putwordShortTOC}%
3848       %
3849       \let\chapentry = \shortchapentry
3850       \let\unnumbchapentry = \shortunnumberedentry
3851       % We want a true roman here for the page numbers.
3852       \secfonts
3853       \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3854       \rm
3855       \hyphenpenalty = 10000
3856       \advance\baselineskip by 1pt % Open it up a little.
3857       \def\secentry ##1##2##3##4{}
3858       \def\unnumbsecentry ##1##2{}
3859       \def\subsecentry ##1##2##3##4##5{}
3860       \def\unnumbsubsecentry ##1##2{}
3861       \def\subsubsecentry ##1##2##3##4##5##6{}
3862       \def\unnumbsubsubsecentry ##1##2{}
3863       \openin 1 \jobname.toc
3864       \ifeof 1 \else
3865         \closein 1
3866         \input \jobname.toc
3867       \fi
3868      \vfill \eject
3869      \contentsalignmacro % in case @setchapternewpage odd is in effect
3870    \endgroup
3871    \lastnegativepageno = \pageno
3872    \pageno = \savepageno
3873 }
3874 \let\shortcontents = \summarycontents
3875
3876 \ifpdf
3877   \pdfcatalog{/PageMode /UseOutlines}%
3878 \fi
3879
3880 % These macros generate individual entries in the table of contents.
3881 % The first argument is the chapter or section name.
3882 % The last argument is the page number.
3883 % The arguments in between are the chapter number, section number, ...
3884
3885 % Chapter-level things, for both the long and short contents.
3886 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3887
3888 % See comments in \dochapentry re vbox and related settings
3889 \def\shortchapentry#1#2#3{%
3890   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
3891 }
3892
3893 % Typeset the label for a chapter or appendix for the short contents.
3894 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3895 % We could simplify the code here by writing out an \appendixentry
3896 % command in the toc file for appendices, instead of using \chapentry
3897 % for both, but it doesn't seem worth it.
3898 %
3899 \newdimen\shortappendixwidth
3900 %
3901 \def\shortchaplabel#1{%
3902   % Compute width of word "Appendix", may change with language.
3903   \setbox0 = \hbox{\shortcontrm \putwordAppendix}%
3904   \shortappendixwidth = \wd0
3905   %
3906   % We typeset #1 in a box of constant width, regardless of the text of
3907   % #1, so the chapter titles will come out aligned.
3908   \setbox0 = \hbox{#1}%
3909   \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3910   %
3911   % This space should be plenty, since a single number is .5em, and the
3912   % widest letter (M) is 1em, at least in the Computer Modern fonts.
3913   % (This space doesn't include the extra space that gets added after
3914   % the label; that gets put in by \shortchapentry above.)
3915   \advance\dimen0 by 1.1em
3916   \hbox to \dimen0{#1\hfil}%
3917 }
3918
3919 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3920 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
3921
3922 % Sections.
3923 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
3924 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
3925
3926 % Subsections.
3927 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
3928 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
3929
3930 % And subsubsections.
3931 \def\subsubsecentry#1#2#3#4#5#6{%
3932   \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
3933 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
3934
3935 % This parameter controls the indentation of the various levels.
3936 \newdimen\tocindent \tocindent = 3pc
3937
3938 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
3939 % page number.
3940 %
3941 % If the toc has to be broken over pages, we want it to be at chapters
3942 % if at all possible; hence the \penalty.
3943 \def\dochapentry#1#2{%
3944    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
3945    \begingroup
3946      \chapentryfonts
3947      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3948    \endgroup
3949    \nobreak\vskip .25\baselineskip plus.1\baselineskip
3950 }
3951
3952 \def\dosecentry#1#2{\begingroup
3953   \secentryfonts \leftskip=\tocindent
3954   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3955 \endgroup}
3956
3957 \def\dosubsecentry#1#2{\begingroup
3958   \subsecentryfonts \leftskip=2\tocindent
3959   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3960 \endgroup}
3961
3962 \def\dosubsubsecentry#1#2{\begingroup
3963   \subsubsecentryfonts \leftskip=3\tocindent
3964   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3965 \endgroup}
3966
3967 % Final typesetting of a toc entry; we use the same \entry macro as for
3968 % the index entries, but we want to suppress hyphenation here.  (We
3969 % can't do that in the \entry macro, since index entries might consist
3970 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3971 \def\tocentry#1#2{\begingroup
3972   \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
3973   % Do not use \turnoffactive in these arguments.  Since the toc is
3974   % typeset in cmr, so characters such as _ would come out wrong; we
3975   % have to do the usual translation tricks.
3976   \entry{#1}{#2}%
3977 \endgroup}
3978
3979 % Space between chapter (or whatever) number and the title.
3980 \def\labelspace{\hskip1em \relax}
3981
3982 \def\dopageno#1{{\rm #1}}
3983 \def\doshortpageno#1{{\rm #1}}
3984
3985 \def\chapentryfonts{\secfonts \rm}
3986 \def\secentryfonts{\textfonts}
3987 \let\subsecentryfonts = \textfonts
3988 \let\subsubsecentryfonts = \textfonts
3989
3990
3991 \message{environments,}
3992 % @foo ... @end foo.
3993
3994 % Since these characters are used in examples, it should be an even number of
3995 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3996 % Furthermore, these definitions must come after we define our fonts.
3997 \newbox\dblarrowbox    \newbox\longdblarrowbox
3998 \newbox\pushcharbox    \newbox\bullbox
3999 \newbox\equivbox       \newbox\errorbox
4000
4001 %{\tentt
4002 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
4003 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
4004 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
4005 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
4006 % Adapted from the manmac format (p.420 of TeXbook)
4007 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
4008 %                                      depth .1ex\hfil}
4009 %}
4010
4011 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4012 \def\point{$\star$}
4013 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4014 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4015 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4016 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4017
4018 % Adapted from the TeXbook's \boxit.
4019 {\tentt \global\dimen0 = 3em}% Width of the box.
4020 \dimen2 = .55pt % Thickness of rules
4021 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4022 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4023
4024 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4025    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4026    \advance\hsize by -2\dimen2 % Rules.
4027    \vbox{
4028       \hrule height\dimen2
4029       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
4030          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4031          \kern3pt\vrule width\dimen2}% Space to right.
4032       \hrule height\dimen2}
4033     \hfil}
4034
4035 % The @error{} command.
4036 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4037
4038 % @tex ... @end tex    escapes into raw Tex temporarily.
4039 % One exception: @ is still an escape character, so that @end tex works.
4040 % But \@ or @@ will get a plain tex @ character.
4041
4042 \def\tex{\begingroup
4043   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4044   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4045   \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4046   \catcode `\%=14
4047   \catcode 43=12 % plus
4048   \catcode`\"=12
4049   \catcode`\==12
4050   \catcode`\|=12
4051   \catcode`\<=12
4052   \catcode`\>=12
4053   \escapechar=`\\
4054   %
4055   \let\b=\ptexb
4056   \let\bullet=\ptexbullet
4057   \let\c=\ptexc
4058   \let\,=\ptexcomma
4059   \let\.=\ptexdot
4060   \let\dots=\ptexdots
4061   \let\equiv=\ptexequiv
4062   \let\!=\ptexexclam
4063   \let\i=\ptexi
4064   \let\{=\ptexlbrace
4065   \let\+=\tabalign
4066   \let\}=\ptexrbrace
4067   \let\*=\ptexstar
4068   \let\t=\ptext
4069   %
4070   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4071   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4072   \def\@{@}%
4073 \let\Etex=\endgroup}
4074
4075 % Define @lisp ... @endlisp.
4076 % @lisp does a \begingroup so it can rebind things,
4077 % including the definition of @endlisp (which normally is erroneous).
4078
4079 % Amount to narrow the margins by for @lisp.
4080 \newskip\lispnarrowing \lispnarrowing=0.4in
4081
4082 % This is the definition that ^^M gets inside @lisp, @example, and other
4083 % such environments.  \null is better than a space, since it doesn't
4084 % have any width.
4085 \def\lisppar{\null\endgraf}
4086
4087 % Make each space character in the input produce a normal interword
4088 % space in the output.  Don't allow a line break at this space, as this
4089 % is used only in environments like @example, where each line of input
4090 % should produce a line of output anyway.
4091 %
4092 {\obeyspaces %
4093 \gdef\sepspaces{\obeyspaces\let =\tie}}
4094
4095 % Define \obeyedspace to be our active space, whatever it is.  This is
4096 % for use in \parsearg.
4097 {\sepspaces%
4098 \global\let\obeyedspace= }
4099
4100 % This space is always present above and below environments.
4101 \newskip\envskipamount \envskipamount = 0pt
4102
4103 % Make spacing and below environment symmetrical.  We use \parskip here
4104 % to help in doing that, since in @example-like environments \parskip
4105 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4106 % start of the next paragraph will insert \parskip
4107 %
4108 \def\aboveenvbreak{{\advance\envskipamount by \parskip
4109 \endgraf \ifdim\lastskip<\envskipamount
4110 \removelastskip \penalty-50 \vskip\envskipamount \fi}}
4111
4112 \let\afterenvbreak = \aboveenvbreak
4113
4114 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
4115 \let\nonarrowing=\relax
4116
4117 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4118 % environment contents.
4119 \font\circle=lcircle10
4120 \newdimen\circthick
4121 \newdimen\cartouter\newdimen\cartinner
4122 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4123 \circthick=\fontdimen8\circle
4124 %
4125 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4126 \def\ctr{{\hskip 6pt\circle\char'010}}
4127 \def\cbl{{\circle\char'012\hskip -6pt}}
4128 \def\cbr{{\hskip 6pt\circle\char'011}}
4129 \def\carttop{\hbox to \cartouter{\hskip\lskip
4130         \ctl\leaders\hrule height\circthick\hfil\ctr
4131         \hskip\rskip}}
4132 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4133         \cbl\leaders\hrule height\circthick\hfil\cbr
4134         \hskip\rskip}}
4135 %
4136 \newskip\lskip\newskip\rskip
4137
4138 \long\def\cartouche{%
4139 \begingroup
4140         \lskip=\leftskip \rskip=\rightskip
4141         \leftskip=0pt\rightskip=0pt %we want these *outside*.
4142         \cartinner=\hsize \advance\cartinner by-\lskip
4143                           \advance\cartinner by-\rskip
4144         \cartouter=\hsize
4145         \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4146 %                                    side, and for 6pt waste from
4147 %                                    each corner char, and rule thickness
4148         \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4149         % Flag to tell @lisp, etc., not to narrow margin.
4150         \let\nonarrowing=\comment
4151         \vbox\bgroup
4152                 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4153                 \carttop
4154                 \hbox\bgroup
4155                         \hskip\lskip
4156                         \vrule\kern3pt
4157                         \vbox\bgroup
4158                                 \hsize=\cartinner
4159                                 \kern3pt
4160                                 \begingroup
4161                                         \baselineskip=\normbskip
4162                                         \lineskip=\normlskip
4163                                         \parskip=\normpskip
4164                                         \vskip -\parskip
4165 \def\Ecartouche{%
4166                                 \endgroup
4167                                 \kern3pt
4168                         \egroup
4169                         \kern3pt\vrule
4170                         \hskip\rskip
4171                 \egroup
4172                 \cartbot
4173         \egroup
4174 \endgroup
4175 }}
4176
4177
4178 % This macro is called at the beginning of all the @example variants,
4179 % inside a group.
4180 \def\nonfillstart{%
4181   \aboveenvbreak
4182   \inENV % This group ends at the end of the body
4183   \hfuzz = 12pt % Don't be fussy
4184   \sepspaces % Make spaces be word-separators rather than space tokens.
4185   \singlespace
4186   \let\par = \lisppar % don't ignore blank lines
4187   \obeylines % each line of input is a line of output
4188   \parskip = 0pt
4189   \parindent = 0pt
4190   \emergencystretch = 0pt % don't try to avoid overfull boxes
4191   % @cartouche defines \nonarrowing to inhibit narrowing
4192   % at next level down.
4193   \ifx\nonarrowing\relax
4194     \advance \leftskip by \lispnarrowing
4195     \exdentamount=\lispnarrowing
4196     \let\exdent=\nofillexdent
4197     \let\nonarrowing=\relax
4198   \fi
4199 }
4200
4201 % Define the \E... control sequence only if we are inside the particular
4202 % environment, so the error checking in \end will work.
4203 %
4204 % To end an @example-like environment, we first end the paragraph (via
4205 % \afterenvbreak's vertical glue), and then the group.  That way we keep
4206 % the zero \parskip that the environments set -- \parskip glue will be
4207 % inserted at the beginning of the next paragraph in the document, after
4208 % the environment.
4209 %
4210 \def\nonfillfinish{\afterenvbreak\endgroup}
4211
4212 % @lisp: indented, narrowed, typewriter font.
4213 \def\lisp{\begingroup
4214   \nonfillstart
4215   \let\Elisp = \nonfillfinish
4216   \tt
4217   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4218   \gobble       % eat return
4219 }
4220
4221 % @example: Same as @lisp.
4222 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4223
4224 % @small... is usually equivalent to the non-small (@smallbook
4225 % redefines).  We must call \example (or whatever) last in the
4226 % definition, since it reads the return following the @example (or
4227 % whatever) command.
4228 %
4229 % This actually allows (for example) @end display inside an
4230 % @smalldisplay.  Too bad, but makeinfo will catch the error anyway.
4231 %
4232 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4233 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4234 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4235 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4236
4237 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4238 % Originally contributed by Pavel@xerox.
4239 \def\smalllispx{\begingroup
4240   \def\Esmalllisp{\nonfillfinish\endgroup}%
4241   \def\Esmallexample{\nonfillfinish\endgroup}%
4242   \smallfonts
4243   \lisp
4244 }
4245
4246 % @display: same as @lisp except keep current font.
4247 %
4248 \def\display{\begingroup
4249   \nonfillstart
4250   \let\Edisplay = \nonfillfinish
4251   \gobble
4252 }
4253
4254 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4255 %
4256 \def\smalldisplayx{\begingroup
4257   \def\Esmalldisplay{\nonfillfinish\endgroup}%
4258   \smallfonts \rm
4259   \display
4260 }
4261
4262 % @format: same as @display except don't narrow margins.
4263 %
4264 \def\format{\begingroup
4265   \let\nonarrowing = t
4266   \nonfillstart
4267   \let\Eformat = \nonfillfinish
4268   \gobble
4269 }
4270
4271 % @smallformat (when @smallbook): @format plus smaller fonts.
4272 %
4273 \def\smallformatx{\begingroup
4274   \def\Esmallformat{\nonfillfinish\endgroup}%
4275   \smallfonts \rm
4276   \format
4277 }
4278
4279 % @flushleft (same as @format).
4280 %
4281 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4282
4283 % @flushright.
4284 %
4285 \def\flushright{\begingroup
4286   \let\nonarrowing = t
4287   \nonfillstart
4288   \let\Eflushright = \nonfillfinish
4289   \advance\leftskip by 0pt plus 1fill
4290   \gobble
4291 }
4292
4293 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4294 % and narrows the margins.
4295 %
4296 \def\quotation{%
4297   \begingroup\inENV %This group ends at the end of the @quotation body
4298   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4299   \singlespace
4300   \parindent=0pt
4301   % We have retained a nonzero parskip for the environment, since we're
4302   % doing normal filling. So to avoid extra space below the environment...
4303   \def\Equotation{\parskip = 0pt \nonfillfinish}%
4304   %
4305   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4306   \ifx\nonarrowing\relax
4307     \advance\leftskip by \lispnarrowing
4308     \advance\rightskip by \lispnarrowing
4309     \exdentamount = \lispnarrowing
4310     \let\nonarrowing = \relax
4311   \fi
4312 }
4313
4314
4315 \message{defuns,}
4316 % @defun etc.
4317
4318 % Allow user to change definition object font (\df) internally
4319 \def\setdeffont #1 {\csname DEF#1\endcsname}
4320
4321 \newskip\defbodyindent \defbodyindent=.4in
4322 \newskip\defargsindent \defargsindent=50pt
4323 \newskip\deftypemargin \deftypemargin=12pt
4324 \newskip\deflastargmargin \deflastargmargin=18pt
4325
4326 \newcount\parencount
4327 % define \functionparens, which makes ( and ) and & do special things.
4328 % \functionparens affects the group it is contained in.
4329 \def\activeparens{%
4330 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4331 \catcode`\[=\active \catcode`\]=\active}
4332
4333 % Make control sequences which act like normal parenthesis chars.
4334 \let\lparen = ( \let\rparen = )
4335
4336 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4337
4338 % Be sure that we always have a definition for `(', etc.  For example,
4339 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4340 % so TeX would otherwise complain about undefined control sequence.
4341 \global\let(=\lparen \global\let)=\rparen
4342 \global\let[=\lbrack \global\let]=\rbrack
4343
4344 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4345 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4346 % This is used to turn on special parens
4347 % but make & act ordinary (given that it's active).
4348 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4349
4350 % Definitions of (, ) and & used in args for functions.
4351 % This is the definition of ( outside of all parentheses.
4352 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4353   \global\advance\parencount by 1
4354 }
4355 %
4356 % This is the definition of ( when already inside a level of parens.
4357 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4358 %
4359 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4360   % also in that case restore the outer-level definition of (.
4361   \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4362   \global\advance \parencount by -1 }
4363 % If we encounter &foo, then turn on ()-hacking afterwards
4364 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
4365 %
4366 \gdef\normalparens{\boldbrax\let&=\ampnr}
4367 } % End of definition inside \activeparens
4368 %% These parens (in \boldbrax) actually are a little bolder than the
4369 %% contained text.  This is especially needed for [ and ]
4370 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4371 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4372 \let\ampnr = \&
4373 \def\lbrb{{\bf\char`\[}}
4374 \def\rbrb{{\bf\char`\]}}
4375
4376 % Active &'s sneak into the index arguments, so make sure it's defined.
4377 {
4378   \catcode`& = 13
4379   \global\let& = \ampnr
4380 }
4381
4382 % First, defname, which formats the header line itself.
4383 % #1 should be the function name.
4384 % #2 should be the type of definition, such as "Function".
4385
4386 \def\defname #1#2{%
4387 % Get the values of \leftskip and \rightskip as they were
4388 % outside the @def...
4389 \dimen2=\leftskip
4390 \advance\dimen2 by -\defbodyindent
4391 \noindent
4392 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4393 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4394 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4395 \parshape 2 0in \dimen0 \defargsindent \dimen1
4396 % Now output arg 2 ("Function" or some such)
4397 % ending at \deftypemargin from the right margin,
4398 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4399 {% Adjust \hsize to exclude the ambient margins,
4400 % so that \rightline will obey them.
4401 \advance \hsize by -\dimen2
4402 \rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4403 % Make all lines underfull and no complaints:
4404 \tolerance=10000 \hbadness=10000
4405 \advance\leftskip by -\defbodyindent
4406 \exdentamount=\defbodyindent
4407 {\df #1}\enskip        % Generate function name
4408 }
4409
4410 % Actually process the body of a definition
4411 % #1 should be the terminating control sequence, such as \Edefun.
4412 % #2 should be the "another name" control sequence, such as \defunx.
4413 % #3 should be the control sequence that actually processes the header,
4414 %    such as \defunheader.
4415
4416 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4417 \medbreak %
4418 % Define the end token that this defining construct specifies
4419 % so that it will exit this group.
4420 \def#1{\endgraf\endgroup\medbreak}%
4421 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4422 \parindent=0in
4423 \advance\leftskip by \defbodyindent
4424 \exdentamount=\defbodyindent
4425 \begingroup %
4426 \catcode 61=\active % 61 is `='
4427 \obeylines\activeparens\spacesplit#3}
4428
4429 % #1 is the \E... control sequence to end the definition (which we define).
4430 % #2 is the \...x control sequence for consecutive fns (which we define).
4431 % #3 is the control sequence to call to resume processing.
4432 % #4, delimited by the space, is the class name.
4433 %
4434 \def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4435 \medbreak %
4436 % Define the end token that this defining construct specifies
4437 % so that it will exit this group.
4438 \def#1{\endgraf\endgroup\medbreak}%
4439 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4440 \parindent=0in
4441 \advance\leftskip by \defbodyindent
4442 \exdentamount=\defbodyindent
4443 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4444
4445 % Used for @deftypemethod and @deftypeivar.
4446 % #1 is the \E... control sequence to end the definition (which we define).
4447 % #2 is the \...x control sequence for consecutive fns (which we define).
4448 % #3 is the control sequence to call to resume processing.
4449 % #4, delimited by a space, is the class name.
4450 % #5 is the method's return type.
4451 %
4452 \def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4453   \medbreak
4454   \def#1{\endgraf\endgroup\medbreak}%
4455   \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4456   \parindent=0in
4457   \advance\leftskip by \defbodyindent
4458   \exdentamount=\defbodyindent
4459   \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4460
4461 % Used for @deftypeop.  The change from \deftypemethparsebody is an
4462 % extra argument at the beginning which is the `category', instead of it
4463 % being the hardwired string `Method' or `Instance Variable'.  We have
4464 % to account for this both in the \...x definition and in parsing the
4465 % input at hand.  Thus also need a control sequence (passed as #5) for
4466 % the \E... definition to assign the category name to.
4467
4468 \def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4469   \medbreak
4470   \def#1{\endgraf\endgroup\medbreak}%
4471   \def#2##1 ##2 ##3 {%
4472     \def#4{##1}%
4473     \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4474   \parindent=0in
4475   \advance\leftskip by \defbodyindent
4476   \exdentamount=\defbodyindent
4477   \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4478
4479 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4480 \medbreak %
4481 % Define the end token that this defining construct specifies
4482 % so that it will exit this group.
4483 \def#1{\endgraf\endgroup\medbreak}%
4484 \def#2##1 ##2 {\def#4{##1}%
4485 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4486 \parindent=0in
4487 \advance\leftskip by \defbodyindent
4488 \exdentamount=\defbodyindent
4489 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4490
4491 % These parsing functions are similar to the preceding ones
4492 % except that they do not make parens into active characters.
4493 % These are used for "variables" since they have no arguments.
4494
4495 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4496 \medbreak %
4497 % Define the end token that this defining construct specifies
4498 % so that it will exit this group.
4499 \def#1{\endgraf\endgroup\medbreak}%
4500 \def#2{\begingroup\obeylines\spacesplit#3}%
4501 \parindent=0in
4502 \advance\leftskip by \defbodyindent
4503 \exdentamount=\defbodyindent
4504 \begingroup %
4505 \catcode 61=\active %
4506 \obeylines\spacesplit#3}
4507
4508 % This is used for \def{tp,vr}parsebody.  It could probably be used for
4509 % some of the others, too, with some judicious conditionals.
4510 %
4511 \def\parsebodycommon#1#2#3{%
4512   \begingroup\inENV %
4513   \medbreak %
4514   % Define the end token that this defining construct specifies
4515   % so that it will exit this group.
4516   \def#1{\endgraf\endgroup\medbreak}%
4517   \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4518   \parindent=0in
4519   \advance\leftskip by \defbodyindent
4520   \exdentamount=\defbodyindent
4521   \begingroup\obeylines
4522 }
4523
4524 \def\defvrparsebody#1#2#3#4 {%
4525   \parsebodycommon{#1}{#2}{#3}%
4526   \spacesplit{#3{#4}}%
4527 }
4528
4529 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4530 % type is just `struct', because we lose the braces in `{struct
4531 % termios}' when \spacesplit reads its undelimited argument.  Sigh.
4532 % \let\deftpparsebody=\defvrparsebody
4533 %
4534 % So, to get around this, we put \empty in with the type name.  That
4535 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4536 % won't strip off the braces.
4537 %
4538 \def\deftpparsebody #1#2#3#4 {%
4539   \parsebodycommon{#1}{#2}{#3}%
4540   \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4541 }
4542
4543 % Fine, but then we have to eventually remove the \empty *and* the
4544 % braces (if any).  That's what this does.
4545 %
4546 \def\removeemptybraces\empty#1\relax{#1}
4547
4548 % After \spacesplit has done its work, this is called -- #1 is the final
4549 % thing to call, #2 the type name (which starts with \empty), and #3
4550 % (which might be empty) the arguments.
4551 %
4552 \def\parsetpheaderline#1#2#3{%
4553   #1{\removeemptybraces#2\relax}{#3}%
4554 }%
4555
4556 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4557 \medbreak %
4558 % Define the end token that this defining construct specifies
4559 % so that it will exit this group.
4560 \def#1{\endgraf\endgroup\medbreak}%
4561 \def#2##1 ##2 {\def#4{##1}%
4562 \begingroup\obeylines\spacesplit{#3{##2}}}%
4563 \parindent=0in
4564 \advance\leftskip by \defbodyindent
4565 \exdentamount=\defbodyindent
4566 \begingroup\obeylines\spacesplit{#3{#5}}}
4567
4568 % Split up #2 at the first space token.
4569 % call #1 with two arguments:
4570 %  the first is all of #2 before the space token,
4571 %  the second is all of #2 after that space token.
4572 % If #2 contains no space token, all of it is passed as the first arg
4573 % and the second is passed as empty.
4574
4575 {\obeylines
4576 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4577 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4578 \ifx\relax #3%
4579 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4580
4581 % So much for the things common to all kinds of definitions.
4582
4583 % Define @defun.
4584
4585 % First, define the processing that is wanted for arguments of \defun
4586 % Use this to expand the args and terminate the paragraph they make up
4587
4588 \def\defunargs#1{\functionparens \sl
4589 % Expand, preventing hyphenation at `-' chars.
4590 % Note that groups don't affect changes in \hyphenchar.
4591 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4592 {\tensl\hyphenchar\font=0}%
4593 #1%
4594 {\tensl\hyphenchar\font=45}%
4595 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4596 \interlinepenalty=10000
4597 \advance\rightskip by 0pt plus 1fil
4598 \endgraf\nobreak\vskip -\parskip\nobreak
4599 }
4600
4601 \def\deftypefunargs #1{%
4602 % Expand, preventing hyphenation at `-' chars.
4603 % Note that groups don't affect changes in \hyphenchar.
4604 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4605 \boldbraxnoamp
4606 \tclose{#1}% avoid \code because of side effects on active chars
4607 \interlinepenalty=10000
4608 \advance\rightskip by 0pt plus 1fil
4609 \endgraf\nobreak\vskip -\parskip\nobreak
4610 }
4611
4612 % Do complete processing of one @defun or @defunx line already parsed.
4613
4614 % @deffn Command forward-char nchars
4615
4616 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4617
4618 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4619 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4620 \catcode 61=\other % Turn off change made in \defparsebody
4621 }
4622
4623 % @defun == @deffn Function
4624
4625 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4626
4627 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4628 \begingroup\defname {#1}{\putwordDeffunc}%
4629 \defunargs {#2}\endgroup %
4630 \catcode 61=\other % Turn off change made in \defparsebody
4631 }
4632
4633 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4634
4635 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4636
4637 % #1 is the data type.  #2 is the name and args.
4638 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4639 % #1 is the data type, #2 the name, #3 the args.
4640 \def\deftypefunheaderx #1#2 #3\relax{%
4641 \doind {fn}{\code{#2}}% Make entry in function index
4642 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}%
4643 \deftypefunargs {#3}\endgroup %
4644 \catcode 61=\other % Turn off change made in \defparsebody
4645 }
4646
4647 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4648
4649 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4650
4651 % \defheaderxcond#1\relax$$$
4652 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4653 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4654
4655 % #1 is the classification.  #2 is the data type.  #3 is the name and args.
4656 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4657 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4658 \def\deftypefnheaderx #1#2#3 #4\relax{%
4659 \doind {fn}{\code{#3}}% Make entry in function index
4660 \begingroup
4661 \normalparens % notably, turn off `&' magic, which prevents
4662 %               at least some C++ text from working
4663 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
4664 \deftypefunargs {#4}\endgroup %
4665 \catcode 61=\other % Turn off change made in \defparsebody
4666 }
4667
4668 % @defmac == @deffn Macro
4669
4670 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4671
4672 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4673 \begingroup\defname {#1}{\putwordDefmac}%
4674 \defunargs {#2}\endgroup %
4675 \catcode 61=\other % Turn off change made in \defparsebody
4676 }
4677
4678 % @defspec == @deffn Special Form
4679
4680 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4681
4682 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4683 \begingroup\defname {#1}{\putwordDefspec}%
4684 \defunargs {#2}\endgroup %
4685 \catcode 61=\other % Turn off change made in \defparsebody
4686 }
4687
4688 % @defop CATEGORY CLASS OPERATION ARG...
4689 %
4690 \def\defop #1 {\def\defoptype{#1}%
4691 \defopparsebody\Edefop\defopx\defopheader\defoptype}
4692 %
4693 \def\defopheader#1#2#3{%
4694 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4695 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4696 \defunargs {#3}\endgroup %
4697 }
4698
4699 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4700 %
4701 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
4702   \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
4703                        \deftypeopcategory}
4704 %
4705 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4706 \def\deftypeopheader#1#2#3#4{%
4707   \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4708   \begingroup
4709     \defname{\defheaderxcond#2\relax$$$#3}
4710             {\deftypeopcategory\ \putwordon\ \code{#1}}%
4711     \deftypefunargs{#4}%
4712   \endgroup
4713 }
4714
4715 % @deftypemethod CLASS TYPE METHOD ARG...
4716 %
4717 \def\deftypemethod{%
4718   \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4719 %
4720 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4721 \def\deftypemethodheader#1#2#3#4{%
4722   \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4723   \begingroup
4724     \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}%
4725     \deftypefunargs{#4}%
4726   \endgroup
4727 }
4728
4729 % @deftypeivar CLASS TYPE VARNAME
4730 %
4731 \def\deftypeivar{%
4732   \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
4733 %
4734 % #1 is the class name, #2 the data type, #3 the variable name.
4735 \def\deftypeivarheader#1#2#3{%
4736   \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
4737   \begingroup
4738     \defname{\defheaderxcond#2\relax$$$#3}
4739             {\putwordInstanceVariableof\ \code{#1}}%
4740     \defvarargs{#3}%
4741   \endgroup
4742 }
4743
4744 % @defmethod == @defop Method
4745 %
4746 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
4747 %
4748 % #1 is the class name, #2 the method name, #3 the args.
4749 \def\defmethodheader#1#2#3{%
4750   \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
4751   \begingroup
4752     \defname{#2}{\putwordMethodon\ \code{#1}}%
4753     \defunargs{#3}%
4754   \endgroup
4755 }
4756
4757 % @defcv {Class Option} foo-class foo-flag
4758
4759 \def\defcv #1 {\def\defcvtype{#1}%
4760 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
4761
4762 \def\defcvarheader #1#2#3{%
4763 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
4764 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
4765 \defvarargs {#3}\endgroup %
4766 }
4767
4768 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
4769 %
4770 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
4771 %
4772 \def\defivarheader#1#2#3{%
4773   \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
4774   \begingroup
4775     \defname{#2}{\putwordInstanceVariableof\ #1}%
4776     \defvarargs{#3}%
4777   \endgroup
4778 }
4779
4780 % @defvar
4781 % First, define the processing that is wanted for arguments of @defvar.
4782 % This is actually simple: just print them in roman.
4783 % This must expand the args and terminate the paragraph they make up
4784 \def\defvarargs #1{\normalparens #1%
4785 \interlinepenalty=10000
4786 \endgraf\nobreak\vskip -\parskip\nobreak}
4787
4788 % @defvr Counter foo-count
4789
4790 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
4791
4792 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
4793 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
4794
4795 % @defvar == @defvr Variable
4796
4797 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
4798
4799 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4800 \begingroup\defname {#1}{\putwordDefvar}%
4801 \defvarargs {#2}\endgroup %
4802 }
4803
4804 % @defopt == @defvr {User Option}
4805
4806 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
4807
4808 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4809 \begingroup\defname {#1}{\putwordDefopt}%
4810 \defvarargs {#2}\endgroup %
4811 }
4812
4813 % @deftypevar int foobar
4814
4815 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
4816
4817 % #1 is the data type.  #2 is the name, perhaps followed by text that
4818 % is actually part of the data type, which should not be put into the index.
4819 \def\deftypevarheader #1#2{%
4820 \dovarind#2 \relax% Make entry in variables index
4821 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}%
4822 \interlinepenalty=10000
4823 \endgraf\nobreak\vskip -\parskip\nobreak
4824 \endgroup}
4825 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
4826
4827 % @deftypevr {Global Flag} int enable
4828
4829 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
4830
4831 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
4832 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
4833 \interlinepenalty=10000
4834 \endgraf\nobreak\vskip -\parskip\nobreak
4835 \endgroup}
4836
4837 % Now define @deftp
4838 % Args are printed in bold, a slight difference from @defvar.
4839
4840 \def\deftpargs #1{\bf \defvarargs{#1}}
4841
4842 % @deftp Class window height width ...
4843
4844 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
4845
4846 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
4847 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
4848
4849 % These definitions are used if you use @defunx (etc.)
4850 % anywhere other than immediately after a @defun or @defunx.
4851
4852 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
4853 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
4854 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
4855 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
4856 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
4857 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
4858 \def\defopx#1 {\errmessage{@defopx in invalid context}}
4859 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
4860 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
4861 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
4862 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
4863 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
4864 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
4865 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
4866 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
4867 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
4868 \def\defunx#1 {\errmessage{@defunx in invalid context}}
4869 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
4870 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
4871
4872
4873 \message{macros,}
4874 % @macro.
4875
4876 % To do this right we need a feature of e-TeX, \scantokens,
4877 % which we arrange to emulate with a temporary file in ordinary TeX.
4878 \ifx\eTeXversion\undefined
4879  \newwrite\macscribble
4880  \def\scanmacro#1{%
4881    \begingroup \newlinechar`\^^M
4882    % Undo catcode changes of \startcontents and \doprintindex
4883    \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
4884    % Append \endinput to make sure that TeX does not see the ending newline.
4885    \toks0={#1\endinput}%
4886    \immediate\openout\macscribble=\jobname.tmp
4887    \immediate\write\macscribble{\the\toks0}%
4888    \immediate\closeout\macscribble
4889    \let\xeatspaces\eatspaces
4890    \input \jobname.tmp
4891    \endgroup
4892 }
4893 \else
4894 \def\scanmacro#1{%
4895 \begingroup \newlinechar`\^^M
4896 % Undo catcode changes of \startcontents and \doprintindex
4897 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
4898 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
4899 \fi
4900
4901 \newcount\paramno   % Count of parameters
4902 \newtoks\macname    % Macro name
4903 \newif\ifrecursive  % Is it recursive?
4904 \def\macrolist{}    % List of all defined macros in the form
4905                     % \do\macro1\do\macro2...
4906
4907 % Utility routines.
4908 % Thisdoes \let #1 = #2, except with \csnames.
4909 \def\cslet#1#2{%
4910 \expandafter\expandafter
4911 \expandafter\let
4912 \expandafter\expandafter
4913 \csname#1\endcsname
4914 \csname#2\endcsname}
4915
4916 % Trim leading and trailing spaces off a string.
4917 % Concepts from aro-bend problem 15 (see CTAN).
4918 {\catcode`\@=11
4919 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
4920 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
4921 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
4922 \def\unbrace#1{#1}
4923 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
4924 }
4925
4926 % Trim a single trailing ^^M off a string.
4927 {\catcode`\^^M=12\catcode`\Q=3%
4928 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
4929 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
4930 \gdef\eatcrb#1Q#2Q{#1}%
4931 }
4932
4933 % Macro bodies are absorbed as an argument in a context where
4934 % all characters are catcode 10, 11 or 12, except \ which is active
4935 % (as in normal texinfo). It is necessary to change the definition of \.
4936
4937 % It's necessary to have hard CRs when the macro is executed. This is
4938 % done by  making ^^M (\endlinechar) catcode 12 when reading the macro
4939 % body, and then making it the \newlinechar in \scanmacro.
4940
4941 \def\macrobodyctxt{%
4942   \catcode`\~=12
4943   \catcode`\^=12
4944   \catcode`\_=12
4945   \catcode`\|=12
4946   \catcode`\<=12
4947   \catcode`\>=12
4948   \catcode`\+=12
4949   \catcode`\{=12
4950   \catcode`\}=12
4951   \catcode`\@=12
4952   \catcode`\^^M=12
4953   \usembodybackslash}
4954
4955 \def\macroargctxt{%
4956   \catcode`\~=12
4957   \catcode`\^=12
4958   \catcode`\_=12
4959   \catcode`\|=12
4960   \catcode`\<=12
4961   \catcode`\>=12
4962   \catcode`\+=12
4963   \catcode`\@=12
4964   \catcode`\\=12}
4965
4966 % \mbodybackslash is the definition of \ in @macro bodies.
4967 % It maps \foo\ => \csname macarg.foo\endcsname => #N
4968 % where N is the macro parameter number.
4969 % We define \csname macarg.\endcsname to be \realbackslash, so
4970 % \\ in macro replacement text gets you a backslash.
4971
4972 {\catcode`@=0 @catcode`@\=@active
4973  @gdef@usembodybackslash{@let\=@mbodybackslash}
4974  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
4975 }
4976 \expandafter\def\csname macarg.\endcsname{\realbackslash}
4977
4978 \def\macro{\recursivefalse\parsearg\macroxxx}
4979 \def\rmacro{\recursivetrue\parsearg\macroxxx}
4980
4981 \def\macroxxx#1{%
4982   \getargs{#1}%           now \macname is the macname and \argl the arglist
4983   \ifx\argl\empty       % no arguments
4984      \paramno=0%
4985   \else
4986      \expandafter\parsemargdef \argl;%
4987   \fi
4988   \if1\csname ismacro.\the\macname\endcsname
4989      \message{Warning: redefining \the\macname}%
4990   \else
4991      \expandafter\ifx\csname \the\macname\endcsname \relax
4992      \else \errmessage{The name \the\macname\space is reserved}\fi
4993      \global\cslet{macsave.\the\macname}{\the\macname}%
4994      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
4995      % Add the macroname to \macrolist
4996      \toks0 = \expandafter{\macrolist\do}%
4997      \xdef\macrolist{\the\toks0
4998        \expandafter\noexpand\csname\the\macname\endcsname}%
4999   \fi
5000   \begingroup \macrobodyctxt
5001   \ifrecursive \expandafter\parsermacbody
5002   \else \expandafter\parsemacbody
5003   \fi}
5004
5005 \def\unmacro{\parsearg\unmacroxxx}
5006 \def\unmacroxxx#1{%
5007   \if1\csname ismacro.#1\endcsname
5008     \global\cslet{#1}{macsave.#1}%
5009     \global\expandafter\let \csname ismacro.#1\endcsname=0%
5010     % Remove the macro name from \macrolist
5011     \begingroup
5012       \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5013       \def\do##1{%
5014         \def\tempb{##1}%
5015         \ifx\tempa\tempb
5016           % remove this
5017         \else
5018           \toks0 = \expandafter{\newmacrolist\do}%
5019           \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5020         \fi}%
5021       \def\newmacrolist{}%
5022       % Execute macro list to define \newmacrolist
5023       \macrolist
5024       \global\let\macrolist\newmacrolist
5025     \endgroup
5026   \else
5027     \errmessage{Macro #1 not defined}%
5028   \fi
5029 }
5030
5031 % This makes use of the obscure feature that if the last token of a
5032 % <parameter list> is #, then the preceding argument is delimited by
5033 % an opening brace, and that opening brace is not consumed.
5034 \def\getargs#1{\getargsxxx#1{}}
5035 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5036 \def\getmacname #1 #2\relax{\macname={#1}}
5037 \def\getmacargs#1{\def\argl{#1}}
5038
5039 % Parse the optional {params} list.  Set up \paramno and \paramlist
5040 % so \defmacro knows what to do.  Define \macarg.blah for each blah
5041 % in the params list, to be ##N where N is the position in that list.
5042 % That gets used by \mbodybackslash (above).
5043
5044 % We need to get `macro parameter char #' into several definitions.
5045 % The technique used is stolen from LaTeX:  let \hash be something
5046 % unexpandable, insert that wherever you need a #, and then redefine
5047 % it to # just before using the token list produced.
5048 %
5049 % The same technique is used to protect \eatspaces till just before
5050 % the macro is used.
5051
5052 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5053         \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5054 \def\parsemargdefxxx#1,{%
5055   \if#1;\let\next=\relax
5056   \else \let\next=\parsemargdefxxx
5057     \advance\paramno by 1%
5058     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5059         {\xeatspaces{\hash\the\paramno}}%
5060     \edef\paramlist{\paramlist\hash\the\paramno,}%
5061   \fi\next}
5062
5063 % These two commands read recursive and nonrecursive macro bodies.
5064 % (They're different since rec and nonrec macros end differently.)
5065
5066 \long\def\parsemacbody#1@end macro%
5067 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5068 \long\def\parsermacbody#1@end rmacro%
5069 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5070
5071 % This defines the macro itself. There are six cases: recursive and
5072 % nonrecursive macros of zero, one, and many arguments.
5073 % Much magic with \expandafter here.
5074 % \xdef is used so that macro definitions will survive the file
5075 % they're defined in; @include reads the file inside a group.
5076 \def\defmacro{%
5077   \let\hash=##% convert placeholders to macro parameter chars
5078   \ifrecursive
5079     \ifcase\paramno
5080     % 0
5081       \expandafter\xdef\csname\the\macname\endcsname{%
5082         \noexpand\scanmacro{\temp}}%
5083     \or % 1
5084       \expandafter\xdef\csname\the\macname\endcsname{%
5085          \bgroup\noexpand\macroargctxt
5086          \noexpand\braceorline
5087          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5088       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5089          \egroup\noexpand\scanmacro{\temp}}%
5090     \else % many
5091       \expandafter\xdef\csname\the\macname\endcsname{%
5092          \bgroup\noexpand\macroargctxt
5093          \noexpand\csname\the\macname xx\endcsname}%
5094       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5095           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5096       \expandafter\expandafter
5097       \expandafter\xdef
5098       \expandafter\expandafter
5099         \csname\the\macname xxx\endcsname
5100           \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5101     \fi
5102   \else
5103     \ifcase\paramno
5104     % 0
5105       \expandafter\xdef\csname\the\macname\endcsname{%
5106         \noexpand\norecurse{\the\macname}%
5107         \noexpand\scanmacro{\temp}\egroup}%
5108     \or % 1
5109       \expandafter\xdef\csname\the\macname\endcsname{%
5110          \bgroup\noexpand\macroargctxt
5111          \noexpand\braceorline
5112          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5113       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5114         \egroup
5115         \noexpand\norecurse{\the\macname}%
5116         \noexpand\scanmacro{\temp}\egroup}%
5117     \else % many
5118       \expandafter\xdef\csname\the\macname\endcsname{%
5119          \bgroup\noexpand\macroargctxt
5120          \expandafter\noexpand\csname\the\macname xx\endcsname}%
5121       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5122           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5123       \expandafter\expandafter
5124       \expandafter\xdef
5125       \expandafter\expandafter
5126       \csname\the\macname xxx\endcsname
5127       \paramlist{%
5128           \egroup
5129           \noexpand\norecurse{\the\macname}%
5130           \noexpand\scanmacro{\temp}\egroup}%
5131     \fi
5132   \fi}
5133
5134 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5135
5136 % \braceorline decides whether the next nonwhitespace character is a
5137 % {.  If so it reads up to the closing }, if not, it reads the whole
5138 % line.  Whatever was read is then fed to the next control sequence
5139 % as an argument (by \parsebrace or \parsearg)
5140 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5141 \def\braceorlinexxx{%
5142   \ifx\nchar\bgroup\else
5143     \expandafter\parsearg
5144   \fi \next}
5145
5146 % We mant to disable all macros during \shipout so that they are not
5147 % expanded by \write.
5148 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5149   \edef\next{\macrolist}\expandafter\endgroup\next}
5150
5151
5152 % @alias.
5153 % We need some trickery to remove the optional spaces around the equal
5154 % sign.  Just make them active and then expand them all to nothing.
5155 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5156 \def\aliasxxx #1{\aliasyyy#1\relax}
5157 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5158 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5159            \expandafter\noexpand\csname#2\endcsname}%
5160 \expandafter\endgroup\next}
5161
5162
5163 \message{cross references,}
5164 % @xref etc.
5165
5166 \newwrite\auxfile
5167
5168 \newif\ifhavexrefs    % True if xref values are known.
5169 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
5170
5171 % @inforef is relatively simple.
5172 \def\inforef #1{\inforefzzz #1,,,,**}
5173 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5174   node \samp{\ignorespaces#1{}}}
5175
5176 % @node's job is to define \lastnode.
5177 \def\node{\ENVcheck\parsearg\nodezzz}
5178 \def\nodezzz#1{\nodexxx [#1,]}
5179 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5180 \let\nwnode=\node
5181 \let\lastnode=\relax
5182
5183 % The sectioning commands (@chapter, etc.) call these.
5184 \def\donoderef{%
5185   \ifx\lastnode\relax\else
5186     \expandafter\expandafter\expandafter\setref{\lastnode}%
5187       {Ysectionnumberandtype}%
5188     \global\let\lastnode=\relax
5189   \fi
5190 }
5191 \def\unnumbnoderef{%
5192   \ifx\lastnode\relax\else
5193     \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5194     \global\let\lastnode=\relax
5195   \fi
5196 }
5197 \def\appendixnoderef{%
5198   \ifx\lastnode\relax\else
5199     \expandafter\expandafter\expandafter\setref{\lastnode}%
5200       {Yappendixletterandtype}%
5201     \global\let\lastnode=\relax
5202   \fi
5203 }
5204
5205
5206 % @anchor{NAME} -- define xref target at arbitrary point.
5207 %
5208 \newcount\savesfregister
5209 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5210 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5211 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5212
5213 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5214 % NAME-title, NAME-pg, and NAME-SNT.  Called from \foonoderef.  We have
5215 % to set \indexdummies so commands such as @code in a section title
5216 % aren't expanded.  It would be nicer not to expand the titles in the
5217 % first place, but there's so many layers that that is hard to do.
5218 %
5219 \def\setref#1#2{{%
5220   \indexdummies
5221   \pdfmkdest{#1}%
5222   \dosetq{#1-title}{Ytitle}%
5223   \dosetq{#1-pg}{Ypagenumber}%
5224   \dosetq{#1-snt}{#2}%
5225 }}
5226
5227 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
5228 % the node name, #2 the name of the Info cross-reference, #3 the printed
5229 % node name, #4 the name of the Info file, #5 the name of the printed
5230 % manual.  All but the node name can be omitted.
5231 %
5232 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5233 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5234 \def\ref#1{\xrefX[#1,,,,,,,]}
5235 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5236   \unsepspaces
5237   \def\printedmanual{\ignorespaces #5}%
5238   \def\printednodename{\ignorespaces #3}%
5239   \setbox1=\hbox{\printedmanual}%
5240   \setbox0=\hbox{\printednodename}%
5241   \ifdim \wd0 = 0pt
5242     % No printed node name was explicitly given.
5243     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5244       % Use the node name inside the square brackets.
5245       \def\printednodename{\ignorespaces #1}%
5246     \else
5247       % Use the actual chapter/section title appear inside
5248       % the square brackets.  Use the real section title if we have it.
5249       \ifdim \wd1 > 0pt
5250         % It is in another manual, so we don't have it.
5251         \def\printednodename{\ignorespaces #1}%
5252       \else
5253         \ifhavexrefs
5254           % We know the real title if we have the xref values.
5255           \def\printednodename{\refx{#1-title}{}}%
5256         \else
5257           % Otherwise just copy the Info node name.
5258           \def\printednodename{\ignorespaces #1}%
5259         \fi%
5260       \fi
5261     \fi
5262   \fi
5263   %
5264   % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5265   % insert empty discretionaries after hyphens, which means that it will
5266   % not find a line break at a hyphen in a node names.  Since some manuals
5267   % are best written with fairly long node names, containing hyphens, this
5268   % is a loss.  Therefore, we give the text of the node name again, so it
5269   % is as if TeX is seeing it for the first time.
5270   \ifpdf
5271     \leavevmode
5272     \getfilename{#4}%
5273     \ifnum\filenamelength>0
5274       \startlink attr{/Border [0 0 0]}%
5275         goto file{\the\filename.pdf} name{#1@}%
5276     \else
5277       \startlink attr{/Border [0 0 0]}%
5278         goto name{#1@}%
5279     \fi
5280     \linkcolor
5281   \fi
5282   %
5283   \ifdim \wd1 > 0pt
5284     \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5285   \else
5286     % _ (for example) has to be the character _ for the purposes of the
5287     % control sequence corresponding to the node, but it has to expand
5288     % into the usual \leavevmode...\vrule stuff for purposes of
5289     % printing. So we \turnoffactive for the \refx-snt, back on for the
5290     % printing, back off for the \refx-pg.
5291     {\normalturnoffactive
5292      % Only output a following space if the -snt ref is nonempty; for
5293      % @unnumbered and @anchor, it won't be.
5294      \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5295      \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5296     }%
5297     % [mynode],
5298     [\printednodename],\space
5299     % page 3
5300     \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5301   \fi
5302   \endlink
5303 \endgroup}
5304
5305 % \dosetq is the interface for calls from other macros
5306
5307 % Use \normalturnoffactive so that punctuation chars such as underscore
5308 % and backslash work in node names.  (\turnoffactive doesn't do \.)
5309 \def\dosetq#1#2{%
5310   {\let\folio=0%
5311    \normalturnoffactive
5312    \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5313    \iflinks
5314      \next
5315    \fi
5316   }%
5317 }
5318
5319 % \internalsetq {foo}{page} expands into
5320 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5321 % When the aux file is read, ' is the escape character
5322
5323 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5324
5325 % Things to be expanded by \internalsetq
5326
5327 \def\Ypagenumber{\folio}
5328
5329 \def\Ytitle{\thissection}
5330
5331 \def\Ynothing{}
5332
5333 \def\Ysectionnumberandtype{%
5334 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5335 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5336 \else \ifnum \subsubsecno=0 %
5337 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5338 \else %
5339 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5340 \fi \fi \fi }
5341
5342 \def\Yappendixletterandtype{%
5343 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5344 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5345 \else \ifnum \subsubsecno=0 %
5346 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5347 \else %
5348 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5349 \fi \fi \fi }
5350
5351 \gdef\xreftie{'tie}
5352
5353 % Use TeX 3.0's \inputlineno to get the line number, for better error
5354 % messages, but if we're using an old version of TeX, don't do anything.
5355 %
5356 \ifx\inputlineno\thisisundefined
5357   \let\linenumber = \empty % Non-3.0.
5358 \else
5359   \def\linenumber{\the\inputlineno:\space}
5360 \fi
5361
5362 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5363 % If its value is nonempty, SUFFIX is output afterward.
5364
5365 \def\refx#1#2{%
5366   \expandafter\ifx\csname X#1\endcsname\relax
5367     % If not defined, say something at least.
5368     \angleleft un\-de\-fined\angleright
5369     \iflinks
5370       \ifhavexrefs
5371         \message{\linenumber Undefined cross reference `#1'.}%
5372       \else
5373         \ifwarnedxrefs\else
5374           \global\warnedxrefstrue
5375           \message{Cross reference values unknown; you must run TeX again.}%
5376         \fi
5377       \fi
5378     \fi
5379   \else
5380     % It's defined, so just use it.
5381     \csname X#1\endcsname
5382   \fi
5383   #2% Output the suffix in any case.
5384 }
5385
5386 % This is the macro invoked by entries in the aux file.
5387 %
5388 \def\xrdef#1{\begingroup
5389   % Reenable \ as an escape while reading the second argument.
5390   \catcode`\\ = 0
5391   \afterassignment\endgroup
5392   \expandafter\gdef\csname X#1\endcsname
5393 }
5394
5395 % Read the last existing aux file, if any.  No error if none exists.
5396 \def\readauxfile{\begingroup
5397   \catcode`\^^@=\other
5398   \catcode`\^^A=\other
5399   \catcode`\^^B=\other
5400   \catcode`\^^C=\other
5401   \catcode`\^^D=\other
5402   \catcode`\^^E=\other
5403   \catcode`\^^F=\other
5404   \catcode`\^^G=\other
5405   \catcode`\^^H=\other
5406   \catcode`\^^K=\other
5407   \catcode`\^^L=\other
5408   \catcode`\^^N=\other
5409   \catcode`\^^P=\other
5410   \catcode`\^^Q=\other
5411   \catcode`\^^R=\other
5412   \catcode`\^^S=\other
5413   \catcode`\^^T=\other
5414   \catcode`\^^U=\other
5415   \catcode`\^^V=\other
5416   \catcode`\^^W=\other
5417   \catcode`\^^X=\other
5418   \catcode`\^^Z=\other
5419   \catcode`\^^[=\other
5420   \catcode`\^^\=\other
5421   \catcode`\^^]=\other
5422   \catcode`\^^^=\other
5423   \catcode`\^^_=\other
5424   \catcode`\@=\other
5425   \catcode`\^=\other
5426   % It was suggested to define this as 7, which would allow ^^e4 etc.
5427   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
5428   % supported in the main text, it doesn't seem desirable.  Furthermore,
5429   % that is not enough: for node names that actually contain a ^
5430   % character, we would end up writing a line like this: 'xrdef {'hat
5431   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5432   % argument, and \hat is not an expandable control sequence.  It could
5433   % all be worked out, but why?  Either we support ^^ or we don't.
5434   %
5435   % The other change necessary for this was to define \auxhat:
5436   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5437   % and then to call \auxhat in \setq.
5438   %
5439   \catcode`\~=\other
5440   \catcode`\[=\other
5441   \catcode`\]=\other
5442   \catcode`\"=\other
5443   \catcode`\_=\other
5444   \catcode`\|=\other
5445   \catcode`\<=\other
5446   \catcode`\>=\other
5447   \catcode`\$=\other
5448   \catcode`\#=\other
5449   \catcode`\&=\other
5450   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5451   % Make the characters 128-255 be printing characters
5452   {%
5453     \count 1=128
5454     \def\loop{%
5455       \catcode\count 1=\other
5456       \advance\count 1 by 1
5457       \ifnum \count 1<256 \loop \fi
5458     }%
5459   }%
5460   % The aux file uses ' as the escape (for now).
5461   % Turn off \ as an escape so we do not lose on
5462   % entries which were dumped with control sequences in their names.
5463   % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5464   % Reference to such entries still does not work the way one would wish,
5465   % but at least they do not bomb out when the aux file is read in.
5466   \catcode`\{=1
5467   \catcode`\}=2
5468   \catcode`\%=\other
5469   \catcode`\'=0
5470   \catcode`\\=\other
5471   %
5472   \openin 1 \jobname.aux
5473   \ifeof 1 \else
5474     \closein 1
5475     \input \jobname.aux
5476     \global\havexrefstrue
5477     \global\warnedobstrue
5478   \fi
5479   % Open the new aux file.  TeX will close it automatically at exit.
5480   \openout\auxfile=\jobname.aux
5481 \endgroup}
5482
5483
5484 % Footnotes.
5485
5486 \newcount \footnoteno
5487
5488 % The trailing space in the following definition for supereject is
5489 % vital for proper filling; pages come out unaligned when you do a
5490 % pagealignmacro call if that space before the closing brace is
5491 % removed. (Generally, numeric constants should always be followed by a
5492 % space to prevent strange expansion errors.)
5493 \def\supereject{\par\penalty -20000\footnoteno =0 }
5494
5495 % @footnotestyle is meaningful for info output only.
5496 \let\footnotestyle=\comment
5497
5498 \let\ptexfootnote=\footnote
5499
5500 {\catcode `\@=11
5501 %
5502 % Auto-number footnotes.  Otherwise like plain.
5503 \gdef\footnote{%
5504   \global\advance\footnoteno by \@ne
5505   \edef\thisfootno{$^{\the\footnoteno}$}%
5506   %
5507   % In case the footnote comes at the end of a sentence, preserve the
5508   % extra spacing after we do the footnote number.
5509   \let\@sf\empty
5510   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5511   %
5512   % Remove inadvertent blank space before typesetting the footnote number.
5513   \unskip
5514   \thisfootno\@sf
5515   \footnotezzz
5516 }%
5517
5518 % Don't bother with the trickery in plain.tex to not require the
5519 % footnote text as a parameter.  Our footnotes don't need to be so general.
5520 %
5521 % Oh yes, they do; otherwise, @ifset and anything else that uses
5522 % \parseargline fail inside footnotes because the tokens are fixed when
5523 % the footnote is read.  --karl, 16nov96.
5524 %
5525 \long\gdef\footnotezzz{\insert\footins\bgroup
5526   % We want to typeset this text as a normal paragraph, even if the
5527   % footnote reference occurs in (for example) a display environment.
5528   % So reset some parameters.
5529   \interlinepenalty\interfootnotelinepenalty
5530   \splittopskip\ht\strutbox % top baseline for broken footnotes
5531   \splitmaxdepth\dp\strutbox
5532   \floatingpenalty\@MM
5533   \leftskip\z@skip
5534   \rightskip\z@skip
5535   \spaceskip\z@skip
5536   \xspaceskip\z@skip
5537   \parindent\defaultparindent
5538   %
5539   \smallfonts \rm
5540   %
5541   % Hang the footnote text off the number.
5542   \hang
5543   \textindent{\thisfootno}%
5544   %
5545   % Don't crash into the line above the footnote text.  Since this
5546   % expands into a box, it must come within the paragraph, lest it
5547   % provide a place where TeX can split the footnote.
5548   \footstrut
5549   \futurelet\next\fo@t
5550 }
5551 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5552   \else\let\next\f@t\fi \next}
5553 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
5554 \def\f@t#1{#1\@foot}
5555 \def\@foot{\strut\par\egroup}
5556
5557 }%end \catcode `\@=11
5558
5559 % Set the baselineskip to #1, and the lineskip and strut size
5560 % correspondingly.  There is no deep meaning behind these magic numbers
5561 % used as factors; they just match (closely enough) what Knuth defined.
5562 %
5563 \def\lineskipfactor{.08333}
5564 \def\strutheightpercent{.70833}
5565 \def\strutdepthpercent {.29167}
5566 %
5567 \def\setleading#1{%
5568   \normalbaselineskip = #1\relax
5569   \normallineskip = \lineskipfactor\normalbaselineskip
5570   \normalbaselines
5571   \setbox\strutbox =\hbox{%
5572     \vrule width0pt height\strutheightpercent\baselineskip
5573                     depth \strutdepthpercent \baselineskip
5574   }%
5575 }
5576
5577 % @| inserts a changebar to the left of the current line.  It should
5578 % surround any changed text.  This approach does *not* work if the
5579 % change spans more than two lines of output.  To handle that, we would
5580 % have adopt a much more difficult approach (putting marks into the main
5581 % vertical list for the beginning and end of each change).
5582 %
5583 \def\|{%
5584   % \vadjust can only be used in horizontal mode.
5585   \leavevmode
5586   %
5587   % Append this vertical mode material after the current line in the output.
5588   \vadjust{%
5589     % We want to insert a rule with the height and depth of the current
5590     % leading; that is exactly what \strutbox is supposed to record.
5591     \vskip-\baselineskip
5592     %
5593     % \vadjust-items are inserted at the left edge of the type.  So
5594     % the \llap here moves out into the left-hand margin.
5595     \llap{%
5596       %
5597       % For a thicker or thinner bar, change the `1pt'.
5598       \vrule height\baselineskip width1pt
5599       %
5600       % This is the space between the bar and the text.
5601       \hskip 12pt
5602     }%
5603   }%
5604 }
5605
5606 % For a final copy, take out the rectangles
5607 % that mark overfull boxes (in case you have decided
5608 % that the text looks ok even though it passes the margin).
5609 %
5610 \def\finalout{\overfullrule=0pt}
5611
5612 % @image.  We use the macros from epsf.tex to support this.
5613 % If epsf.tex is not installed and @image is used, we complain.
5614 %
5615 % Check for and read epsf.tex up front.  If we read it only at @image
5616 % time, we might be inside a group, and then its definitions would get
5617 % undone and the next image would fail.
5618 \openin 1 = epsf.tex
5619 \ifeof 1 \else
5620   \closein 1
5621   % Do not bother showing banner with post-v2.7 epsf.tex (available in
5622   % doc/epsf.tex until it shows up on ctan).
5623   \def\epsfannounce{\toks0 = }%
5624   \input epsf.tex
5625 \fi
5626 %
5627 % We will only complain once about lack of epsf.tex.
5628 \newif\ifwarnednoepsf
5629 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5630   work.  It is also included in the Texinfo distribution, or you can get
5631   it from ftp://tug.org/tex/epsf.tex.}
5632 %
5633 \def\image#1{%
5634   \ifx\epsfbox\undefined
5635     \ifwarnednoepsf \else
5636       \errhelp = \noepsfhelp
5637       \errmessage{epsf.tex not found, images will be ignored}%
5638       \global\warnednoepsftrue
5639     \fi
5640   \else
5641     \imagexxx #1,,,\finish
5642   \fi
5643 }
5644 %
5645 % Arguments to @image:
5646 % #1 is (mandatory) image filename; we tack on .eps extension.
5647 % #2 is (optional) width, #3 is (optional) height.
5648 % #4 is just the usual extra ignored arg for parsing this stuff.
5649 \def\imagexxx#1,#2,#3,#4\finish{%
5650   \ifpdf
5651     \centerline{\dopdfimage{#1}{#2}{#3}}%
5652   \else
5653     % \epsfbox itself resets \epsf?size at each figure.
5654     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5655     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5656     \begingroup
5657       \catcode`\^^M = 5 % in case we're inside an example
5658       % If the image is by itself, center it.
5659       \ifvmode
5660         \nobreak\bigskip
5661         % Usually we'll have text after the image which will insert
5662         % \parskip glue, so insert it here too to equalize the space
5663         % above and below. 
5664         \nobreak\vskip\parskip
5665         \nobreak
5666         \centerline{\epsfbox{#1.eps}}%
5667         \bigbreak
5668       \else
5669         % In the middle of a paragraph, no extra space.
5670         \epsfbox{#1.eps}%
5671       \fi
5672     \endgroup
5673   \fi
5674 }
5675
5676
5677 \message{localization,}
5678 % and i18n.
5679
5680 % @documentlanguage is usually given very early, just after
5681 % @setfilename.  If done too late, it may not override everything
5682 % properly.  Single argument is the language abbreviation.
5683 % It would be nice if we could set up a hyphenation file here.
5684 %
5685 \def\documentlanguage{\parsearg\dodocumentlanguage}
5686 \def\dodocumentlanguage#1{%
5687   \tex % read txi-??.tex file in plain TeX.
5688   % Read the file if it exists.
5689   \openin 1 txi-#1.tex
5690   \ifeof1
5691     \errhelp = \nolanghelp
5692     \errmessage{Cannot read language file txi-#1.tex}%
5693     \let\temp = \relax
5694   \else
5695     \def\temp{\input txi-#1.tex }%
5696   \fi
5697   \temp
5698   \endgroup
5699 }
5700 \newhelp\nolanghelp{The given language definition file cannot be found or
5701 is empty.  Maybe you need to install it?  In the current directory
5702 should work if nowhere else does.}
5703
5704
5705 % @documentencoding should change something in TeX eventually, most
5706 % likely, but for now just recognize it.
5707 \let\documentencoding = \comment
5708
5709
5710 % Page size parameters.
5711 %
5712 \newdimen\defaultparindent \defaultparindent = 15pt
5713
5714 \chapheadingskip = 15pt plus 4pt minus 2pt
5715 \secheadingskip = 12pt plus 3pt minus 2pt
5716 \subsecheadingskip = 9pt plus 2pt minus 2pt
5717
5718 % Prevent underfull vbox error messages.
5719 \vbadness = 10000
5720
5721 % Don't be so finicky about underfull hboxes, either.
5722 \hbadness = 2000
5723
5724 % Following George Bush, just get rid of widows and orphans.
5725 \widowpenalty=10000
5726 \clubpenalty=10000
5727
5728 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
5729 % using an old version of TeX, don't do anything.  We want the amount of
5730 % stretch added to depend on the line length, hence the dependence on
5731 % \hsize.  We call this whenever the paper size is set.
5732 %
5733 \def\setemergencystretch{%
5734   \ifx\emergencystretch\thisisundefined
5735     % Allow us to assign to \emergencystretch anyway.
5736     \def\emergencystretch{\dimen0}%
5737   \else
5738     \emergencystretch = .15\hsize
5739   \fi
5740 }
5741
5742 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
5743 % 4) hoffset; 5) binding offset; 6) topskip.  Then whoever calls us can
5744 % set \parskip and call \setleading for \baselineskip.
5745 %
5746 \def\internalpagesizes#1#2#3#4#5#6{%
5747   \voffset = #3\relax
5748   \topskip = #6\relax
5749   \splittopskip = \topskip
5750   %
5751   \vsize = #1\relax
5752   \advance\vsize by \topskip
5753   \outervsize = \vsize
5754   \advance\outervsize by 2\topandbottommargin
5755   \pageheight = \vsize
5756   %
5757   \hsize = #2\relax
5758   \outerhsize = \hsize
5759   \advance\outerhsize by 0.5in
5760   \pagewidth = \hsize
5761   %
5762   \normaloffset = #4\relax
5763   \bindingoffset = #5\relax
5764   %
5765   \parindent = \defaultparindent
5766   \setemergencystretch
5767 }
5768
5769 % @letterpaper (the default).
5770 \def\letterpaper{{\globaldefs = 1
5771   \parskip = 3pt plus 2pt minus 1pt
5772   \setleading{13.2pt}%
5773   %
5774   % If page is nothing but text, make it come out even.
5775   \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}%
5776 }}
5777
5778 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
5779 \def\smallbook{{\globaldefs = 1
5780   \parskip = 2pt plus 1pt
5781   \setleading{12pt}%
5782   %
5783   \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}%
5784   %
5785   \lispnarrowing = 0.3in
5786   \tolerance = 700
5787   \hfuzz = 1pt
5788   \contentsrightmargin = 0pt
5789   \deftypemargin = 0pt
5790   \defbodyindent = .5cm
5791   %
5792   \let\smalldisplay = \smalldisplayx
5793   \let\smallexample = \smalllispx
5794   \let\smallformat = \smallformatx
5795   \let\smalllisp = \smalllispx
5796 }}
5797
5798 % Use @afourpaper to print on European A4 paper.
5799 \def\afourpaper{{\globaldefs = 1
5800   \setleading{12pt}%
5801   \parskip = 3pt plus 2pt minus 1pt
5802   %
5803   \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}%
5804   %
5805   \tolerance = 700
5806   \hfuzz = 1pt
5807 }}
5808
5809 % A specific text layout, 24x15cm overall, intended for A4 paper.  Top margin
5810 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
5811 \def\afourlatex{{\globaldefs = 1
5812   \setleading{13.6pt}%
5813   %
5814   \afourpaper
5815   \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}%
5816   %
5817   \globaldefs = 0
5818 }}
5819
5820 % Use @afourwide to print on European A4 paper in wide format.
5821 \def\afourwide{%
5822   \afourpaper
5823   \internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}%
5824   %
5825   \globaldefs = 0
5826 }
5827
5828 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
5829 % Perhaps we should allow setting the margins, \topskip, \parskip,
5830 % and/or leading, also. Or perhaps we should compute them somehow.
5831 %
5832 \def\pagesizes{\parsearg\pagesizesxxx}
5833 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
5834 \def\pagesizesyyy#1,#2,#3\finish{{%
5835   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
5836   \globaldefs = 1
5837   %
5838   \parskip = 3pt plus 2pt minus 1pt
5839   \setleading{13.2pt}%
5840   %
5841   \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}%
5842 }}
5843
5844 % Set default to letter.
5845 %
5846 \letterpaper
5847
5848
5849 \message{and turning on texinfo input format.}
5850
5851 % Define macros to output various characters with catcode for normal text.
5852 \catcode`\"=\other
5853 \catcode`\~=\other
5854 \catcode`\^=\other
5855 \catcode`\_=\other
5856 \catcode`\|=\other
5857 \catcode`\<=\other
5858 \catcode`\>=\other
5859 \catcode`\+=\other
5860 \catcode`\$=\other
5861 \def\normaldoublequote{"}
5862 \def\normaltilde{~}
5863 \def\normalcaret{^}
5864 \def\normalunderscore{_}
5865 \def\normalverticalbar{|}
5866 \def\normalless{<}
5867 \def\normalgreater{>}
5868 \def\normalplus{+}
5869 \def\normaldollar{$}
5870
5871 % This macro is used to make a character print one way in ttfont
5872 % where it can probably just be output, and another way in other fonts,
5873 % where something hairier probably needs to be done.
5874 %
5875 % #1 is what to print if we are indeed using \tt; #2 is what to print
5876 % otherwise.  Since all the Computer Modern typewriter fonts have zero
5877 % interword stretch (and shrink), and it is reasonable to expect all
5878 % typewriter fonts to have this, we can check that font parameter.
5879 %
5880 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
5881
5882 % Same as above, but check for italic font.  Actually this also catches
5883 % non-italic slanted fonts since it is impossible to distinguish them from
5884 % italic fonts.  But since this is only used by $ and it uses \sl anyway
5885 % this is not a problem.
5886 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
5887
5888 % Turn off all special characters except @
5889 % (and those which the user can use as if they were ordinary).
5890 % Most of these we simply print from the \tt font, but for some, we can
5891 % use math or other variants that look better in normal text.
5892
5893 \catcode`\"=\active
5894 \def\activedoublequote{{\tt\char34}}
5895 \let"=\activedoublequote
5896 \catcode`\~=\active
5897 \def~{{\tt\char126}}
5898 \chardef\hat=`\^
5899 \catcode`\^=\active
5900 \def^{{\tt \hat}}
5901
5902 \catcode`\_=\active
5903 \def_{\ifusingtt\normalunderscore\_}
5904 % Subroutine for the previous macro.
5905 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
5906
5907 \catcode`\|=\active
5908 \def|{{\tt\char124}}
5909 \chardef \less=`\<
5910 \catcode`\<=\active
5911 \def<{{\tt \less}}
5912 \chardef \gtr=`\>
5913 \catcode`\>=\active
5914 \def>{{\tt \gtr}}
5915 \catcode`\+=\active
5916 \def+{{\tt \char 43}}
5917 \catcode`\$=\active
5918 \def${\ifusingit{{\sl\$}}\normaldollar}
5919 %\catcode 27=\active
5920 %\def^^[{$\diamondsuit$}
5921
5922 % Set up an active definition for =, but don't enable it most of the time.
5923 {\catcode`\==\active
5924 \global\def={{\tt \char 61}}}
5925
5926 \catcode`+=\active
5927 \catcode`\_=\active
5928
5929 % If a .fmt file is being used, characters that might appear in a file
5930 % name cannot be active until we have parsed the command line.
5931 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
5932 % \otherifyactive is called near the end of this file.
5933 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
5934
5935 \catcode`\@=0
5936
5937 % \rawbackslashxx output one backslash character in current font
5938 \global\chardef\rawbackslashxx=`\\
5939 %{\catcode`\\=\other
5940 %@gdef@rawbackslashxx{\}}
5941
5942 % \rawbackslash redefines \ as input to do \rawbackslashxx.
5943 {\catcode`\\=\active
5944 @gdef@rawbackslash{@let\=@rawbackslashxx }}
5945
5946 % \normalbackslash outputs one backslash in fixed width font.
5947 \def\normalbackslash{{\tt\rawbackslashxx}}
5948
5949 % \catcode 17=0   % Define control-q
5950 \catcode`\\=\active
5951
5952 % Used sometimes to turn off (effectively) the active characters
5953 % even after parsing them.
5954 @def@turnoffactive{@let"=@normaldoublequote
5955 @let\=@realbackslash
5956 @let~=@normaltilde
5957 @let^=@normalcaret
5958 @let_=@normalunderscore
5959 @let|=@normalverticalbar
5960 @let<=@normalless
5961 @let>=@normalgreater
5962 @let+=@normalplus
5963 @let$=@normaldollar}
5964
5965 @def@normalturnoffactive{@let"=@normaldoublequote
5966 @let\=@normalbackslash
5967 @let~=@normaltilde
5968 @let^=@normalcaret
5969 @let_=@normalunderscore
5970 @let|=@normalverticalbar
5971 @let<=@normalless
5972 @let>=@normalgreater
5973 @let+=@normalplus
5974 @let$=@normaldollar}
5975
5976 % Make _ and + \other characters, temporarily.
5977 % This is canceled by @fixbackslash.
5978 @otherifyactive
5979
5980 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
5981 % That is what \eatinput is for; after that, the `\' should revert to printing
5982 % a backslash.
5983 %
5984 @gdef@eatinput input texinfo{@fixbackslash}
5985 @global@let\ = @eatinput
5986
5987 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
5988 % the first `\{ in the file would cause an error. This macro tries to fix
5989 % that, assuming it is called before the first `\' could plausibly occur.
5990 % Also back turn on active characters that might appear in the input
5991 % file name, in case not using a pre-dumped format.
5992 %
5993 @gdef@fixbackslash{%
5994   @ifx\@eatinput @let\ = @normalbackslash @fi
5995   @catcode`+=@active
5996   @catcode`@_=@active
5997 }
5998
5999 % Say @foo, not \foo, in error messages.
6000 @escapechar = `@@
6001
6002 % These look ok in all fonts, so just make them not special.  
6003 @catcode`@& = @other
6004 @catcode`@# = @other
6005 @catcode`@% = @other
6006
6007 @c Set initial fonts.
6008 @textfonts
6009 @rm
6010
6011
6012 @c Local variables:
6013 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6014 @c page-delimiter: "^\\\\message"
6015 @c time-stamp-start: "def\\\\texinfoversion{"
6016 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6017 @c time-stamp-end: "}"
6018 @c End: