source: trunk/third/gtk/docs/texinfo.tex @ 14482

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