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