1 %% TeX macros to handle texinfo files
3 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93,
4 % 94, 95, 1996 Free Software Foundation, Inc.
6 %This texinfo.tex file is free software; you can redistribute it and/or
7 %modify it under the terms of the GNU General Public License as
8 %published by the Free Software Foundation; either version 2, or (at
9 %your option) any later version.
11 %This texinfo.tex file is distributed in the hope that it will be
12 %useful, but WITHOUT ANY WARRANTY; without even the implied warranty
13 %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 %General Public License for more details.
16 %You should have received a copy of the GNU General Public License
17 %along with this texinfo.tex file; see the file COPYING. If not, write
18 %to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 %Boston, MA 02111-1307, USA.
22 %In other words, you are welcome to use, share and improve this program.
23 %You are forbidden to forbid anyone else to use, share and improve
24 %what you give them. Help stamp out software-hoarding!
27 % Send bug reports to bug-texinfo@prep.ai.mit.edu.
28 % Please include a *precise* test case in each bug report.
31 % Make it possible to create a .fmt file just by loading this file:
32 % if the underlying format is not loaded, start by loading it now.
33 % Added by gildea November 1993.
34 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
36 % This automatically updates the version number based on RCS.
37 \def\deftexinfoversion$#1: #2 ${\def\texinfoversion{#2}}
38 \deftexinfoversion$Revision: 1.2 $
39 \message{Loading texinfo package [Version \texinfoversion]:}
41 % If in a .fmt file, print the version number
42 % and turn on active characters that we couldn't do earlier because
43 % they might have appeared in the input file name.
44 \everyjob{\message{[Texinfo version \texinfoversion]}\message{}
45 \catcode`+=\active \catcode`\_=\active}
47 % Save some parts of plain tex whose names we will redefine.
56 \let\ptexbullet=\bullet
64 % Be sure we're in horizontal mode when doing a tie, since we make space
65 % equivalent to this in @example-like environments. Otherwise, a space
66 % at the beginning of a line will start with \penalty -- and
67 % since \penalty is valid in vertical mode, we'd end up putting the
68 % penalty on the vertical list instead of in the new paragraph.
70 % Avoid using \@M directly, because that causes trouble
71 % if the definition is written into an index file.
72 \global\let\tiepenalty = \@M
73 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
75 \let\~ = \tie % And make it available as @~.
80 % If this character appears in an error message or help string, it
81 % starts a new line in the output.
84 % Set up fixed words for English.
85 \ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter}}\fi%
86 \def\putwordInfo{Info}%
87 \ifx\putwordSee\undefined{\gdef\putwordSee{See}}\fi%
88 \ifx\putwordsee\undefined{\gdef\putwordsee{see}}\fi%
89 \ifx\putwordfile\undefined{\gdef\putwordfile{file}}\fi%
90 \ifx\putwordpage\undefined{\gdef\putwordpage{page}}\fi%
91 \ifx\putwordsection\undefined{\gdef\putwordsection{section}}\fi%
92 \ifx\putwordSection\undefined{\gdef\putwordSection{Section}}\fi%
93 \ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents}}\fi%
94 \ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents}}\fi%
95 \ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix}}\fi%
101 \hyphenation{ap-pen-dix}
102 \hyphenation{mini-buf-fer mini-buf-fers}
105 % Margin to add to right of even pages, to left of odd pages.
106 \newdimen \bindingoffset \bindingoffset=0pt
107 \newdimen \normaloffset \normaloffset=\hoffset
108 \newdimen\pagewidth \newdimen\pageheight
109 \pagewidth=\hsize \pageheight=\vsize
111 % Sometimes it is convenient to have everything in the transcript file
112 % and nothing on the terminal. We don't just call \tracingall here,
113 % since that produces some useless output on the terminal.
115 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
116 \def\loggingall{\tracingcommands2 \tracingstats2
117 \tracingpages1 \tracingoutput1 \tracinglostchars1
118 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
119 \showboxbreadth\maxdimen\showboxdepth\maxdimen
122 %---------------------Begin change-----------------------
124 %%%% For @cropmarks command.
125 % Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986
127 \newdimen\cornerlong \newdimen\cornerthick
128 \newdimen \topandbottommargin
129 \newdimen \outerhsize \newdimen \outervsize
130 \cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks
133 % Alternative @smallbook page size is 9.25in
135 \topandbottommargin=.75in
137 %---------------------End change-----------------------
139 % \onepageout takes a vbox as an argument. Note that \pagecontents
140 % does insertions itself, but you have to call it yourself.
141 \chardef\PAGE=255 \output={\onepageout{\pagecontents\PAGE}}
142 \def\onepageout#1{\hoffset=\normaloffset
143 \ifodd\pageno \advance\hoffset by \bindingoffset
144 \else \advance\hoffset by -\bindingoffset\fi
145 {\escapechar=`\\\relax % makes sure backslash is used in output files.
146 \shipout\vbox{{\let\hsize=\pagewidth \makeheadline} \pagebody{#1}%
147 {\let\hsize=\pagewidth \makefootline}}}%
148 \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
150 %%%% For @cropmarks command %%%%
152 % Here is a modification of the main output routine for Near East Publications
153 % This provides right-angle cropmarks at all four corners.
154 % The contents of the page are centerlined into the cropmarks,
155 % and any desired binding offset is added as an \hskip on either
156 % site of the centerlined box. (P. A. MacKay, 12 November, 1986)
158 \def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up
159 {\escapechar=`\\\relax % makes sure backslash is used in output files.
161 \vbox to \outervsize{\hsize=\outerhsize
162 \vbox{\line{\ewtop\hfill\ewtop}}
164 \line{\vbox{\moveleft\cornerthick\nstop}
166 \vbox{\moveright\cornerthick\nstop}}
167 \vskip \topandbottommargin
168 \centerline{\ifodd\pageno\hskip\bindingoffset\fi
170 {\let\hsize=\pagewidth \makeheadline}
172 {\let\hsize=\pagewidth \makefootline}}
173 \ifodd\pageno\else\hskip\bindingoffset\fi}
174 \vskip \topandbottommargin plus1fill minus1fill
175 \boxmaxdepth\cornerthick
176 \line{\vbox{\moveleft\cornerthick\nsbot}
178 \vbox{\moveright\cornerthick\nsbot}}
180 \vbox{\line{\ewbot\hfill\ewbot}}
183 \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
185 % Do @cropmarks to get crop marks
186 \def\cropmarks{\let\onepageout=\croppageout }
188 \newinsert\margin \dimen\margin=\maxdimen
190 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
192 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
193 % marginal hacks, juha@viisa.uucp (Juha Takala)
194 \ifvoid\margin\else % marginal info is present
195 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
196 \dimen@=\dp#1 \unvbox#1
197 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
198 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
202 % Here are the rules for the cropmarks. Note that they are
203 % offset so that the space between them is truly \outerhsize or \outervsize
204 % (P. A. MacKay, 12 November, 1986)
206 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
208 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
209 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
211 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
213 % Parse an argument, then pass it to #1. The argument is the rest of
214 % the input line (except we remove a trailing comment). #1 should be a
215 % macro which expects an ordinary undelimited TeX argument.
221 \futurelet\temp\parseargx
224 % If the next token is an obeyed space (from an @example environment or
225 % the like), remove it and recurse. Otherwise, we're done.
227 % \obeyedspace is defined far below, after the definition of \sepspaces.
228 \ifx\obeyedspace\temp
229 \expandafter\parseargdiscardspace
231 \expandafter\parseargline
235 % Remove a single space (as the delimiter token to the macro call).
237 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
240 \gdef\parseargline#1^^M{%
241 \endgroup % End of the group started in \parsearg.
243 % First remove any @c comment, then any @comment.
244 % Result of each macro is put in \toks0.
245 \argremovec #1\c\relax %
246 \expandafter\argremovecomment \the\toks0 \comment\relax %
248 % Call the caller's macro, saved as \next in \parsearg.
249 \expandafter\next\expandafter{\the\toks0}%
253 % Since all \c{,omment} does is throw away the argument, we can let TeX
254 % do that for us. The \relax here is matched by the \relax in the call
255 % in \parseargline; it could be more or less anything, its purpose is
256 % just to delimit the argument to the \c.
257 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
258 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
260 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
261 % @end itemize @c foo
262 % will have two active spaces as part of the argument with the
263 % `itemize'. Here we remove all active spaces from #1, and assign the
266 % This loses if there are any *other* active characters besides spaces
267 % in the argument -- _ ^ +, for example -- since they get expanded.
268 % Fortunately, Texinfo does not define any such commands. (If it ever
269 % does, the catcode of the characters in questionwill have to be changed
270 % here.) But this means we cannot call \removeactivespaces as part of
271 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
272 % that \parsearg gets might well have any character at all in it.
274 \def\removeactivespaces#1{%
278 \global\toks0 = \expandafter{\temp}%
282 % Change the active space to expand to nothing.
286 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
290 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
292 %% These are used to keep @begin/@end levels from running away
293 %% Call \inENV within environments (after a \begingroup)
294 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
296 \ifENV\errmessage{Still within an environment. Type Return to continue.}
297 \endgroup\fi} % This is not perfect, but it should reduce lossage
299 % @begin foo is the same as @foo, for now.
300 \newhelp\EMsimple{Type <Return> to continue.}
302 \outer\def\begin{\parsearg\beginxxx}
305 \expandafter\ifx\csname #1\endcsname\relax
306 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
307 \csname #1\endcsname\fi}
309 % @end foo executes the definition of \Efoo.
311 \def\end{\parsearg\endxxx}
313 \removeactivespaces{#1}%
314 \edef\endthing{\the\toks0}%
316 \expandafter\ifx\csname E\endthing\endcsname\relax
317 \expandafter\ifx\csname \endthing\endcsname\relax
318 % There's no \foo, i.e., no ``environment'' foo.
320 \errmessage{Undefined command `@end \endthing'}%
322 \unmatchedenderror\endthing
325 % Everything's ok; the right environment has been started.
326 \csname E\endthing\endcsname
330 % There is an environment #1, but it hasn't been started. Give an error.
332 \def\unmatchedenderror#1{%
334 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
337 % Define the control sequence \E#1 to give an unmatched @end error.
339 \def\defineunmatchedend#1{%
340 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
344 % Single-spacing is done by various environments (specifically, in
345 % \nonfillstart and \quotations).
346 \newskip\singlespaceskip \singlespaceskip = 12.5pt
348 % Why was this kern here? It messes up equalizing space above and below
349 % environments. --karl, 6may93
350 %{\advance \baselineskip by -\singlespaceskip
351 %\kern \baselineskip}%
352 \setleading \singlespaceskip
355 %% Simple single-character @ commands
358 % Kludge this until the fonts are right (grr).
359 \def\@{{\tt \char '100}}
361 % This is turned off because it was never documented
362 % and you can use @w{...} around a quote to suppress ligatures.
363 %% Define @` and @' to be the same as ` and '
364 %% but suppressing ligatures.
368 % Used to generate quoted braces.
370 \def\mylbrace {{\tt \char '173}}
371 \def\myrbrace {{\tt \char '175}}
375 % @: forces normal size whitespace following.
376 \def\:{\spacefactor=1000 }
378 % @* forces a line break.
379 \def\*{\hfil\break\hbox{}\ignorespaces}
381 % @. is an end-of-sentence period.
382 \def\.{.\spacefactor=3000 }
384 % @enddots{} is an end-of-sentence ellipsis.
385 \gdef\enddots{$\mathinner{\ldotp\ldotp\ldotp\ldotp}$\spacefactor=3000}
387 % @! is an end-of-sentence bang.
388 \gdef\!{!\spacefactor=3000 }
390 % @? is an end-of-sentence query.
391 \gdef\?{?\spacefactor=3000 }
393 % @w prevents a word break. Without the \leavevmode, @w at the
394 % beginning of a paragraph, when TeX is still in vertical mode, would
395 % produce a whole line of output instead of starting the paragraph.
396 \def\w#1{\leavevmode\hbox{#1}}
398 % @group ... @end group forces ... to be all on one page, by enclosing
399 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
400 % to keep its height that of a normal line. According to the rules for
401 % \topskip (p.114 of the TeXbook), the glue inserted is
402 % max (\topskip - \ht (first item), 0). If that height is large,
403 % therefore, no glue is inserted, and the space between the headline and
404 % the text is small, which looks bad.
406 \def\group{\begingroup
407 \ifnum\catcode13=\active \else
408 \errhelp = \groupinvalidhelp
409 \errmessage{@group invalid in context where filling is enabled}%
412 % The \vtop we start below produces a box with normal height and large
413 % depth; thus, TeX puts \baselineskip glue before it, and (when the
414 % next line of text is done) \lineskip glue after it. (See p.82 of
415 % the TeXbook.) Thus, space below is not quite equal to space
416 % above. But it's pretty close.
418 \egroup % End the \vtop.
419 \endgroup % End the \group.
423 % We have to put a strut on the last line in case the @group is in
424 % the midst of an example, rather than completely enclosing it.
425 % Otherwise, the interline space between the last line of the group
426 % and the first line afterwards is too small. But we can't put the
427 % strut in \Egroup, since there it would be on a line by itself.
428 % Hence this just inserts a strut at the beginning of each line.
429 \everypar = {\strut}%
431 % Since we have a strut on every line, we don't need any of TeX's
432 % normal interline spacing.
435 % OK, but now we have to do something about blank
436 % lines in the input in @example-like environments, which normally
437 % just turn into \lisppar, which will insert no space now that we've
438 % turned off the interline space. Simplest is to make them be an
441 \edef\par{\leavevmode \par}%
443 % Reset ^^M's definition to new definition of \par.
447 % Do @comment since we are called inside an environment such as
448 % @example, where each end-of-line in the input causes an
449 % end-of-line in the output. We don't want the end-of-line after
450 % the `@group' to put extra space in the output. Since @group
451 % should appear on a line by itself (according to the Texinfo
452 % manual), we don't worry about eating any user text.
456 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
457 % message, so this ends up printing `@group can only ...'.
459 \newhelp\groupinvalidhelp{%
460 group can only be used in environments such as @example,^^J%
461 where each line of input produces a line of output.}
463 % @need space-in-mils
464 % forces a page break if there is not space-in-mils remaining.
466 \newdimen\mil \mil=0.001in
468 \def\need{\parsearg\needx}
470 % Old definition--didn't work.
471 %\def\needx #1{\par %
472 %% This method tries to make TeX break the page naturally
473 %% if the depth of the box does not fit.
475 %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
480 % Go into vertical mode, so we don't make a big box in the middle of a
484 % Don't add any leading before our big empty box, but allow a page
485 % break, since the best break might be right here.
488 \vtop to #1\mil{\vfil}%
490 % TeX does not even consider page breaks if a penalty added to the
491 % main vertical list is 10000 or more. But in order to see if the
492 % empty box we just added fits on the page, we must make it consider
493 % page breaks. On the other hand, we don't want to actually break the
494 % page after the empty box. So we use a penalty of 9999.
496 % There is an extremely small chance that TeX will actually break the
497 % page at this \penalty, if there are no other feasible breakpoints in
498 % sight. (If the user is using lots of big @group commands, which
499 % almost-but-not-quite fill up a page, TeX will have a hard time doing
500 % good page breaking, for example.) However, I could not construct an
501 % example where a page broke at this \penalty; if it happens in a real
502 % document, then we can reconsider our strategy.
505 % Back up by the size of the box, whether we did a page break or not.
508 % Do not allow a page break right after this kern.
512 % @br forces paragraph break
516 % @dots{} output some dots
520 % @page forces the start of a new page
522 \def\page{\par\vfill\supereject}
525 % outputs text on separate line in roman font, starting at standard page margin
527 % This records the amount of indent in the innermost environment.
528 % That's how much \exdent should take out.
529 \newskip\exdentamount
531 % This defn is used inside fill environments such as @defun.
532 \def\exdent{\parsearg\exdentyyy}
533 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
535 % This defn is used inside nofill environments such as @example.
536 \def\nofillexdent{\parsearg\nofillexdentyyy}
537 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
538 \leftline{\hskip\leftskip{\rm#1}}}}
540 % @inmargin{TEXT} puts TEXT in the margin next to the current paragraph.
543 \strut\vadjust{\nobreak\kern-\strutdepth
544 \vtop to \strutdepth{\baselineskip\strutdepth\vss
545 \llap{\rightskip=\inmarginspacing \vbox{\noindent #1}}\null}}}
546 \newskip\inmarginspacing \inmarginspacing=1cm
547 \def\strutdepth{\dp\strutbox}
549 %\hbox{{\rm#1}}\hfil\break}}
551 % @include file insert text of that file as input.
552 % Allow normal characters that we make active in the argument (a file name).
553 \def\include{\begingroup
562 \parsearg\includezzz}
563 % Restore active chars for included file.
564 \def\includezzz#1{\endgroup\begingroup
565 % Read the included file in a group so nested @include's work.
572 % @center line outputs that line, centered
574 \def\center{\parsearg\centerzzz}
575 \def\centerzzz #1{{\advance\hsize by -\leftskip
576 \advance\hsize by -\rightskip
579 % @sp n outputs n lines of vertical space
581 \def\sp{\parsearg\spxxx}
582 \def\spxxx #1{\par \vskip #1\baselineskip}
584 % @comment ...line which is ignored...
585 % @c is the same as @comment
586 % @ignore ... @end ignore is another way to write a comment
588 \def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
589 \parsearg \commentxxx}
591 \def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
595 % @paragraphindent is defined for the Info formatting commands only.
596 \let\paragraphindent=\comment
598 % Prevent errors for section commands.
599 % Used in @ignore and in failing conditionals.
600 \def\ignoresections{%
602 \let\unnumbered=\relax
604 \let\unnumberedsec=\relax
605 \let\unnumberedsection=\relax
606 \let\unnumberedsubsec=\relax
607 \let\unnumberedsubsection=\relax
608 \let\unnumberedsubsubsec=\relax
609 \let\unnumberedsubsubsection=\relax
612 \let\subsubsec=\relax
613 \let\subsection=\relax
614 \let\subsubsection=\relax
616 \let\appendixsec=\relax
617 \let\appendixsection=\relax
618 \let\appendixsubsec=\relax
619 \let\appendixsubsection=\relax
620 \let\appendixsubsubsec=\relax
621 \let\appendixsubsubsection=\relax
623 \let\smallbook=\relax
624 \let\titlepage=\relax
627 % Used in nested conditionals, where we have to parse the Texinfo source
628 % and so want to turn off most commands, in case they are used
631 \def\ignoremorecommands{%
632 \let\defcodeindex = \relax
636 \let\defindex = \relax
637 \let\defivar = \relax
639 \let\defmethod = \relax
642 \let\defspec = \relax
644 \let\deftypefn = \relax
645 \let\deftypefun = \relax
646 \let\deftypevar = \relax
647 \let\deftypevr = \relax
653 \let\printindex = \relax
655 \let\settitle = \relax
656 \let\setchapternewpage = \relax
657 \let\setchapterstyle = \relax
658 \let\everyheading = \relax
659 \let\evenheading = \relax
660 \let\oddheading = \relax
661 \let\everyfooting = \relax
662 \let\evenfooting = \relax
663 \let\oddfooting = \relax
664 \let\headings = \relax
665 \let\include = \relax
666 \let\lowersections = \relax
668 \let\raisesections = \relax
675 % Ignore @ignore ... @end ignore.
677 \def\ignore{\doignore{ignore}}
679 % Also ignore @ifinfo, @ifhtml, @html, @menu, and @direntry text.
681 \def\ifinfo{\doignore{ifinfo}}
682 \def\ifhtml{\doignore{ifhtml}}
683 \def\html{\doignore{html}}
684 \def\menu{\doignore{menu}}
685 \def\direntry{\doignore{direntry}}
687 % @dircategory CATEGORY -- specify a category of the dir file
688 % which this file should belong to. Ignore this in TeX.
690 \def\dircategory{\comment}
692 % Ignore text until a line `@end #1'.
694 \def\doignore#1{\begingroup
695 % Don't complain about control sequences we have declared \outer.
698 % Define a command to swallow text until we reach `@end #1'.
699 \long\def\doignoretext##1\end #1{\enddoignore}%
701 % Make sure that spaces turn into tokens that match what \doignoretext wants.
704 % And now expand that command.
708 % What we do to finish off ignored text.
710 \def\enddoignore{\endgroup\ignorespaces}%
712 \newif\ifwarnedobs\warnedobsfalse
714 \ifwarnedobs\relax\else
715 % We need to warn folks that they may have trouble with TeX 3.0.
716 % This uses \immediate\write16 rather than \message to get newlines.
718 \immediate\write16{***WARNING*** for users of Unix TeX 3.0!}
719 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
720 \immediate\write16{If you are running another version of TeX, relax.}
721 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
722 \immediate\write16{ Then upgrade your TeX installation if you can.}
723 \immediate\write16{If you are stuck with version 3.0, run the}
724 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
725 \immediate\write16{ to use a workaround.}
727 \global\warnedobstrue
731 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
732 % workaround (which requires the file ``dummy.tfm'' to be installed),
733 % uncomment the following line:
734 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
736 % Ignore text, except that we keep track of conditional commands for
737 % purposes of nesting, up to an `@end #1' command.
739 \def\nestedignore#1{%
741 % We must actually expand the ignored text to look for the @end
742 % command, so that nested ignore constructs work. Thus, we put the
743 % text into a \vbox and then do nothing with the result. To minimize
744 % the change of memory overflow, we follow the approach outlined on
745 % page 401 of the TeXbook: make the current font be a dummy font.
747 \setbox0 = \vbox\bgroup
748 % Don't complain about control sequences we have declared \outer.
751 % Define `@end #1' to end the box, which will in turn undefine the
752 % @end command again.
753 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
755 % We are going to be parsing Texinfo commands. Most cause no
756 % trouble when they are used incorrectly, but some commands do
757 % complicated argument parsing or otherwise get confused, so we
760 % We can't do anything about stray @-signs, unfortunately;
761 % they'll produce `undefined control sequence' errors.
764 % Set the current font to be \nullfont, a TeX primitive, and define
765 % all the font commands to also use \nullfont. We don't use
766 % dummy.tfm, as suggested in the TeXbook, because not all sites
767 % might have that installed. Therefore, math mode will still
768 % produce output, but that should be an extremely small amount of
769 % stuff compared to the main input.
772 \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont
773 \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont
774 \let\tensf = \nullfont
775 % Similarly for index fonts (mostly for their use in
777 \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont
778 \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont
779 \let\indsf = \nullfont
781 % Don't complain when characters are missing from the fonts.
782 \tracinglostchars = 0
784 % Don't bother to do space factor calculations.
787 % Don't report underfull hboxes.
790 % Do minimal line-breaking.
791 \pretolerance = 10000
793 % Do not execute instructions in @tex
794 \def\tex{\doignore{tex}}
797 % @set VAR sets the variable VAR to an empty value.
798 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
800 % Since we want to separate VAR from REST-OF-LINE (which might be
801 % empty), we can't just use \parsearg; we have to insert a space of our
802 % own to delimit the rest of the line, and then take it out again if we
803 % didn't need it. Make sure the catcode of space is correct to avoid
804 % losing inside @example, for instance.
806 \def\set{\begingroup\catcode` =10 \parsearg\setxxx}
807 \def\setxxx#1{\setyyy#1 \endsetyyy}
808 \def\setyyy#1 #2\endsetyyy{%
810 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
811 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
815 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
816 % \next or other control sequences that we've defined might get us into
817 % an infinite loop. Consider `@set foo @cite{bar}'.
818 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
820 % @clear VAR clears (i.e., unsets) the variable VAR.
822 \def\clear{\parsearg\clearxxx}
823 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
825 % @value{foo} gets the text saved in variable foo.
827 \def\value#1{\expandafter
828 \ifx\csname SET#1\endcsname\relax
829 {\{No value for ``#1''\}}
830 \else \csname SET#1\endcsname \fi}
832 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
835 \def\ifset{\parsearg\ifsetxxx}
837 \expandafter\ifx\csname SET#1\endcsname\relax
838 \expandafter\ifsetfail
840 \expandafter\ifsetsucceed
843 \def\ifsetsucceed{\conditionalsucceed{ifset}}
844 \def\ifsetfail{\nestedignore{ifset}}
845 \defineunmatchedend{ifset}
847 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
848 % defined with @set, or has been undefined with @clear.
850 \def\ifclear{\parsearg\ifclearxxx}
852 \expandafter\ifx\csname SET#1\endcsname\relax
853 \expandafter\ifclearsucceed
855 \expandafter\ifclearfail
858 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
859 \def\ifclearfail{\nestedignore{ifclear}}
860 \defineunmatchedend{ifclear}
862 % @iftex always succeeds; we read the text following, through @end
863 % iftex). But `@end iftex' should be valid only after an @iftex.
865 \def\iftex{\conditionalsucceed{iftex}}
866 \defineunmatchedend{iftex}
868 % We can't just want to start a group at @iftex (for example) and end it
869 % at @end iftex, since then @set commands inside the conditional have no
870 % effect (they'd get reverted at the end of the group). So we must
871 % define \Eiftex to redefine itself to be its previous value. (We can't
872 % just define it to fail again with an ``unmatched end'' error, since
873 % the @ifset might be nested.)
875 \def\conditionalsucceed#1{%
877 % Remember the current value of \E#1.
878 \let\nece{prevE#1} = \nece{E#1}%
880 % At the `@end #1', redefine \E#1 to be its previous value.
881 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
886 % We need to expand lots of \csname's, but we don't want to expand the
887 % control sequences after we've constructed them.
889 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
891 % @asis just yields its argument. Used with @table, for example.
895 % @math means output in math mode.
896 % We don't use $'s directly in the definition of \math because control
897 % sequences like \math are expanded when the toc file is written. Then,
898 % we read the toc file back, the $'s will be normal characters (as they
899 % should be, according to the definition of Texinfo). So we must use a
900 % control sequence to switch into and out of math mode.
902 % This isn't quite enough for @math to work properly in indices, but it
903 % seems unlikely it will ever be needed there.
905 \let\implicitmath = $
906 \def\math#1{\implicitmath #1\implicitmath}
908 % @bullet and @minus need the same treatment as @math, just above.
909 \def\bullet{\implicitmath\ptexbullet\implicitmath}
910 \def\minus{\implicitmath-\implicitmath}
912 \def\node{\ENVcheck\parsearg\nodezzz}
913 \def\nodezzz#1{\nodexxx [#1,]}
914 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
918 \def\donoderef{\ifx\lastnode\relax\else
919 \expandafter\expandafter\expandafter\setref{\lastnode}\fi
920 \global\let\lastnode=\relax}
922 \def\unnumbnoderef{\ifx\lastnode\relax\else
923 \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
924 \global\let\lastnode=\relax}
926 \def\appendixnoderef{\ifx\lastnode\relax\else
927 \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
928 \global\let\lastnode=\relax}
932 % @setfilename is done at the beginning of every texinfo file.
933 % So open here the files we need to have open while reading the input.
934 % This makes it possible to make a .fmt file for texinfo.
939 \fixbackslash % Turn off hack to swallow `\input texinfo'.
940 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
941 \comment % Ignore the actual filename.
944 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
946 \def\inforef #1{\inforefzzz #1,,,,**}
947 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
948 node \samp{\ignorespaces#1{}}}
950 \def\macro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\macroxxx}
951 \def\macroxxx#1#2 \end macro{%
952 \expandafter\gdef\macrotemp#1{#2}%
955 %\def\linemacro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\linemacroxxx}
956 %\def\linemacroxxx#1#2 \end linemacro{%
957 %\let\parsearg=\relax
958 %\edef\macrotempx{\csname M\butfirst\expandafter\string\macrotemp\endcsname}%
959 %\expandafter\xdef\macrotemp{\parsearg\macrotempx}%
960 %\expandafter\gdef\macrotempx#1{#2}%
967 % Font-change commands.
969 % Texinfo supports the sans serif font style, which plain TeX does not.
970 % So we set up a \sf analogous to plain's \rm, etc.
972 \def\sf{\fam=\sffam \tensf}
973 \let\li = \sf % Sometimes we call it \li, not \sf.
975 % We don't need math for this one.
978 %% Try out Computer Modern fonts at \magstephalf
979 \let\mainmagstep=\magstephalf
981 % Set the font macro #1 to the font named #2, adding on the
982 % specified font prefix (normally `cm').
983 % #3 is the font's design size, #4 is a scale factor
984 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
986 % Use cm as the default font prefix.
987 % To specify the font prefix, you must define \fontprefix
988 % before you read in texinfo.tex.
989 \ifx\fontprefix\undefined
992 % Support font families that don't use the same naming scheme as CM.
994 \def\rmbshape{bx} %where the normal face is bold
1010 \let\mainmagstep=\magstep1
1011 \setfont\textrm\rmshape{12}{1000}
1012 \setfont\texttt\ttshape{12}{1000}
1014 \setfont\textrm\rmshape{10}{\mainmagstep}
1015 \setfont\texttt\ttshape{10}{\mainmagstep}
1017 % Instead of cmb10, you many want to use cmbx10.
1018 % cmbx10 is a prettier font on its own, but cmb10
1019 % looks better when embedded in a line with cmr10.
1020 \setfont\textbf\bfshape{10}{\mainmagstep}
1021 \setfont\textit\itshape{10}{\mainmagstep}
1022 \setfont\textsl\slshape{10}{\mainmagstep}
1023 \setfont\textsf\sfshape{10}{\mainmagstep}
1024 \setfont\textsc\scshape{10}{\mainmagstep}
1025 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1026 \font\texti=cmmi10 scaled \mainmagstep
1027 \font\textsy=cmsy10 scaled \mainmagstep
1029 % A few fonts for @defun, etc.
1030 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1031 \setfont\deftt\ttshape{10}{\magstep1}
1032 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1034 % Fonts for indices and small examples (9pt).
1035 % We actually use the slanted font rather than the italic,
1036 % because texinfo normally uses the slanted fonts for that.
1037 % Do not make many font distinctions in general in the index, since they
1038 % aren't very useful.
1039 \setfont\ninett\ttshape{9}{1000}
1040 \setfont\indrm\rmshape{9}{1000}
1041 \setfont\indit\slshape{9}{1000}
1044 \let\indttsl=\ninett
1047 \setfont\indsc\scshape{10}{900}
1051 % Chapter (and unnumbered) fonts (17.28pt).
1052 \setfont\chaprm\rmbshape{12}{\magstep2}
1053 \setfont\chapit\itbshape{10}{\magstep3}
1054 \setfont\chapsl\slbshape{10}{\magstep3}
1055 \setfont\chaptt\ttbshape{12}{\magstep2}
1056 \setfont\chapttsl\ttslshape{10}{\magstep3}
1057 \setfont\chapsf\sfbshape{12}{\magstep2}
1059 \setfont\chapsc\scbshape{10}{\magstep3}
1060 \font\chapi=cmmi12 scaled \magstep2
1061 \font\chapsy=cmsy10 scaled \magstep3
1063 % Section fonts (14.4pt).
1064 \setfont\secrm\rmbshape{12}{\magstep1}
1065 \setfont\secit\itbshape{10}{\magstep2}
1066 \setfont\secsl\slbshape{10}{\magstep2}
1067 \setfont\sectt\ttbshape{12}{\magstep1}
1068 \setfont\secttsl\ttslshape{10}{\magstep2}
1069 \setfont\secsf\sfbshape{12}{\magstep1}
1071 \setfont\secsc\scbshape{10}{\magstep2}
1072 \font\seci=cmmi12 scaled \magstep1
1073 \font\secsy=cmsy10 scaled \magstep2
1075 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1076 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1077 % \setfont\ssecsl\slshape{10}{\magstep1}
1078 % \setfont\ssectt\ttshape{10}{\magstep1}
1079 % \setfont\ssecsf\sfshape{10}{\magstep1}
1081 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1082 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1083 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1084 %\setfont\ssectt\ttshape{10}{1315}
1085 %\setfont\ssecsf\sfshape{10}{1315}
1087 %\let\ssecbf=\ssecrm
1089 % Subsection fonts (13.15pt).
1090 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1091 \setfont\ssecit\itbshape{10}{1315}
1092 \setfont\ssecsl\slbshape{10}{1315}
1093 \setfont\ssectt\ttbshape{12}{\magstephalf}
1094 \setfont\ssecttsl\ttslshape{10}{\magstep1}
1095 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1097 \setfont\ssecsc\scbshape{10}{\magstep1}
1098 \font\sseci=cmmi12 scaled \magstephalf
1099 \font\ssecsy=cmsy10 scaled \magstep1
1100 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1101 % but that is not a standard magnification.
1103 % Fonts for title page:
1104 \setfont\titlerm\rmbshape{12}{\magstep3}
1105 \let\authorrm = \secrm
1107 % In order for the font changes to affect most math symbols and letters,
1108 % we have to define the \textfont of the standard families. Since
1109 % texinfo doesn't allow for producing subscripts and superscripts, we
1110 % don't bother to reset \scriptfont and \scriptscriptfont (which would
1111 % also require loading a lot more fonts).
1113 \def\resetmathfonts{%
1114 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1115 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1116 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1120 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1121 % of just \STYLE. We do this so that font changes will continue to work
1122 % in math mode, where it is the current \fam that is relevant in most
1123 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1124 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1125 % redefine \bf itself.
1127 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1128 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1129 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1132 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1133 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1134 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1135 \resetmathfonts \setleading{19pt}}
1137 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1138 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1139 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1140 \resetmathfonts \setleading{16pt}}
1142 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1143 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1144 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1145 \resetmathfonts \setleading{15pt}}
1146 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1148 \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
1149 \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
1150 \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy \let\tenttsl=\indttsl
1151 \resetmathfonts \setleading{12pt}}
1153 % Set up the default fonts, so we can use them for creating boxes.
1157 % Count depth in font-changes, for error checks
1158 \newcount\fontdepth \fontdepth=0
1160 % Fonts for short table of contents.
1161 \setfont\shortcontrm\rmshape{12}{1000}
1162 \setfont\shortcontbf\bxshape{12}{1000}
1163 \setfont\shortcontsl\slshape{12}{1000}
1165 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1166 %% serif) and @ii for TeX italic
1168 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1169 % unless the following character is such as not to need one.
1170 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1171 \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1174 \let\var=\smartitalic
1175 \let\dfn=\smartitalic
1176 \let\emph=\smartitalic
1177 \let\cite=\smartitalic
1182 % We can't just use \exhyphenpenalty, because that only has effect at
1183 % the end of a paragraph. Restore normal hyphenation at the end of the
1184 % group within which \nohyphenation is presumably called.
1186 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1187 \def\restorehyphenation{\hyphenchar\font = `- }
1190 {\tt \rawbackslash \frenchspacing #1}%
1194 \def\samp #1{`\tclose{#1}'\null}
1195 \def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1196 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1200 \let\url=\samp % perhaps include a hypertex \special eventually
1202 % @code is a modification of @t,
1203 % which makes spaces the same size as normal in the surrounding text.
1206 % Change normal interword space to be same as for the current font.
1207 \spaceskip = \fontdimen2\font
1209 % Switch to typewriter.
1212 % But `\ ' produces the large typewriter interword space.
1213 \def\ {{\spaceskip = 0pt{} }}%
1215 % Turn off hyphenation.
1225 % We *must* turn on hyphenation at `-' and `_' in \code.
1226 % Otherwise, it is too hard to avoid overfull hboxes
1227 % in the Emacs manual, the Library manual, etc.
1229 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1230 % both hyphenation at - and hyphenation within words.
1231 % We must therefore turn them both off (\tclose does that)
1232 % and arrange explicitly to hyphenate an a dash.
1237 \global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex}
1238 % The following is used by \doprintindex to insure that long function names
1239 % wrap around. It is necessary for - and _ to be active before the index is
1240 % read from the file, as \entry parses the arguments long before \code is
1241 % ever called. -- mycroft
1242 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash \catcode`\_=\active \let_\realunder}
1247 \def\codedash{-\discretionary{}{}{}}
1248 \def\codeunder{\normalunderscore\discretionary{}{}{}}
1249 \def\codex #1{\tclose{#1}\endgroup}
1251 %\let\exp=\tclose %Was temporary
1253 % @kbd is like @code, except that if the argument is just one @key command,
1254 % then @kbd has no effect.
1257 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1258 \ifx\one\xkey\ifx\threex\three \key{#2}%
1259 \else{\tclose{\ttsl\look}}\fi
1260 \else{\tclose{\ttsl\look}}\fi}
1262 % Check if we are currently using a typewriter font. Since all the
1263 % Computer Modern typewriter fonts have zero interword stretch (and
1264 % shrink), and it is reasonable to expect all typewriter fonts to have
1265 % this property, we can check that font parameter.
1267 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1269 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1270 % argument is to make the input look right: @dmn{pt} instead of
1273 \def\dmn#1{\thinspace #1}
1275 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1277 \def\l#1{{\li #1}\null} %
1279 \def\r#1{{\rm #1}} % roman font
1280 % Use of \lowercase was suggested.
1281 \def\sc#1{{\smallcaps#1}} % smallcaps font
1282 \def\ii#1{{\it #1}} % italic font
1284 \message{page headings,}
1286 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1287 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1289 % First the title page. Must do @settitle before @titlepage.
1290 \def\titlefont#1{{\titlerm #1}}
1293 \newif\iffinishedtitlepage
1295 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1296 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1297 \endgroup\page\hbox{}\page}
1299 \def\titlepage{\begingroup \parindent=0pt \textfonts
1300 \let\subtitlerm=\tenrm
1301 % I deinstalled the following change because \cmr12 is undefined.
1302 % This change was not in the ChangeLog anyway. --rms.
1303 % \let\subtitlerm=\cmr12
1304 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1306 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1308 % Leave some space at the very top of the page.
1309 \vglue\titlepagetopglue
1311 % Now you can print the title using @title.
1312 \def\title{\parsearg\titlezzz}%
1313 \def\titlezzz##1{\leftline{\titlefont{##1}}
1314 % print a rule at the page bottom also.
1315 \finishedtitlepagefalse
1316 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1317 % No rule at page bottom unless we print one at the top with @title.
1318 \finishedtitlepagetrue
1320 % Now you can put text using @subtitle.
1321 \def\subtitle{\parsearg\subtitlezzz}%
1322 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1324 % @author should come last, but may come many times.
1325 \def\author{\parsearg\authorzzz}%
1326 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1327 {\authorfont \leftline{##1}}}%
1329 % Most title ``pages'' are actually two pages long, with space
1330 % at the top of the second. We don't want the ragged left on the second.
1331 \let\oldpage = \page
1333 \iffinishedtitlepage\else
1337 \let\page = \oldpage
1339 % \def\page{\oldpage \hbox{}}
1343 \iffinishedtitlepage\else
1346 % It is important to do the page break before ending the group,
1347 % because the headline and footline are only empty inside the group.
1348 % If we use the new definition of \page, we always get a blank page
1349 % after the title page, which we certainly don't want.
1355 \def\finishtitlepage{%
1356 \vskip4pt \hrule height 2pt width \hsize
1357 \vskip\titlepagebottomglue
1358 \finishedtitlepagetrue
1361 %%% Set up page headings and footings.
1363 \let\thispage=\folio
1365 \newtoks \evenheadline % Token sequence for heading line of even pages
1366 \newtoks \oddheadline % Token sequence for heading line of odd pages
1367 \newtoks \evenfootline % Token sequence for footing line of even pages
1368 \newtoks \oddfootline % Token sequence for footing line of odd pages
1370 % Now make Tex use those variables
1371 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1372 \else \the\evenheadline \fi}}
1373 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1374 \else \the\evenfootline \fi}\HEADINGShook}
1375 \let\HEADINGShook=\relax
1377 % Commands to set those variables.
1378 % For example, this is what @headings on does
1379 % @evenheading @thistitle|@thispage|@thischapter
1380 % @oddheading @thischapter|@thispage|@thistitle
1381 % @evenfooting @thisfile||
1382 % @oddfooting ||@thisfile
1384 \def\evenheading{\parsearg\evenheadingxxx}
1385 \def\oddheading{\parsearg\oddheadingxxx}
1386 \def\everyheading{\parsearg\everyheadingxxx}
1388 \def\evenfooting{\parsearg\evenfootingxxx}
1389 \def\oddfooting{\parsearg\oddfootingxxx}
1390 \def\everyfooting{\parsearg\everyfootingxxx}
1394 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1395 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1396 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1398 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1399 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1400 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1402 \gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish}
1403 \gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{%
1404 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1405 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1407 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1408 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1409 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1411 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1412 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1413 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1415 \gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish}
1416 \gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{%
1417 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1418 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1420 }% unbind the catcode of @.
1422 % @headings double turns headings on for double-sided printing.
1423 % @headings single turns headings on for single-sided printing.
1424 % @headings off turns them off.
1425 % @headings on same as @headings double, retained for compatibility.
1426 % @headings after turns on double-sided headings after this page.
1427 % @headings doubleafter turns on double-sided headings after this page.
1428 % @headings singleafter turns on single-sided headings after this page.
1429 % By default, they are off.
1431 \def\headings #1 {\csname HEADINGS#1\endcsname}
1434 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1435 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1437 % When we turn headings on, set the page number to 1.
1438 % For double-sided printing, put current file name in lower left corner,
1439 % chapter name on inside top of right hand pages, document
1440 % title on inside top of left hand pages, and page numbers on outside top
1441 % edge of all pages.
1442 \def\HEADINGSdouble{
1445 \global\evenfootline={\hfil}
1446 \global\oddfootline={\hfil}
1447 \global\evenheadline={\line{\folio\hfil\thistitle}}
1448 \global\oddheadline={\line{\thischapter\hfil\folio}}
1450 % For single-sided printing, chapter title goes across top left of page,
1451 % page number on top right.
1452 \def\HEADINGSsingle{
1455 \global\evenfootline={\hfil}
1456 \global\oddfootline={\hfil}
1457 \global\evenheadline={\line{\thischapter\hfil\folio}}
1458 \global\oddheadline={\line{\thischapter\hfil\folio}}
1460 \def\HEADINGSon{\HEADINGSdouble}
1462 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1463 \let\HEADINGSdoubleafter=\HEADINGSafter
1464 \def\HEADINGSdoublex{%
1465 \global\evenfootline={\hfil}
1466 \global\oddfootline={\hfil}
1467 \global\evenheadline={\line{\folio\hfil\thistitle}}
1468 \global\oddheadline={\line{\thischapter\hfil\folio}}
1471 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1472 \def\HEADINGSsinglex{%
1473 \global\evenfootline={\hfil}
1474 \global\oddfootline={\hfil}
1475 \global\evenheadline={\line{\thischapter\hfil\folio}}
1476 \global\oddheadline={\line{\thischapter\hfil\folio}}
1479 % Subroutines used in generating headings
1480 % Produces Day Month Year style of output.
1481 \def\today{\number\day\space
1483 January\or February\or March\or April\or May\or June\or
1484 July\or August\or September\or October\or November\or December\fi
1487 % Use this if you want the Month Day, Year style of output.
1488 %\def\today{\ifcase\month\or
1489 %January\or February\or March\or April\or May\or June\or
1490 %July\or August\or September\or October\or November\or December\fi
1491 %\space\number\day, \number\year}
1493 % @settitle line... specifies the title of the document, for headings
1494 % It generates no output of its own
1496 \def\thistitle{No Title}
1497 \def\settitle{\parsearg\settitlezzz}
1498 \def\settitlezzz #1{\gdef\thistitle{#1}}
1502 % @tabs -- simple alignment
1504 % These don't work. For one thing, \+ is defined as outer.
1505 % So these macros cannot even be defined.
1507 %\def\tabs{\parsearg\tabszzz}
1508 %\def\tabszzz #1{\settabs\+#1\cr}
1509 %\def\tabline{\parsearg\tablinezzz}
1510 %\def\tablinezzz #1{\+#1\cr}
1513 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1515 % default indentation of table text
1516 \newdimen\tableindent \tableindent=.8in
1517 % default indentation of @itemize and @enumerate text
1518 \newdimen\itemindent \itemindent=.3in
1519 % margin between end of table item and start of table text.
1520 \newdimen\itemmargin \itemmargin=.1in
1522 % used internally for \itemindent minus \itemmargin
1525 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1527 % They also define \itemindex
1528 % to index the item name in whatever manner is desired (perhaps none).
1530 \newif\ifitemxneedsnegativevskip
1532 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1534 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1535 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1537 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1538 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1540 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1541 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1543 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1546 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1549 \def\itemzzz #1{\begingroup %
1550 \advance\hsize by -\rightskip
1551 \advance\hsize by -\tableindent
1552 \setbox0=\hbox{\itemfont{#1}}%
1554 \nobreak % This prevents a break before @itemx.
1556 % Be sure we are not still in the middle of a paragraph.
1561 % If the item text does not fit in the space we have, put it on a line
1562 % by itself, and do not allow a page break either before or after that
1563 % line. We do not start a paragraph here because then if the next
1564 % command is, e.g., @kindex, the whatsit would get put into the
1565 % horizontal list on a line by itself, resulting in extra blank space.
1566 \ifdim \wd0>\itemmax
1568 % Make this a paragraph so we get the \parskip glue and wrapping,
1569 % but leave it ragged-right.
1571 \advance\leftskip by-\tableindent
1572 \advance\hsize by\tableindent
1573 \advance\rightskip by0pt plus1fil
1574 \leavevmode\unhbox0\par
1577 % We're going to be starting a paragraph, but we don't want the
1578 % \parskip glue -- logically it's part of the @item we just started.
1579 \nobreak \vskip-\parskip
1581 % Stop a page break at the \parskip glue coming up. Unfortunately
1582 % we can't prevent a possible page break at the following
1583 % \baselineskip glue.
1586 \itemxneedsnegativevskipfalse
1588 % The item text fits into the space. Start a paragraph, so that the
1589 % following text (if any) will end up on the same line. Since that
1590 % text will be indented by \tableindent, we make the item text be in
1593 \rlap{\hskip -\tableindent\box0}\ignorespaces%
1595 \itemxneedsnegativevskiptrue%
1599 \def\item{\errmessage{@item while not in a table}}
1600 \def\itemx{\errmessage{@itemx while not in a table}}
1601 \def\kitem{\errmessage{@kitem while not in a table}}
1602 \def\kitemx{\errmessage{@kitemx while not in a table}}
1603 \def\xitem{\errmessage{@xitem while not in a table}}
1604 \def\xitemx{\errmessage{@xitemx while not in a table}}
1606 %% Contains a kludge to get @end[description] to work
1607 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1609 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1610 {\obeylines\obeyspaces%
1611 \gdef\tablex #1^^M{%
1612 \tabley\dontindex#1 \endtabley}}
1614 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1615 {\obeylines\obeyspaces%
1616 \gdef\ftablex #1^^M{%
1617 \tabley\fnitemindex#1 \endtabley
1618 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1619 \let\Etable=\relax}}
1621 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1622 {\obeylines\obeyspaces%
1623 \gdef\vtablex #1^^M{%
1624 \tabley\vritemindex#1 \endtabley
1625 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1626 \let\Etable=\relax}}
1629 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1630 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1633 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1634 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1636 \def\tablez #1#2#3#4#5#6{%
1639 \def\Edescription{\Etable}% Necessary kludge.
1641 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1642 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1643 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1645 \itemmax=\tableindent %
1646 \advance \itemmax by -\itemmargin %
1647 \advance \leftskip by \tableindent %
1648 \exdentamount=\tableindent
1650 \parskip = \smallskipamount
1651 \ifdim \parskip=0pt \parskip=2pt \fi%
1652 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1653 \let\item = \internalBitem %
1654 \let\itemx = \internalBitemx %
1655 \let\kitem = \internalBkitem %
1656 \let\kitemx = \internalBkitemx %
1657 \let\xitem = \internalBxitem %
1658 \let\xitemx = \internalBxitemx %
1661 % This is the counter used by @enumerate, which is really @itemize
1665 \def\itemize{\parsearg\itemizezzz}
1667 \def\itemizezzz #1{%
1668 \begingroup % ended by the @end itemsize
1669 \itemizey {#1}{\Eitemize}
1672 \def\itemizey #1#2{%
1674 \itemmax=\itemindent %
1675 \advance \itemmax by -\itemmargin %
1676 \advance \leftskip by \itemindent %
1677 \exdentamount=\itemindent
1679 \parskip = \smallskipamount %
1680 \ifdim \parskip=0pt \parskip=2pt \fi%
1681 \def#2{\endgraf\afterenvbreak\endgroup}%
1682 \def\itemcontents{#1}%
1683 \let\item=\itemizeitem}
1685 % Set sfcode to normal for the chars that usually have another value.
1686 % These are `.?!:;,'
1687 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1688 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1690 % \splitoff TOKENS\endmark defines \first to be the first token in
1691 % TOKENS, and \rest to be the remainder.
1693 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1695 % Allow an optional argument of an uppercase letter, lowercase letter,
1696 % or number, to specify the first label in the enumerated list. No
1697 % argument is the same as `1'.
1699 \def\enumerate{\parsearg\enumeratezzz}
1700 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1701 \def\enumeratey #1 #2\endenumeratey{%
1702 \begingroup % ended by the @end enumerate
1704 % If we were given no argument, pretend we were given `1'.
1706 \ifx\thearg\empty \def\thearg{1}\fi
1708 % Detect if the argument is a single token. If so, it might be a
1709 % letter. Otherwise, the only valid thing it can be is a number.
1710 % (We will always have one token, because of the test we just made.
1711 % This is a good thing, since \splitoff doesn't work given nothing at
1712 % all -- the first parameter is undelimited.)
1713 \expandafter\splitoff\thearg\endmark
1715 % Only one token in the argument. It could still be anything.
1716 % A ``lowercase letter'' is one whose \lccode is nonzero.
1717 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1718 % not equal to itself.
1719 % Otherwise, we assume it's a number.
1721 % We need the \relax at the end of the \ifnum lines to stop TeX from
1722 % continuing to look for a <number>.
1724 \ifnum\lccode\expandafter`\thearg=0\relax
1725 \numericenumerate % a number (we hope)
1728 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1729 \lowercaseenumerate % lowercase letter
1731 \uppercaseenumerate % uppercase letter
1735 % Multiple tokens in the argument. We hope it's a number.
1740 % An @enumerate whose labels are integers. The starting integer is
1743 \def\numericenumerate{%
1745 \startenumeration{\the\itemno}%
1748 % The starting (lowercase) letter is in \thearg.
1749 \def\lowercaseenumerate{%
1750 \itemno = \expandafter`\thearg
1752 % Be sure we're not beyond the end of the alphabet.
1754 \errmessage{No more lowercase letters in @enumerate; get a bigger
1761 % The starting (uppercase) letter is in \thearg.
1762 \def\uppercaseenumerate{%
1763 \itemno = \expandafter`\thearg
1765 % Be sure we're not beyond the end of the alphabet.
1767 \errmessage{No more uppercase letters in @enumerate; get a bigger
1774 % Call itemizey, adding a period to the first argument and supplying the
1775 % common last two arguments. Also subtract one from the initial value in
1776 % \itemno, since @item increments \itemno.
1778 \def\startenumeration#1{%
1779 \advance\itemno by -1
1780 \itemizey{#1.}\Eenumerate\flushcr
1783 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1786 \def\alphaenumerate{\enumerate{a}}
1787 \def\capsenumerate{\enumerate{A}}
1788 \def\Ealphaenumerate{\Eenumerate}
1789 \def\Ecapsenumerate{\Eenumerate}
1791 % Definition of @item while inside @itemize.
1794 \advance\itemno by 1
1795 {\let\par=\endgraf \smallbreak}%
1796 \ifhmode \errmessage{\in hmode at itemizeitem}\fi
1797 {\parskip=0in \hskip 0pt
1798 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1799 \vadjust{\penalty 1200}}%
1802 % @multitable macros
1803 % Amy Hendrickson, 8/18/94, 3/6/96
1805 % @multitable ... @end multitable will make as many columns as desired.
1806 % Contents of each column will wrap at width given in preamble. Width
1807 % can be specified either with sample text given in a template line,
1808 % or in percent of \hsize, the current width of text on page.
1810 % Table can continue over pages but will only break between lines.
1814 % Either define widths of columns in terms of percent of \hsize:
1815 % @multitable @columnfractions .25 .3 .45
1818 % Numbers following @columnfractions are the percent of the total
1819 % current hsize to be used for each column. You may use as many
1820 % columns as desired.
1822 % Or use a template:
1823 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1825 % using the widest term desired in each column.
1827 % For those who want to use more than one line's worth of words in
1828 % the preamble, break the line within one argument and it
1829 % will parse correctly, i.e.,
1831 % @multitable {Column 1 template} {Column 2 template} {Column 3
1834 % @multitable {Column 1 template} {Column 2 template}
1835 % {Column 3 template}
1837 % Each new table line starts with @item, each subsequent new column
1838 % starts with @tab. Empty columns may be produced by supplying @tab's
1839 % with nothing between them for as many times as empty columns are needed,
1840 % ie, @tab@tab@tab will produce two empty columns.
1842 % @item, @tab, @multicolumn or @endmulticolumn do not need to be on their
1843 % own lines, but it will not hurt if they are.
1845 % Sample multitable:
1847 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1848 % @item first col stuff @tab second col stuff @tab third col
1855 % @item first col stuff @tab second col stuff
1856 % @tab Many paragraphs of text may be used in any column.
1858 % They will wrap at the width determined by the template.
1859 % @item@tab@tab This will be in third column.
1862 % Default dimensions may be reset by user.
1863 % @multitableparskip is vertical space between paragraphs in table.
1864 % @multitableparindent is paragraph indent in table.
1865 % @multitablecolmargin is horizontal space to be left between columns.
1866 % @multitablelinespace is space to leave between table items, baseline
1868 % 0pt means it depends on current normal line spacing.
1873 \newskip\multitableparskip
1874 \newskip\multitableparindent
1875 \newdimen\multitablecolspace
1876 \newskip\multitablelinespace
1877 \multitableparskip=0pt
1878 \multitableparindent=6pt
1879 \multitablecolspace=12pt
1880 \multitablelinespace=0pt
1883 % Macros used to set up halign preamble:
1884 \let\endsetuptable\relax
1885 \def\xendsetuptable{\endsetuptable}
1886 \let\columnfractions\relax
1887 \def\xcolumnfractions{\columnfractions}
1890 %% 2/1/96, to allow fractions to be given with more than one digit.
1891 \def\pickupwholefraction#1 {\global\advance\colcount by1 %
1892 \expandafter\xdef\csname col\the\colcount\endcsname{.#1\hsize}%
1896 \def\setuptable#1{\def\firstarg{#1}%
1897 \ifx\firstarg\xendsetuptable\let\go\relax%
1899 \ifx\firstarg\xcolumnfractions\global\setpercenttrue%
1902 \let\go\pickupwholefraction % In this case arg of setuptable
1903 % is the decimal point before the
1904 % number given in percent of hsize.
1905 % We don't need this so we don't use it.
1907 \global\advance\colcount by1
1909 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
1912 \ifx\go\pickupwholefraction\else\let\go\setuptable\fi%
1917 \def\tab{&\hskip1sp\relax} % 2/2/96
1918 % tiny skip here makes sure this column space is
1919 % maintained, even if it is never used.
1923 % @multitable ... @end multitable definitions:
1925 \def\multitable{\parsearg\dotable}
1927 \def\dotable#1{\bgroup
1931 \setmultitablespacing
1932 \parskip=\multitableparskip
1933 \parindent=\multitableparindent
1935 \global\colcount=0\relax%
1936 \def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}%
1937 % To parse everything between @multitable and @item :
1938 \setuptable#1 \endsetuptable
1939 % Need to reset this to 0 after \setuptable.
1940 \global\colcount=0\relax%
1942 % This preamble sets up a generic column definition, which will
1943 % be used as many times as user calls for columns.
1944 % \vtop will set a single line and will also let text wrap and
1945 % continue for many paragraphs if desired.
1946 \halign\bgroup&\global\advance\colcount by 1\relax%
1947 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
1948 % In order to keep entries from bumping into each other
1949 % we will add a \leftskip of \multitablecolspace to all columns after
1951 % If a template has been used, we will add \multitablecolspace
1952 % to the width of each template entry.
1953 % If user has set preamble in terms of percent of \hsize
1954 % we will use that dimension as the width of the column, and
1955 % the \leftskip will keep entries from bumping into each other.
1956 % Table will start at left margin and final column will justify at
1962 % If user has <not> set preamble in terms of percent of \hsize
1963 % we will advance \hsize by \multitablecolspace
1964 \advance\hsize by \multitablecolspace
1966 % In either case we will make \leftskip=\multitablecolspace:
1967 \leftskip=\multitablecolspace
1970 % \everycr will reset column counter, \colcount, at the end of
1971 % each line. Every column entry will cause \colcount to advance by one.
1972 % The table preamble
1973 % looks at the current \colcount to find the correct column width.
1974 \global\everycr{\noalign{%
1975 \filbreak%% keeps underfull box messages off when table breaks over pages.
1976 \global\colcount=0\relax}}
1979 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
1980 % If so, do nothing. If not, give it an appropriate dimension based on
1981 % current baselineskip.
1983 \ifdim\multitablelinespace=0pt
1984 %% strut to put in table in case some entry doesn't have descenders,
1985 %% to keep lines equally spaced
1986 \gdef\multistrut{\vrule height\ht0 depth\dp0 width0pt\relax}
1987 %% Test to see if parskip is larger than space between lines of
1988 %% table. If not, do nothing.
1989 %% If so, set to same dimension as multitablelinespace.
1991 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
1993 \ifdim\multitableparskip>\multitablelinespace
1994 \global\multitableparskip=\multitablelinespace
1995 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
1996 %% than skip between lines in the table.
1998 \ifdim\multitableparskip=0pt
1999 \global\multitableparskip=\multitablelinespace
2000 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2001 %% than skip between lines in the table.
2004 % Index generation facilities
2006 % Define \newwrite to be identical to plain tex's \newwrite
2007 % except not \outer, so it can be used within \newindex.
2009 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2011 % \newindex {foo} defines an index named foo.
2012 % It automatically defines \fooindex such that
2013 % \fooindex ...rest of line... puts an entry in the index foo.
2014 % It also defines \fooindfile to be the number of the output channel for
2015 % the file that accumulates this index. The file's extension is foo.
2016 % The name of an index should be no more than 2 characters long
2017 % for the sake of vms.
2020 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
2021 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2022 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2023 \noexpand\doindex {#1}}
2026 % @defindex foo == \newindex{foo}
2028 \def\defindex{\parsearg\newindex}
2030 % Define @defcodeindex, like @defindex except put all entries in @code.
2032 \def\newcodeindex #1{
2033 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
2034 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2035 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2036 \noexpand\docodeindex {#1}}
2039 \def\defcodeindex{\parsearg\newcodeindex}
2041 % @synindex foo bar makes index foo feed into index bar.
2042 % Do this instead of @defindex foo if you don't want it as a separate index.
2043 \def\synindex #1 #2 {%
2044 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2045 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
2046 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2047 \noexpand\doindex {#2}}%
2050 % @syncodeindex foo bar similar, but put all entries made for index foo
2052 \def\syncodeindex #1 #2 {%
2053 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2054 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
2055 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2056 \noexpand\docodeindex {#2}}%
2059 % Define \doindex, the driver for all \fooindex macros.
2060 % Argument #1 is generated by the calling \fooindex macro,
2061 % and it is "foo", the name of the index.
2063 % \doindex just uses \parsearg; it calls \doind for the actual work.
2064 % This is because \doind is more useful to call from other macros.
2066 % There is also \dosubind {index}{topic}{subtopic}
2067 % which makes an entry in a two-level index such as the operation index.
2069 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2070 \def\singleindexer #1{\doind{\indexname}{#1}}
2072 % like the previous two, but they put @code around the argument.
2073 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2074 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2077 % Take care of the plain tex accent commands.
2078 \def\"{\realbackslash "}%
2079 \def\`{\realbackslash `}%
2080 \def\'{\realbackslash '}%
2081 \def\^{\realbackslash ^}%
2082 \def\~{\realbackslash ~}%
2083 \def\={\realbackslash =}%
2084 \def\b{\realbackslash b}%
2085 \def\c{\realbackslash c}%
2086 \def\d{\realbackslash d}%
2087 \def\u{\realbackslash u}%
2088 \def\v{\realbackslash v}%
2089 \def\H{\realbackslash H}%
2090 % Take care of the plain tex special European modified letters.
2091 \def\oe{\realbackslash oe}%
2092 \def\ae{\realbackslash ae}%
2093 \def\aa{\realbackslash aa}%
2094 \def\OE{\realbackslash OE}%
2095 \def\AE{\realbackslash AE}%
2096 \def\AA{\realbackslash AA}%
2097 \def\o{\realbackslash o}%
2098 \def\O{\realbackslash O}%
2099 \def\l{\realbackslash l}%
2100 \def\L{\realbackslash L}%
2101 \def\ss{\realbackslash ss}%
2102 % Take care of texinfo commands likely to appear in an index entry.
2103 \def\_{{\realbackslash _}}%
2104 \def\w{\realbackslash w }%
2105 \def\bf{\realbackslash bf }%
2106 \def\rm{\realbackslash rm }%
2107 \def\sl{\realbackslash sl }%
2108 \def\sf{\realbackslash sf}%
2109 \def\tt{\realbackslash tt}%
2110 \def\gtr{\realbackslash gtr}%
2111 \def\less{\realbackslash less}%
2112 \def\hat{\realbackslash hat}%
2113 \def\char{\realbackslash char}%
2114 \def\TeX{\realbackslash TeX}%
2115 \def\dots{\realbackslash dots }%
2116 \def\copyright{\realbackslash copyright }%
2117 \def\tclose##1{\realbackslash tclose {##1}}%
2118 \def\code##1{\realbackslash code {##1}}%
2119 \def\samp##1{\realbackslash samp {##1}}%
2120 \def\t##1{\realbackslash r {##1}}%
2121 \def\r##1{\realbackslash r {##1}}%
2122 \def\i##1{\realbackslash i {##1}}%
2123 \def\b##1{\realbackslash b {##1}}%
2124 \def\cite##1{\realbackslash cite {##1}}%
2125 \def\key##1{\realbackslash key {##1}}%
2126 \def\file##1{\realbackslash file {##1}}%
2127 \def\var##1{\realbackslash var {##1}}%
2128 \def\kbd##1{\realbackslash kbd {##1}}%
2129 \def\dfn##1{\realbackslash dfn {##1}}%
2130 \def\emph##1{\realbackslash emph {##1}}%
2134 % If an index command is used in an @example environment, any spaces
2135 % therein should become regular spaces in the raw index file, not the
2136 % expansion of \tie (\\leavevmode \penalty \@M \ ).
2138 \gdef\unsepspaces{\obeyspaces\let =\space}}
2140 % \indexnofonts no-ops all font-change commands.
2141 % This is used when outputting the strings to sort the index by.
2142 \def\indexdummyfont#1{#1}
2143 \def\indexdummytex{TeX}
2144 \def\indexdummydots{...}
2147 % Just ignore accents.
2148 \let\"=\indexdummyfont
2149 \let\`=\indexdummyfont
2150 \let\'=\indexdummyfont
2151 \let\^=\indexdummyfont
2152 \let\~=\indexdummyfont
2153 \let\==\indexdummyfont
2154 \let\b=\indexdummyfont
2155 \let\c=\indexdummyfont
2156 \let\d=\indexdummyfont
2157 \let\u=\indexdummyfont
2158 \let\v=\indexdummyfont
2159 \let\H=\indexdummyfont
2160 % Take care of the plain tex special European modified letters.
2172 \let\w=\indexdummyfont
2173 \let\t=\indexdummyfont
2174 \let\r=\indexdummyfont
2175 \let\i=\indexdummyfont
2176 \let\b=\indexdummyfont
2177 \let\emph=\indexdummyfont
2178 \let\strong=\indexdummyfont
2179 \let\cite=\indexdummyfont
2180 \let\sc=\indexdummyfont
2181 %Don't no-op \tt, since it isn't a user-level command
2182 % and is used in the definitions of the active chars like <, >, |...
2183 %\let\tt=\indexdummyfont
2184 \let\tclose=\indexdummyfont
2185 \let\code=\indexdummyfont
2186 \let\file=\indexdummyfont
2187 \let\samp=\indexdummyfont
2188 \let\kbd=\indexdummyfont
2189 \let\key=\indexdummyfont
2190 \let\var=\indexdummyfont
2191 \let\TeX=\indexdummytex
2192 \let\dots=\indexdummydots
2195 % To define \realbackslash, we must make \ not be an escape.
2196 % We must first make another character (@) an escape
2197 % so we do not become unable to do a definition.
2199 {\catcode`\@=0 \catcode`\\=\other
2200 @gdef@realbackslash{\}}
2202 \let\indexbackslash=0 %overridden during \printindex.
2204 \let\SETmarginindex=\relax %initialize!
2205 % workhorse for all \fooindexes
2206 % #1 is name of index, #2 is stuff to put there
2208 % Put the index entry in the margin if desired.
2209 \ifx\SETmarginindex\relax\else%
2210 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2212 {\count10=\lastpenalty %
2213 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2215 {\let\folio=0% Expand all macros now EXCEPT \folio
2216 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2217 % so it will be output as is; and it will print as backslash in the indx.
2219 % Now process the index-string once, with all font commands turned off,
2220 % to get the string to sort the index by.
2224 % Now produce the complete index entry. We process the index-string again,
2225 % this time with font commands expanded, to get what to print in the index.
2227 \write \csname#1indfile\endcsname{%
2228 \realbackslash entry {\temp1}{\folio}{#2}}}%
2232 \def\dosubind #1#2#3{%
2233 {\count10=\lastpenalty %
2234 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2237 \def\rawbackslashxx{\indexbackslash}%
2239 % Now process the index-string once, with all font commands turned off,
2240 % to get the string to sort the index by.
2244 % Now produce the complete index entry. We process the index-string again,
2245 % this time with font commands expanded, to get what to print in the index.
2247 \write \csname#1indfile\endcsname{%
2248 \realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
2252 % The index entry written in the file actually looks like
2253 % \entry {sortstring}{page}{topic}
2255 % \entry {sortstring}{page}{topic}{subtopic}
2256 % The texindex program reads in these files and writes files
2257 % containing these kinds of lines:
2259 % before the first topic whose initial is c
2260 % \entry {topic}{pagelist}
2261 % for a topic that is used without subtopics
2263 % for the beginning of a topic that is used with subtopics
2264 % \secondary {subtopic}{pagelist}
2265 % for each subtopic.
2267 % Define the user-accessible indexing commands
2268 % @findex, @vindex, @kindex, @cindex.
2270 \def\findex {\fnindex}
2271 \def\kindex {\kyindex}
2272 \def\cindex {\cpindex}
2273 \def\vindex {\vrindex}
2274 \def\tindex {\tpindex}
2275 \def\pindex {\pgindex}
2277 \def\cindexsub {\begingroup\obeylines\cindexsub}
2279 \gdef\cindexsub "#1" #2^^M{\endgroup %
2280 \dosubind{cp}{#2}{#1}}}
2282 % Define the macros used in formatting output of the sorted index material.
2284 % This is what you call to cause a particular index to get printed.
2286 % @unnumbered Function Index
2289 \def\printindex{\parsearg\doprintindex}
2291 \def\doprintindex#1{\begingroup
2292 \dobreak \chapheadingskip{10000}%
2297 \def\indexbackslash{\rawbackslashxx}%
2298 % Index files are almost Texinfo source, but we use \ as the escape
2299 % character. It would be better to use @, but that's too big a change
2300 % to make right now.
2304 % See if the index file exists and is nonempty.
2305 \openin 1 \jobname.#1s
2307 % \enddoublecolumns gets confused if there is no text in the index,
2308 % and it loses the chapter title and the aux file entries for the
2309 % index. The easiest way to prevent this problem is to make sure
2310 % there is some text.
2311 (Index is nonexistent)
2314 % If the index file exists but is empty, then \openin leaves \ifeof
2315 % false. We have to make TeX try to read something from the file, so
2316 % it can discover if there is anything in it.
2328 % These macros are used by the sorted index file itself.
2329 % Change them to control the appearance of the index.
2331 % Same as \bigskipamount except no shrink.
2332 % \balancecolumns gets confused if there is any shrink.
2333 \newskip\initialskipamount \initialskipamount 12pt plus4pt
2336 {\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
2337 \ifdim\lastskip<\initialskipamount
2338 \removelastskip \penalty-200 \vskip \initialskipamount\fi
2339 \line{\secbf#1\hfill}\kern 2pt\penalty10000}}
2341 % This typesets a paragraph consisting of #1, dot leaders, and then #2
2342 % flush to the right margin. It is used for index and table of contents
2343 % entries. The paragraph is indented by \leftskip.
2345 \def\entry #1#2{\begingroup
2347 % Start a new paragraph if necessary, so our assignments below can't
2348 % affect previous text.
2351 % Do not fill out the last line with white space.
2354 % No extra space above this paragraph.
2357 % Do not prefer a separate line ending with a hyphen to fewer lines.
2358 \finalhyphendemerits = 0
2360 % \hangindent is only relevant when the entry text and page number
2361 % don't both fit on one line. In that case, bob suggests starting the
2362 % dots pretty far over on the line. Unfortunately, a large
2363 % indentation looks wrong when the entry text itself is broken across
2364 % lines. So we use a small indentation and put up with long leaders.
2366 % \hangafter is reset to 1 (which is the value we want) at the start
2367 % of each paragraph, so we need not do anything with that.
2370 % When the entry text needs to be broken, just fill out the first line
2372 \rightskip = 0pt plus1fil
2374 % Start a ``paragraph'' for the index entry so the line breaking
2375 % parameters we've set above will have an effect.
2378 % Insert the text of the index entry. TeX will do line-breaking on it.
2380 % The following is kludged to not output a line of dots in the index if
2381 % there are no page numbers. The next person who breaks this will be
2382 % cursed by a Unix daemon.
2385 \edef\tempc{\tempa}%
2386 \edef\tempd{\tempb}%
2387 \ifx\tempc\tempd\ \else%
2389 % If we must, put the page number on a line of its own, and fill out
2390 % this line with blank space. (The \hfil is overwhelmed with the
2391 % fill leaders glue in \indexdotfill if the page number does fit.)
2393 \null\nobreak\indexdotfill % Have leaders before the page number.
2395 % The `\ ' here is removed by the implicit \unskip that TeX does as
2396 % part of (the primitive) \par. Without it, a spurious underfull
2398 \ #2% The page number ends the paragraph.
2403 % Like \dotfill except takes at least 1 em.
2404 \def\indexdotfill{\cleaders
2405 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
2407 \def\primary #1{\line{#1\hfil}}
2409 \newskip\secondaryindent \secondaryindent=0.5cm
2411 \def\secondary #1#2{
2412 {\parfillskip=0in \parskip=0in
2413 \hangindent =1in \hangafter=1
2414 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
2417 %% Define two-column mode, which is used in indexes.
2418 %% Adapted from the TeXbook, page 416.
2423 \newdimen\doublecolumnhsize
2425 \def\begindoublecolumns{\begingroup
2426 % Grab any single-column material above us.
2427 \output = {\global\setbox\partialpage
2428 =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}%
2431 % Now switch to the double-column output routine.
2432 \output={\doublecolumnout}%
2434 % Change the page size parameters. We could do this once outside this
2435 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2436 % format, but then we repeat the same computation. Repeating a couple
2437 % of assignments once per index is clearly meaningless for the
2438 % execution time, so we may as well do it once.
2440 % First we halve the line length, less a little for the gutter between
2441 % the columns. We compute the gutter based on the line length, so it
2442 % changes automatically with the paper format. The magic constant
2443 % below is chosen so that the gutter has the same value (well, +- <
2444 % 1pt) as it did when we hard-coded it.
2446 % We put the result in a separate register, \doublecolumhsize, so we
2447 % can restore it in \pagesofar, after \hsize itself has (potentially)
2450 \doublecolumnhsize = \hsize
2451 \advance\doublecolumnhsize by -.04154\hsize
2452 \divide\doublecolumnhsize by 2
2453 \hsize = \doublecolumnhsize
2455 % Double the \vsize as well. (We don't need a separate register here,
2456 % since nobody clobbers \vsize.)
2458 \doublecolumnpagegoal
2461 \def\enddoublecolumns{\eject \endgroup \pagegoal=\vsize \unvbox\partialpage}
2463 \def\doublecolumnsplit{\splittopskip=\topskip \splitmaxdepth=\maxdepth
2464 \global\dimen@=\pageheight \global\advance\dimen@ by-\ht\partialpage
2465 \global\setbox1=\vsplit255 to\dimen@ \global\setbox0=\vbox{\unvbox1}
2466 \global\setbox3=\vsplit255 to\dimen@ \global\setbox2=\vbox{\unvbox3}
2467 \ifdim\ht0>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2468 \ifdim\ht2>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2470 \def\doublecolumnpagegoal{%
2471 \dimen@=\vsize \advance\dimen@ by-2\ht\partialpage \global\pagegoal=\dimen@
2473 \def\pagesofar{\unvbox\partialpage %
2474 \hsize=\doublecolumnhsize % have to restore this since output routine
2475 \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}}
2476 \def\doublecolumnout{%
2478 {\vbadness=10000 \doublecolumnsplit}
2480 \setbox0=\vtop to\dimen@{\unvbox0}
2481 \setbox2=\vtop to\dimen@{\unvbox2}
2482 \onepageout\pagesofar \unvbox255 \penalty\outputpenalty
2484 \setbox0=\vbox{\unvbox5}
2486 \dimen@=\ht0 \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
2487 \divide\dimen@ by2 \splittopskip=\topskip \splitmaxdepth=\maxdepth
2489 \loop \global\setbox5=\copy0
2490 \setbox1=\vsplit5 to\dimen@
2491 \setbox3=\vsplit5 to\dimen@
2492 \ifvbox5 \global\advance\dimen@ by1pt \repeat
2493 \setbox0=\vbox to\dimen@{\unvbox1}
2494 \setbox2=\vbox to\dimen@{\unvbox3}
2495 \global\setbox\partialpage=\vbox{\pagesofar}
2496 \doublecolumnpagegoal
2503 \message{sectioning,}
2504 % Define chapters, sections, etc.
2507 \newcount \secno \secno=0
2508 \newcount \subsecno \subsecno=0
2509 \newcount \subsubsecno \subsubsecno=0
2511 % This counter is funny since it counts through charcodes of letters A, B, ...
2512 \newcount \appendixno \appendixno = `\@
2513 \def\appendixletter{\char\the\appendixno}
2515 \newwrite \contentsfile
2516 % This is called from \setfilename.
2517 \def\opencontents{\openout \contentsfile = \jobname.toc}
2519 % Each @chapter defines this as the name of the chapter.
2520 % page headings and footings can use it. @section does likewise
2522 \def\thischapter{} \def\thissection{}
2523 \def\seccheck#1{\if \pageno<0 %
2524 \errmessage{@#1 not allowed after generating table of contents}\fi
2528 \def\chapternofonts{%
2529 \let\rawbackslash=\relax%
2530 \let\frenchspacing=\relax%
2531 \def\result{\realbackslash result}
2532 \def\equiv{\realbackslash equiv}
2533 \def\expansion{\realbackslash expansion}
2534 \def\print{\realbackslash print}
2535 \def\TeX{\realbackslash TeX}
2536 \def\dots{\realbackslash dots}
2537 \def\copyright{\realbackslash copyright}
2538 \def\tt{\realbackslash tt}
2539 \def\bf{\realbackslash bf }
2540 \def\w{\realbackslash w}
2541 \def\less{\realbackslash less}
2542 \def\gtr{\realbackslash gtr}
2543 \def\hat{\realbackslash hat}
2544 \def\char{\realbackslash char}
2545 \def\tclose##1{\realbackslash tclose {##1}}
2546 \def\code##1{\realbackslash code {##1}}
2547 \def\samp##1{\realbackslash samp {##1}}
2548 \def\r##1{\realbackslash r {##1}}
2549 \def\b##1{\realbackslash b {##1}}
2550 \def\key##1{\realbackslash key {##1}}
2551 \def\file##1{\realbackslash file {##1}}
2552 \def\kbd##1{\realbackslash kbd {##1}}
2553 % These are redefined because @smartitalic wouldn't work inside xdef.
2554 \def\i##1{\realbackslash i {##1}}
2555 \def\cite##1{\realbackslash cite {##1}}
2556 \def\var##1{\realbackslash var {##1}}
2557 \def\emph##1{\realbackslash emph {##1}}
2558 \def\dfn##1{\realbackslash dfn {##1}}
2561 \newcount\absseclevel % used to calculate proper heading level
2562 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
2564 % @raisesections: treat @section as chapter, @subsection as section, etc.
2565 \def\raisesections{\global\advance\secbase by -1}
2566 \let\up=\raisesections % original BFox name
2568 % @lowersections: treat @chapter as section, @section as subsection, etc.
2569 \def\lowersections{\global\advance\secbase by 1}
2570 \let\down=\lowersections % original BFox name
2572 % Choose a numbered-heading macro
2573 % #1 is heading level if unmodified by @raisesections or @lowersections
2574 % #2 is text for heading
2575 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2581 \numberedsubseczzz{#2}
2583 \numberedsubsubseczzz{#2}
2585 \ifnum \absseclevel<0
2588 \numberedsubsubseczzz{#2}
2593 % like \numhead, but chooses appendix heading levels
2594 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2598 \appendixsectionzzz{#2}
2600 \appendixsubseczzz{#2}
2602 \appendixsubsubseczzz{#2}
2604 \ifnum \absseclevel<0
2607 \appendixsubsubseczzz{#2}
2612 % like \numhead, but chooses numberless heading levels
2613 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2617 \unnumberedseczzz{#2}
2619 \unnumberedsubseczzz{#2}
2621 \unnumberedsubsubseczzz{#2}
2623 \ifnum \absseclevel<0
2626 \unnumberedsubsubseczzz{#2}
2632 \def\thischaptername{No Chapter Title}
2633 \outer\def\chapter{\parsearg\chapteryyy}
2634 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2635 \def\chapterzzz #1{\seccheck{chapter}%
2636 \secno=0 \subsecno=0 \subsubsecno=0
2637 \global\advance \chapno by 1 \message{\putwordChapter \the\chapno}%
2638 \chapmacro {#1}{\the\chapno}%
2639 \gdef\thissection{#1}%
2640 \gdef\thischaptername{#1}%
2641 % We don't substitute the actual chapter name into \thischapter
2642 % because we don't want its macros evaluated now.
2643 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
2645 \edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}%
2647 \write \contentsfile \temp %
2649 \global\let\section = \numberedsec
2650 \global\let\subsection = \numberedsubsec
2651 \global\let\subsubsection = \numberedsubsubsec
2654 \outer\def\appendix{\parsearg\appendixyyy}
2655 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2656 \def\appendixzzz #1{\seccheck{appendix}%
2657 \secno=0 \subsecno=0 \subsubsecno=0
2658 \global\advance \appendixno by 1 \message{Appendix \appendixletter}%
2659 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
2660 \gdef\thissection{#1}%
2661 \gdef\thischaptername{#1}%
2662 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
2664 \edef\temp{{\realbackslash chapentry
2665 {#1}{\putwordAppendix{} \appendixletter}{\noexpand\folio}}}%
2667 \write \contentsfile \temp %
2669 \global\let\section = \appendixsec
2670 \global\let\subsection = \appendixsubsec
2671 \global\let\subsubsection = \appendixsubsubsec
2674 % @centerchap is like @unnumbered, but the heading is centered.
2675 \outer\def\centerchap{\parsearg\centerchapyyy}
2676 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
2678 \outer\def\top{\parsearg\unnumberedyyy}
2679 \outer\def\unnumbered{\parsearg\unnumberedyyy}
2680 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2681 \def\unnumberedzzz #1{\seccheck{unnumbered}%
2682 \secno=0 \subsecno=0 \subsubsecno=0
2684 % This used to be simply \message{#1}, but TeX fully expands the
2685 % argument to \message. Therefore, if #1 contained @-commands, TeX
2686 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2687 % expanded @cite (which turns out to cause errors because \cite is meant
2688 % to be executed, not expanded).
2690 % Anyway, we don't want the fully-expanded definition of @cite to appear
2691 % as a result of the \message, we just want `@cite' itself. We use
2692 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
2693 % simply yielding the contents of the <toks register>.
2694 \toks0 = {#1}\message{(\the\toks0)}%
2696 \unnumbchapmacro {#1}%
2697 \gdef\thischapter{#1}\gdef\thissection{#1}%
2699 \edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}%
2701 \write \contentsfile \temp %
2703 \global\let\section = \unnumberedsec
2704 \global\let\subsection = \unnumberedsubsec
2705 \global\let\subsubsection = \unnumberedsubsubsec
2708 \outer\def\numberedsec{\parsearg\secyyy}
2709 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2710 \def\seczzz #1{\seccheck{section}%
2711 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2712 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2714 \edef\temp{{\realbackslash secentry %
2715 {#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
2717 \write \contentsfile \temp %
2722 \outer\def\appendixsection{\parsearg\appendixsecyyy}
2723 \outer\def\appendixsec{\parsearg\appendixsecyyy}
2724 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2725 \def\appendixsectionzzz #1{\seccheck{appendixsection}%
2726 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2727 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2729 \edef\temp{{\realbackslash secentry %
2730 {#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
2732 \write \contentsfile \temp %
2737 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2738 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2739 \def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
2740 \plainsecheading {#1}\gdef\thissection{#1}%
2742 \edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}%
2744 \write \contentsfile \temp %
2749 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
2750 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
2751 \def\numberedsubseczzz #1{\seccheck{subsection}%
2752 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2753 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
2755 \edef\temp{{\realbackslash subsecentry %
2756 {#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2758 \write \contentsfile \temp %
2763 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
2764 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
2765 \def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
2766 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2767 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
2769 \edef\temp{{\realbackslash subsecentry %
2770 {#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2772 \write \contentsfile \temp %
2777 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
2778 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
2779 \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
2780 \plainsecheading {#1}\gdef\thissection{#1}%
2782 \edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}%
2784 \write \contentsfile \temp %
2789 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
2790 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
2791 \def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
2792 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2793 \subsubsecheading {#1}
2794 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2796 \edef\temp{{\realbackslash subsubsecentry %
2798 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
2799 {\noexpand\folio}}}%
2801 \write \contentsfile \temp %
2806 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
2807 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
2808 \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
2809 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2810 \subsubsecheading {#1}
2811 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2813 \edef\temp{{\realbackslash subsubsecentry{#1}%
2815 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
2817 \write \contentsfile \temp %
2822 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
2823 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
2824 \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
2825 \plainsecheading {#1}\gdef\thissection{#1}%
2827 \edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}%
2829 \write \contentsfile \temp %
2834 % These are variants which are not "outer", so they can appear in @ifinfo.
2835 % Actually, they should now be obsolete; ordinary section commands should work.
2836 \def\infotop{\parsearg\unnumberedzzz}
2837 \def\infounnumbered{\parsearg\unnumberedzzz}
2838 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
2839 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
2840 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
2842 \def\infoappendix{\parsearg\appendixzzz}
2843 \def\infoappendixsec{\parsearg\appendixseczzz}
2844 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
2845 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
2847 \def\infochapter{\parsearg\chapterzzz}
2848 \def\infosection{\parsearg\sectionzzz}
2849 \def\infosubsection{\parsearg\subsectionzzz}
2850 \def\infosubsubsection{\parsearg\subsubsectionzzz}
2852 % These macros control what the section commands do, according
2853 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
2854 % Define them by default for a numbered chapter.
2855 \global\let\section = \numberedsec
2856 \global\let\subsection = \numberedsubsec
2857 \global\let\subsubsection = \numberedsubsubsec
2859 % Define @majorheading, @heading and @subheading
2861 % NOTE on use of \vbox for chapter headings, section headings, and
2863 % 1) We use \vbox rather than the earlier \line to permit
2864 % overlong headings to fold.
2865 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
2866 % heading is obnoxious; this forbids it.
2867 % 3) Likewise, headings look best if no \parindent is used, and
2868 % if justification is not attempted. Hence \raggedright.
2871 \def\majorheading{\parsearg\majorheadingzzz}
2872 \def\majorheadingzzz #1{%
2873 {\advance\chapheadingskip by 10pt \chapbreak }%
2874 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2875 \parindent=0pt\raggedright
2876 \rm #1\hfill}}\bigskip \par\penalty 200}
2878 \def\chapheading{\parsearg\chapheadingzzz}
2879 \def\chapheadingzzz #1{\chapbreak %
2880 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2881 \parindent=0pt\raggedright
2882 \rm #1\hfill}}\bigskip \par\penalty 200}
2884 \def\heading{\parsearg\secheadingi}
2886 \def\subheading{\parsearg\subsecheadingi}
2888 \def\subsubheading{\parsearg\subsubsecheadingi}
2890 % These macros generate a chapter, section, etc. heading only
2891 % (including whitespace, linebreaking, etc. around it),
2892 % given all the information in convenient, parsed form.
2894 %%% Args are the skip and penalty (usually negative)
2895 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
2897 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
2899 %%% Define plain chapter starts, and page on/off switching for it
2900 % Parameter controlling skip before chapter headings (if needed)
2902 \newskip \chapheadingskip \chapheadingskip = 30pt plus 8pt minus 4pt
2904 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
2905 \def\chappager{\par\vfill\supereject}
2906 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
2908 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
2911 \global\let\pchapsepmacro=\chapbreak
2912 \global\let\pagealignmacro=\chappager}
2915 \global\let\pchapsepmacro=\chappager
2916 \global\let\pagealignmacro=\chappager
2917 \global\def\HEADINGSon{\HEADINGSsingle}}
2920 \global\let\pchapsepmacro=\chapoddpage
2921 \global\let\pagealignmacro=\chapoddpage
2922 \global\def\HEADINGSon{\HEADINGSdouble}}
2927 \global\let\chapmacro=\chfplain
2928 \global\let\unnumbchapmacro=\unnchfplain
2929 \global\let\centerchapmacro=\centerchfplain}
2931 % #1 is the text, #2 the chapter number.
2932 \def\chfplain #1#2{%
2936 \setbox0 = \hbox{#2\enspace}%
2937 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
2941 \nobreak\bigskip % no page break after a chapter title
2945 \def\unnchfplain #1{%
2947 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2948 \parindent=0pt\raggedright
2949 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2952 \def\centerchfplain #1{%
2954 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2956 {\rm #1}\hfill}}\bigskip \par\penalty 10000 %
2959 \CHAPFplain % The default
2961 \def\unnchfopen #1{%
2962 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2963 \parindent=0pt\raggedright
2964 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2967 \def\chfopen #1#2{\chapoddpage {\chapfonts
2968 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
2972 \def\centerchfopen #1{%
2973 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2975 \hfill {\rm #1}\hfill}}\bigskip \par\penalty 10000 %
2979 \global\let\chapmacro=\chfopen
2980 \global\let\unnumbchapmacro=\unnchfopen
2981 \global\let\centerchapmacro=\centerchfopen}
2985 \newskip \secheadingskip \secheadingskip = 21pt plus 8pt minus 4pt
2986 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
2987 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
2988 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
2990 % Subsection titles.
2991 \newskip \subsecheadingskip \subsecheadingskip = 17pt plus 8pt minus 4pt
2992 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
2993 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
2995 % Subsubsection titles.
2996 \let\subsubsecheadingskip = \subsecheadingskip
2997 \let\subsubsecheadingbreak = \subsecheadingbreak
2998 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3001 % Print any size section title.
3003 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3004 % number (maybe empty), #3 the text.
3005 \def\sectionheading#1#2#3{%
3007 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3008 \csname #1headingbreak\endcsname
3011 \csname #1fonts\endcsname \rm
3013 % Only insert the separating space if we have a section number.
3014 \setbox0 = \hbox{#2\ifx\secnum\empty\else \enspace \fi}%
3015 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3016 \hangindent = \wd0 % zero if no section number
3019 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3023 \message{toc printing,}
3025 % Finish up the main text and prepare to read what we've written
3028 \newskip\contentsrightmargin \contentsrightmargin=1in
3029 \def\startcontents#1{%
3031 \immediate\closeout \contentsfile
3033 \pageno = -1 % Request roman numbered pages.
3035 % Don't need to put `Contents' or `Short Contents' in the headline.
3036 % It is abundantly clear what they are.
3037 \unnumbchapmacro{#1}\def\thischapter{}%
3038 \begingroup % Set up to handle contents files properly.
3039 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3040 \catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3041 \raggedbottom % Worry more about breakpoints than the bottom.
3042 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3046 % Normal (long) toc.
3047 \outer\def\contents{%
3048 \startcontents{\putwordTableofContents}%
3054 % And just the chapters.
3055 \outer\def\summarycontents{%
3056 \startcontents{\putwordShortContents}%
3058 \let\chapentry = \shortchapentry
3059 \let\unnumbchapentry = \shortunnumberedentry
3060 % We want a true roman here for the page numbers.
3062 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3064 \advance\baselineskip by 1pt % Open it up a little.
3065 \def\secentry ##1##2##3##4{}
3066 \def\unnumbsecentry ##1##2{}
3067 \def\subsecentry ##1##2##3##4##5{}
3068 \def\unnumbsubsecentry ##1##2{}
3069 \def\subsubsecentry ##1##2##3##4##5##6{}
3070 \def\unnumbsubsubsecentry ##1##2{}
3075 \let\shortcontents = \summarycontents
3077 % These macros generate individual entries in the table of contents.
3078 % The first argument is the chapter or section name.
3079 % The last argument is the page number.
3080 % The arguments in between are the chapter number, section number, ...
3082 % Chapter-level things, for both the long and short contents.
3083 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3085 % See comments in \dochapentry re vbox and related settings
3086 \def\shortchapentry#1#2#3{%
3087 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
3090 % Typeset the label for a chapter or appendix for the short contents.
3091 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3092 % We could simplify the code here by writing out an \appendixentry
3093 % command in the toc file for appendices, instead of using \chapentry
3094 % for both, but it doesn't seem worth it.
3095 \setbox0 = \hbox{\shortcontrm \putwordAppendix }
3096 \newdimen\shortappendixwidth \shortappendixwidth = \wd0
3098 \def\shortchaplabel#1{%
3099 % We typeset #1 in a box of constant width, regardless of the text of
3100 % #1, so the chapter titles will come out aligned.
3101 \setbox0 = \hbox{#1}%
3102 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3104 % This space should be plenty, since a single number is .5em, and the
3105 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3106 % (This space doesn't include the extra space that gets added after
3107 % the label; that gets put in in \shortchapentry above.)
3108 \advance\dimen0 by 1.1em
3109 \hbox to \dimen0{#1\hfil}%
3112 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3113 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
3116 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
3117 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
3120 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
3121 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
3123 % And subsubsections.
3124 \def\subsubsecentry#1#2#3#4#5#6{%
3125 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
3126 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
3129 % This parameter controls the indentation of the various levels.
3130 \newdimen\tocindent \tocindent = 3pc
3132 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
3135 % If the toc has to be broken over pages, we would want to be at chapters
3136 % if at all possible; hence the \penalty.
3137 \def\dochapentry#1#2{%
3138 \penalty-300 \vskip\baselineskip
3141 \tocentry{#1}{\dopageno{#2}}%
3143 \nobreak\vskip .25\baselineskip
3146 \def\dosecentry#1#2{\begingroup
3147 \secentryfonts \leftskip=\tocindent
3148 \tocentry{#1}{\dopageno{#2}}%
3151 \def\dosubsecentry#1#2{\begingroup
3152 \subsecentryfonts \leftskip=2\tocindent
3153 \tocentry{#1}{\dopageno{#2}}%
3156 \def\dosubsubsecentry#1#2{\begingroup
3157 \subsubsecentryfonts \leftskip=3\tocindent
3158 \tocentry{#1}{\dopageno{#2}}%
3161 % Final typesetting of a toc entry; we use the same \entry macro as for
3162 % the index entries, but we want to suppress hyphenation here. (We
3163 % can't do that in the \entry macro, since index entries might consist
3164 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3166 % \turnoffactive is for the sake of @" used for umlauts.
3167 \def\tocentry#1#2{\begingroup
3168 \hyphenpenalty = 10000
3169 \entry{\turnoffactive #1}{\turnoffactive #2}%
3172 % Space between chapter (or whatever) number and the title.
3173 \def\labelspace{\hskip1em \relax}
3175 \def\dopageno#1{{\rm #1}}
3176 \def\doshortpageno#1{{\rm #1}}
3178 \def\chapentryfonts{\secfonts \rm}
3179 \def\secentryfonts{\textfonts}
3180 \let\subsecentryfonts = \textfonts
3181 \let\subsubsecentryfonts = \textfonts
3184 \message{environments,}
3186 % Since these characters are used in examples, it should be an even number of
3187 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3188 % Furthermore, these definitions must come after we define our fonts.
3189 \newbox\dblarrowbox \newbox\longdblarrowbox
3190 \newbox\pushcharbox \newbox\bullbox
3191 \newbox\equivbox \newbox\errorbox
3193 \let\ptexequiv = \equiv
3196 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3197 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3198 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3199 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3200 % Adapted from the manmac format (p.420 of TeXbook)
3201 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3207 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3208 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
3209 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3211 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3213 % Adapted from the TeXbook's \boxit.
3214 {\tentt \global\dimen0 = 3em}% Width of the box.
3215 \dimen2 = .55pt % Thickness of rules
3216 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3217 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
3219 \global\setbox\errorbox=\hbox to \dimen0{\hfil
3220 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3221 \advance\hsize by -2\dimen2 % Rules.
3223 \hrule height\dimen2
3224 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3225 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3226 \kern3pt\vrule width\dimen2}% Space to right.
3227 \hrule height\dimen2}
3230 % The @error{} command.
3231 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3233 % @tex ... @end tex escapes into raw Tex temporarily.
3234 % One exception: @ is still an escape character, so that @end tex works.
3235 % But \@ or @@ will get a plain tex @ character.
3237 \def\tex{\begingroup
3238 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
3239 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
3240 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
3256 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}
3257 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}
3259 \let\bullet=\ptexbullet
3260 \let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext \let\l=\ptexl
3263 \let\Etex=\endgroup}
3265 % Define @lisp ... @endlisp.
3266 % @lisp does a \begingroup so it can rebind things,
3267 % including the definition of @endlisp (which normally is erroneous).
3269 % Amount to narrow the margins by for @lisp.
3270 \newskip\lispnarrowing \lispnarrowing=0.4in
3272 % This is the definition that ^^M gets inside @lisp, @example, and other
3273 % such environments. \null is better than a space, since it doesn't
3275 \def\lisppar{\null\endgraf}
3277 % Make each space character in the input produce a normal interword
3278 % space in the output. Don't allow a line break at this space, as this
3279 % is used only in environments like @example, where each line of input
3280 % should produce a line of output anyway.
3283 \gdef\sepspaces{\obeyspaces\let =\tie}}
3285 % Define \obeyedspace to be our active space, whatever it is. This is
3286 % for use in \parsearg.
3288 \global\let\obeyedspace= }
3290 % This space is always present above and below environments.
3291 \newskip\envskipamount \envskipamount = 0pt
3293 % Make spacing and below environment symmetrical. We use \parskip here
3294 % to help in doing that, since in @example-like environments \parskip
3295 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
3296 % start of the next paragraph will insert \parskip
3298 \def\aboveenvbreak{{\advance\envskipamount by \parskip
3299 \endgraf \ifdim\lastskip<\envskipamount
3300 \removelastskip \penalty-50 \vskip\envskipamount \fi}}
3302 \let\afterenvbreak = \aboveenvbreak
3304 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
3305 \let\nonarrowing=\relax
3307 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3308 % \cartouche: draw rectangle w/rounded corners around argument
3309 \font\circle=lcircle10
3311 \newdimen\cartouter\newdimen\cartinner
3312 \newskip\normbskip\newskip\normpskip\newskip\normlskip
3313 \circthick=\fontdimen8\circle
3315 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
3316 \def\ctr{{\hskip 6pt\circle\char'010}}
3317 \def\cbl{{\circle\char'012\hskip -6pt}}
3318 \def\cbr{{\hskip 6pt\circle\char'011}}
3319 \def\carttop{\hbox to \cartouter{\hskip\lskip
3320 \ctl\leaders\hrule height\circthick\hfil\ctr
3322 \def\cartbot{\hbox to \cartouter{\hskip\lskip
3323 \cbl\leaders\hrule height\circthick\hfil\cbr
3326 \newskip\lskip\newskip\rskip
3328 \long\def\cartouche{%
3330 \lskip=\leftskip \rskip=\rightskip
3331 \leftskip=0pt\rightskip=0pt %we want these *outside*.
3332 \cartinner=\hsize \advance\cartinner by-\lskip
3333 \advance\cartinner by-\rskip
3335 \advance\cartouter by 18pt % allow for 3pt kerns on either
3336 % side, and for 6pt waste from
3338 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
3339 % Flag to tell @lisp, etc., not to narrow margin.
3340 \let\nonarrowing=\comment
3342 \baselineskip=0pt\parskip=0pt\lineskip=0pt
3351 \baselineskip=\normbskip
3352 \lineskip=\normlskip
3368 % This macro is called at the beginning of all the @example variants,
3372 \inENV % This group ends at the end of the body
3373 \hfuzz = 12pt % Don't be fussy
3374 \sepspaces % Make spaces be word-separators rather than space tokens.
3376 \let\par = \lisppar % don't ignore blank lines
3377 \obeylines % each line of input is a line of output
3380 \emergencystretch = 0pt % don't try to avoid overfull boxes
3381 % @cartouche defines \nonarrowing to inhibit narrowing
3382 % at next level down.
3383 \ifx\nonarrowing\relax
3384 \advance \leftskip by \lispnarrowing
3385 \exdentamount=\lispnarrowing
3386 \let\exdent=\nofillexdent
3387 \let\nonarrowing=\relax
3391 % To ending an @example-like environment, we first end the paragraph
3392 % (via \afterenvbreak's vertical glue), and then the group. That way we
3393 % keep the zero \parskip that the environments set -- \parskip glue
3394 % will be inserted at the beginning of the next paragraph in the
3395 % document, after the environment.
3397 \def\nonfillfinish{\afterenvbreak\endgroup}%
3400 \def\lisp{\begingroup
3402 \let\Elisp = \nonfillfinish
3404 \rawbackslash % have \ input char produce \ char from current font
3408 % Define the \E... control sequence only if we are inside the
3409 % environment, so the error checking in \end will work.
3411 % We must call \lisp last in the definition, since it reads the
3412 % return following the @example (or whatever) command.
3414 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
3415 \def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
3416 \def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
3418 % @smallexample and @smalllisp. This is not used unless the @smallbook
3419 % command is given. Originally contributed by Pavel@xerox.
3421 \def\smalllispx{\begingroup
3423 \let\Esmalllisp = \nonfillfinish
3424 \let\Esmallexample = \nonfillfinish
3426 % Smaller fonts for small examples.
3428 \rawbackslash % make \ output the \ character from the current font (tt)
3432 % This is @display; same as @lisp except use roman font.
3434 \def\display{\begingroup
3436 \let\Edisplay = \nonfillfinish
3440 % This is @format; same as @display except don't narrow margins.
3442 \def\format{\begingroup
3443 \let\nonarrowing = t
3445 \let\Eformat = \nonfillfinish
3449 % @flushleft (same as @format) and @flushright.
3451 \def\flushleft{\begingroup
3452 \let\nonarrowing = t
3454 \let\Eflushleft = \nonfillfinish
3457 \def\flushright{\begingroup
3458 \let\nonarrowing = t
3460 \let\Eflushright = \nonfillfinish
3461 \advance\leftskip by 0pt plus 1fill
3464 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
3465 % and narrows the margins.
3468 \begingroup\inENV %This group ends at the end of the @quotation body
3469 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
3472 % We have retained a nonzero parskip for the environment, since we're
3473 % doing normal filling. So to avoid extra space below the environment...
3474 \def\Equotation{\parskip = 0pt \nonfillfinish}%
3476 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
3477 \ifx\nonarrowing\relax
3478 \advance\leftskip by \lispnarrowing
3479 \advance\rightskip by \lispnarrowing
3480 \exdentamount = \lispnarrowing
3481 \let\nonarrowing = \relax
3486 % Define formatter for defuns
3487 % First, allow user to change definition object font (\df) internally
3488 \def\setdeffont #1 {\csname DEF#1\endcsname}
3490 \newskip\defbodyindent \defbodyindent=.4in
3491 \newskip\defargsindent \defargsindent=50pt
3492 \newskip\deftypemargin \deftypemargin=12pt
3493 \newskip\deflastargmargin \deflastargmargin=18pt
3495 \newcount\parencount
3496 % define \functionparens, which makes ( and ) and & do special things.
3497 % \functionparens affects the group it is contained in.
3499 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
3500 \catcode`\[=\active \catcode`\]=\active}
3502 % Make control sequences which act like normal parenthesis chars.
3503 \let\lparen = ( \let\rparen = )
3505 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3507 % Be sure that we always have a definition for `(', etc. For example,
3508 % if the fn name has parens in it, \boldbrax will not be in effect yet,
3509 % so TeX would otherwise complain about undefined control sequence.
3510 \global\let(=\lparen \global\let)=\rparen
3511 \global\let[=\lbrack \global\let]=\rbrack
3513 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
3514 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
3515 % This is used to turn on special parens
3516 % but make & act ordinary (given that it's active).
3517 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
3519 % Definitions of (, ) and & used in args for functions.
3520 % This is the definition of ( outside of all parentheses.
3521 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested %
3522 \global\advance\parencount by 1 }
3524 % This is the definition of ( when already inside a level of parens.
3525 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
3527 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
3528 % also in that case restore the outer-level definition of (.
3529 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
3530 \global\advance \parencount by -1 }
3531 % If we encounter &foo, then turn on ()-hacking afterwards
3532 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
3534 \gdef\normalparens{\boldbrax\let&=\ampnr}
3535 } % End of definition inside \activeparens
3536 %% These parens (in \boldbrax) actually are a little bolder than the
3537 %% contained text. This is especially needed for [ and ]
3538 \def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&}
3539 \def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}}
3541 % First, defname, which formats the header line itself.
3542 % #1 should be the function name.
3543 % #2 should be the type of definition, such as "Function".
3546 % Get the values of \leftskip and \rightskip as they were
3547 % outside the @def...
3549 \advance\dimen2 by -\defbodyindent
3551 \advance\dimen3 by -\defbodyindent
3553 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3554 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
3555 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
3556 \parshape 2 0in \dimen0 \defargsindent \dimen1 %
3557 % Now output arg 2 ("Function" or some such)
3558 % ending at \deftypemargin from the right margin,
3559 % but stuck inside a box of width 0 so it does not interfere with linebreaking
3560 {% Adjust \hsize to exclude the ambient margins,
3561 % so that \rightline will obey them.
3562 \advance \hsize by -\dimen2 \advance \hsize by -\dimen3
3563 \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3564 % Make all lines underfull and no complaints:
3565 \tolerance=10000 \hbadness=10000
3566 \advance\leftskip by -\defbodyindent
3567 \exdentamount=\defbodyindent
3568 {\df #1}\enskip % Generate function name
3571 % Actually process the body of a definition
3572 % #1 should be the terminating control sequence, such as \Edefun.
3573 % #2 should be the "another name" control sequence, such as \defunx.
3574 % #3 should be the control sequence that actually processes the header,
3575 % such as \defunheader.
3577 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3579 % Define the end token that this defining construct specifies
3580 % so that it will exit this group.
3581 \def#1{\endgraf\endgroup\medbreak}%
3582 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3584 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3585 \exdentamount=\defbodyindent
3587 \catcode 61=\active % 61 is `='
3588 \obeylines\activeparens\spacesplit#3}
3590 \def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3592 % Define the end token that this defining construct specifies
3593 % so that it will exit this group.
3594 \def#1{\endgraf\endgroup\medbreak}%
3595 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
3597 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3598 \exdentamount=\defbodyindent
3599 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3601 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3603 % Define the end token that this defining construct specifies
3604 % so that it will exit this group.
3605 \def#1{\endgraf\endgroup\medbreak}%
3606 \def#2##1 ##2 {\def#4{##1}%
3607 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
3609 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3610 \exdentamount=\defbodyindent
3611 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3613 % These parsing functions are similar to the preceding ones
3614 % except that they do not make parens into active characters.
3615 % These are used for "variables" since they have no arguments.
3617 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3619 % Define the end token that this defining construct specifies
3620 % so that it will exit this group.
3621 \def#1{\endgraf\endgroup\medbreak}%
3622 \def#2{\begingroup\obeylines\spacesplit#3}%
3624 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3625 \exdentamount=\defbodyindent
3627 \catcode 61=\active %
3628 \obeylines\spacesplit#3}
3630 % This is used for \def{tp,vr}parsebody. It could probably be used for
3631 % some of the others, too, with some judicious conditionals.
3633 \def\parsebodycommon#1#2#3{%
3636 % Define the end token that this defining construct specifies
3637 % so that it will exit this group.
3638 \def#1{\endgraf\endgroup\medbreak}%
3639 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
3641 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3642 \exdentamount=\defbodyindent
3643 \begingroup\obeylines
3646 \def\defvrparsebody#1#2#3#4 {%
3647 \parsebodycommon{#1}{#2}{#3}%
3648 \spacesplit{#3{#4}}%
3651 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3652 % type is just `struct', because we lose the braces in `{struct
3653 % termios}' when \spacesplit reads its undelimited argument. Sigh.
3654 % \let\deftpparsebody=\defvrparsebody
3656 % So, to get around this, we put \empty in with the type name. That
3657 % way, TeX won't find exactly `{...}' as an undelimited argument, and
3658 % won't strip off the braces.
3660 \def\deftpparsebody #1#2#3#4 {%
3661 \parsebodycommon{#1}{#2}{#3}%
3662 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3665 % Fine, but then we have to eventually remove the \empty *and* the
3666 % braces (if any). That's what this does, putting the result in \tptemp.
3668 \def\removeemptybraces\empty#1\relax{\def\tptemp{#1}}%
3670 % After \spacesplit has done its work, this is called -- #1 is the final
3671 % thing to call, #2 the type name (which starts with \empty), and #3
3672 % (which might be empty) the arguments.
3674 \def\parsetpheaderline#1#2#3{%
3675 \removeemptybraces#2\relax
3679 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3681 % Define the end token that this defining construct specifies
3682 % so that it will exit this group.
3683 \def#1{\endgraf\endgroup\medbreak}%
3684 \def#2##1 ##2 {\def#4{##1}%
3685 \begingroup\obeylines\spacesplit{#3{##2}}}%
3687 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3688 \exdentamount=\defbodyindent
3689 \begingroup\obeylines\spacesplit{#3{#5}}}
3691 % Split up #2 at the first space token.
3692 % call #1 with two arguments:
3693 % the first is all of #2 before the space token,
3694 % the second is all of #2 after that space token.
3695 % If #2 contains no space token, all of it is passed as the first arg
3696 % and the second is passed as empty.
3699 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3700 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3702 #1{#2}{}\else #1{#2}{#3#4}\fi}}
3704 % So much for the things common to all kinds of definitions.
3708 % First, define the processing that is wanted for arguments of \defun
3709 % Use this to expand the args and terminate the paragraph they make up
3711 \def\defunargs #1{\functionparens \sl
3712 % Expand, preventing hyphenation at `-' chars.
3713 % Note that groups don't affect changes in \hyphenchar.
3716 \hyphenchar\tensl=45
3717 \ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi%
3718 \interlinepenalty=10000
3719 \advance\rightskip by 0pt plus 1fil
3720 \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3723 \def\deftypefunargs #1{%
3724 % Expand, preventing hyphenation at `-' chars.
3725 % Note that groups don't affect changes in \hyphenchar.
3726 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
3728 \tclose{#1}% avoid \code because of side effects on active chars
3729 \interlinepenalty=10000
3730 \advance\rightskip by 0pt plus 1fil
3731 \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3734 % Do complete processing of one @defun or @defunx line already parsed.
3736 % @deffn Command forward-char nchars
3738 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
3740 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
3741 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
3742 \catcode 61=\other % Turn off change made in \defparsebody
3745 % @defun == @deffn Function
3747 \def\defun{\defparsebody\Edefun\defunx\defunheader}
3749 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3750 \begingroup\defname {#1}{Function}%
3751 \defunargs {#2}\endgroup %
3752 \catcode 61=\other % Turn off change made in \defparsebody
3755 % @deftypefun int foobar (int @var{foo}, float @var{bar})
3757 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
3759 % #1 is the data type. #2 is the name and args.
3760 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
3761 % #1 is the data type, #2 the name, #3 the args.
3762 \def\deftypefunheaderx #1#2 #3\relax{%
3763 \doind {fn}{\code{#2}}% Make entry in function index
3764 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Function}%
3765 \deftypefunargs {#3}\endgroup %
3766 \catcode 61=\other % Turn off change made in \defparsebody
3769 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
3771 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
3773 % \defheaderxcond#1\relax$$$
3774 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
3775 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
3777 % #1 is the classification. #2 is the data type. #3 is the name and args.
3778 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
3779 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
3780 \def\deftypefnheaderx #1#2#3 #4\relax{%
3781 \doind {fn}{\code{#3}}% Make entry in function index
3783 \normalparens % notably, turn off `&' magic, which prevents
3784 % at least some C++ text from working
3785 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
3786 \deftypefunargs {#4}\endgroup %
3787 \catcode 61=\other % Turn off change made in \defparsebody
3790 % @defmac == @deffn Macro
3792 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
3794 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3795 \begingroup\defname {#1}{Macro}%
3796 \defunargs {#2}\endgroup %
3797 \catcode 61=\other % Turn off change made in \defparsebody
3800 % @defspec == @deffn Special Form
3802 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
3804 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3805 \begingroup\defname {#1}{Special Form}%
3806 \defunargs {#2}\endgroup %
3807 \catcode 61=\other % Turn off change made in \defparsebody
3810 % This definition is run if you use @defunx
3811 % anywhere other than immediately after a @defun or @defunx.
3813 \def\deffnx #1 {\errmessage{@deffnx in invalid context}}
3814 \def\defunx #1 {\errmessage{@defunx in invalid context}}
3815 \def\defmacx #1 {\errmessage{@defmacx in invalid context}}
3816 \def\defspecx #1 {\errmessage{@defspecx in invalid context}}
3817 \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
3818 \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
3820 % @defmethod, and so on
3822 % @defop {Funny Method} foo-class frobnicate argument
3824 \def\defop #1 {\def\defoptype{#1}%
3825 \defopparsebody\Edefop\defopx\defopheader\defoptype}
3827 \def\defopheader #1#2#3{%
3828 \dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
3829 \begingroup\defname {#2}{\defoptype{} on #1}%
3830 \defunargs {#3}\endgroup %
3833 % @defmethod == @defop Method
3835 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
3837 \def\defmethodheader #1#2#3{%
3838 \dosubind {fn}{\code{#2}}{on #1}% entry in function index
3839 \begingroup\defname {#2}{Method on #1}%
3840 \defunargs {#3}\endgroup %
3843 % @defcv {Class Option} foo-class foo-flag
3845 \def\defcv #1 {\def\defcvtype{#1}%
3846 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
3848 \def\defcvarheader #1#2#3{%
3849 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3850 \begingroup\defname {#2}{\defcvtype{} of #1}%
3851 \defvarargs {#3}\endgroup %
3854 % @defivar == @defcv {Instance Variable}
3856 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
3858 \def\defivarheader #1#2#3{%
3859 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3860 \begingroup\defname {#2}{Instance Variable of #1}%
3861 \defvarargs {#3}\endgroup %
3864 % These definitions are run if you use @defmethodx, etc.,
3865 % anywhere other than immediately after a @defmethod, etc.
3867 \def\defopx #1 {\errmessage{@defopx in invalid context}}
3868 \def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
3869 \def\defcvx #1 {\errmessage{@defcvx in invalid context}}
3870 \def\defivarx #1 {\errmessage{@defivarx in invalid context}}
3874 % First, define the processing that is wanted for arguments of @defvar.
3875 % This is actually simple: just print them in roman.
3876 % This must expand the args and terminate the paragraph they make up
3877 \def\defvarargs #1{\normalparens #1%
3878 \interlinepenalty=10000
3879 \endgraf\penalty 10000\vskip -\parskip\penalty 10000}
3881 % @defvr Counter foo-count
3883 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
3885 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
3886 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
3888 % @defvar == @defvr Variable
3890 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
3892 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3893 \begingroup\defname {#1}{Variable}%
3894 \defvarargs {#2}\endgroup %
3897 % @defopt == @defvr {User Option}
3899 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
3901 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3902 \begingroup\defname {#1}{User Option}%
3903 \defvarargs {#2}\endgroup %
3906 % @deftypevar int foobar
3908 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
3910 % #1 is the data type. #2 is the name.
3911 \def\deftypevarheader #1#2{%
3912 \doind {vr}{\code{#2}}% Make entry in variables index
3913 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Variable}%
3914 \interlinepenalty=10000
3915 \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3918 % @deftypevr {Global Flag} int enable
3920 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
3922 \def\deftypevrheader #1#2#3{\doind {vr}{\code{#3}}%
3923 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
3924 \interlinepenalty=10000
3925 \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3928 % This definition is run if you use @defvarx
3929 % anywhere other than immediately after a @defvar or @defvarx.
3931 \def\defvrx #1 {\errmessage{@defvrx in invalid context}}
3932 \def\defvarx #1 {\errmessage{@defvarx in invalid context}}
3933 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
3934 \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
3935 \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
3938 % Args are printed in bold, a slight difference from @defvar.
3940 \def\deftpargs #1{\bf \defvarargs{#1}}
3942 % @deftp Class window height width ...
3944 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
3946 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
3947 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
3949 % This definition is run if you use @deftpx, etc
3950 % anywhere other than immediately after a @deftp, etc.
3952 \def\deftpx #1 {\errmessage{@deftpx in invalid context}}
3954 \message{cross reference,}
3955 % Define cross-reference macros
3958 \newif\ifhavexrefs % True if xref values are known.
3959 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
3961 % \setref{foo} defines a cross-reference point named foo.
3964 \dosetq{#1-title}{Ytitle}%
3965 \dosetq{#1-pg}{Ypagenumber}%
3966 \dosetq{#1-snt}{Ysectionnumberandtype}}
3968 \def\unnumbsetref#1{%
3969 \dosetq{#1-title}{Ytitle}%
3970 \dosetq{#1-pg}{Ypagenumber}%
3971 \dosetq{#1-snt}{Ynothing}}
3973 \def\appendixsetref#1{%
3974 \dosetq{#1-title}{Ytitle}%
3975 \dosetq{#1-pg}{Ypagenumber}%
3976 \dosetq{#1-snt}{Yappendixletterandtype}}
3978 % \xref, \pxref, and \ref generate cross-references to specified points.
3979 % For \xrefX, #1 is the node name, #2 the name of the Info
3980 % cross-reference, #3 the printed node name, #4 the name of the Info
3981 % file, #5 the name of the printed manual. All but the node name can be
3984 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
3985 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
3986 \def\ref#1{\xrefX[#1,,,,,,,]}
3987 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
3988 \def\printedmanual{\ignorespaces #5}%
3989 \def\printednodename{\ignorespaces #3}%
3990 \setbox1=\hbox{\printedmanual}%
3991 \setbox0=\hbox{\printednodename}%
3993 % No printed node name was explicitly given.
3994 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
3995 % Use the node name inside the square brackets.
3996 \def\printednodename{\ignorespaces #1}%
3998 % Use the actual chapter/section title appear inside
3999 % the square brackets. Use the real section title if we have it.
4001 % It is in another manual, so we don't have it.
4002 \def\printednodename{\ignorespaces #1}%
4005 % We know the real title if we have the xref values.
4006 \def\printednodename{\refx{#1-title}{}}%
4008 % Otherwise just copy the Info node name.
4009 \def\printednodename{\ignorespaces #1}%
4015 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
4016 % insert empty discretionaries after hyphens, which means that it will
4017 % not find a line break at a hyphen in a node names. Since some manuals
4018 % are best written with fairly long node names, containing hyphens, this
4019 % is a loss. Therefore, we give the text of the node name again, so it
4020 % is as if TeX is seeing it for the first time.
4022 \putwordsection{} ``\printednodename'' in \cite{\printedmanual}%
4024 % _ (for example) has to be the character _ for the purposes of the
4025 % control sequence corresponding to the node, but it has to expand
4026 % into the usual \leavevmode...\vrule stuff for purposes of
4027 % printing. So we \turnoffactive for the \refx-snt, back on for the
4028 % printing, back off for the \refx-pg.
4029 {\turnoffactive \refx{#1-snt}{}}%
4030 \space [\printednodename],\space
4031 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
4035 % \dosetq is the interface for calls from other macros
4037 % Use \turnoffactive so that punctuation chars such as underscore
4038 % work in node names.
4039 \def\dosetq #1#2{{\let\folio=0 \turnoffactive \auxhat%
4040 \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
4043 % \internalsetq {foo}{page} expands into
4044 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
4045 % When the aux file is read, ' is the escape character
4047 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
4049 % Things to be expanded by \internalsetq
4051 \def\Ypagenumber{\folio}
4053 \def\Ytitle{\thissection}
4057 \def\Ysectionnumberandtype{%
4058 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
4059 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
4060 \else \ifnum \subsubsecno=0 %
4061 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
4063 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
4066 \def\Yappendixletterandtype{%
4067 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
4068 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
4069 \else \ifnum \subsubsecno=0 %
4070 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
4072 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
4077 % Use TeX 3.0's \inputlineno to get the line number, for better error
4078 % messages, but if we're using an old version of TeX, don't do anything.
4080 \ifx\inputlineno\thisisundefined
4081 \let\linenumber = \empty % Non-3.0.
4083 \def\linenumber{\the\inputlineno:\space}
4086 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
4087 % If its value is nonempty, SUFFIX is output afterward.
4090 \expandafter\ifx\csname X#1\endcsname\relax
4091 % If not defined, say something at least.
4092 $\langle$un\-de\-fined$\rangle$%
4094 \message{\linenumber Undefined cross reference `#1'.}%
4097 \global\warnedxrefstrue
4098 \message{Cross reference values unknown; you must run TeX again.}%
4102 % It's defined, so just use it.
4103 \csname X#1\endcsname
4105 #2% Output the suffix in any case.
4108 % Read the last existing aux file, if any. No error if none exists.
4110 % This is the macro invoked by entries in the aux file.
4112 {\catcode`\'=\other\expandafter \gdef \csname X#1\endcsname {#2}}}
4116 \catcode `\^^@=\other
4117 \catcode `\
\ 1=\other
4118 \catcode `\
\ 2=\other
4119 \catcode `\^^C=\other
4120 \catcode `\^^D=\other
4121 \catcode `\^^E=\other
4122 \catcode `\^^F=\other
4123 \catcode `\^^G=\other
4124 \catcode `\^^H=\other
4125 \catcode `\
\v=\other
4126 \catcode `\^^L=\other
4127 \catcode `\
\ e=\other
4128 \catcode `\
\ f=\other
4129 \catcode `\
\10=\other
4130 \catcode `\
\11=\other
4131 \catcode `\
\12=\other
4132 \catcode `\
\13=\other
4133 \catcode `\
\14=\other
4134 \catcode `\
\15=\other
4135 \catcode `\
\16=\other
4136 \catcode `\
\17=\other
4137 \catcode `\
\18=\other
4138 \catcode `\
\19=\other
4140 \catcode `\^^[=\other
4141 \catcode `\^^\=\other
4142 \catcode `\^^]=\other
4143 \catcode `\^^^=\other
4144 \catcode `\^^_=\other
4158 % `\+ does not work, so use 43.
4160 % Make the characters 128-255 be printing characters
4164 \catcode\count 1=\other
4165 \advance\count 1 by 1
4166 \ifnum \count 1<256 \loop \fi
4169 % the aux file uses ' as the escape.
4170 % Turn off \ as an escape so we do not lose on
4171 % entries which were dumped with control sequences in their names.
4172 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
4173 % Reference to such entries still does not work the way one would wish,
4174 % but at least they do not bomb out when the aux file is read in.
4175 \catcode `\{=1 \catcode `\}=2
4178 \catcode`\^=7 % to make ^^e4 etc usable in xref tags
4180 \openin 1 \jobname.aux
4181 \ifeof 1 \else \closein 1 \input \jobname.aux \global\havexrefstrue
4182 \global\warnedobstrue
4184 % Open the new aux file. Tex will close it automatically at exit.
4185 \openout \auxfile=\jobname.aux
4191 \newcount \footnoteno
4193 % The trailing space in the following definition for supereject is
4194 % vital for proper filling; pages come out unaligned when you do a
4195 % pagealignmacro call if that space before the closing brace is
4197 \def\supereject{\par\penalty -20000\footnoteno =0 }
4199 % @footnotestyle is meaningful for info output only..
4200 \let\footnotestyle=\comment
4202 \let\ptexfootnote=\footnote
4206 % Auto-number footnotes. Otherwise like plain.
4208 \global\advance\footnoteno by \@ne
4209 \edef\thisfootno{$^{\the\footnoteno}$}%
4211 % In case the footnote comes at the end of a sentence, preserve the
4212 % extra spacing after we do the footnote number.
4214 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
4216 % Remove inadvertent blank space before typesetting the footnote number.
4222 % Don't bother with the trickery in plain.tex to not require the
4223 % footnote text as a parameter. Our footnotes don't need to be so general.
4225 \long\gdef\footnotezzz#1{\insert\footins{%
4226 % We want to typeset this text as a normal paragraph, even if the
4227 % footnote reference occurs in (for example) a display environment.
4228 % So reset some parameters.
4229 \interlinepenalty\interfootnotelinepenalty
4230 \splittopskip\ht\strutbox % top baseline for broken footnotes
4231 \splitmaxdepth\dp\strutbox
4232 \floatingpenalty\@MM
4237 \parindent\defaultparindent
4239 % Hang the footnote text off the number.
4241 \textindent{\thisfootno}%
4243 % Don't crash into the line above the footnote text. Since this
4244 % expands into a box, it must come within the paragraph, lest it
4245 % provide a place where TeX can split the footnote.
4250 }%end \catcode `\@=11
4252 % Set the baselineskip to #1, and the lineskip and strut size
4253 % correspondingly. There is no deep meaning behind these magic numbers
4254 % used as factors; they just match (closely enough) what Knuth defined.
4256 \def\lineskipfactor{.08333}
4257 \def\strutheightpercent{.70833}
4258 \def\strutdepthpercent {.29167}
4261 \normalbaselineskip = #1\relax
4262 \normallineskip = \lineskipfactor\normalbaselineskip
4264 \setbox\strutbox =\hbox{%
4265 \vrule width0pt height\strutheightpercent\baselineskip
4266 depth \strutdepthpercent \baselineskip
4270 % @| inserts a changebar to the left of the current line. It should
4271 % surround any changed text. This approach does *not* work if the
4272 % change spans more than two lines of output. To handle that, we would
4273 % have adopt a much more difficult approach (putting marks into the main
4274 % vertical list for the beginning and end of each change).
4277 % \vadjust can only be used in horizontal mode.
4280 % Append this vertical mode material after the current line in the output.
4282 % We want to insert a rule with the height and depth of the current
4283 % leading; that is exactly what \strutbox is supposed to record.
4284 \vskip-\baselineskip
4286 % \vadjust-items are inserted at the left edge of the type. So
4287 % the \llap here moves out into the left-hand margin.
4290 % For a thicker or thinner bar, change the `1pt'.
4291 \vrule height\baselineskip width1pt
4293 % This is the space between the bar and the text.
4299 % For a final copy, take out the rectangles
4300 % that mark overfull boxes (in case you have decided
4301 % that the text looks ok even though it passes the margin).
4303 \def\finalout{\overfullrule=0pt}
4306 % End of control word definitions.
4308 \message{and turning on texinfo input format.}
4319 % Set some numeric style parameters, for 8.5 x 11 format.
4322 \newdimen\defaultparindent \defaultparindent = 15pt
4323 \parindent = \defaultparindent
4324 \parskip 18pt plus 1pt
4326 \advance\topskip by 1.2cm
4328 % Prevent underfull vbox error messages.
4331 % Following George Bush, just get rid of widows and orphans.
4335 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
4336 % using an old version of TeX, don't do anything. We want the amount of
4337 % stretch added to depend on the line length, hence the dependence on
4338 % \hsize. This makes it come to about 9pt for the 8.5x11 format.
4340 \ifx\emergencystretch\thisisundefined
4341 % Allow us to assign to \emergencystretch anyway.
4342 \def\emergencystretch{\dimen0}%
4344 \emergencystretch = \hsize
4345 \divide\emergencystretch by 45
4348 % Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
4351 % These values for secheadingskip and subsecheadingskip are
4352 % experiments. RJC 7 Aug 1992
4353 \global\secheadingskip = 17pt plus 6pt minus 3pt
4354 \global\subsecheadingskip = 14pt plus 6pt minus 3pt
4356 \global\lispnarrowing = 0.3in
4358 \advance\topskip by -1cm
4359 \global\parskip 3pt plus 1pt
4362 \global\tolerance=700
4364 \global\contentsrightmargin=0pt
4365 \global\deftypemargin=0pt
4366 \global\defbodyindent=.5cm
4368 \global\pagewidth=\hsize
4369 \global\pageheight=\vsize
4371 \global\let\smalllisp=\smalllispx
4372 \global\let\smallexample=\smalllispx
4373 \global\def\Esmallexample{\Esmalllisp}
4376 % Use @afourpaper to print on European A4 paper.
4378 \global\tolerance=700
4381 \global\parskip 15pt plus 1pt
4383 \global\vsize= 53\baselineskip
4384 \advance\vsize by \topskip
4385 %\global\hsize= 5.85in % A4 wide 10pt
4386 \global\hsize= 6.5in
4387 \global\outerhsize=\hsize
4388 \global\advance\outerhsize by 0.5in
4389 \global\outervsize=\vsize
4390 \global\advance\outervsize by 0.6in
4392 \global\pagewidth=\hsize
4393 \global\pageheight=\vsize
4396 % Allow control of the text dimensions. Parameters in order: textheight;
4397 % textwidth; voffset; hoffset; binding offset; topskip.
4398 % All require a dimension;
4399 % header is additional; added length extends the bottom of the page.
4401 \def\changepagesizes#1#2#3#4#5#6{
4404 \advance\vsize by \topskip
4407 \global\outerhsize=\hsize
4408 \global\advance\outerhsize by 0.5in
4409 \global\outervsize=\vsize
4410 \global\advance\outervsize by 0.6in
4411 \global\pagewidth=\hsize
4412 \global\pageheight=\vsize
4413 \global\normaloffset= #4
4414 \global\bindingoffset= #5}
4416 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
4417 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
4419 {\global\tolerance=700
4422 \global\parskip 15pt plus 1pt
4423 \advance\baselineskip by 1.6pt
4424 \changepagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}
4427 % Use @afourwide to print on European A4 paper in wide format.
4428 \def\afourwide{\afourpaper
4429 \changepagesizes{9.5in}{6.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}}
4431 % Define macros to output various characters with catcode for normal text.
4440 \def\normaldoublequote{"}
4443 \def\normalunderscore{_}
4444 \def\normalverticalbar{|}
4446 \def\normalgreater{>}
4449 % This macro is used to make a character print one way in ttfont
4450 % where it can probably just be output, and another way in other fonts,
4451 % where something hairier probably needs to be done.
4453 % #1 is what to print if we are indeed using \tt; #2 is what to print
4454 % otherwise. Since all the Computer Modern typewriter fonts have zero
4455 % interword stretch (and shrink), and it is reasonable to expect all
4456 % typewriter fonts to have this, we can check that font parameter.
4458 \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
4460 % Turn off all special characters except @
4461 % (and those which the user can use as if they were ordinary).
4462 % Most of these we simply print from the \tt font, but for some, we can
4463 % use math or other variants that look better in normal text.
4466 \def\activedoublequote{{\tt \char '042}}
4467 \let"=\activedoublequote
4469 \def~{{\tt \char '176}}
4472 \def\auxhat{\def^{'hat}}
4476 \def_{\ifusingtt\normalunderscore\_}
4477 % Subroutine for the previous macro.
4478 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
4481 \def|{{\tt \char '174}}
4489 \def+{{\tt \char 43}}
4490 %\catcode 27=\active
4491 %\def^^[{$\diamondsuit$}
4493 % Set up an active definition for =, but don't enable it most of the time.
4494 {\catcode`\==\active
4495 \global\def={{\tt \char 61}}}
4500 % If a .fmt file is being used, characters that might appear in a file
4501 % name cannot be active until we have parsed the command line.
4502 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
4503 % \otherifyactive is called near the end of this file.
4504 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
4508 % \rawbackslashxx output one backslash character in current font
4509 \global\chardef\rawbackslashxx=`\\
4510 %{\catcode`\\=\other
4511 %@gdef@rawbackslashxx{\}}
4513 % \rawbackslash redefines \ as input to do \rawbackslashxx.
4514 {\catcode`\\=\active
4515 @gdef@rawbackslash{@let\=@rawbackslashxx }}
4517 % \normalbackslash outputs one backslash in fixed width font.
4518 \def\normalbackslash{{\tt\rawbackslashxx}}
4520 % Say @foo, not \foo, in error messages.
4523 % \catcode 17=0 % Define control-q
4526 % Used sometimes to turn off (effectively) the active characters
4527 % even after parsing them.
4528 @def@turnoffactive{@let"=@normaldoublequote
4529 @let\=@realbackslash
4532 @let_=@normalunderscore
4533 @let|=@normalverticalbar
4535 @let>=@normalgreater
4538 @def@normalturnoffactive{@let"=@normaldoublequote
4539 @let\=@normalbackslash
4542 @let_=@normalunderscore
4543 @let|=@normalverticalbar
4545 @let>=@normalgreater
4548 % Make _ and + \other characters, temporarily.
4549 % This is canceled by @fixbackslash.
4552 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4553 % That is what \eatinput is for; after that, the `\' should revert to printing
4556 @gdef@eatinput input texinfo{@fixbackslash}
4557 @global@let\ = @eatinput
4559 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
4560 % the first `\{ in the file would cause an error. This macro tries to fix
4561 % that, assuming it is called before the first `\' could plausibly occur.
4562 % Also back turn on active characters that might appear in the input
4563 % file name, in case not using a pre-dumped format.
4565 @gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi
4566 @catcode`+=@active @catcode`@_=@active}
4568 %% These look ok in all fonts, so just make them not special. The @rm below
4569 %% makes sure that the current font starts out as the newly loaded cmr10
4570 @catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
4576 @c page-delimiter: "^\\\\message"