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