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