OSDN Git Service

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