source: rtems/doc/texinfo/texinfo.tex @ 31bfb92

4.104.114.84.95
Last change on this file since 31bfb92 was 31bfb92, checked in by Joel Sherrill <joel.sherrill@…>, on May 28, 2000 at 6:31:01 PM

Patch obtain from bug-texinfo mailing list from Trevin Beattie
<trevin@…> to make hyperlinks take you to the top of
a page rather than the bottom.

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