1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2003-01-08.14}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
11 % This texinfo.tex file is free software; you can redistribute it and/or
12 % modify it under the terms of the GNU General Public License as
13 % published by the Free Software Foundation; either version 2, or (at
14 % your option) any later version.
16 % This texinfo.tex file is distributed in the hope that it will be
17 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 % General Public License for more details.
21 % You should have received a copy of the GNU General Public License
22 % along with this texinfo.tex file; see the file COPYING. If not, write
23 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 % Boston, MA 02111-1307, USA.
26 % In other words, you are welcome to use, share and improve this program.
27 % You are forbidden to forbid anyone else to use, share and improve
28 % what you give them. Help stamp out software-hoarding!
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org),
36 % and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
40 % The texinfo.tex in any given Texinfo distribution could well be out
41 % of date, so if that's what you're using, please check.
43 % Send bug reports to bug-texinfo@gnu.org. Please include including a
44 % complete document in each bug report with which we can reproduce the
45 % problem. Patches are, of course, greatly appreciated.
47 % To process a Texinfo manual with TeX, it's most reliable to use the
48 % texi2dvi shell script that comes with the distribution. For a simple
49 % manual foo.texi, however, you can get away with this:
54 % dvips foo.dvi -o # or whatever; this makes foo.ps.
55 % The extra TeX runs get the cross-reference information correct.
56 % Sometimes one run after texindex suffices, and sometimes you need more
57 % than two; texi2dvi does it as many times as necessary.
59 % It is possible to adapt texinfo.tex for other languages. You can get
60 % the existing language-specific files from the full Texinfo distribution.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
73 % We never want plain's outer \+ definition in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some parts of plain tex whose names we will redefine.
79 \let\ptexbullet=\bullet
97 % If this character appears in an error message or help string, it
98 % starts a new line in the output.
101 % Set up fixed words for English if not already set.
102 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
103 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
104 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
105 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
106 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
107 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
108 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
109 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
110 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
111 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
112 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
113 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
114 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
115 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
116 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
117 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
118 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
119 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
120 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
122 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
123 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
124 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
125 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
126 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
127 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
128 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
129 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
130 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
131 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
132 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
133 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
135 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
136 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
137 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
138 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
139 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
140 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
141 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
147 % True if #1 is the empty string, i.e., called like `\ifempty{}'.
149 \def\ifempty#1{\ifemptyx #1\emptymarkA\emptymarkB}%
150 \def\ifemptyx#1#2\emptymarkB{\ifx #1\emptymarkA}%
153 \hyphenation{ap-pen-dix}
154 \hyphenation{mini-buf-fer mini-buf-fers}
156 \hyphenation{white-space}
158 % Margin to add to right of even pages, to left of odd pages.
159 \newdimen\bindingoffset
160 \newdimen\normaloffset
161 \newdimen\pagewidth \newdimen\pageheight
163 % Sometimes it is convenient to have everything in the transcript file
164 % and nothing on the terminal. We don't just call \tracingall here,
165 % since that produces some useless output on the terminal. We also make
166 % some effort to order the tracing commands to reduce output in the log
167 % file; cf. trace.sty in LaTeX.
169 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
173 \tracinglostchars2 % 2 gives us more in etex
178 \showboxbreadth\maxdimen \showboxdepth\maxdimen
179 \ifx\eTeXversion\undefined\else % etex gives us more logging
186 \tracingcommands3 % 3 gives us more in etex
187 \errorcontextlines\maxdimen
190 % add check for \lastpenalty to plain's definitions. If the last thing
191 % we did was a \nobreak, we don't want to insert more space.
193 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
194 \removelastskip\penalty-50\smallskip\fi\fi}
195 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
196 \removelastskip\penalty-100\medskip\fi\fi}
197 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
198 \removelastskip\penalty-200\bigskip\fi\fi}
200 % For @cropmarks command.
201 % Do @cropmarks to get crop marks.
204 \let\cropmarks = \cropmarkstrue
206 % Dimensions to add cropmarks at corners.
207 % Added by P. A. MacKay, 12 Nov. 1986
209 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
210 \newdimen\cornerlong \cornerlong=1pc
211 \newdimen\cornerthick \cornerthick=.3pt
212 \newdimen\topandbottommargin \topandbottommargin=.75in
214 % Main output routine.
216 \output = {\onepageout{\pagecontents\PAGE}}
221 % \onepageout takes a vbox as an argument. Note that \pagecontents
222 % does insertions, but you have to call it yourself.
224 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
226 \ifodd\pageno \advance\hoffset by \bindingoffset
227 \else \advance\hoffset by -\bindingoffset\fi
229 % Do this outside of the \shipout so @code etc. will be expanded in
230 % the headline as they should be, not taken literally (outputting ''code).
231 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
232 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
235 % Have to do this stuff outside the \shipout because we want it to
236 % take effect in \write's, yet the group defined by the \vbox ends
237 % before the \shipout runs.
239 \escapechar = `\\ % use backslash in output files.
240 \indexdummies % don't expand commands in the output.
241 \normalturnoffactive % \ in index entries must not stay \, e.g., if
242 % the page break happens to be in the middle of an example.
244 % Do this early so pdf references go to the beginning of the page.
245 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
247 \ifcropmarks \vbox to \outervsize\bgroup
249 \vskip-\topandbottommargin
251 \line{\ewtop\hfil\ewtop}%
254 \vbox{\moveleft\cornerthick\nstop}%
256 \vbox{\moveright\cornerthick\nstop}%
259 \vskip\topandbottommargin
261 \hfil % center the page within the outer (page) hsize.
262 \ifodd\pageno\hskip\bindingoffset\fi
268 \ifdim\ht\footlinebox > 0pt
269 % Only leave this space if the footline is nonempty.
270 % (We lessened \vsize for it in \oddfootingxxx.)
271 % The \baselineskip=24pt in plain's \makefootline has no effect.
272 \vskip 2\baselineskip
277 \egroup % end of \vbox\bgroup
278 \hfil\egroup % end of (centering) \line\bgroup
279 \vskip\topandbottommargin plus1fill minus1fill
280 \boxmaxdepth = \cornerthick
283 \vbox{\moveleft\cornerthick\nsbot}%
285 \vbox{\moveright\cornerthick\nsbot}%
288 \line{\ewbot\hfil\ewbot}%
290 \egroup % \vbox from first cropmarks clause
292 }% end of \shipout\vbox
293 }% end of group with \turnoffactive
295 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
298 \newinsert\margin \dimen\margin=\maxdimen
300 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
302 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
303 % marginal hacks, juha@viisa.uucp (Juha Takala)
304 \ifvoid\margin\else % marginal info is present
305 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
306 \dimen@=\dp#1 \unvbox#1
307 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
308 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
311 % Here are the rules for the cropmarks. Note that they are
312 % offset so that the space between them is truly \outerhsize or \outervsize
313 % (P. A. MacKay, 12 November, 1986)
315 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
317 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
318 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
320 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
322 % Parse an argument, then pass it to #1. The argument is the rest of
323 % the input line (except we remove a trailing comment). #1 should be a
324 % macro which expects an ordinary undelimited TeX argument.
330 \futurelet\temp\parseargx
333 % If the next token is an obeyed space (from an @example environment or
334 % the like), remove it and recurse. Otherwise, we're done.
336 % \obeyedspace is defined far below, after the definition of \sepspaces.
337 \ifx\obeyedspace\temp
338 \expandafter\parseargdiscardspace
340 \expandafter\parseargline
344 % Remove a single space (as the delimiter token to the macro call).
346 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
349 \gdef\parseargline#1^^M{%
350 \endgroup % End of the group started in \parsearg.
352 % First remove any @c comment, then any @comment.
353 % Result of each macro is put in \toks0.
354 \argremovec #1\c\relax %
355 \expandafter\argremovecomment \the\toks0 \comment\relax %
357 % Call the caller's macro, saved as \next in \parsearg.
358 \expandafter\next\expandafter{\the\toks0}%
362 % Since all \c{,omment} does is throw away the argument, we can let TeX
363 % do that for us. The \relax here is matched by the \relax in the call
364 % in \parseargline; it could be more or less anything, its purpose is
365 % just to delimit the argument to the \c.
366 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
367 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
369 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
370 % @end itemize @c foo
371 % will have two active spaces as part of the argument with the
372 % `itemize'. Here we remove all active spaces from #1, and assign the
375 % This loses if there are any *other* active characters besides spaces
376 % in the argument -- _ ^ +, for example -- since they get expanded.
377 % Fortunately, Texinfo does not define any such commands. (If it ever
378 % does, the catcode of the characters in questionwill have to be changed
379 % here.) But this means we cannot call \removeactivespaces as part of
380 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
381 % that \parsearg gets might well have any character at all in it.
383 \def\removeactivespaces#1{%
387 \global\toks0 = \expandafter{\temp}%
391 % Change the active space to expand to nothing.
395 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
399 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
401 %% These are used to keep @begin/@end levels from running away
402 %% Call \inENV within environments (after a \begingroup)
403 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
405 \ifENV\errmessage{Still within an environment; press RETURN to continue}
406 \endgroup\fi} % This is not perfect, but it should reduce lossage
408 % @begin foo is the same as @foo, for now.
409 \newhelp\EMsimple{Press RETURN to continue.}
411 \outer\def\begin{\parsearg\beginxxx}
414 \expandafter\ifx\csname #1\endcsname\relax
415 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
416 \csname #1\endcsname\fi}
418 % @end foo executes the definition of \Efoo.
420 \def\end{\parsearg\endxxx}
422 \removeactivespaces{#1}%
423 \edef\endthing{\the\toks0}%
425 \expandafter\ifx\csname E\endthing\endcsname\relax
426 \expandafter\ifx\csname \endthing\endcsname\relax
427 % There's no \foo, i.e., no ``environment'' foo.
429 \errmessage{Undefined command `@end \endthing'}%
431 \unmatchedenderror\endthing
434 % Everything's ok; the right environment has been started.
435 \csname E\endthing\endcsname
439 % There is an environment #1, but it hasn't been started. Give an error.
441 \def\unmatchedenderror#1{%
443 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
446 % Define the control sequence \E#1 to give an unmatched @end error.
448 \def\defineunmatchedend#1{%
449 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
453 %% Simple single-character @ commands
456 % Kludge this until the fonts are right (grr).
459 % This is turned off because it was never documented
460 % and you can use @w{...} around a quote to suppress ligatures.
461 %% Define @` and @' to be the same as ` and '
462 %% but suppressing ligatures.
466 % Used to generate quoted braces.
467 \def\mylbrace {{\tt\char123}}
468 \def\myrbrace {{\tt\char125}}
472 % Definitions to produce actual \{ & \} command in an index.
473 \catcode`\{ = 12 \catcode`\} = 12
474 \catcode`\[ = 1 \catcode`\] = 2
475 \catcode`\@ = 0 \catcode`\\ = 12
480 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
481 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
484 \def\ringaccent#1{{\accent23 #1}}
489 % Other special characters: @questiondown @exclamdown
490 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
491 \def\questiondown{?`}
494 % Dotless i and dotless j, used for accents.
499 \ifx\temp\imacro \ptexi
500 \else\ifx\temp\jmacro \j
501 \else \errmessage{@dotless can be used only with i or j}%
505 % Be sure we're in horizontal mode when doing a tie, since we make space
506 % equivalent to this in @example-like environments. Otherwise, a space
507 % at the beginning of a line will start with \penalty -- and
508 % since \penalty is valid in vertical mode, we'd end up putting the
509 % penalty on the vertical list instead of in the new paragraph.
511 % Avoid using \@M directly, because that causes trouble
512 % if the definition is written into an index file.
513 \global\let\tiepenalty = \@M
514 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
517 % @: forces normal size whitespace following.
518 \def\:{\spacefactor=1000 }
520 % @* forces a line break.
521 \def\*{\hfil\break\hbox{}\ignorespaces}
523 % @. is an end-of-sentence period.
524 \def\.{.\spacefactor=3000 }
526 % @! is an end-of-sentence bang.
527 \def\!{!\spacefactor=3000 }
529 % @? is an end-of-sentence query.
530 \def\?{?\spacefactor=3000 }
532 % @w prevents a word break. Without the \leavevmode, @w at the
533 % beginning of a paragraph, when TeX is still in vertical mode, would
534 % produce a whole line of output instead of starting the paragraph.
535 \def\w#1{\leavevmode\hbox{#1}}
537 % @group ... @end group forces ... to be all on one page, by enclosing
538 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
539 % to keep its height that of a normal line. According to the rules for
540 % \topskip (p.114 of the TeXbook), the glue inserted is
541 % max (\topskip - \ht (first item), 0). If that height is large,
542 % therefore, no glue is inserted, and the space between the headline and
543 % the text is small, which looks bad.
545 \def\group{\begingroup
546 \ifnum\catcode13=\active \else
547 \errhelp = \groupinvalidhelp
548 \errmessage{@group invalid in context where filling is enabled}%
551 % The \vtop we start below produces a box with normal height and large
552 % depth; thus, TeX puts \baselineskip glue before it, and (when the
553 % next line of text is done) \lineskip glue after it. (See p.82 of
554 % the TeXbook.) Thus, space below is not quite equal to space
555 % above. But it's pretty close.
557 \egroup % End the \vtop.
558 \endgroup % End the \group.
562 % We have to put a strut on the last line in case the @group is in
563 % the midst of an example, rather than completely enclosing it.
564 % Otherwise, the interline space between the last line of the group
565 % and the first line afterwards is too small. But we can't put the
566 % strut in \Egroup, since there it would be on a line by itself.
567 % Hence this just inserts a strut at the beginning of each line.
568 \everypar = {\strut}%
570 % Since we have a strut on every line, we don't need any of TeX's
571 % normal interline spacing.
574 % OK, but now we have to do something about blank
575 % lines in the input in @example-like environments, which normally
576 % just turn into \lisppar, which will insert no space now that we've
577 % turned off the interline space. Simplest is to make them be an
580 \edef\par{\leavevmode \par}%
582 % Reset ^^M's definition to new definition of \par.
586 % Do @comment since we are called inside an environment such as
587 % @example, where each end-of-line in the input causes an
588 % end-of-line in the output. We don't want the end-of-line after
589 % the `@group' to put extra space in the output. Since @group
590 % should appear on a line by itself (according to the Texinfo
591 % manual), we don't worry about eating any user text.
595 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
596 % message, so this ends up printing `@group can only ...'.
598 \newhelp\groupinvalidhelp{%
599 group can only be used in environments such as @example,^^J%
600 where each line of input produces a line of output.}
602 % @need space-in-mils
603 % forces a page break if there is not space-in-mils remaining.
605 \newdimen\mil \mil=0.001in
607 \def\need{\parsearg\needx}
609 % Old definition--didn't work.
610 %\def\needx #1{\par %
611 %% This method tries to make TeX break the page naturally
612 %% if the depth of the box does not fit.
614 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
619 % Ensure vertical mode, so we don't make a big box in the middle of a
623 % If the @need value is less than one line space, it's useless.
625 \dimen2 = \ht\strutbox
626 \advance\dimen2 by \dp\strutbox
627 \ifdim\dimen0 > \dimen2
629 % Do a \strut just to make the height of this box be normal, so the
630 % normal leading is inserted relative to the preceding line.
631 % And a page break here is fine.
632 \vtop to #1\mil{\strut\vfil}%
634 % TeX does not even consider page breaks if a penalty added to the
635 % main vertical list is 10000 or more. But in order to see if the
636 % empty box we just added fits on the page, we must make it consider
637 % page breaks. On the other hand, we don't want to actually break the
638 % page after the empty box. So we use a penalty of 9999.
640 % There is an extremely small chance that TeX will actually break the
641 % page at this \penalty, if there are no other feasible breakpoints in
642 % sight. (If the user is using lots of big @group commands, which
643 % almost-but-not-quite fill up a page, TeX will have a hard time doing
644 % good page breaking, for example.) However, I could not construct an
645 % example where a page broke at this \penalty; if it happens in a real
646 % document, then we can reconsider our strategy.
649 % Back up by the size of the box, whether we did a page break or not.
652 % Do not allow a page break right after this kern.
657 % @br forces paragraph break
661 % @dots{} output an ellipsis using the current font.
662 % We do .5em per period so that it has the same spacing in a typewriter
663 % font as three actual period characters.
668 \hskip 0pt plus 0.25fil minus 0.25fil
670 \hskip 0pt plus 0.5fil minus 0.5fil
674 % @enddots{} is an end-of-sentence ellipsis.
679 \hskip 0pt plus 0.25fil minus 0.25fil
681 \hskip 0pt plus 0.5fil minus 0.5fil
687 % @page forces the start of a new page
689 \def\page{\par\vfill\supereject}
692 % outputs text on separate line in roman font, starting at standard page margin
694 % This records the amount of indent in the innermost environment.
695 % That's how much \exdent should take out.
696 \newskip\exdentamount
698 % This defn is used inside fill environments such as @defun.
699 \def\exdent{\parsearg\exdentyyy}
700 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
702 % This defn is used inside nofill environments such as @example.
703 \def\nofillexdent{\parsearg\nofillexdentyyy}
704 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
705 \leftline{\hskip\leftskip{\rm#1}}}}
707 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
708 % paragraph. For more general purposes, use the \margin insertion
709 % class. WHICH is `l' or `r'.
711 \newskip\inmarginspacing \inmarginspacing=1cm
712 \def\strutdepth{\dp\strutbox}
714 \def\doinmargin#1#2{\strut\vadjust{%
717 \vtop to \strutdepth{%
718 \baselineskip=\strutdepth
720 % if you have multiple lines of stuff to put here, you'll need to
721 % make the vbox yourself of the appropriate size.
723 \llap{\ignorespaces #2\hskip\inmarginspacing}%
725 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
730 \def\inleftmargin{\doinmargin l}
731 \def\inrightmargin{\doinmargin r}
733 % @inmargin{TEXT [, RIGHT-TEXT]}
734 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
735 % else use TEXT for both).
737 \def\inmargin#1{\parseinmargin #1,,\finish}
738 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
739 \setbox0 = \hbox{\ignorespaces #2}%
741 \def\lefttext{#1}% have both texts
744 \def\lefttext{#1}% have only one text
749 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
751 \def\temp{\inleftmargin\lefttext}%
756 % @include file insert text of that file as input.
757 % Allow normal characters that we make active in the argument (a file name).
758 \def\include{\begingroup
767 \parsearg\includezzz}
768 % Restore active chars for included file.
769 \def\includezzz#1{\endgroup\begingroup
770 % Read the included file in a group so nested @include's work.
777 % @center line outputs that line, centered
779 \def\center{\parsearg\centerzzz}
780 \def\centerzzz #1{{\advance\hsize by -\leftskip
781 \advance\hsize by -\rightskip
784 % @sp n outputs n lines of vertical space
786 \def\sp{\parsearg\spxxx}
787 \def\spxxx #1{\vskip #1\baselineskip}
789 % @comment ...line which is ignored...
790 % @c is the same as @comment
791 % @ignore ... @end ignore is another way to write a comment
793 \def\comment{\begingroup \catcode`\^^M=\other%
794 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
796 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
800 % @paragraphindent NCHARS
801 % We'll use ems for NCHARS, close enough.
802 % We cannot implement @paragraphindent asis, though.
804 \def\asisword{asis} % no translation, these are keywords
807 \def\paragraphindent{\parsearg\doparagraphindent}
808 \def\doparagraphindent#1{%
813 \defaultparindent = 0pt
815 \defaultparindent = #1em
818 \parindent = \defaultparindent
821 % @exampleindent NCHARS
822 % We'll use ems for NCHARS like @paragraphindent.
823 % It seems @exampleindent asis isn't necessary, but
824 % I preserve it to make it similar to @paragraphindent.
825 \def\exampleindent{\parsearg\doexampleindent}
826 \def\doexampleindent#1{%
833 \lispnarrowing = #1em
838 % @asis just yields its argument. Used with @table, for example.
842 % @math outputs its argument in math mode.
843 % We don't use $'s directly in the definition of \math because we need
844 % to set catcodes according to plain TeX first, to allow for subscripts,
845 % superscripts, special math chars, etc.
847 \let\implicitmath = $%$ font-lock fix
849 % One complication: _ usually means subscripts, but it could also mean
850 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
851 % _ within @math be active (mathcode "8000), and distinguish by seeing
852 % if the current family is \slfam, which is what @var uses.
854 {\catcode95 = \active % 95 = _
855 \gdef\mathunderscore{%
857 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
860 % Another complication: we want \\ (and @\) to output a \ character.
861 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
862 % this is not advertised and we don't care. Texinfo does not
863 % otherwise define @\.
865 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
866 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
870 \mathcode`\_="8000 \mathunderscore
871 \let\\ = \mathbackslash
873 \implicitmath\finishmath}
874 \def\finishmath#1{#1\implicitmath\Etex}
876 % Some active characters (such as <) are spaced differently in math.
877 % We have to reset their definitions in case the @math was an
878 % argument to a command which set the catcodes (such as @item or @section).
893 % @bullet and @minus need the same treatment as @math, just above.
894 \def\bullet{\implicitmath\ptexbullet\implicitmath}
895 \def\minus{\implicitmath-\implicitmath}
897 % @refill is a no-op.
900 % If working on a large document in chapters, it is convenient to
901 % be able to disable indexing, cross-referencing, and contents, for test runs.
902 % This is done with @novalidate (before @setfilename).
904 \newif\iflinks \linkstrue % by default we want the aux files.
905 \let\novalidate = \linksfalse
907 % @setfilename is done at the beginning of every texinfo file.
908 % So open here the files we need to have open while reading the input.
909 % This makes it possible to make a .fmt file for texinfo.
913 \fi % \openindices needs to do some work in any case.
915 \fixbackslash % Turn off hack to swallow `\input texinfo'.
916 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
918 % If texinfo.cnf is present on the system, read it.
919 % Useful for site-wide @afourpaper, etc.
920 % Just to be on the safe side, close the input stream before the \input.
921 \openin 1 texinfo.cnf
922 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
926 \comment % Ignore the actual filename.
929 % Called from \setfilename.
941 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
945 % adobe `portable' document format
949 \newcount\filenamelength
958 \newif\ifpdfmakepagedest
960 \ifx\pdfoutput\undefined
962 \let\pdfmkdest = \gobble
963 \let\pdfurl = \gobble
964 \let\endlink = \relax
965 \let\linkcolor = \relax
966 \let\pdfmakeoutlines = \relax
971 \def\dopdfimage#1#2#3{%
973 \def\imageheight{#3}%
974 % without \immediate, pdftex seg faults when the same image is
975 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
976 \ifnum\pdftexversion < 14
981 \ifx\empty\imagewidth\else width \imagewidth \fi
982 \ifx\empty\imageheight\else height \imageheight \fi
983 \ifnum\pdftexversion<13
988 \ifnum\pdftexversion < 14 \else
989 \pdfrefximage \pdflastximage
991 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
993 \let\linkcolor = \Blue % was Cyan, but that seems light?
994 \def\endlink{\Black\pdfendlink}
995 % Adding outlines to PDF; macros for calculating structure of outlines
996 % come from Petr Olsak
997 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
998 \else \csname#1\endcsname \fi}
999 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1000 \advance\tempnum by1
1001 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1002 \def\pdfmakeoutlines{{%
1003 \openin 1 \jobname.toc
1004 \ifeof 1\else\begingroup
1006 % Thanh's hack / proper braces in bookmarks
1007 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1008 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1010 \def\chapentry ##1##2##3{}
1011 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
1012 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
1013 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
1014 \let\appendixentry = \chapentry
1015 \let\unnumbchapentry = \chapentry
1016 \let\unnumbsecentry = \secentry
1017 \let\unnumbsubsecentry = \subsecentry
1018 \let\unnumbsubsubsecentry = \subsubsecentry
1020 \def\chapentry ##1##2##3{%
1021 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1022 \def\secentry ##1##2##3##4{%
1023 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1024 \def\subsecentry ##1##2##3##4##5{%
1025 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1026 \def\subsubsecentry ##1##2##3##4##5##6{%
1027 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1028 \let\appendixentry = \chapentry
1029 \let\unnumbchapentry = \chapentry
1030 \let\unnumbsecentry = \secentry
1031 \let\unnumbsubsecentry = \subsecentry
1032 \let\unnumbsubsubsecentry = \subsubsecentry
1034 % Make special characters normal for writing to the pdf file.
1042 \def\makelinks #1,{%
1043 \def\params{#1}\def\E{END}%
1045 \let\nextmakelinks=\relax
1047 \let\nextmakelinks=\makelinks
1048 \ifnum\lnkcount>0,\fi
1050 \startlink attr{/Border [0 0 0]}
1051 goto name{\pdfmkpgn{\the\pgn}}%
1053 \advance\lnkcount by 1%
1058 \def\picknum#1{\expandafter\pn#1}
1069 \def\ppn#1{\pgn=#1\gobble}
1070 \def\ppnn{\pgn=\first}
1071 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1072 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1073 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1074 \ifx\PP\D\let\nextsp\relax
1075 \else\let\nextsp\skipspaces
1076 \ifx\p\space\else\addtokens{\filename}{\PP}%
1077 \advance\filenamelength by 1
1081 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1082 \ifnum\pdftexversion < 14
1083 \let \startlink \pdfannotlink
1085 \let \startlink \pdfstartlink
1089 \normalturnoffactive\def\@{@}%
1090 \let\value=\expandablevalue
1092 \startlink attr{/Border [0 0 0]}%
1093 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1096 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1097 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1098 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1099 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1101 \expandafter\poptoks\the\toksA|ENDTOKS|
1103 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1104 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1105 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1107 \ifnum0=\countA\else\makelink\fi
1108 \ifx\first.\let\next=\done\else
1110 \addtokens{\toksB}{\the\toksD}
1111 \ifx\first,\addtokens{\toksB}{\space}\fi
1113 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1115 \def\makelink{\addtokens{\toksB}%
1116 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1118 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1119 \linkcolor #1\endlink}
1120 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1121 \fi % \ifx\pdfoutput
1125 % Font-change commands.
1127 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1128 % So we set up a \sf analogous to plain's \rm, etc.
1130 \def\sf{\fam=\sffam \tensf}
1131 \let\li = \sf % Sometimes we call it \li, not \sf.
1133 % We don't need math for this one.
1137 \newdimen\textleading \textleading = 13.2pt
1139 % Set the baselineskip to #1, and the lineskip and strut size
1140 % correspondingly. There is no deep meaning behind these magic numbers
1141 % used as factors; they just match (closely enough) what Knuth defined.
1143 \def\lineskipfactor{.08333}
1144 \def\strutheightpercent{.70833}
1145 \def\strutdepthpercent {.29167}
1148 \normalbaselineskip = #1\relax
1149 \normallineskip = \lineskipfactor\normalbaselineskip
1151 \setbox\strutbox =\hbox{%
1152 \vrule width0pt height\strutheightpercent\baselineskip
1153 depth \strutdepthpercent \baselineskip
1157 % Set the font macro #1 to the font named #2, adding on the
1158 % specified font prefix (normally `cm').
1159 % #3 is the font's design size, #4 is a scale factor
1160 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1162 % Use cm as the default font prefix.
1163 % To specify the font prefix, you must define \fontprefix
1164 % before you read in texinfo.tex.
1165 \ifx\fontprefix\undefined
1168 % Support font families that don't use the same naming scheme as CM.
1170 \def\rmbshape{bx} %where the normal face is bold
1175 \def\ttslshape{sltt}
1185 \newcount\mainmagstep
1187 % not really supported.
1188 \mainmagstep=\magstep1
1189 \setfont\textrm\rmshape{12}{1000}
1190 \setfont\texttt\ttshape{12}{1000}
1192 \mainmagstep=\magstephalf
1193 \setfont\textrm\rmshape{10}{\mainmagstep}
1194 \setfont\texttt\ttshape{10}{\mainmagstep}
1196 % Instead of cmb10, you many want to use cmbx10.
1197 % cmbx10 is a prettier font on its own, but cmb10
1198 % looks better when embedded in a line with cmr10.
1199 \setfont\textbf\bfshape{10}{\mainmagstep}
1200 \setfont\textit\itshape{10}{\mainmagstep}
1201 \setfont\textsl\slshape{10}{\mainmagstep}
1202 \setfont\textsf\sfshape{10}{\mainmagstep}
1203 \setfont\textsc\scshape{10}{\mainmagstep}
1204 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1205 \font\texti=cmmi10 scaled \mainmagstep
1206 \font\textsy=cmsy10 scaled \mainmagstep
1208 % A few fonts for @defun, etc.
1209 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1210 \setfont\deftt\ttshape{10}{\magstep1}
1211 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1213 % Fonts for indices, footnotes, small examples (9pt).
1214 \setfont\smallrm\rmshape{9}{1000}
1215 \setfont\smalltt\ttshape{9}{1000}
1216 \setfont\smallbf\bfshape{10}{900}
1217 \setfont\smallit\itshape{9}{1000}
1218 \setfont\smallsl\slshape{9}{1000}
1219 \setfont\smallsf\sfshape{9}{1000}
1220 \setfont\smallsc\scshape{10}{900}
1221 \setfont\smallttsl\ttslshape{10}{900}
1225 % Fonts for small examples (8pt).
1226 \setfont\smallerrm\rmshape{8}{1000}
1227 \setfont\smallertt\ttshape{8}{1000}
1228 \setfont\smallerbf\bfshape{10}{800}
1229 \setfont\smallerit\itshape{8}{1000}
1230 \setfont\smallersl\slshape{8}{1000}
1231 \setfont\smallersf\sfshape{8}{1000}
1232 \setfont\smallersc\scshape{10}{800}
1233 \setfont\smallerttsl\ttslshape{10}{800}
1234 \font\smalleri=cmmi8
1235 \font\smallersy=cmsy8
1237 % Fonts for title page:
1238 \setfont\titlerm\rmbshape{12}{\magstep3}
1239 \setfont\titleit\itbshape{10}{\magstep4}
1240 \setfont\titlesl\slbshape{10}{\magstep4}
1241 \setfont\titlett\ttbshape{12}{\magstep3}
1242 \setfont\titlettsl\ttslshape{10}{\magstep4}
1243 \setfont\titlesf\sfbshape{17}{\magstep1}
1244 \let\titlebf=\titlerm
1245 \setfont\titlesc\scbshape{10}{\magstep4}
1246 \font\titlei=cmmi12 scaled \magstep3
1247 \font\titlesy=cmsy10 scaled \magstep4
1248 \def\authorrm{\secrm}
1249 \def\authortt{\sectt}
1251 % Chapter (and unnumbered) fonts (17.28pt).
1252 \setfont\chaprm\rmbshape{12}{\magstep2}
1253 \setfont\chapit\itbshape{10}{\magstep3}
1254 \setfont\chapsl\slbshape{10}{\magstep3}
1255 \setfont\chaptt\ttbshape{12}{\magstep2}
1256 \setfont\chapttsl\ttslshape{10}{\magstep3}
1257 \setfont\chapsf\sfbshape{17}{1000}
1259 \setfont\chapsc\scbshape{10}{\magstep3}
1260 \font\chapi=cmmi12 scaled \magstep2
1261 \font\chapsy=cmsy10 scaled \magstep3
1263 % Section fonts (14.4pt).
1264 \setfont\secrm\rmbshape{12}{\magstep1}
1265 \setfont\secit\itbshape{10}{\magstep2}
1266 \setfont\secsl\slbshape{10}{\magstep2}
1267 \setfont\sectt\ttbshape{12}{\magstep1}
1268 \setfont\secttsl\ttslshape{10}{\magstep2}
1269 \setfont\secsf\sfbshape{12}{\magstep1}
1271 \setfont\secsc\scbshape{10}{\magstep2}
1272 \font\seci=cmmi12 scaled \magstep1
1273 \font\secsy=cmsy10 scaled \magstep2
1275 % Subsection fonts (13.15pt).
1276 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1277 \setfont\ssecit\itbshape{10}{1315}
1278 \setfont\ssecsl\slbshape{10}{1315}
1279 \setfont\ssectt\ttbshape{12}{\magstephalf}
1280 \setfont\ssecttsl\ttslshape{10}{1315}
1281 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1283 \setfont\ssecsc\scbshape{10}{\magstep1}
1284 \font\sseci=cmmi12 scaled \magstephalf
1285 \font\ssecsy=cmsy10 scaled 1315
1286 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1287 % but that is not a standard magnification.
1289 % In order for the font changes to affect most math symbols and letters,
1290 % we have to define the \textfont of the standard families. Since
1291 % texinfo doesn't allow for producing subscripts and superscripts except
1292 % in the main text, we don't bother to reset \scriptfont and
1293 % \scriptscriptfont (which would also require loading a lot more fonts).
1295 \def\resetmathfonts{%
1296 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1297 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1298 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1301 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1302 % of just \STYLE. We do this so that font changes will continue to work
1303 % in math mode, where it is the current \fam that is relevant in most
1304 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1305 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1306 % redefine \bf itself.
1308 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1309 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1310 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1311 \resetmathfonts \setleading{\textleading}}
1313 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1314 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1315 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1316 \let\tenttsl=\titlettsl
1317 \resetmathfonts \setleading{25pt}}
1318 \def\titlefont#1{{\titlefonts\rm #1}}
1320 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1321 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1322 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1323 \resetmathfonts \setleading{19pt}}
1325 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1326 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1327 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1328 \resetmathfonts \setleading{16pt}}
1330 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1331 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1332 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1333 \resetmathfonts \setleading{15pt}}
1334 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1336 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1337 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1338 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1339 \let\tenttsl=\smallttsl
1340 \resetmathfonts \setleading{10.5pt}}
1342 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1343 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1344 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1345 \let\tenttsl=\smallerttsl
1346 \resetmathfonts \setleading{9.5pt}}
1347 \let\smallexamplefonts = \smallerfonts
1349 % Set up the default fonts, so we can use them for creating boxes.
1353 % Define these so they can be easily changed for other fonts.
1354 \def\angleleft{$\langle$}
1355 \def\angleright{$\rangle$}
1357 % Count depth in font-changes, for error checks
1358 \newcount\fontdepth \fontdepth=0
1360 % Fonts for short table of contents.
1361 \setfont\shortcontrm\rmshape{12}{1000}
1362 \setfont\shortcontbf\bxshape{12}{1000}
1363 \setfont\shortcontsl\slshape{12}{1000}
1364 \setfont\shortconttt\ttshape{12}{1000}
1366 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1367 %% serif) and @ii for TeX italic
1369 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1370 % unless the following character is such as not to need one.
1371 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1372 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1373 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1376 \let\var=\smartslanted
1377 \let\dfn=\smartslanted
1378 \let\emph=\smartitalic
1379 \let\cite=\smartslanted
1384 % We can't just use \exhyphenpenalty, because that only has effect at
1385 % the end of a paragraph. Restore normal hyphenation at the end of the
1386 % group within which \nohyphenation is presumably called.
1388 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1389 \def\restorehyphenation{\hyphenchar\font = `- }
1392 {\tt \rawbackslash \frenchspacing #1}%
1396 \def\samp#1{`\tclose{#1}'\null}
1397 \setfont\keyrm\rmshape{8}{1000}
1399 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1400 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1401 \vbox{\hrule\kern-0.4pt
1402 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1404 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1405 % The old definition, with no lozenge:
1406 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1407 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1409 % @file, @option are the same as @samp.
1413 % @code is a modification of @t,
1414 % which makes spaces the same size as normal in the surrounding text.
1417 % Change normal interword space to be same as for the current font.
1418 \spaceskip = \fontdimen2\font
1420 % Switch to typewriter.
1423 % But `\ ' produces the large typewriter interword space.
1424 \def\ {{\spaceskip = 0pt{} }}%
1426 % Turn off hyphenation.
1436 % We *must* turn on hyphenation at `-' and `_' in \code.
1437 % Otherwise, it is too hard to avoid overfull hboxes
1438 % in the Emacs manual, the Library manual, etc.
1440 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1441 % both hyphenation at - and hyphenation within words.
1442 % We must therefore turn them both off (\tclose does that)
1443 % and arrange explicitly to hyphenate at a dash.
1449 \global\def\code{\begingroup
1450 \catcode`\-=\active \let-\codedash
1451 \catcode`\_=\active \let_\codeunder
1455 % If we end up with any active - characters when handling the index,
1456 % just treat them as a normal -.
1457 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1461 \def\codedash{-\discretionary{}{}{}}
1463 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1464 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1465 % will therefore expand the active definition of _, which is us
1466 % (inside @code that is), therefore an endless loop.
1468 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1469 \else\normalunderscore \fi
1470 \discretionary{}{}{}}%
1473 \def\codex #1{\tclose{#1}\endgroup}
1475 % @kbd is like @code, except that if the argument is just one @key command,
1476 % then @kbd has no effect.
1478 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1479 % `example' (@kbd uses ttsl only inside of @example and friends),
1480 % or `code' (@kbd uses normal tty font always).
1481 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1482 \def\kbdinputstylexxx#1{%
1484 \ifx\arg\worddistinct
1485 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1486 \else\ifx\arg\wordexample
1487 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1488 \else\ifx\arg\wordcode
1489 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1492 \def\worddistinct{distinct}
1493 \def\wordexample{example}
1496 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1497 % the catcodes are wrong for parsearg to work.)
1498 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1501 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1502 \ifx\one\xkey\ifx\threex\three \key{#2}%
1503 \else{\tclose{\kbdfont\look}}\fi
1504 \else{\tclose{\kbdfont\look}}\fi}
1506 % For @url, @env, @command quotes seem unnecessary, so use \code.
1511 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1512 % second argument specifying the text to display and an optional third
1513 % arg as text to display instead of (rather than in addition to) the url
1514 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1515 % a hypertex \special here.
1517 \def\uref#1{\douref #1,,,\finish}
1518 \def\douref#1,#2,#3,#4\finish{\begingroup
1521 \setbox0 = \hbox{\ignorespaces #3}%
1523 \unhbox0 % third arg given, show only that
1525 \setbox0 = \hbox{\ignorespaces #2}%
1528 \unhbox0 % PDF: 2nd arg given, show only it
1530 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1533 \code{#1}% only url given, so show it
1539 % rms does not like angle brackets --karl, 17may97.
1540 % So now @email is just like @uref, unless we are pdf.
1542 %\def\email#1{\angleleft{\tt #1}\angleright}
1544 \def\email#1{\doemail#1,,\finish}
1545 \def\doemail#1,#2,#3\finish{\begingroup
1548 \setbox0 = \hbox{\ignorespaces #2}%
1549 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1556 % Check if we are currently using a typewriter font. Since all the
1557 % Computer Modern typewriter fonts have zero interword stretch (and
1558 % shrink), and it is reasonable to expect all typewriter fonts to have
1559 % this property, we can check that font parameter.
1561 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1563 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1564 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1566 \def\dmn#1{\thinspace #1}
1568 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1570 % @l was never documented to mean ``switch to the Lisp font'',
1571 % and it is not used as such in any manual I can find. We need it for
1572 % Polish suppressed-l. --karl, 22sep96.
1573 %\def\l#1{{\li #1}\null}
1575 % Explicit font changes: @r, @sc, undocumented @ii.
1576 \def\r#1{{\rm #1}} % roman font
1577 \def\sc#1{{\smallcaps#1}} % smallcaps font
1578 \def\ii#1{{\it #1}} % italic font
1580 % @acronym downcases the argument and prints in smallcaps.
1581 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1583 % @pounds{} is a sterling sign.
1584 \def\pounds{{\it\$}}
1587 \message{page headings,}
1589 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1590 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1592 % First the title page. Must do @settitle before @titlepage.
1594 \newif\iffinishedtitlepage
1596 % Do an implicit @contents or @shortcontents after @end titlepage if the
1597 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1599 \newif\ifsetcontentsaftertitlepage
1600 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1601 \newif\ifsetshortcontentsaftertitlepage
1602 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1604 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1605 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1606 \endgroup\page\hbox{}\page}
1608 \def\titlepage{\begingroup \parindent=0pt \textfonts
1609 \let\subtitlerm=\tenrm
1610 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1612 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
1615 % Leave some space at the very top of the page.
1616 \vglue\titlepagetopglue
1618 % Now you can print the title using @title.
1619 \def\title{\parsearg\titlezzz}%
1620 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1621 % print a rule at the page bottom also.
1622 \finishedtitlepagefalse
1623 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1624 % No rule at page bottom unless we print one at the top with @title.
1625 \finishedtitlepagetrue
1627 % Now you can put text using @subtitle.
1628 \def\subtitle{\parsearg\subtitlezzz}%
1629 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1631 % @author should come last, but may come many times.
1632 \def\author{\parsearg\authorzzz}%
1633 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1634 {\authorfont \leftline{##1}}}%
1636 % Most title ``pages'' are actually two pages long, with space
1637 % at the top of the second. We don't want the ragged left on the second.
1638 \let\oldpage = \page
1640 \iffinishedtitlepage\else
1644 \let\page = \oldpage
1646 % \def\page{\oldpage \hbox{}}
1650 \iffinishedtitlepage\else
1653 % It is important to do the page break before ending the group,
1654 % because the headline and footline are only empty inside the group.
1655 % If we use the new definition of \page, we always get a blank page
1656 % after the title page, which we certainly don't want.
1660 % Need this before the \...aftertitlepage checks so that if they are
1661 % in effect the toc pages will come out with page numbers.
1664 % If they want short, they certainly want long too.
1665 \ifsetshortcontentsaftertitlepage
1668 \global\let\shortcontents = \relax
1669 \global\let\contents = \relax
1672 \ifsetcontentsaftertitlepage
1674 \global\let\contents = \relax
1675 \global\let\shortcontents = \relax
1679 \def\finishtitlepage{%
1680 \vskip4pt \hrule height 2pt width \hsize
1681 \vskip\titlepagebottomglue
1682 \finishedtitlepagetrue
1685 %%% Set up page headings and footings.
1687 \let\thispage=\folio
1689 \newtoks\evenheadline % headline on even pages
1690 \newtoks\oddheadline % headline on odd pages
1691 \newtoks\evenfootline % footline on even pages
1692 \newtoks\oddfootline % footline on odd pages
1694 % Now make Tex use those variables
1695 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1696 \else \the\evenheadline \fi}}
1697 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1698 \else \the\evenfootline \fi}\HEADINGShook}
1699 \let\HEADINGShook=\relax
1701 % Commands to set those variables.
1702 % For example, this is what @headings on does
1703 % @evenheading @thistitle|@thispage|@thischapter
1704 % @oddheading @thischapter|@thispage|@thistitle
1705 % @evenfooting @thisfile||
1706 % @oddfooting ||@thisfile
1708 \def\evenheading{\parsearg\evenheadingxxx}
1709 \def\oddheading{\parsearg\oddheadingxxx}
1710 \def\everyheading{\parsearg\everyheadingxxx}
1712 \def\evenfooting{\parsearg\evenfootingxxx}
1713 \def\oddfooting{\parsearg\oddfootingxxx}
1714 \def\everyfooting{\parsearg\everyfootingxxx}
1718 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1719 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1720 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1722 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1723 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1724 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1726 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1728 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1729 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1730 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1732 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1733 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1734 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1736 % Leave some space for the footline. Hopefully ok to assume
1737 % @evenfooting will not be used by itself.
1738 \global\advance\pageheight by -\baselineskip
1739 \global\advance\vsize by -\baselineskip
1742 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1744 }% unbind the catcode of @.
1746 % @headings double turns headings on for double-sided printing.
1747 % @headings single turns headings on for single-sided printing.
1748 % @headings off turns them off.
1749 % @headings on same as @headings double, retained for compatibility.
1750 % @headings after turns on double-sided headings after this page.
1751 % @headings doubleafter turns on double-sided headings after this page.
1752 % @headings singleafter turns on single-sided headings after this page.
1753 % By default, they are off at the start of a document,
1754 % and turned `on' after @end titlepage.
1756 \def\headings #1 {\csname HEADINGS#1\endcsname}
1759 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1760 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1762 % When we turn headings on, set the page number to 1.
1763 % For double-sided printing, put current file name in lower left corner,
1764 % chapter name on inside top of right hand pages, document
1765 % title on inside top of left hand pages, and page numbers on outside top
1766 % edge of all pages.
1767 \def\HEADINGSdouble{
1769 \global\evenfootline={\hfil}
1770 \global\oddfootline={\hfil}
1771 \global\evenheadline={\line{\folio\hfil\thistitle}}
1772 \global\oddheadline={\line{\thischapter\hfil\folio}}
1773 \global\let\contentsalignmacro = \chapoddpage
1775 \let\contentsalignmacro = \chappager
1777 % For single-sided printing, chapter title goes across top left of page,
1778 % page number on top right.
1779 \def\HEADINGSsingle{
1781 \global\evenfootline={\hfil}
1782 \global\oddfootline={\hfil}
1783 \global\evenheadline={\line{\thischapter\hfil\folio}}
1784 \global\oddheadline={\line{\thischapter\hfil\folio}}
1785 \global\let\contentsalignmacro = \chappager
1787 \def\HEADINGSon{\HEADINGSdouble}
1789 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1790 \let\HEADINGSdoubleafter=\HEADINGSafter
1791 \def\HEADINGSdoublex{%
1792 \global\evenfootline={\hfil}
1793 \global\oddfootline={\hfil}
1794 \global\evenheadline={\line{\folio\hfil\thistitle}}
1795 \global\oddheadline={\line{\thischapter\hfil\folio}}
1796 \global\let\contentsalignmacro = \chapoddpage
1799 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1800 \def\HEADINGSsinglex{%
1801 \global\evenfootline={\hfil}
1802 \global\oddfootline={\hfil}
1803 \global\evenheadline={\line{\thischapter\hfil\folio}}
1804 \global\oddheadline={\line{\thischapter\hfil\folio}}
1805 \global\let\contentsalignmacro = \chappager
1808 % Subroutines used in generating headings
1809 % This produces Day Month Year style of output.
1810 % Only define if not already defined, in case a txi-??.tex file has set
1811 % up a different format (e.g., txi-cs.tex does this).
1812 \ifx\today\undefined
1816 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1817 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1818 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1823 % @settitle line... specifies the title of the document, for headings.
1824 % It generates no output of its own.
1825 \def\thistitle{\putwordNoTitle}
1826 \def\settitle{\parsearg\settitlezzz}
1827 \def\settitlezzz #1{\gdef\thistitle{#1}}
1831 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1833 % default indentation of table text
1834 \newdimen\tableindent \tableindent=.8in
1835 % default indentation of @itemize and @enumerate text
1836 \newdimen\itemindent \itemindent=.3in
1837 % margin between end of table item and start of table text.
1838 \newdimen\itemmargin \itemmargin=.1in
1840 % used internally for \itemindent minus \itemmargin
1843 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1845 % They also define \itemindex
1846 % to index the item name in whatever manner is desired (perhaps none).
1848 \newif\ifitemxneedsnegativevskip
1850 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1852 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1853 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1855 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1856 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1858 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1859 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1861 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1864 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1867 \def\itemzzz #1{\begingroup %
1868 \advance\hsize by -\rightskip
1869 \advance\hsize by -\tableindent
1870 \setbox0=\hbox{\itemfont{#1}}%
1872 \nobreak % This prevents a break before @itemx.
1874 % If the item text does not fit in the space we have, put it on a line
1875 % by itself, and do not allow a page break either before or after that
1876 % line. We do not start a paragraph here because then if the next
1877 % command is, e.g., @kindex, the whatsit would get put into the
1878 % horizontal list on a line by itself, resulting in extra blank space.
1879 \ifdim \wd0>\itemmax
1881 % Make this a paragraph so we get the \parskip glue and wrapping,
1882 % but leave it ragged-right.
1884 \advance\leftskip by-\tableindent
1885 \advance\hsize by\tableindent
1886 \advance\rightskip by0pt plus1fil
1887 \leavevmode\unhbox0\par
1890 % We're going to be starting a paragraph, but we don't want the
1891 % \parskip glue -- logically it's part of the @item we just started.
1892 \nobreak \vskip-\parskip
1894 % Stop a page break at the \parskip glue coming up. (Unfortunately
1895 % we can't prevent a possible page break at the following
1896 % \baselineskip glue.) However, if what follows is an environment
1897 % such as @example, there will be no \parskip glue; then
1898 % the negative vskip we just would cause the example and the item to
1899 % crash together. So we use this bizarre value of 10001 as a signal
1900 % to \aboveenvbreak to insert \parskip glue after all.
1901 % (Possibly there are other commands that could be followed by
1902 % @example which need the same treatment, but not section titles; or
1903 % maybe section titles are the only special case and they should be
1907 \itemxneedsnegativevskipfalse
1909 % The item text fits into the space. Start a paragraph, so that the
1910 % following text (if any) will end up on the same line.
1912 % Do this with kerns and \unhbox so that if there is a footnote in
1913 % the item text, it can migrate to the main vertical list and
1914 % eventually be printed.
1915 \nobreak\kern-\tableindent
1916 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1918 \nobreak\kern\dimen0
1920 \itemxneedsnegativevskiptrue
1924 \def\item{\errmessage{@item while not in a table}}
1925 \def\itemx{\errmessage{@itemx while not in a table}}
1926 \def\kitem{\errmessage{@kitem while not in a table}}
1927 \def\kitemx{\errmessage{@kitemx while not in a table}}
1928 \def\xitem{\errmessage{@xitem while not in a table}}
1929 \def\xitemx{\errmessage{@xitemx while not in a table}}
1931 % Contains a kludge to get @end[description] to work.
1932 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1934 % @table, @ftable, @vtable.
1935 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1936 {\obeylines\obeyspaces%
1937 \gdef\tablex #1^^M{%
1938 \tabley\dontindex#1 \endtabley}}
1940 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1941 {\obeylines\obeyspaces%
1942 \gdef\ftablex #1^^M{%
1943 \tabley\fnitemindex#1 \endtabley
1944 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1945 \let\Etable=\relax}}
1947 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1948 {\obeylines\obeyspaces%
1949 \gdef\vtablex #1^^M{%
1950 \tabley\vritemindex#1 \endtabley
1951 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1952 \let\Etable=\relax}}
1955 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1956 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1959 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1960 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1962 \def\tablez #1#2#3#4#5#6{%
1965 \def\Edescription{\Etable}% Necessary kludge.
1967 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1968 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1969 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1971 \itemmax=\tableindent %
1972 \advance \itemmax by -\itemmargin %
1973 \advance \leftskip by \tableindent %
1974 \exdentamount=\tableindent
1976 \parskip = \smallskipamount
1977 \ifdim \parskip=0pt \parskip=2pt \fi%
1978 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1979 \let\item = \internalBitem %
1980 \let\itemx = \internalBitemx %
1981 \let\kitem = \internalBkitem %
1982 \let\kitemx = \internalBkitemx %
1983 \let\xitem = \internalBxitem %
1984 \let\xitemx = \internalBxitemx %
1987 % This is the counter used by @enumerate, which is really @itemize
1991 \def\itemize{\parsearg\itemizezzz}
1993 \def\itemizezzz #1{%
1994 \begingroup % ended by the @end itemize
1995 \itemizey {#1}{\Eitemize}
1998 \def\itemizey #1#2{%
2000 \itemmax=\itemindent %
2001 \advance \itemmax by -\itemmargin %
2002 \advance \leftskip by \itemindent %
2003 \exdentamount=\itemindent
2005 \parskip = \smallskipamount %
2006 \ifdim \parskip=0pt \parskip=2pt \fi%
2007 \def#2{\endgraf\afterenvbreak\endgroup}%
2008 \def\itemcontents{#1}%
2009 \let\item=\itemizeitem}
2011 % Set sfcode to normal for the chars that usually have another value.
2012 % These are `.?!:;,'
2013 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
2014 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
2016 % \splitoff TOKENS\endmark defines \first to be the first token in
2017 % TOKENS, and \rest to be the remainder.
2019 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2021 % Allow an optional argument of an uppercase letter, lowercase letter,
2022 % or number, to specify the first label in the enumerated list. No
2023 % argument is the same as `1'.
2025 \def\enumerate{\parsearg\enumeratezzz}
2026 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2027 \def\enumeratey #1 #2\endenumeratey{%
2028 \begingroup % ended by the @end enumerate
2030 % If we were given no argument, pretend we were given `1'.
2032 \ifx\thearg\empty \def\thearg{1}\fi
2034 % Detect if the argument is a single token. If so, it might be a
2035 % letter. Otherwise, the only valid thing it can be is a number.
2036 % (We will always have one token, because of the test we just made.
2037 % This is a good thing, since \splitoff doesn't work given nothing at
2038 % all -- the first parameter is undelimited.)
2039 \expandafter\splitoff\thearg\endmark
2041 % Only one token in the argument. It could still be anything.
2042 % A ``lowercase letter'' is one whose \lccode is nonzero.
2043 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2044 % not equal to itself.
2045 % Otherwise, we assume it's a number.
2047 % We need the \relax at the end of the \ifnum lines to stop TeX from
2048 % continuing to look for a <number>.
2050 \ifnum\lccode\expandafter`\thearg=0\relax
2051 \numericenumerate % a number (we hope)
2054 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2055 \lowercaseenumerate % lowercase letter
2057 \uppercaseenumerate % uppercase letter
2061 % Multiple tokens in the argument. We hope it's a number.
2066 % An @enumerate whose labels are integers. The starting integer is
2069 \def\numericenumerate{%
2071 \startenumeration{\the\itemno}%
2074 % The starting (lowercase) letter is in \thearg.
2075 \def\lowercaseenumerate{%
2076 \itemno = \expandafter`\thearg
2078 % Be sure we're not beyond the end of the alphabet.
2080 \errmessage{No more lowercase letters in @enumerate; get a bigger
2087 % The starting (uppercase) letter is in \thearg.
2088 \def\uppercaseenumerate{%
2089 \itemno = \expandafter`\thearg
2091 % Be sure we're not beyond the end of the alphabet.
2093 \errmessage{No more uppercase letters in @enumerate; get a bigger
2100 % Call itemizey, adding a period to the first argument and supplying the
2101 % common last two arguments. Also subtract one from the initial value in
2102 % \itemno, since @item increments \itemno.
2104 \def\startenumeration#1{%
2105 \advance\itemno by -1
2106 \itemizey{#1.}\Eenumerate\flushcr
2109 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2112 \def\alphaenumerate{\enumerate{a}}
2113 \def\capsenumerate{\enumerate{A}}
2114 \def\Ealphaenumerate{\Eenumerate}
2115 \def\Ecapsenumerate{\Eenumerate}
2117 % Definition of @item while inside @itemize.
2120 \advance\itemno by 1
2121 {\let\par=\endgraf \smallbreak}%
2122 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2123 {\parskip=0in \hskip 0pt
2124 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2125 \vadjust{\penalty 1200}}%
2128 % @multitable macros
2129 % Amy Hendrickson, 8/18/94, 3/6/96
2131 % @multitable ... @end multitable will make as many columns as desired.
2132 % Contents of each column will wrap at width given in preamble. Width
2133 % can be specified either with sample text given in a template line,
2134 % or in percent of \hsize, the current width of text on page.
2136 % Table can continue over pages but will only break between lines.
2140 % Either define widths of columns in terms of percent of \hsize:
2141 % @multitable @columnfractions .25 .3 .45
2144 % Numbers following @columnfractions are the percent of the total
2145 % current hsize to be used for each column. You may use as many
2146 % columns as desired.
2149 % Or use a template:
2150 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2152 % using the widest term desired in each column.
2154 % For those who want to use more than one line's worth of words in
2155 % the preamble, break the line within one argument and it
2156 % will parse correctly, i.e.,
2158 % @multitable {Column 1 template} {Column 2 template} {Column 3
2161 % @multitable {Column 1 template} {Column 2 template}
2162 % {Column 3 template}
2164 % Each new table line starts with @item, each subsequent new column
2165 % starts with @tab. Empty columns may be produced by supplying @tab's
2166 % with nothing between them for as many times as empty columns are needed,
2167 % ie, @tab@tab@tab will produce two empty columns.
2169 % @item, @tab, @multitable or @end multitable do not need to be on their
2170 % own lines, but it will not hurt if they are.
2172 % Sample multitable:
2174 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2175 % @item first col stuff @tab second col stuff @tab third col
2182 % @item first col stuff @tab second col stuff
2183 % @tab Many paragraphs of text may be used in any column.
2185 % They will wrap at the width determined by the template.
2186 % @item@tab@tab This will be in third column.
2189 % Default dimensions may be reset by user.
2190 % @multitableparskip is vertical space between paragraphs in table.
2191 % @multitableparindent is paragraph indent in table.
2192 % @multitablecolmargin is horizontal space to be left between columns.
2193 % @multitablelinespace is space to leave between table items, baseline
2195 % 0pt means it depends on current normal line spacing.
2197 \newskip\multitableparskip
2198 \newskip\multitableparindent
2199 \newdimen\multitablecolspace
2200 \newskip\multitablelinespace
2201 \multitableparskip=0pt
2202 \multitableparindent=6pt
2203 \multitablecolspace=12pt
2204 \multitablelinespace=0pt
2206 % Macros used to set up halign preamble:
2208 \let\endsetuptable\relax
2209 \def\xendsetuptable{\endsetuptable}
2210 \let\columnfractions\relax
2211 \def\xcolumnfractions{\columnfractions}
2214 % #1 is the part of the @columnfraction before the decimal point, which
2215 % is presumably either 0 or the empty string (but we don't check, we
2216 % just throw it away). #2 is the decimal part, which we use as the
2217 % percent of \hsize for this column.
2218 \def\pickupwholefraction#1.#2 {%
2219 \global\advance\colcount by 1
2220 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2227 \ifx\firstarg\xendsetuptable
2230 \ifx\firstarg\xcolumnfractions
2231 \global\setpercenttrue
2234 \let\go\pickupwholefraction
2236 \global\advance\colcount by 1
2237 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2238 % typically that is always in the input, anyway.
2239 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2242 \ifx\go\pickupwholefraction
2243 % Put the argument back for the \pickupwholefraction call, so
2244 % we'll always have a period there to be parsed.
2245 \def\go{\pickupwholefraction#1}%
2247 \let\go = \setuptable
2253 % This used to have \hskip1sp. But then the space in a template line is
2254 % not enough. That is bad. So let's go back to just & until we
2255 % encounter the problem it was intended to solve again.
2256 % --karl, nathan@acm.org, 20apr99.
2259 % @multitable ... @end multitable definitions:
2261 \def\multitable{\parsearg\dotable}
2262 \def\dotable#1{\bgroup
2267 \setmultitablespacing
2268 \parskip=\multitableparskip
2269 \parindent=\multitableparindent
2272 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2274 % To parse everything between @multitable and @item:
2275 \setuptable#1 \endsetuptable
2277 % \everycr will reset column counter, \colcount, at the end of
2278 % each line. Every column entry will cause \colcount to advance by one.
2279 % The table preamble
2280 % looks at the current \colcount to find the correct column width.
2283 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2284 % Maybe so, but it also creates really weird page breaks when the table
2285 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2286 % manifests itself, so it can be fixed for real --karl.
2287 \global\colcount=0\relax}}%
2289 % This preamble sets up a generic column definition, which will
2290 % be used as many times as user calls for columns.
2291 % \vtop will set a single line and will also let text wrap and
2292 % continue for many paragraphs if desired.
2293 \halign\bgroup&\global\advance\colcount by 1\relax
2294 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2296 % In order to keep entries from bumping into each other
2297 % we will add a \leftskip of \multitablecolspace to all columns after
2300 % If a template has been used, we will add \multitablecolspace
2301 % to the width of each template entry.
2303 % If the user has set preamble in terms of percent of \hsize we will
2304 % use that dimension as the width of the column, and the \leftskip
2305 % will keep entries from bumping into each other. Table will start at
2306 % left margin and final column will justify at right margin.
2308 % Make sure we don't inherit \rightskip from the outer environment.
2311 % The first column will be indented with the surrounding text.
2312 \advance\hsize by\leftskip
2315 % If user has not set preamble in terms of percent of \hsize
2316 % we will advance \hsize by \multitablecolspace.
2317 \advance\hsize by \multitablecolspace
2319 % In either case we will make \leftskip=\multitablecolspace:
2320 \leftskip=\multitablecolspace
2322 % Ignoring space at the beginning and end avoids an occasional spurious
2323 % blank line, when TeX decides to break the line at the space before the
2324 % box from the multistrut, so the strut ends up on a line by itself.
2326 % @multitable @columnfractions .11 .89
2328 % @tab Legal holiday which is valid in major parts of the whole country.
2329 % Is automatically provided with highlighting sequences respectively marking
2331 \noindent\ignorespaces##\unskip\multistrut}\cr
2334 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2335 % If so, do nothing. If not, give it an appropriate dimension based on
2336 % current baselineskip.
2337 \ifdim\multitablelinespace=0pt
2338 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2339 \global\advance\multitablelinespace by-\ht0
2340 %% strut to put in table in case some entry doesn't have descenders,
2341 %% to keep lines equally spaced
2342 \let\multistrut = \strut
2344 %% FIXME: what is \box0 supposed to be?
2345 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2347 %% Test to see if parskip is larger than space between lines of
2348 %% table. If not, do nothing.
2349 %% If so, set to same dimension as multitablelinespace.
2350 \ifdim\multitableparskip>\multitablelinespace
2351 \global\multitableparskip=\multitablelinespace
2352 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2353 %% than skip between lines in the table.
2355 \ifdim\multitableparskip=0pt
2356 \global\multitableparskip=\multitablelinespace
2357 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2358 %% than skip between lines in the table.
2362 \message{conditionals,}
2363 % Prevent errors for section commands.
2364 % Used in @ignore and in failing conditionals.
2365 \def\ignoresections{%
2367 \let\unnumbered=\relax
2369 \let\unnumberedsec=\relax
2370 \let\unnumberedsection=\relax
2371 \let\unnumberedsubsec=\relax
2372 \let\unnumberedsubsection=\relax
2373 \let\unnumberedsubsubsec=\relax
2374 \let\unnumberedsubsubsection=\relax
2377 \let\subsubsec=\relax
2378 \let\subsection=\relax
2379 \let\subsubsection=\relax
2380 \let\appendix=\relax
2381 \let\appendixsec=\relax
2382 \let\appendixsection=\relax
2383 \let\appendixsubsec=\relax
2384 \let\appendixsubsection=\relax
2385 \let\appendixsubsubsec=\relax
2386 \let\appendixsubsubsection=\relax
2387 \let\contents=\relax
2388 \let\smallbook=\relax
2389 \let\titlepage=\relax
2392 % Used in nested conditionals, where we have to parse the Texinfo source
2393 % and so want to turn off most commands, in case they are used
2396 % We use \empty instead of \relax for the @def... commands, so that \end
2397 % doesn't throw an error. For instance:
2403 % The @end deffn is going to get expanded, because we're trying to allow
2404 % nested conditionals. But we don't want to expand the actual @deffn,
2405 % since it might be syntactically correct and intended to be ignored.
2406 % Since \end checks for \relax, using \empty does not cause an error.
2408 \def\ignoremorecommands{%
2409 \let\defcodeindex = \relax
2411 \let\defcvx = \empty
2412 \let\Edefcv = \empty
2414 \let\deffnx = \empty
2415 \let\Edeffn = \empty
2416 \let\defindex = \relax
2417 \let\defivar = \empty
2418 \let\defivarx = \empty
2419 \let\Edefivar = \empty
2420 \let\defmac = \empty
2421 \let\defmacx = \empty
2422 \let\Edefmac = \empty
2423 \let\defmethod = \empty
2424 \let\defmethodx = \empty
2425 \let\Edefmethod = \empty
2427 \let\defopx = \empty
2428 \let\Edefop = \empty
2429 \let\defopt = \empty
2430 \let\defoptx = \empty
2431 \let\Edefopt = \empty
2432 \let\defspec = \empty
2433 \let\defspecx = \empty
2434 \let\Edefspec = \empty
2436 \let\deftpx = \empty
2437 \let\Edeftp = \empty
2438 \let\deftypefn = \empty
2439 \let\deftypefnx = \empty
2440 \let\Edeftypefn = \empty
2441 \let\deftypefun = \empty
2442 \let\deftypefunx = \empty
2443 \let\Edeftypefun = \empty
2444 \let\deftypeivar = \empty
2445 \let\deftypeivarx = \empty
2446 \let\Edeftypeivar = \empty
2447 \let\deftypemethod = \empty
2448 \let\deftypemethodx = \empty
2449 \let\Edeftypemethod = \empty
2450 \let\deftypeop = \empty
2451 \let\deftypeopx = \empty
2452 \let\Edeftypeop = \empty
2453 \let\deftypevar = \empty
2454 \let\deftypevarx = \empty
2455 \let\Edeftypevar = \empty
2456 \let\deftypevr = \empty
2457 \let\deftypevrx = \empty
2458 \let\Edeftypevr = \empty
2460 \let\defunx = \empty
2461 \let\Edefun = \empty
2462 \let\defvar = \empty
2463 \let\defvarx = \empty
2464 \let\Edefvar = \empty
2466 \let\defvrx = \empty
2467 \let\Edefvr = \empty
2470 \let\evenfooting = \relax
2471 \let\evenheading = \relax
2472 \let\everyfooting = \relax
2473 \let\everyheading = \relax
2474 \let\headings = \relax
2475 \let\include = \relax
2477 \let\lowersections = \relax
2478 \let\oddfooting = \relax
2479 \let\oddheading = \relax
2480 \let\printindex = \relax
2482 \let\raisesections = \relax
2485 \let\setchapternewpage = \relax
2486 \let\setchapterstyle = \relax
2487 \let\settitle = \relax
2489 \let\verbatiminclude = \relax
2493 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2495 \def\direntry{\doignore{direntry}}
2496 \def\documentdescriptionword{documentdescription}
2497 \def\documentdescription{\doignore{documentdescription}}
2498 \def\html{\doignore{html}}
2499 \def\ifhtml{\doignore{ifhtml}}
2500 \def\ifinfo{\doignore{ifinfo}}
2501 \def\ifnottex{\doignore{ifnottex}}
2502 \def\ifplaintext{\doignore{ifplaintext}}
2503 \def\ifxml{\doignore{ifxml}}
2504 \def\ignore{\doignore{ignore}}
2505 \def\menu{\doignore{menu}}
2506 \def\xml{\doignore{xml}}
2508 % @dircategory CATEGORY -- specify a category of the dir file
2509 % which this file should belong to. Ignore this in TeX.
2510 \let\dircategory = \comment
2512 % Ignore text until a line `@end #1'.
2514 \def\doignore#1{\begingroup
2515 % Don't complain about control sequences we have declared \outer.
2518 % Define a command to swallow text until we reach `@end #1'.
2519 % This @ is a catcode 12 token (that is the normal catcode of @ in
2520 % this texinfo.tex file). We change the catcode of @ below to match.
2521 \long\def\doignoretext##1@end #1{\enddoignore}%
2523 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2526 % Ignore braces, too, so mismatched braces don't cause trouble.
2530 % We must not have @c interpreted as a control sequence.
2533 \def\ignoreword{#1}%
2534 \ifx\ignoreword\documentdescriptionword
2535 % The c kludge breaks documentdescription, since
2536 % `documentdescription' contains a `c'. Means not everything will
2537 % be ignored inside @documentdescription, but oh well...
2539 % Make the letter c a comment character so that the rest of the line
2540 % will be ignored. This way, the document can have (for example)
2542 % and the @end ifinfo will be properly ignored.
2543 % (We've just changed @ to catcode 12.)
2547 % And now expand the command defined above.
2551 % What we do to finish off ignored text.
2553 \def\enddoignore{\endgroup\ignorespaces}%
2555 \newif\ifwarnedobs\warnedobsfalse
2557 \ifwarnedobs\relax\else
2558 % We need to warn folks that they may have trouble with TeX 3.0.
2559 % This uses \immediate\write16 rather than \message to get newlines.
2560 \immediate\write16{}
2561 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2562 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2563 \immediate\write16{If you are running another version of TeX, relax.}
2564 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2565 \immediate\write16{ Then upgrade your TeX installation if you can.}
2566 \immediate\write16{ (See ftp://ftp.gnu.org/non-gnu/TeX.README.)}
2567 \immediate\write16{If you are stuck with version 3.0, run the}
2568 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2569 \immediate\write16{ to use a workaround.}
2570 \immediate\write16{}
2571 \global\warnedobstrue
2575 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2576 % workaround (which requires the file ``dummy.tfm'' to be installed),
2577 % uncomment the following line:
2578 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2580 % Ignore text, except that we keep track of conditional commands for
2581 % purposes of nesting, up to an `@end #1' command.
2583 \def\nestedignore#1{%
2585 % We must actually expand the ignored text to look for the @end
2586 % command, so that nested ignore constructs work. Thus, we put the
2587 % text into a \vbox and then do nothing with the result. To minimize
2588 % the chance of memory overflow, we follow the approach outlined on
2589 % page 401 of the TeXbook.
2591 \setbox0 = \vbox\bgroup
2592 % Don't complain about control sequences we have declared \outer.
2595 % Define `@end #1' to end the box, which will in turn undefine the
2596 % @end command again.
2597 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2599 % We are going to be parsing Texinfo commands. Most cause no
2600 % trouble when they are used incorrectly, but some commands do
2601 % complicated argument parsing or otherwise get confused, so we
2604 % We can't do anything about stray @-signs, unfortunately;
2605 % they'll produce `undefined control sequence' errors.
2608 % Set the current font to be \nullfont, a TeX primitive, and define
2609 % all the font commands to also use \nullfont. We don't use
2610 % dummy.tfm, as suggested in the TeXbook, because some sites
2611 % might not have that installed. Therefore, math mode will still
2612 % produce output, but that should be an extremely small amount of
2613 % stuff compared to the main input.
2616 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2617 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2618 \let\tensf=\nullfont
2619 % Similarly for index fonts.
2620 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2621 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2622 \let\smallsf=\nullfont
2623 % Similarly for smallexample fonts.
2624 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2625 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2626 \let\smallersf=\nullfont
2628 % Don't complain when characters are missing from the fonts.
2629 \tracinglostchars = 0
2631 % Don't bother to do space factor calculations.
2634 % Don't report underfull hboxes.
2637 % Do minimal line-breaking.
2638 \pretolerance = 10000
2640 % Do not execute instructions in @tex.
2641 \def\tex{\doignore{tex}}%
2642 % Do not execute macro definitions.
2643 % `c' is a comment character, so the word `macro' will get cut off.
2644 \def\macro{\doignore{ma}}%
2647 % @set VAR sets the variable VAR to an empty value.
2648 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2650 % Since we want to separate VAR from REST-OF-LINE (which might be
2651 % empty), we can't just use \parsearg; we have to insert a space of our
2652 % own to delimit the rest of the line, and then take it out again if we
2653 % didn't need it. Make sure the catcode of space is correct to avoid
2654 % losing inside @example, for instance.
2656 \def\set{\begingroup\catcode` =10
2657 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2659 \def\setxxx#1{\setyyy#1 \endsetyyy}
2660 \def\setyyy#1 #2\endsetyyy{%
2662 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2663 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2667 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2668 % \next or other control sequences that we've defined might get us into
2669 % an infinite loop. Consider `@set foo @cite{bar}'.
2670 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2672 % @clear VAR clears (i.e., unsets) the variable VAR.
2674 \def\clear{\parsearg\clearxxx}
2675 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2677 % @value{foo} gets the text saved in variable foo.
2679 \catcode`\_ = \active
2681 % We might end up with active _ or - characters in the argument if
2682 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2683 % such active characters to their normal equivalents.
2684 \gdef\value{\begingroup
2685 \catcode`\-=12 \catcode`\_=12
2686 \indexbreaks \let_\normalunderscore
2689 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2691 % We have this subroutine so that we can handle at least some @value's
2692 % properly in indexes (we \let\value to this in \indexdummies). Ones
2693 % whose names contain - or _ still won't work, but we can't do anything
2694 % about that. The command has to be fully expandable, since the result
2695 % winds up in the index file. This means that if the variable's value
2696 % contains other Texinfo commands, it's almost certain it will fail
2697 % (although perhaps we could fix that with sufficient work to do a
2698 % one-level expansion on the result, instead of complete).
2700 \def\expandablevalue#1{%
2701 \expandafter\ifx\csname SET#1\endcsname\relax
2702 {[No value for ``#1'']}%
2704 \csname SET#1\endcsname
2708 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2711 \def\ifset{\parsearg\ifsetxxx}
2713 \expandafter\ifx\csname SET#1\endcsname\relax
2714 \expandafter\ifsetfail
2716 \expandafter\ifsetsucceed
2719 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2720 \def\ifsetfail{\nestedignore{ifset}}
2721 \defineunmatchedend{ifset}
2723 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2724 % defined with @set, or has been undefined with @clear.
2726 \def\ifclear{\parsearg\ifclearxxx}
2727 \def\ifclearxxx #1{%
2728 \expandafter\ifx\csname SET#1\endcsname\relax
2729 \expandafter\ifclearsucceed
2731 \expandafter\ifclearfail
2734 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2735 \def\ifclearfail{\nestedignore{ifclear}}
2736 \defineunmatchedend{ifclear}
2738 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2739 % read the text following, through the first @end iftex (etc.). Make
2740 % `@end iftex' (etc.) valid only after an @iftex.
2742 \def\iftex{\conditionalsucceed{iftex}}
2743 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2744 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2745 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2746 \defineunmatchedend{iftex}
2747 \defineunmatchedend{ifnothtml}
2748 \defineunmatchedend{ifnotinfo}
2749 \defineunmatchedend{ifnotplaintext}
2751 % We can't just want to start a group at @iftex (etc.) and end it at
2752 % @end iftex, since then @set commands inside the conditional have no
2753 % effect (they'd get reverted at the end of the group). So we must
2754 % define \Eiftex to redefine itself to be its previous value. (We can't
2755 % just define it to fail again with an ``unmatched end'' error, since
2756 % the @ifset might be nested.)
2758 \def\conditionalsucceed#1{%
2760 % Remember the current value of \E#1.
2761 \let\nece{prevE#1} = \nece{E#1}%
2763 % At the `@end #1', redefine \E#1 to be its previous value.
2764 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2769 % We need to expand lots of \csname's, but we don't want to expand the
2770 % control sequences after we've constructed them.
2772 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2774 % @defininfoenclose.
2775 \let\definfoenclose=\comment
2779 % Index generation facilities
2781 % Define \newwrite to be identical to plain tex's \newwrite
2782 % except not \outer, so it can be used within \newindex.
2784 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2786 % \newindex {foo} defines an index named foo.
2787 % It automatically defines \fooindex such that
2788 % \fooindex ...rest of line... puts an entry in the index foo.
2789 % It also defines \fooindfile to be the number of the output channel for
2790 % the file that accumulates this index. The file's extension is foo.
2791 % The name of an index should be no more than 2 characters long
2792 % for the sake of vms.
2796 \expandafter\newwrite \csname#1indfile\endcsname
2797 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2799 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2800 \noexpand\doindex{#1}}
2803 % @defindex foo == \newindex{foo}
2805 \def\defindex{\parsearg\newindex}
2807 % Define @defcodeindex, like @defindex except put all entries in @code.
2809 \def\defcodeindex{\parsearg\newcodeindex}
2811 \def\newcodeindex#1{%
2813 \expandafter\newwrite \csname#1indfile\endcsname
2814 \openout \csname#1indfile\endcsname \jobname.#1
2816 \expandafter\xdef\csname#1index\endcsname{%
2817 \noexpand\docodeindex{#1}}%
2821 % @synindex foo bar makes index foo feed into index bar.
2822 % Do this instead of @defindex foo if you don't want it as a separate index.
2824 % @syncodeindex foo bar similar, but put all entries made for index foo
2827 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2828 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2830 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2831 % #3 the target index (bar).
2832 \def\dosynindex#1#2#3{%
2833 % Only do \closeout if we haven't already done it, else we'll end up
2834 % closing the target index.
2835 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2836 % The \closeout helps reduce unnecessary open files; the limit on the
2837 % Acorn RISC OS is a mere 16 files.
2838 \expandafter\closeout\csname#2indfile\endcsname
2839 \expandafter\let\csname\donesynindex#2\endcsname = 1
2841 % redefine \fooindfile:
2842 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2843 \expandafter\let\csname#2indfile\endcsname=\temp
2844 % redefine \fooindex:
2845 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2848 % Define \doindex, the driver for all \fooindex macros.
2849 % Argument #1 is generated by the calling \fooindex macro,
2850 % and it is "foo", the name of the index.
2852 % \doindex just uses \parsearg; it calls \doind for the actual work.
2853 % This is because \doind is more useful to call from other macros.
2855 % There is also \dosubind {index}{topic}{subtopic}
2856 % which makes an entry in a two-level index such as the operation index.
2858 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2859 \def\singleindexer #1{\doind{\indexname}{#1}}
2861 % like the previous two, but they put @code around the argument.
2862 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2863 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2865 % Take care of texinfo commands likely to appear in an index entry.
2866 % (Must be a way to avoid doing expansion at all, and thus not have to
2867 % laboriously list every single command here.)
2871 \def\@{@}% change to @@ when we switch to @ as escape char in aux files.
2872 % Need these in case \tex is in effect and \{ is a \delimiter again.
2873 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2874 % braces and backslashes are used only as delimiters.
2877 \def\_{{\realbackslash _}}%
2878 \normalturnoffactive
2880 % Take care of the plain tex accent commands.
2881 \def\,##1{\realbackslash ,{##1}}%
2882 \def\"{\realbackslash "}%
2883 \def\`{\realbackslash `}%
2884 \def\'{\realbackslash '}%
2885 \def\^{\realbackslash ^}%
2886 \def\~{\realbackslash ~}%
2887 \def\={\realbackslash =}%
2888 \def\b{\realbackslash b}%
2889 \def\c{\realbackslash c}%
2890 \def\d{\realbackslash d}%
2891 \def\u{\realbackslash u}%
2892 \def\v{\realbackslash v}%
2893 \def\H{\realbackslash H}%
2894 \def\dotless##1{\realbackslash dotless {##1}}%
2895 % Take care of the plain tex special European modified letters.
2896 \def\AA{\realbackslash AA}%
2897 \def\AE{\realbackslash AE}%
2898 \def\L{\realbackslash L}%
2899 \def\OE{\realbackslash OE}%
2900 \def\O{\realbackslash O}%
2901 \def\aa{\realbackslash aa}%
2902 \def\ae{\realbackslash ae}%
2903 \def\l{\realbackslash l}%
2904 \def\oe{\realbackslash oe}%
2905 \def\o{\realbackslash o}%
2906 \def\ss{\realbackslash ss}%
2908 % Although these internals commands shouldn't show up, sometimes they do.
2909 \def\bf{\realbackslash bf }%
2910 \def\gtr{\realbackslash gtr}%
2911 \def\hat{\realbackslash hat}%
2912 \def\less{\realbackslash less}%
2913 %\def\rm{\realbackslash rm }%
2914 \def\sf{\realbackslash sf}%
2915 \def\sl{\realbackslash sl }%
2916 \def\tclose##1{\realbackslash tclose {##1}}%
2917 \def\tt{\realbackslash tt}%
2919 \def\b##1{\realbackslash b {##1}}%
2920 \def\i##1{\realbackslash i {##1}}%
2921 \def\sc##1{\realbackslash sc {##1}}%
2922 \def\t##1{\realbackslash t {##1}}%
2923 \def\r##1{\realbackslash r {##1}}%
2925 \def\TeX{\realbackslash TeX}%
2926 \def\acronym##1{\realbackslash acronym {##1}}%
2927 \def\cite##1{\realbackslash cite {##1}}%
2928 \def\code##1{\realbackslash code {##1}}%
2929 \def\command##1{\realbackslash command {##1}}%
2930 \def\dfn##1{\realbackslash dfn {##1}}%
2931 \def\dots{\realbackslash dots }%
2932 \def\emph##1{\realbackslash emph {##1}}%
2933 \def\env##1{\realbackslash env {##1}}%
2934 \def\file##1{\realbackslash file {##1}}%
2935 \def\kbd##1{\realbackslash kbd {##1}}%
2936 \def\key##1{\realbackslash key {##1}}%
2937 \def\math##1{\realbackslash math {##1}}%
2938 \def\option##1{\realbackslash option {##1}}%
2939 \def\samp##1{\realbackslash samp {##1}}%
2940 \def\strong##1{\realbackslash strong {##1}}%
2941 \def\uref##1{\realbackslash uref {##1}}%
2942 \def\url##1{\realbackslash url {##1}}%
2943 \def\var##1{\realbackslash var {##1}}%
2944 \def\w{\realbackslash w }%
2946 % These math commands don't seem likely to be used in index entries.
2947 \def\copyright{\realbackslash copyright}%
2948 \def\equiv{\realbackslash equiv}%
2949 \def\error{\realbackslash error}%
2950 \def\expansion{\realbackslash expansion}%
2951 \def\point{\realbackslash point}%
2952 \def\print{\realbackslash print}%
2953 \def\result{\realbackslash result}%
2955 % Handle some cases of @value -- where the variable name does not
2956 % contain - or _, and the value does not contain any
2957 % (non-fully-expandable) commands.
2958 \let\value = \expandablevalue
2961 % Turn off macro expansion
2965 % If an index command is used in an @example environment, any spaces
2966 % therein should become regular spaces in the raw index file, not the
2967 % expansion of \tie (\leavevmode \penalty \@M \ ).
2969 \gdef\unsepspaces{\obeyspaces\let =\space}}
2971 % \indexnofonts no-ops all font-change commands.
2972 % This is used when outputting the strings to sort the index by.
2973 \def\indexdummyfont#1{#1}
2974 \def\indexdummytex{TeX}
2975 \def\indexdummydots{...}
2979 % how to handle braces?
2980 \def\_{\normalunderscore}%
2982 \let\,=\indexdummyfont
2983 \let\"=\indexdummyfont
2984 \let\`=\indexdummyfont
2985 \let\'=\indexdummyfont
2986 \let\^=\indexdummyfont
2987 \let\~=\indexdummyfont
2988 \let\==\indexdummyfont
2989 \let\b=\indexdummyfont
2990 \let\c=\indexdummyfont
2991 \let\d=\indexdummyfont
2992 \let\u=\indexdummyfont
2993 \let\v=\indexdummyfont
2994 \let\H=\indexdummyfont
2995 \let\dotless=\indexdummyfont
2996 % Take care of the plain tex special European modified letters.
3009 % Don't no-op \tt, since it isn't a user-level command
3010 % and is used in the definitions of the active chars like <, >, |, etc.
3011 % Likewise with the other plain tex font commands.
3012 %\let\tt=\indexdummyfont
3014 \let\b=\indexdummyfont
3015 \let\i=\indexdummyfont
3016 \let\r=\indexdummyfont
3017 \let\sc=\indexdummyfont
3018 \let\t=\indexdummyfont
3020 \let\TeX=\indexdummytex
3021 \let\acronym=\indexdummyfont
3022 \let\cite=\indexdummyfont
3023 \let\code=\indexdummyfont
3024 \let\command=\indexdummyfont
3025 \let\dfn=\indexdummyfont
3026 \let\dots=\indexdummydots
3027 \let\emph=\indexdummyfont
3028 \let\env=\indexdummyfont
3029 \let\file=\indexdummyfont
3030 \let\kbd=\indexdummyfont
3031 \let\key=\indexdummyfont
3032 \let\math=\indexdummyfont
3033 \let\option=\indexdummyfont
3034 \let\samp=\indexdummyfont
3035 \let\strong=\indexdummyfont
3036 \let\uref=\indexdummyfont
3037 \let\url=\indexdummyfont
3038 \let\var=\indexdummyfont
3039 \let\w=\indexdummyfont
3042 % To define \realbackslash, we must make \ not be an escape.
3043 % We must first make another character (@) an escape
3044 % so we do not become unable to do a definition.
3046 {\catcode`\@=0 \catcode`\\=\other
3047 @gdef@realbackslash{\}}
3049 \let\indexbackslash=0 %overridden during \printindex.
3050 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3052 % For \ifx comparisons.
3053 \def\emptymacro{\empty}
3055 % Most index entries go through here, but \dosubind is the general case.
3057 \def\doind#1#2{\dosubind{#1}{#2}\empty}
3059 % Workhorse for all \fooindexes.
3060 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3061 % \empty if called from \doind, as we usually are. The main exception
3062 % is with defuns, which call us directly.
3064 \def\dosubind#1#2#3{%
3065 % Put the index entry in the margin if desired.
3066 \ifx\SETmarginindex\relax\else
3067 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
3070 \count255=\lastpenalty
3072 \indexdummies % Must do this here, since \bf, etc expand at this stage
3075 \let\folio = 0% We will expand all macros now EXCEPT \folio.
3076 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3077 % so it will be output as is; and it will print as backslash.
3081 % If third arg is present, precede it with space in sort key.
3082 \ifx\thirdarg\emptymacro
3083 \let\subentry = \empty
3088 % First process the index entry with all font commands turned
3089 % off to get the string to sort by.
3090 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
3092 % Now the real index entry with the fonts.
3095 % If the third (subentry) arg is present, add it to the index
3097 \ifx\thirdarg\emptymacro \else
3098 \toks0 = \expandafter{\the\toks0{#3}}%
3101 % Set up the complete index entry, with both the sort key and
3102 % the original text, including any font commands. We write
3103 % three arguments to \entry to the .?? file (four in the
3104 % subentry case), texindex reduces to two when writing the .??s
3107 \write\csname#1indfile\endcsname{%
3108 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3111 % If a skip is the last thing on the list now, preserve it
3112 % by backing up by \lastskip, doing the \write, then inserting
3113 % the skip again. Otherwise, the whatsit generated by the
3114 % \write will make \lastskip zero. The result is that sequences
3119 % will have extra space inserted, because the \medbreak in the
3120 % start of the @defun won't see the skip inserted by the @end of
3121 % the previous defun.
3123 % But don't do any of this if we're not in vertical mode. We
3124 % don't want to do a \vskip and prematurely end a paragraph.
3126 % Avoid page breaks due to these extra skips, too.
3131 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
3134 \temp % do the write
3137 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3145 % The index entry written in the file actually looks like
3146 % \entry {sortstring}{page}{topic}
3148 % \entry {sortstring}{page}{topic}{subtopic}
3149 % The texindex program reads in these files and writes files
3150 % containing these kinds of lines:
3152 % before the first topic whose initial is c
3153 % \entry {topic}{pagelist}
3154 % for a topic that is used without subtopics
3156 % for the beginning of a topic that is used with subtopics
3157 % \secondary {subtopic}{pagelist}
3158 % for each subtopic.
3160 % Define the user-accessible indexing commands
3161 % @findex, @vindex, @kindex, @cindex.
3163 \def\findex {\fnindex}
3164 \def\kindex {\kyindex}
3165 \def\cindex {\cpindex}
3166 \def\vindex {\vrindex}
3167 \def\tindex {\tpindex}
3168 \def\pindex {\pgindex}
3170 \def\cindexsub {\begingroup\obeylines\cindexsub}
3172 \gdef\cindexsub "#1" #2^^M{\endgroup %
3173 \dosubind{cp}{#2}{#1}}}
3175 % Define the macros used in formatting output of the sorted index material.
3177 % @printindex causes a particular index (the ??s file) to get printed.
3178 % It does not print any chapter heading (usually an @unnumbered).
3180 \def\printindex{\parsearg\doprintindex}
3181 \def\doprintindex#1{\begingroup
3182 \dobreak \chapheadingskip{10000}%
3188 % See if the index file exists and is nonempty.
3189 % Change catcode of @ here so that if the index file contains
3191 % as its first line, TeX doesn't complain about mismatched braces
3192 % (because it thinks @} is a control sequence).
3194 \openin 1 \jobname.#1s
3196 % \enddoublecolumns gets confused if there is no text in the index,
3197 % and it loses the chapter title and the aux file entries for the
3198 % index. The easiest way to prevent this problem is to make sure
3199 % there is some text.
3200 \putwordIndexNonexistent
3203 % If the index file exists but is empty, then \openin leaves \ifeof
3204 % false. We have to make TeX try to read something from the file, so
3205 % it can discover if there is anything in it.
3208 \putwordIndexIsEmpty
3210 % Index files are almost Texinfo source, but we use \ as the escape
3211 % character. It would be better to use @, but that's too big a change
3212 % to make right now.
3213 \def\indexbackslash{\rawbackslashxx}%
3224 % These macros are used by the sorted index file itself.
3225 % Change them to control the appearance of the index.
3228 % Some minor font changes for the special characters.
3229 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3231 % Remove any glue we may have, we'll be inserting our own.
3234 % We like breaks before the index initials, so insert a bonus.
3237 % Typeset the initial. Making this add up to a whole number of
3238 % baselineskips increases the chance of the dots lining up from column
3239 % to column. It still won't often be perfect, because of the stretch
3240 % we need before each entry, but it's better.
3242 % No shrink because it confuses \balancecolumns.
3243 \vskip 1.67\baselineskip plus .5\baselineskip
3244 \leftline{\secbf #1}%
3245 \vskip .33\baselineskip plus .1\baselineskip
3247 % Do our best not to break after the initial.
3251 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3252 % flush to the right margin. It is used for index and table of contents
3253 % entries. The paragraph is indented by \leftskip.
3255 \def\entry#1#2{\begingroup
3257 % Start a new paragraph if necessary, so our assignments below can't
3258 % affect previous text.
3261 % Do not fill out the last line with white space.
3264 % No extra space above this paragraph.
3267 % Do not prefer a separate line ending with a hyphen to fewer lines.
3268 \finalhyphendemerits = 0
3270 % \hangindent is only relevant when the entry text and page number
3271 % don't both fit on one line. In that case, bob suggests starting the
3272 % dots pretty far over on the line. Unfortunately, a large
3273 % indentation looks wrong when the entry text itself is broken across
3274 % lines. So we use a small indentation and put up with long leaders.
3276 % \hangafter is reset to 1 (which is the value we want) at the start
3277 % of each paragraph, so we need not do anything with that.
3280 % When the entry text needs to be broken, just fill out the first line
3282 \rightskip = 0pt plus1fil
3284 % A bit of stretch before each entry for the benefit of balancing columns.
3287 % Start a ``paragraph'' for the index entry so the line breaking
3288 % parameters we've set above will have an effect.
3291 % Insert the text of the index entry. TeX will do line-breaking on it.
3293 % The following is kludged to not output a line of dots in the index if
3294 % there are no page numbers. The next person who breaks this will be
3295 % cursed by a Unix daemon.
3298 \edef\tempc{\tempa}%
3299 \edef\tempd{\tempb}%
3300 \ifx\tempc\tempd\ \else%
3302 % If we must, put the page number on a line of its own, and fill out
3303 % this line with blank space. (The \hfil is overwhelmed with the
3304 % fill leaders glue in \indexdotfill if the page number does fit.)
3306 \null\nobreak\indexdotfill % Have leaders before the page number.
3308 % The `\ ' here is removed by the implicit \unskip that TeX does as
3309 % part of (the primitive) \par. Without it, a spurious underfull
3312 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3314 \ #2% The page number ends the paragraph.
3320 % Like \dotfill except takes at least 1 em.
3321 \def\indexdotfill{\cleaders
3322 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3324 \def\primary #1{\line{#1\hfil}}
3326 \newskip\secondaryindent \secondaryindent=0.5cm
3327 \def\secondary#1#2{{%
3332 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3334 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3341 % Define two-column mode, which we use to typeset indexes.
3342 % Adapted from the TeXbook, page 416, which is to say,
3343 % the manmac.tex format used to print the TeXbook itself.
3347 \newdimen\doublecolumnhsize
3349 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3350 % Grab any single-column material above us.
3353 % Here is a possibility not foreseen in manmac: if we accumulate a
3354 % whole lot of material, we might end up calling this \output
3355 % routine twice in a row (see the doublecol-lose test, which is
3356 % essentially a couple of indexes with @setchapternewpage off). In
3357 % that case we just ship out what is in \partialpage with the normal
3358 % output routine. Generally, \partialpage will be empty when this
3359 % runs and this will be a no-op. See the indexspread.tex test case.
3360 \ifvoid\partialpage \else
3361 \onepageout{\pagecontents\partialpage}%
3364 \global\setbox\partialpage = \vbox{%
3365 % Unvbox the main output page.
3367 \kern-\topskip \kern\baselineskip
3370 \eject % run that output routine to set \partialpage
3372 % Use the double-column output routine for subsequent pages.
3373 \output = {\doublecolumnout}%
3375 % Change the page size parameters. We could do this once outside this
3376 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3377 % format, but then we repeat the same computation. Repeating a couple
3378 % of assignments once per index is clearly meaningless for the
3379 % execution time, so we may as well do it in one place.
3381 % First we halve the line length, less a little for the gutter between
3382 % the columns. We compute the gutter based on the line length, so it
3383 % changes automatically with the paper format. The magic constant
3384 % below is chosen so that the gutter has the same value (well, +-<1pt)
3385 % as it did when we hard-coded it.
3387 % We put the result in a separate register, \doublecolumhsize, so we
3388 % can restore it in \pagesofar, after \hsize itself has (potentially)
3391 \doublecolumnhsize = \hsize
3392 \advance\doublecolumnhsize by -.04154\hsize
3393 \divide\doublecolumnhsize by 2
3394 \hsize = \doublecolumnhsize
3396 % Double the \vsize as well. (We don't need a separate register here,
3397 % since nobody clobbers \vsize.)
3401 % The double-column output routine for all double-column pages except
3404 \def\doublecolumnout{%
3405 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3406 % Get the available space for the double columns -- the normal
3407 % (undoubled) page height minus any material left over from the
3411 \advance\dimen@ by -\ht\partialpage
3413 % box0 will be the left-hand column, box2 the right.
3414 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3415 \onepageout\pagesofar
3417 \penalty\outputpenalty
3420 % Re-output the contents of the output page -- any previous material,
3421 % followed by the two boxes we just split, in box0 and box2.
3425 \hsize = \doublecolumnhsize
3426 \wd0=\hsize \wd2=\hsize
3427 \hbox to\pagewidth{\box0\hfil\box2}%
3430 % All done with double columns.
3431 \def\enddoublecolumns{%
3433 % Split the last of the double-column material. Leave it on the
3434 % current page, no automatic page break.
3437 % If we end up splitting too much material for the current page,
3438 % though, there will be another page break right after this \output
3439 % invocation ends. Having called \balancecolumns once, we do not
3440 % want to call it again. Therefore, reset \output to its normal
3441 % definition right away. (We hope \balancecolumns will never be
3442 % called on to balance too much material, but if it is, this makes
3443 % the output somewhat more palatable.)
3444 \global\output = {\onepageout{\pagecontents\PAGE}}%
3447 \endgroup % started in \begindoublecolumns
3449 % \pagegoal was set to the doubled \vsize above, since we restarted
3450 % the current page. We're now back to normal single-column
3451 % typesetting, so reset \pagegoal to the normal \vsize (after the
3452 % \endgroup where \vsize got restored).
3456 % Called at the end of the double column material.
3457 \def\balancecolumns{%
3458 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3460 \advance\dimen@ by \topskip
3461 \advance\dimen@ by-\baselineskip
3462 \divide\dimen@ by 2 % target to split to
3463 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3464 \splittopskip = \topskip
3465 % Loop until we get a decent breakpoint.
3469 \global\setbox3 = \copy0
3470 \global\setbox1 = \vsplit3 to \dimen@
3472 \global\advance\dimen@ by 1pt
3475 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3476 \setbox0=\vbox to\dimen@{\unvbox1}%
3477 \setbox2=\vbox to\dimen@{\unvbox3}%
3481 \catcode`\@ = \other
3484 \message{sectioning,}
3485 % Chapters, sections, etc.
3488 \newcount\secno \secno=0
3489 \newcount\subsecno \subsecno=0
3490 \newcount\subsubsecno \subsubsecno=0
3492 % This counter is funny since it counts through charcodes of letters A, B, ...
3493 \newcount\appendixno \appendixno = `\@
3494 % \def\appendixletter{\char\the\appendixno}
3495 % We do the following for the sake of pdftex, which needs the actual
3496 % letter in the expansion, not just typeset.
3497 \def\appendixletter{%
3498 \ifnum\appendixno=`A A%
3499 \else\ifnum\appendixno=`B B%
3500 \else\ifnum\appendixno=`C C%
3501 \else\ifnum\appendixno=`D D%
3502 \else\ifnum\appendixno=`E E%
3503 \else\ifnum\appendixno=`F F%
3504 \else\ifnum\appendixno=`G G%
3505 \else\ifnum\appendixno=`H H%
3506 \else\ifnum\appendixno=`I I%
3507 \else\ifnum\appendixno=`J J%
3508 \else\ifnum\appendixno=`K K%
3509 \else\ifnum\appendixno=`L L%
3510 \else\ifnum\appendixno=`M M%
3511 \else\ifnum\appendixno=`N N%
3512 \else\ifnum\appendixno=`O O%
3513 \else\ifnum\appendixno=`P P%
3514 \else\ifnum\appendixno=`Q Q%
3515 \else\ifnum\appendixno=`R R%
3516 \else\ifnum\appendixno=`S S%
3517 \else\ifnum\appendixno=`T T%
3518 \else\ifnum\appendixno=`U U%
3519 \else\ifnum\appendixno=`V V%
3520 \else\ifnum\appendixno=`W W%
3521 \else\ifnum\appendixno=`X X%
3522 \else\ifnum\appendixno=`Y Y%
3523 \else\ifnum\appendixno=`Z Z%
3524 % The \the is necessary, despite appearances, because \appendixletter is
3525 % expanded while writing the .toc file. \char\appendixno is not
3526 % expandable, thus it is written literally, thus all appendixes come out
3527 % with the same letter (or @) in the toc without it.
3528 \else\char\the\appendixno
3529 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3530 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3532 % Each @chapter defines this as the name of the chapter.
3533 % page headings and footings can use it. @section does likewise.
3537 \newcount\absseclevel % used to calculate proper heading level
3538 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3540 % @raisesections: treat @section as chapter, @subsection as section, etc.
3541 \def\raisesections{\global\advance\secbase by -1}
3542 \let\up=\raisesections % original BFox name
3544 % @lowersections: treat @chapter as section, @section as subsection, etc.
3545 \def\lowersections{\global\advance\secbase by 1}
3546 \let\down=\lowersections % original BFox name
3548 % Choose a numbered-heading macro
3549 % #1 is heading level if unmodified by @raisesections or @lowersections
3550 % #2 is text for heading
3551 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3557 \numberedsubseczzz{#2}
3559 \numberedsubsubseczzz{#2}
3561 \ifnum \absseclevel<0
3564 \numberedsubsubseczzz{#2}
3569 % like \numhead, but chooses appendix heading levels
3570 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3574 \appendixsectionzzz{#2}
3576 \appendixsubseczzz{#2}
3578 \appendixsubsubseczzz{#2}
3580 \ifnum \absseclevel<0
3583 \appendixsubsubseczzz{#2}
3588 % like \numhead, but chooses numberless heading levels
3589 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3593 \unnumberedseczzz{#2}
3595 \unnumberedsubseczzz{#2}
3597 \unnumberedsubsubseczzz{#2}
3599 \ifnum \absseclevel<0
3602 \unnumberedsubsubseczzz{#2}
3607 % @chapter, @appendix, @unnumbered.
3608 \def\thischaptername{No Chapter Title}
3609 \outer\def\chapter{\parsearg\chapteryyy}
3610 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3611 \def\chapterzzz #1{%
3612 \secno=0 \subsecno=0 \subsubsecno=0
3613 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3614 \chapmacro {#1}{\the\chapno}%
3615 \gdef\thissection{#1}%
3616 \gdef\thischaptername{#1}%
3617 % We don't substitute the actual chapter name into \thischapter
3618 % because we don't want its macros evaluated now.
3619 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3621 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3625 \global\let\section = \numberedsec
3626 \global\let\subsection = \numberedsubsec
3627 \global\let\subsubsection = \numberedsubsubsec
3630 % we use \chapno to avoid indenting back
3631 \def\appendixbox#1{%
3632 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}%
3633 \hbox to \wd0{#1\hss}}
3635 \outer\def\appendix{\parsearg\appendixyyy}
3636 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3637 \def\appendixzzz #1{%
3638 \secno=0 \subsecno=0 \subsubsecno=0
3639 \global\advance \appendixno by 1
3640 \message{\putwordAppendix\space \appendixletter}%
3641 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}%
3642 \gdef\thissection{#1}%
3643 \gdef\thischaptername{#1}%
3644 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3646 \edef\temp{\noexpand\writetocentry{\realbackslash appendixentry{\the\toks0}%
3647 {\appendixletter}}}%
3650 \global\let\section = \appendixsec
3651 \global\let\subsection = \appendixsubsec
3652 \global\let\subsubsection = \appendixsubsubsec
3655 % @centerchap is like @unnumbered, but the heading is centered.
3656 \outer\def\centerchap{\parsearg\centerchapyyy}
3657 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3659 % @top is like @unnumbered.
3660 \outer\def\top{\parsearg\unnumberedyyy}
3662 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3663 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3664 \def\unnumberedzzz #1{%
3665 \secno=0 \subsecno=0 \subsubsecno=0
3667 % This used to be simply \message{#1}, but TeX fully expands the
3668 % argument to \message. Therefore, if #1 contained @-commands, TeX
3669 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3670 % expanded @cite (which turns out to cause errors because \cite is meant
3671 % to be executed, not expanded).
3673 % Anyway, we don't want the fully-expanded definition of @cite to appear
3674 % as a result of the \message, we just want `@cite' itself. We use
3675 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3676 % simply yielding the contents of <toks register>. (We also do this for
3678 \toks0 = {#1}\message{(\the\toks0)}%
3680 \unnumbchapmacro {#1}%
3681 \gdef\thischapter{#1}\gdef\thissection{#1}%
3683 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}{\the\chapno}}}%
3686 \global\let\section = \unnumberedsec
3687 \global\let\subsection = \unnumberedsubsec
3688 \global\let\subsubsection = \unnumberedsubsubsec
3692 \outer\def\numberedsec{\parsearg\secyyy}
3693 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3695 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3696 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3698 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3699 {\the\chapno}{\the\secno}}}%
3705 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3706 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3707 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3708 \def\appendixsectionzzz #1{%
3709 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3710 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3712 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3713 {\appendixletter}{\the\secno}}}%
3719 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3720 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3721 \def\unnumberedseczzz #1{%
3722 \plainsecheading {#1}\gdef\thissection{#1}%
3724 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry%
3725 {\the\toks0}{\the\chapno}{\the\secno}}}%
3732 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3733 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3734 \def\numberedsubseczzz #1{%
3735 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3736 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3738 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3739 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3745 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3746 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3747 \def\appendixsubseczzz #1{%
3748 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3749 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3751 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3752 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3758 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3759 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3760 \def\unnumberedsubseczzz #1{%
3761 \plainsubsecheading {#1}\gdef\thissection{#1}%
3763 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3764 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}}}%
3771 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3772 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3773 \def\numberedsubsubseczzz #1{%
3774 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3775 \subsubsecheading {#1}
3776 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3778 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3779 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3785 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3786 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3787 \def\appendixsubsubseczzz #1{%
3788 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3789 \subsubsecheading {#1}
3790 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3792 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3793 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3799 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3800 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3801 \def\unnumberedsubsubseczzz #1{%
3802 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3804 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3805 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3811 % These are variants which are not "outer", so they can appear in @ifinfo.
3812 % Actually, they should now be obsolete; ordinary section commands should work.
3813 \def\infotop{\parsearg\unnumberedzzz}
3814 \def\infounnumbered{\parsearg\unnumberedzzz}
3815 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3816 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3817 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3819 \def\infoappendix{\parsearg\appendixzzz}
3820 \def\infoappendixsec{\parsearg\appendixseczzz}
3821 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3822 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3824 \def\infochapter{\parsearg\chapterzzz}
3825 \def\infosection{\parsearg\sectionzzz}
3826 \def\infosubsection{\parsearg\subsectionzzz}
3827 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3829 % These macros control what the section commands do, according
3830 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3831 % Define them by default for a numbered chapter.
3832 \global\let\section = \numberedsec
3833 \global\let\subsection = \numberedsubsec
3834 \global\let\subsubsection = \numberedsubsubsec
3836 % Define @majorheading, @heading and @subheading
3838 % NOTE on use of \vbox for chapter headings, section headings, and such:
3839 % 1) We use \vbox rather than the earlier \line to permit
3840 % overlong headings to fold.
3841 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3842 % heading is obnoxious; this forbids it.
3843 % 3) Likewise, headings look best if no \parindent is used, and
3844 % if justification is not attempted. Hence \raggedright.
3847 \def\majorheading{\parsearg\majorheadingzzz}
3848 \def\majorheadingzzz #1{%
3849 {\advance\chapheadingskip by 10pt \chapbreak }%
3850 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3851 \parindent=0pt\raggedright
3852 \rm #1\hfill}}\bigskip \par\penalty 200}
3854 \def\chapheading{\parsearg\chapheadingzzz}
3855 \def\chapheadingzzz #1{\chapbreak %
3856 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3857 \parindent=0pt\raggedright
3858 \rm #1\hfill}}\bigskip \par\penalty 200}
3860 % @heading, @subheading, @subsubheading.
3861 \def\heading{\parsearg\plainsecheading}
3862 \def\subheading{\parsearg\plainsubsecheading}
3863 \def\subsubheading{\parsearg\plainsubsubsecheading}
3865 % These macros generate a chapter, section, etc. heading only
3866 % (including whitespace, linebreaking, etc. around it),
3867 % given all the information in convenient, parsed form.
3869 %%% Args are the skip and penalty (usually negative)
3870 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3872 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3874 %%% Define plain chapter starts, and page on/off switching for it
3875 % Parameter controlling skip before chapter headings (if needed)
3877 \newskip\chapheadingskip
3879 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3880 \def\chappager{\par\vfill\supereject}
3881 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3883 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3886 \global\let\contentsalignmacro = \chappager
3887 \global\let\pchapsepmacro=\chapbreak
3888 \global\let\pagealignmacro=\chappager}
3891 \global\let\contentsalignmacro = \chappager
3892 \global\let\pchapsepmacro=\chappager
3893 \global\let\pagealignmacro=\chappager
3894 \global\def\HEADINGSon{\HEADINGSsingle}}
3897 \global\let\contentsalignmacro = \chapoddpage
3898 \global\let\pchapsepmacro=\chapoddpage
3899 \global\let\pagealignmacro=\chapoddpage
3900 \global\def\HEADINGSon{\HEADINGSdouble}}
3905 \global\let\chapmacro=\chfplain
3906 \global\let\unnumbchapmacro=\unnchfplain
3907 \global\let\centerchapmacro=\centerchfplain}
3909 % Plain chapter opening.
3910 % #1 is the text, #2 the chapter number or empty if unnumbered.
3916 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3917 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3918 \hangindent = \wd0 \centerparametersmaybe
3921 \nobreak\bigskip % no page break after a chapter title
3925 % Plain opening for unnumbered.
3926 \def\unnchfplain#1{\chfplain{#1}{}}
3928 % @centerchap -- centered and unnumbered.
3929 \let\centerparametersmaybe = \relax
3930 \def\centerchfplain#1{{%
3931 \def\centerparametersmaybe{%
3932 \advance\rightskip by 3\rightskip
3933 \leftskip = \rightskip
3939 \CHAPFplain % The default
3941 \def\unnchfopen #1{%
3942 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3943 \parindent=0pt\raggedright
3944 \rm #1\hfill}}\bigskip \par\nobreak
3947 \def\chfopen #1#2{\chapoddpage {\chapfonts
3948 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3952 \def\centerchfopen #1{%
3953 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3955 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3959 \global\let\chapmacro=\chfopen
3960 \global\let\unnumbchapmacro=\unnchfopen
3961 \global\let\centerchapmacro=\centerchfopen}
3965 \newskip\secheadingskip
3966 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3967 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3968 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3970 % Subsection titles.
3971 \newskip \subsecheadingskip
3972 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3973 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3974 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3976 % Subsubsection titles.
3977 \let\subsubsecheadingskip = \subsecheadingskip
3978 \let\subsubsecheadingbreak = \subsecheadingbreak
3979 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3980 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3983 % Print any size section title.
3985 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3986 % number (maybe empty), #3 the text.
3987 \def\sectionheading#1#2#3{%
3989 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3990 \csname #1headingbreak\endcsname
3993 % Switch to the right set of fonts.
3994 \csname #1fonts\endcsname \rm
3996 % Only insert the separating space if we have a section number.
3998 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
4000 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4001 \hangindent = \wd0 % zero if no section number
4004 % Add extra space after the heading -- either a line space or a
4005 % paragraph space, whichever is more. (Some people like to set
4006 % \parskip to large values for some reason.)
4008 \ifdim\parskip>\normalbaselineskip
4011 \kern\normalbaselineskip
4018 % Table of contents.
4021 % Write an entry to the toc file, opening it if necessary.
4022 % Called from @chapter, etc. We supply {\folio} at the end of the
4023 % argument, which will end up as the last argument to the \...entry macro.
4025 % We open the .toc file here instead of at @setfilename or any other
4026 % fixed time so that @contents can be put in the document anywhere.
4028 \newif\iftocfileopened
4029 \def\writetocentry#1{%
4030 \iftocfileopened\else
4031 \immediate\openout\tocfile = \jobname.toc
4032 \global\tocfileopenedtrue
4034 \iflinks \write\tocfile{#1{\folio}}\fi
4036 % Tell \shipout to create a page destination if we're doing pdf, which
4037 % will be the target of the links in the table of contents. We can't
4038 % just do it on every page because the title pages are numbered 1 and
4039 % 2 (the page numbers aren't printed), and so are the first two pages
4040 % of the document. Thus, we'd have two destinations named `1', and
4042 \ifpdf \pdfmakepagedesttrue \fi
4045 \newskip\contentsrightmargin \contentsrightmargin=1in
4046 \newcount\savepageno
4047 \newcount\lastnegativepageno \lastnegativepageno = -1
4049 % Finish up the main text and prepare to read what we've written
4052 \def\startcontents#1{%
4053 % If @setchapternewpage on, and @headings double, the contents should
4054 % start on an odd page, unlike chapters. Thus, we maintain
4055 % \contentsalignmacro in parallel with \pagealignmacro.
4056 % From: Torbjorn Granlund <tege@matematik.su.se>
4058 \immediate\closeout\tocfile
4060 % Don't need to put `Contents' or `Short Contents' in the headline.
4061 % It is abundantly clear what they are.
4062 \unnumbchapmacro{#1}\def\thischapter{}%
4063 \savepageno = \pageno
4064 \begingroup % Set up to handle contents files properly.
4065 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4066 % We can't do this, because then an actual ^ in a section
4067 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4068 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4069 \raggedbottom % Worry more about breakpoints than the bottom.
4070 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4072 % Roman numerals for page numbers.
4073 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
4077 % Normal (long) toc.
4079 \startcontents{\putwordTOC}%
4080 \openin 1 \jobname.toc
4086 \contentsalignmacro % in case @setchapternewpage odd is in effect
4089 \lastnegativepageno = \pageno
4090 \pageno = \savepageno
4093 % And just the chapters.
4094 \def\summarycontents{%
4095 \startcontents{\putwordShortTOC}%
4097 \let\chapentry = \shortchapentry
4098 \let\appendixentry = \shortappendixentry
4099 \let\unnumbchapentry = \shortunnumberedentry
4100 % We want a true roman here for the page numbers.
4102 \let\rm=\shortcontrm \let\bf=\shortcontbf
4103 \let\sl=\shortcontsl \let\tt=\shortconttt
4105 \hyphenpenalty = 10000
4106 \advance\baselineskip by 1pt % Open it up a little.
4107 \def\secentry ##1##2##3##4{}
4108 \def\subsecentry ##1##2##3##4##5{}
4109 \def\subsubsecentry ##1##2##3##4##5##6{}
4110 \let\unnumbsecentry = \secentry
4111 \let\unnumbsubsecentry = \subsecentry
4112 \let\unnumbsubsubsecentry = \subsubsecentry
4113 \openin 1 \jobname.toc
4119 \contentsalignmacro % in case @setchapternewpage odd is in effect
4121 \lastnegativepageno = \pageno
4122 \pageno = \savepageno
4124 \let\shortcontents = \summarycontents
4127 \pdfcatalog{/PageMode /UseOutlines}%
4130 % These macros generate individual entries in the table of contents.
4131 % The first argument is the chapter or section name.
4132 % The last argument is the page number.
4133 % The arguments in between are the chapter number, section number, ...
4135 % Chapters, in the main contents.
4136 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4138 % Chapters, in the short toc.
4139 % See comments in \dochapentry re vbox and related settings.
4140 \def\shortchapentry#1#2#3{%
4141 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4144 % Appendices, in the main contents.
4145 \def\appendixentry#1#2#3{%
4146 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}}
4148 % Appendices, in the short toc.
4149 \let\shortappendixentry = \shortchapentry
4151 % Typeset the label for a chapter or appendix for the short contents.
4152 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4153 % We could simplify the code here by writing out an \appendixentry
4154 % command in the toc file for appendices, instead of using \chapentry
4155 % for both, but it doesn't seem worth it.
4157 \newdimen\shortappendixwidth
4159 \def\shortchaplabel#1{%
4160 % This space should be enough, since a single number is .5em, and the
4161 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4162 % But use \hss just in case.
4163 % (This space doesn't include the extra space that gets added after
4164 % the label; that gets put in by \shortchapentry above.)
4166 \hbox to \dimen0{#1\hss}%
4169 % Unnumbered chapters.
4170 \def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}}
4171 \def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}}
4174 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4175 \def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4178 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4179 \def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}}
4181 % And subsubsections.
4182 \def\subsubsecentry#1#2#3#4#5#6{%
4183 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4184 \def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}}
4186 % This parameter controls the indentation of the various levels.
4187 \newdimen\tocindent \tocindent = 3pc
4189 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4192 % If the toc has to be broken over pages, we want it to be at chapters
4193 % if at all possible; hence the \penalty.
4194 \def\dochapentry#1#2{%
4195 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4198 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4200 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4203 \def\dosecentry#1#2{\begingroup
4204 \secentryfonts \leftskip=\tocindent
4205 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4208 \def\dosubsecentry#1#2{\begingroup
4209 \subsecentryfonts \leftskip=2\tocindent
4210 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4213 \def\dosubsubsecentry#1#2{\begingroup
4214 \subsubsecentryfonts \leftskip=3\tocindent
4215 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4218 % Final typesetting of a toc entry; we use the same \entry macro as for
4219 % the index entries, but we want to suppress hyphenation here. (We
4220 % can't do that in the \entry macro, since index entries might consist
4221 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4222 \def\tocentry#1#2{\begingroup
4223 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4224 % Do not use \turnoffactive in these arguments. Since the toc is
4225 % typeset in cmr, characters such as _ would come out wrong; we
4226 % have to do the usual translation tricks.
4230 % Space between chapter (or whatever) number and the title.
4231 \def\labelspace{\hskip1em \relax}
4233 \def\dopageno#1{{\rm #1}}
4234 \def\doshortpageno#1{{\rm #1}}
4236 \def\chapentryfonts{\secfonts \rm}
4237 \def\secentryfonts{\textfonts}
4238 \let\subsecentryfonts = \textfonts
4239 \let\subsubsecentryfonts = \textfonts
4242 \message{environments,}
4243 % @foo ... @end foo.
4245 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4247 % Since these characters are used in examples, it should be an even number of
4248 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4251 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4252 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4253 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4254 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4256 % The @error{} command.
4257 % Adapted from the TeXbook's \boxit.
4261 {\tentt \global\dimen0 = 3em}% Width of the box.
4262 \dimen2 = .55pt % Thickness of rules
4263 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4264 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4266 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4267 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4268 \advance\hsize by -2\dimen2 % Rules.
4270 \hrule height\dimen2
4271 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4272 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4273 \kern3pt\vrule width\dimen2}% Space to right.
4274 \hrule height\dimen2}
4277 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4279 % @tex ... @end tex escapes into raw Tex temporarily.
4280 % One exception: @ is still an escape character, so that @end tex works.
4281 % But \@ or @@ will get a plain tex @ character.
4283 \def\tex{\begingroup
4284 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4285 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4286 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4288 \catcode 43=12 % plus
4297 \let\bullet=\ptexbullet
4302 \let\equiv=\ptexequiv
4311 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4312 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4314 \let\Etex=\endgroup}
4316 % Define @lisp ... @end lisp.
4317 % @lisp does a \begingroup so it can rebind things,
4318 % including the definition of @end lisp (which normally is erroneous).
4320 % Amount to narrow the margins by for @lisp.
4321 \newskip\lispnarrowing \lispnarrowing=0.4in
4323 % This is the definition that ^^M gets inside @lisp, @example, and other
4324 % such environments. \null is better than a space, since it doesn't
4326 \def\lisppar{\null\endgraf}
4328 % Make each space character in the input produce a normal interword
4329 % space in the output. Don't allow a line break at this space, as this
4330 % is used only in environments like @example, where each line of input
4331 % should produce a line of output anyway.
4334 \gdef\sepspaces{\obeyspaces\let =\tie}}
4336 % Define \obeyedspace to be our active space, whatever it is. This is
4337 % for use in \parsearg.
4339 \global\let\obeyedspace= }
4341 % This space is always present above and below environments.
4342 \newskip\envskipamount \envskipamount = 0pt
4344 % Make spacing and below environment symmetrical. We use \parskip here
4345 % to help in doing that, since in @example-like environments \parskip
4346 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4347 % start of the next paragraph will insert \parskip.
4349 \def\aboveenvbreak{{%
4350 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4351 \ifnum \lastpenalty=10000 \else
4352 \advance\envskipamount by \parskip
4354 \ifdim\lastskip<\envskipamount
4356 % it's not a good place to break if the last penalty was \nobreak
4358 \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4359 \vskip\envskipamount
4364 \let\afterenvbreak = \aboveenvbreak
4366 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4367 \let\nonarrowing=\relax
4369 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4370 % environment contents.
4371 \font\circle=lcircle10
4373 \newdimen\cartouter\newdimen\cartinner
4374 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4375 \circthick=\fontdimen8\circle
4377 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4378 \def\ctr{{\hskip 6pt\circle\char'010}}
4379 \def\cbl{{\circle\char'012\hskip -6pt}}
4380 \def\cbr{{\hskip 6pt\circle\char'011}}
4381 \def\carttop{\hbox to \cartouter{\hskip\lskip
4382 \ctl\leaders\hrule height\circthick\hfil\ctr
4384 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4385 \cbl\leaders\hrule height\circthick\hfil\cbr
4388 \newskip\lskip\newskip\rskip
4390 \long\def\cartouche{%
4392 \lskip=\leftskip \rskip=\rightskip
4393 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4394 \cartinner=\hsize \advance\cartinner by-\lskip
4395 \advance\cartinner by-\rskip
4397 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4398 % side, and for 6pt waste from
4399 % each corner char, and rule thickness
4400 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4401 % Flag to tell @lisp, etc., not to narrow margin.
4402 \let\nonarrowing=\comment
4404 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4413 \baselineskip=\normbskip
4414 \lineskip=\normlskip
4430 % This macro is called at the beginning of all the @example variants,
4434 \inENV % This group ends at the end of the body
4435 \hfuzz = 12pt % Don't be fussy
4436 \sepspaces % Make spaces be word-separators rather than space tokens.
4437 \let\par = \lisppar % don't ignore blank lines
4438 \obeylines % each line of input is a line of output
4441 \emergencystretch = 0pt % don't try to avoid overfull boxes
4442 % @cartouche defines \nonarrowing to inhibit narrowing
4443 % at next level down.
4444 \ifx\nonarrowing\relax
4445 \advance \leftskip by \lispnarrowing
4446 \exdentamount=\lispnarrowing
4447 \let\exdent=\nofillexdent
4448 \let\nonarrowing=\relax
4452 % Define the \E... control sequence only if we are inside the particular
4453 % environment, so the error checking in \end will work.
4455 % To end an @example-like environment, we first end the paragraph (via
4456 % \afterenvbreak's vertical glue), and then the group. That way we keep
4457 % the zero \parskip that the environments set -- \parskip glue will be
4458 % inserted at the beginning of the next paragraph in the document, after
4461 \def\nonfillfinish{\afterenvbreak\endgroup}
4463 % @lisp: indented, narrowed, typewriter font.
4464 \def\lisp{\begingroup
4466 \let\Elisp = \nonfillfinish
4468 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4469 \gobble % eat return
4472 % @example: Same as @lisp.
4473 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4475 % @small... is usually equivalent to the non-small (@smallbook
4476 % redefines). We must call \example (or whatever) last in the
4477 % definition, since it reads the return following the @example (or
4478 % whatever) command.
4480 % This actually allows (for example) @end display inside an
4481 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4483 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4484 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4485 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4486 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4488 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4489 % Originally contributed by Pavel@xerox.
4490 \def\smalllispx{\begingroup
4491 \def\Esmalllisp{\nonfillfinish\endgroup}%
4492 \def\Esmallexample{\nonfillfinish\endgroup}%
4497 % @display: same as @lisp except keep current font.
4499 \def\display{\begingroup
4501 \let\Edisplay = \nonfillfinish
4505 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4507 \def\smalldisplayx{\begingroup
4508 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4509 \smallexamplefonts \rm
4513 % @format: same as @display except don't narrow margins.
4515 \def\format{\begingroup
4516 \let\nonarrowing = t
4518 \let\Eformat = \nonfillfinish
4522 % @smallformat (when @smallbook): @format plus smaller fonts.
4524 \def\smallformatx{\begingroup
4525 \def\Esmallformat{\nonfillfinish\endgroup}%
4526 \smallexamplefonts \rm
4530 % @flushleft (same as @format).
4532 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4536 \def\flushright{\begingroup
4537 \let\nonarrowing = t
4539 \let\Eflushright = \nonfillfinish
4540 \advance\leftskip by 0pt plus 1fill
4545 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4546 % and narrows the margins.
4549 \begingroup\inENV %This group ends at the end of the @quotation body
4550 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4552 % We have retained a nonzero parskip for the environment, since we're
4553 % doing normal filling. So to avoid extra space below the environment...
4554 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4556 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4557 \ifx\nonarrowing\relax
4558 \advance\leftskip by \lispnarrowing
4559 \advance\rightskip by \lispnarrowing
4560 \exdentamount = \lispnarrowing
4561 \let\nonarrowing = \relax
4566 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4567 % If we want to allow any <char> as delimiter,
4568 % we need the curly braces so that makeinfo sees the @verb command, eg:
4569 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4571 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4573 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4574 % active too. Otherwise, they get lost as the first character on a
4577 \do\ \do\\\do\{\do\}\do\$\do\&%
4578 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4579 \do\<\do\>\do\|\do\@\do+\do\"%
4583 \def\uncatcodespecials{%
4584 \def\do##1{\catcode`##1=12}\dospecials}
4586 % [Knuth] pp. 380,381,391
4587 % Disable Spanish ligatures ?` and !` of \tt font
4589 \catcode`\`=\active\gdef`{\relax\lq}
4592 % Setup for the @verb command.
4594 % Eight spaces for a tab
4596 \catcode`\^^I=\active
4597 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4601 \tt % easiest (and conventionally used) font for verbatim
4602 \def\par{\leavevmode\endgraf}%
4605 % Respect line breaks,
4606 % print special symbols as themselves, and
4607 % make each space count
4608 % must do in this order:
4609 \obeylines \uncatcodespecials \sepspaces
4612 % Setup for the @verbatim environment
4614 % Real tab expansion
4615 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4617 \def\starttabbox{\setbox0=\hbox\bgroup}
4619 \catcode`\^^I=\active
4621 \catcode`\^^I=\active
4622 \def^^I{\leavevmode\egroup
4623 \dimen0=\wd0 % the width so far, or since the previous tab
4624 \divide\dimen0 by\tabw
4625 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4626 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4627 \wd0=\dimen0 \box0 \starttabbox
4631 \def\setupverbatim{%
4632 % Easiest (and conventionally used) font for verbatim
4634 \def\par{\leavevmode\egroup\box0\endgraf}%
4637 % Respect line breaks,
4638 % print special symbols as themselves, and
4639 % make each space count
4640 % must do in this order:
4641 \obeylines \uncatcodespecials \sepspaces
4642 \everypar{\starttabbox}%
4645 % Do the @verb magic: verbatim text is quoted by unique
4646 % delimiter characters. Before first delimiter expect a
4647 % right brace, after last delimiter expect closing brace:
4649 % \def\doverb'{'<char>#1<char>'}'{#1}
4651 % [Knuth] p. 382; only eat outer {}
4653 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4654 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4657 \def\verb{\begingroup\setupverb\doverb}
4660 % Do the @verbatim magic: define the macro \doverbatim so that
4661 % the (first) argument ends when '@end verbatim' is reached, ie:
4663 % \def\doverbatim#1@end verbatim{#1}
4665 % For Texinfo it's a lot easier than for LaTeX,
4666 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4667 % we need not redefine '\', '{' and '}'.
4669 % Inspired by LaTeX's verbatim command set [latex.ltx]
4670 %% Include LaTeX hack for completeness -- never know
4672 %% \catcode`|=0 \catcode`[=1
4673 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4674 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4675 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4681 % ignore everything up to the first ^^M, that's the newline at the end
4682 % of the @verbatim input line itself. Otherwise we get an extra blank
4683 % line in the output.
4684 \gdef\doverbatim#1^^M#2@end verbatim{#2\end{verbatim}}%
4688 \def\Everbatim{\nonfillfinish\endgroup}%
4691 \advance\leftskip by -\defbodyindent
4692 \begingroup\setupverbatim\doverbatim
4695 % @verbatiminclude FILE - insert text of file in verbatim environment.
4697 % Allow normal characters that we make active in the argument (a file name).
4698 \def\verbatiminclude{%
4708 \parsearg\doverbatiminclude
4710 \def\setupverbatiminclude{%
4713 \advance\leftskip by -\defbodyindent
4714 \begingroup\setupverbatim
4717 \def\doverbatiminclude#1{%
4718 % Restore active chars for included file.
4722 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4723 \endgroup\nonfillfinish\endgroup
4726 % @copying ... @end copying.
4727 % Save the text away for @insertcopying later. Many commands won't be
4728 % allowed in this context, but that's ok.
4730 % We save the uninterpreted tokens, rather than creating a box.
4731 % Saving the text in a box would be much easier, but then all the
4732 % typesetting commands (@smallbook, font changes, etc.) have to be done
4733 % beforehand -- and a) we want @copying to be done first in the source
4734 % file; b) letting users define the frontmatter in as flexible order as
4735 % possible is very desirable.
4737 \def\copying{\begingroup
4738 % Define a command to swallow text until we reach `@end copying'.
4739 % \ is the escape char in this texinfo.tex file, so it is the
4740 % delimiter for the command; @ will be the escape char when we read
4741 % it, but that doesn't matter.
4742 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4744 % We must preserve ^^M's in the input file; see \insertcopying below.
4745 \catcode`\^^M = \active
4749 % What we do to finish off the copying text.
4751 \def\enddocopying{\endgroup\ignorespaces}
4753 % @insertcopying. Here we must play games with ^^M's. On the one hand,
4754 % we need them to delimit commands such as `@end quotation', so they
4755 % must be active. On the other hand, we certainly don't want every
4756 % end-of-line to be a \par, as would happen with the normal active
4757 % definition of ^^M. On the third hand, two ^^M's in a row should still
4760 % Our approach is to make ^^M insert a space and a penalty1 normally;
4761 % then it can also check if \lastpenalty=1. If it does, then manually
4764 % This messes up the normal definitions of @c[omment], so we redefine
4765 % it. Similarly for @ignore. (These commands are used in the gcc
4766 % manual for man page generation.)
4768 % Seems pretty fragile, most line-oriented commands will presumably
4769 % fail, but for the limited use of getting the copying text (which
4770 % should be quite simple) inserted, we can hope it's ok.
4772 {\catcode`\^^M=\active %
4773 \gdef\insertcopying{\begingroup %
4774 \parindent = 0pt % looks wrong on title page
4776 \ifnum \lastpenalty=1 %
4783 % Fix @c[omment] for catcode 13 ^^M's.
4784 \def\c##1^^M{\ignorespaces}%
4787 % Don't bother jumping through all the hoops that \doignore does, it
4788 % would be very hard since the catcodes are already set.
4789 \long\def\ignore##1\end ignore{\ignorespaces}%
4798 % Allow user to change definition object font (\df) internally
4799 \def\setdeffont#1 {\csname DEF#1\endcsname}
4801 \newskip\defbodyindent \defbodyindent=.4in
4802 \newskip\defargsindent \defargsindent=50pt
4803 \newskip\deflastargmargin \deflastargmargin=18pt
4805 \newcount\parencount
4807 % We want ()&[] to print specially on the defun line.
4810 \catcode`\(=\active \catcode`\)=\active
4812 \catcode`\[=\active \catcode`\]=\active
4815 % Make control sequences which act like normal parenthesis chars.
4816 \let\lparen = ( \let\rparen = )
4818 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4820 % Be sure that we always have a definition for `(', etc. For example,
4821 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4822 % so TeX would otherwise complain about undefined control sequence.
4823 \global\let(=\lparen \global\let)=\rparen
4824 \global\let[=\lbrack \global\let]=\rbrack
4826 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4827 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4828 % This is used to turn on special parens
4829 % but make & act ordinary (given that it's active).
4830 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4832 % Definitions of (, ) and & used in args for functions.
4833 % This is the definition of ( outside of all parentheses.
4834 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4835 \global\advance\parencount by 1
4838 % This is the definition of ( when already inside a level of parens.
4839 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4841 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4842 % also in that case restore the outer-level definition of (.
4843 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4844 \global\advance \parencount by -1 }
4845 % If we encounter &foo, then turn on ()-hacking afterwards
4846 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
4848 \gdef\normalparens{\boldbrax\let&=\ampnr}
4849 } % End of definition inside \activeparens
4850 %% These parens (in \boldbrax) actually are a little bolder than the
4851 %% contained text. This is especially needed for [ and ]
4852 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4853 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4855 \def\lbrb{{\bf\char`\[}}
4856 \def\rbrb{{\bf\char`\]}}
4858 % Active &'s sneak into the index arguments, so make sure it's defined.
4861 \global\let& = \ampnr
4864 % \defname, which formats the name of the @def (not the args).
4865 % #1 is the function name.
4866 % #2 is the type of definition, such as "Function".
4869 % How we'll output the type name. Putting it in brackets helps
4870 % distinguish it from the body text that may end up on the next line
4875 \def\defnametype{[\rm #2]}%
4878 % Get the values of \leftskip and \rightskip as they were outside the @def...
4880 \advance\dimen2 by -\defbodyindent
4882 % Figure out values for the paragraph shape.
4883 \setbox0=\hbox{\hskip \deflastargmargin{\defnametype}}%
4884 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4885 \dimen1=\hsize \advance \dimen1 by -\defargsindent % size for continuations
4886 \parshape 2 0in \dimen0 \defargsindent \dimen1
4888 % Output arg 2 ("Function" or some such) but stuck inside a box of
4889 % width 0 so it does not interfere with linebreaking.
4892 {% Adjust \hsize to exclude the ambient margins,
4893 % so that \rightline will obey them.
4894 \advance \hsize by -\dimen2
4895 \dimen3 = 0pt % was -1.25pc
4896 \rlap{\rightline{\defnametype\kern\dimen3}}%
4899 % Allow all lines to be underfull without complaint:
4900 \tolerance=10000 \hbadness=10000
4901 \advance\leftskip by -\defbodyindent
4902 \exdentamount=\defbodyindent
4903 {\df #1}\enskip % output function name
4904 % \defunargs will be called next to output the arguments, if any.
4907 % Common pieces to start any @def...
4908 % #1 is the \E... control sequence to end the definition (which we define).
4909 % #2 is the \...x control sequence (which our caller defines).
4910 % #3 is the control sequence to process the header, such as \defunheader.
4912 \def\parsebodycommon#1#2#3{%
4914 % If there are two @def commands in a row, we'll have a \nobreak,
4915 % which is there to keep the function description together with its
4916 % header. But if there's nothing but headers, we want to allow a
4918 \ifnum\lastpenalty=10000 \penalty0 \fi
4921 % Define the \E... end token that this defining construct specifies
4922 % so that it will exit this group.
4923 \def#1{\endgraf\endgroup\medbreak}%
4926 \advance\leftskip by \defbodyindent
4927 \exdentamount=\defbodyindent
4930 % Common part of the \...x definitions.
4932 \def\defxbodycommon{%
4933 % As with \parsebodycommon above, allow line break if we have multiple
4934 % x headers in a row. It's not a great place, though.
4935 \ifnum\lastpenalty=10000 \penalty1000 \fi
4937 \begingroup\obeylines
4940 % Process body of @defun, @deffn, @defmac, etc.
4942 \def\defparsebody#1#2#3{%
4943 \parsebodycommon{#1}{#2}{#3}%
4944 \def#2{\defxbodycommon \activeparens \spacesplit#3}%
4945 \catcode61=\active % 61 is `='
4946 \begingroup\obeylines\activeparens
4950 % #1, #2, #3 are the common arguments (see \parsebodycommon above).
4951 % #4, delimited by the space, is the class name.
4953 \def\defmethparsebody#1#2#3#4 {%
4954 \parsebodycommon{#1}{#2}{#3}%
4955 \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}%
4956 \begingroup\obeylines\activeparens
4957 % The \empty here prevents misinterpretation of a construct such as
4958 % @deffn {whatever} {Enharmonic comma}
4959 % See comments at \deftpparsebody, although in our case we don't have
4960 % to remove the \empty afterwards, since it is empty.
4961 \spacesplit{#3{#4}}\empty
4964 % Used for @deftypemethod and @deftypeivar.
4965 % #1, #2, #3 are the common arguments (see \defparsebody).
4966 % #4, delimited by a space, is the class name.
4967 % #5 is the method's return type.
4969 \def\deftypemethparsebody#1#2#3#4 #5 {%
4970 \parsebodycommon{#1}{#2}{#3}%
4971 \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}%
4972 \begingroup\obeylines\activeparens
4973 \spacesplit{#3{#4}{#5}}%
4976 % Used for @deftypeop. The change from \deftypemethparsebody is an
4977 % extra argument at the beginning which is the `category', instead of it
4978 % being the hardwired string `Method' or `Instance Variable'. We have
4979 % to account for this both in the \...x definition and in parsing the
4980 % input at hand. Thus also need a control sequence (passed as #5) for
4981 % the \E... definition to assign the category name to.
4983 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
4984 \parsebodycommon{#1}{#2}{#3}%
4985 \def#2##1 ##2 ##3 {\def#4{##1}%
4986 \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}%
4987 \begingroup\obeylines\activeparens
4988 \spacesplit{#3{#5}{#6}}%
4992 \def\defopparsebody #1#2#3#4#5 {%
4993 \parsebodycommon{#1}{#2}{#3}%
4994 \def#2##1 ##2 {\def#4{##1}%
4995 \defxbodycommon \activeparens \spacesplit{#3{##2}}}%
4996 \begingroup\obeylines\activeparens
4997 \spacesplit{#3{#5}}%
5000 % These parsing functions are similar to the preceding ones
5001 % except that they do not make parens into active characters.
5002 % These are used for "variables" since they have no arguments.
5004 \def\defvarparsebody #1#2#3{%
5005 \parsebodycommon{#1}{#2}{#3}%
5006 \def#2{\defxbodycommon \spacesplit#3}%
5007 \catcode61=\active %
5008 \begingroup\obeylines
5013 \def\defopvarparsebody #1#2#3#4#5 {%
5014 \parsebodycommon{#1}{#2}{#3}%
5015 \def#2##1 ##2 {\def#4{##1}%
5016 \defxbodycommon \spacesplit{#3{##2}}}%
5017 \begingroup\obeylines
5018 \spacesplit{#3{#5}}%
5021 \def\defvrparsebody#1#2#3#4 {%
5022 \parsebodycommon{#1}{#2}{#3}%
5023 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5024 \begingroup\obeylines
5025 \spacesplit{#3{#4}}%
5028 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
5029 % type is just `struct', because we lose the braces in `{struct
5030 % termios}' when \spacesplit reads its undelimited argument. Sigh.
5031 % \let\deftpparsebody=\defvrparsebody
5033 % So, to get around this, we put \empty in with the type name. That
5034 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5035 % won't strip off the braces.
5037 \def\deftpparsebody #1#2#3#4 {%
5038 \parsebodycommon{#1}{#2}{#3}%
5039 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5040 \begingroup\obeylines
5041 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
5044 % Fine, but then we have to eventually remove the \empty *and* the
5045 % braces (if any). That's what this does.
5047 \def\removeemptybraces\empty#1\relax{#1}
5049 % After \spacesplit has done its work, this is called -- #1 is the final
5050 % thing to call, #2 the type name (which starts with \empty), and #3
5051 % (which might be empty) the arguments.
5053 \def\parsetpheaderline#1#2#3{%
5054 #1{\removeemptybraces#2\relax}{#3}%
5057 % Split up #2 (the rest of the input line) at the first space token.
5058 % call #1 with two arguments:
5059 % the first is all of #2 before the space token,
5060 % the second is all of #2 after that space token.
5061 % If #2 contains no space token, all of it is passed as the first arg
5062 % and the second is passed as empty.
5065 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}%
5066 \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{%
5076 % First, define the processing that is wanted for arguments of \defun
5077 % Use this to expand the args and terminate the paragraph they make up
5079 \def\defunargs#1{\functionparens \sl
5080 % Expand, preventing hyphenation at `-' chars.
5081 % Note that groups don't affect changes in \hyphenchar.
5082 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5083 {\tensl\hyphenchar\font=0}%
5085 {\tensl\hyphenchar\font=45}%
5086 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
5087 \interlinepenalty=10000
5088 \advance\rightskip by 0pt plus 1fil
5089 \endgraf\nobreak\vskip -\parskip\nobreak
5092 \def\deftypefunargs #1{%
5093 % Expand, preventing hyphenation at `-' chars.
5094 % Note that groups don't affect changes in \hyphenchar.
5095 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
5097 \tclose{#1}% avoid \code because of side effects on active chars
5098 \interlinepenalty=10000
5099 \advance\rightskip by 0pt plus 1fil
5100 \endgraf\nobreak\vskip -\parskip\nobreak
5103 % Do complete processing of one @defun or @defunx line already parsed.
5105 % @deffn Command forward-char nchars
5107 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
5109 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
5110 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
5111 \catcode 61=\other % Turn off change made in \defparsebody
5114 % @defun == @deffn Function
5116 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5118 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5119 \begingroup\defname {#1}{\putwordDeffunc}%
5120 \defunargs {#2}\endgroup %
5121 \catcode 61=\other % Turn off change made in \defparsebody
5124 % @deftypefun int foobar (int @var{foo}, float @var{bar})
5126 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
5128 % #1 is the data type. #2 is the name and args.
5129 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
5130 % #1 is the data type, #2 the name, #3 the args.
5131 \def\deftypefunheaderx #1#2 #3\relax{%
5132 \doind {fn}{\code{#2}}% Make entry in function index
5133 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
5134 \deftypefunargs {#3}\endgroup %
5135 \catcode 61=\other % Turn off change made in \defparsebody
5138 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
5140 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
5142 % \defheaderxcond#1\relax$.$
5143 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
5144 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
5146 % #1 is the classification. #2 is the data type. #3 is the name and args.
5147 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
5148 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5149 \def\deftypefnheaderx #1#2#3 #4\relax{%
5150 \doind {fn}{\code{#3}}% Make entry in function index
5152 \normalparens % notably, turn off `&' magic, which prevents
5153 % at least some C++ text from working
5154 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
5155 \deftypefunargs {#4}\endgroup %
5156 \catcode 61=\other % Turn off change made in \defparsebody
5159 % @defmac == @deffn Macro
5161 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5163 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5164 \begingroup\defname {#1}{\putwordDefmac}%
5165 \defunargs {#2}\endgroup %
5166 \catcode 61=\other % Turn off change made in \defparsebody
5169 % @defspec == @deffn Special Form
5171 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5173 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5174 \begingroup\defname {#1}{\putwordDefspec}%
5175 \defunargs {#2}\endgroup %
5176 \catcode 61=\other % Turn off change made in \defparsebody
5179 % @defop CATEGORY CLASS OPERATION ARG...
5181 \def\defop #1 {\def\defoptype{#1}%
5182 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5184 \def\defopheader#1#2#3{%
5185 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
5186 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
5187 \defunargs {#3}\endgroup %
5190 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5192 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5193 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5196 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5197 \def\deftypeopheader#1#2#3#4{%
5198 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5200 \defname{\defheaderxcond#2\relax$.$#3}
5201 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5202 \deftypefunargs{#4}%
5206 % @deftypemethod CLASS TYPE METHOD ARG...
5208 \def\deftypemethod{%
5209 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5211 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5212 \def\deftypemethodheader#1#2#3#4{%
5213 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5215 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5216 \deftypefunargs{#4}%
5220 % @deftypeivar CLASS TYPE VARNAME
5223 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5225 % #1 is the class name, #2 the data type, #3 the variable name.
5226 \def\deftypeivarheader#1#2#3{%
5227 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5229 \defname{\defheaderxcond#2\relax$.$#3}
5230 {\putwordInstanceVariableof\ \code{#1}}%
5235 % @defmethod == @defop Method
5237 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5239 % #1 is the class name, #2 the method name, #3 the args.
5240 \def\defmethodheader#1#2#3{%
5241 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5243 \defname{#2}{\putwordMethodon\ \code{#1}}%
5248 % @defcv {Class Option} foo-class foo-flag
5250 \def\defcv #1 {\def\defcvtype{#1}%
5251 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5253 \def\defcvarheader #1#2#3{%
5254 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5255 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5256 \defvarargs {#3}\endgroup %
5259 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5261 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5263 \def\defivarheader#1#2#3{%
5264 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5266 \defname{#2}{\putwordInstanceVariableof\ #1}%
5272 % First, define the processing that is wanted for arguments of @defvar.
5273 % This is actually simple: just print them in roman.
5274 % This must expand the args and terminate the paragraph they make up
5275 \def\defvarargs #1{\normalparens #1%
5276 \interlinepenalty=10000
5277 \endgraf\nobreak\vskip -\parskip\nobreak}
5279 % @defvr Counter foo-count
5281 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5283 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5284 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5286 % @defvar == @defvr Variable
5288 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5290 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5291 \begingroup\defname {#1}{\putwordDefvar}%
5292 \defvarargs {#2}\endgroup %
5295 % @defopt == @defvr {User Option}
5297 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5299 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5300 \begingroup\defname {#1}{\putwordDefopt}%
5301 \defvarargs {#2}\endgroup %
5304 % @deftypevar int foobar
5306 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5308 % #1 is the data type. #2 is the name, perhaps followed by text that
5309 % is actually part of the data type, which should not be put into the index.
5310 \def\deftypevarheader #1#2{%
5311 \dovarind#2 \relax% Make entry in variables index
5312 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5313 \interlinepenalty=10000
5314 \endgraf\nobreak\vskip -\parskip\nobreak
5316 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5318 % @deftypevr {Global Flag} int enable
5320 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5322 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5323 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5324 \interlinepenalty=10000
5325 \endgraf\nobreak\vskip -\parskip\nobreak
5329 % Args are printed in bold, a slight difference from @defvar.
5331 \def\deftpargs #1{\bf \defvarargs{#1}}
5333 % @deftp Class window height width ...
5335 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5337 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5338 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5340 % These definitions are used if you use @defunx (etc.)
5341 % anywhere other than immediately after a @defun or @defunx.
5343 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5344 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5345 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5346 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5347 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5348 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5349 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5350 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5351 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5352 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5353 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5354 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5355 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5356 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5357 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5358 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5359 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5360 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5361 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5367 % To do this right we need a feature of e-TeX, \scantokens,
5368 % which we arrange to emulate with a temporary file in ordinary TeX.
5369 \ifx\eTeXversion\undefined
5370 \newwrite\macscribble
5372 \begingroup \newlinechar`\^^M
5373 % Undo catcode changes of \startcontents and \doprintindex
5374 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5375 % Append \endinput to make sure that TeX does not see the ending newline.
5376 \toks0={#1\endinput}%
5377 \immediate\openout\macscribble=\jobname.tmp
5378 \immediate\write\macscribble{\the\toks0}%
5379 \immediate\closeout\macscribble
5380 \let\xeatspaces\eatspaces
5386 \begingroup \newlinechar`\^^M
5387 % Undo catcode changes of \startcontents and \doprintindex
5388 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5389 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5392 \newcount\paramno % Count of parameters
5393 \newtoks\macname % Macro name
5394 \newif\ifrecursive % Is it recursive?
5395 \def\macrolist{} % List of all defined macros in the form
5396 % \do\macro1\do\macro2...
5399 % Thisdoes \let #1 = #2, except with \csnames.
5401 \expandafter\expandafter
5403 \expandafter\expandafter
5405 \csname#2\endcsname}
5407 % Trim leading and trailing spaces off a string.
5408 % Concepts from aro-bend problem 15 (see CTAN).
5410 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5411 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5412 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5414 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5417 % Trim a single trailing ^^M off a string.
5418 {\catcode`\^^M=12\catcode`\Q=3%
5419 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5420 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5421 \gdef\eatcrb#1Q#2Q{#1}%
5424 % Macro bodies are absorbed as an argument in a context where
5425 % all characters are catcode 10, 11 or 12, except \ which is active
5426 % (as in normal texinfo). It is necessary to change the definition of \.
5428 % It's necessary to have hard CRs when the macro is executed. This is
5429 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5430 % body, and then making it the \newlinechar in \scanmacro.
5432 \def\macrobodyctxt{%
5457 % \mbodybackslash is the definition of \ in @macro bodies.
5458 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5459 % where N is the macro parameter number.
5460 % We define \csname macarg.\endcsname to be \realbackslash, so
5461 % \\ in macro replacement text gets you a backslash.
5463 {\catcode`@=0 @catcode`@\=@active
5464 @gdef@usembodybackslash{@let\=@mbodybackslash}
5465 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5467 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5469 \def\macro{\recursivefalse\parsearg\macroxxx}
5470 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5473 \getargs{#1}% now \macname is the macname and \argl the arglist
5474 \ifx\argl\empty % no arguments
5477 \expandafter\parsemargdef \argl;%
5479 \if1\csname ismacro.\the\macname\endcsname
5480 \message{Warning: redefining \the\macname}%
5482 \expandafter\ifx\csname \the\macname\endcsname \relax
5483 \else \errmessage{Macro name \the\macname\space already defined}\fi
5484 \global\cslet{macsave.\the\macname}{\the\macname}%
5485 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5486 % Add the macroname to \macrolist
5487 \toks0 = \expandafter{\macrolist\do}%
5488 \xdef\macrolist{\the\toks0
5489 \expandafter\noexpand\csname\the\macname\endcsname}%
5491 \begingroup \macrobodyctxt
5492 \ifrecursive \expandafter\parsermacbody
5493 \else \expandafter\parsemacbody
5496 \def\unmacro{\parsearg\unmacroxxx}
5498 \if1\csname ismacro.#1\endcsname
5499 \global\cslet{#1}{macsave.#1}%
5500 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5501 % Remove the macro name from \macrolist
5503 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5509 \toks0 = \expandafter{\newmacrolist\do}%
5510 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5512 \def\newmacrolist{}%
5513 % Execute macro list to define \newmacrolist
5515 \global\let\macrolist\newmacrolist
5518 \errmessage{Macro #1 not defined}%
5522 % This makes use of the obscure feature that if the last token of a
5523 % <parameter list> is #, then the preceding argument is delimited by
5524 % an opening brace, and that opening brace is not consumed.
5525 \def\getargs#1{\getargsxxx#1{}}
5526 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5527 \def\getmacname #1 #2\relax{\macname={#1}}
5528 \def\getmacargs#1{\def\argl{#1}}
5530 % Parse the optional {params} list. Set up \paramno and \paramlist
5531 % so \defmacro knows what to do. Define \macarg.blah for each blah
5532 % in the params list, to be ##N where N is the position in that list.
5533 % That gets used by \mbodybackslash (above).
5535 % We need to get `macro parameter char #' into several definitions.
5536 % The technique used is stolen from LaTeX: let \hash be something
5537 % unexpandable, insert that wherever you need a #, and then redefine
5538 % it to # just before using the token list produced.
5540 % The same technique is used to protect \eatspaces till just before
5541 % the macro is used.
5543 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5544 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5545 \def\parsemargdefxxx#1,{%
5546 \if#1;\let\next=\relax
5547 \else \let\next=\parsemargdefxxx
5548 \advance\paramno by 1%
5549 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5550 {\xeatspaces{\hash\the\paramno}}%
5551 \edef\paramlist{\paramlist\hash\the\paramno,}%
5554 % These two commands read recursive and nonrecursive macro bodies.
5555 % (They're different since rec and nonrec macros end differently.)
5557 \long\def\parsemacbody#1@end macro%
5558 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5559 \long\def\parsermacbody#1@end rmacro%
5560 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5562 % This defines the macro itself. There are six cases: recursive and
5563 % nonrecursive macros of zero, one, and many arguments.
5564 % Much magic with \expandafter here.
5565 % \xdef is used so that macro definitions will survive the file
5566 % they're defined in; @include reads the file inside a group.
5568 \let\hash=##% convert placeholders to macro parameter chars
5572 \expandafter\xdef\csname\the\macname\endcsname{%
5573 \noexpand\scanmacro{\temp}}%
5575 \expandafter\xdef\csname\the\macname\endcsname{%
5576 \bgroup\noexpand\macroargctxt
5577 \noexpand\braceorline
5578 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5579 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5580 \egroup\noexpand\scanmacro{\temp}}%
5582 \expandafter\xdef\csname\the\macname\endcsname{%
5583 \bgroup\noexpand\macroargctxt
5584 \noexpand\csname\the\macname xx\endcsname}%
5585 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5586 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5587 \expandafter\expandafter
5589 \expandafter\expandafter
5590 \csname\the\macname xxx\endcsname
5591 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5596 \expandafter\xdef\csname\the\macname\endcsname{%
5597 \noexpand\norecurse{\the\macname}%
5598 \noexpand\scanmacro{\temp}\egroup}%
5600 \expandafter\xdef\csname\the\macname\endcsname{%
5601 \bgroup\noexpand\macroargctxt
5602 \noexpand\braceorline
5603 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5604 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5606 \noexpand\norecurse{\the\macname}%
5607 \noexpand\scanmacro{\temp}\egroup}%
5609 \expandafter\xdef\csname\the\macname\endcsname{%
5610 \bgroup\noexpand\macroargctxt
5611 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5612 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5613 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5614 \expandafter\expandafter
5616 \expandafter\expandafter
5617 \csname\the\macname xxx\endcsname
5620 \noexpand\norecurse{\the\macname}%
5621 \noexpand\scanmacro{\temp}\egroup}%
5625 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5627 % \braceorline decides whether the next nonwhitespace character is a
5628 % {. If so it reads up to the closing }, if not, it reads the whole
5629 % line. Whatever was read is then fed to the next control sequence
5630 % as an argument (by \parsebrace or \parsearg)
5631 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5632 \def\braceorlinexxx{%
5633 \ifx\nchar\bgroup\else
5634 \expandafter\parsearg
5637 % We mant to disable all macros during \shipout so that they are not
5638 % expanded by \write.
5639 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5640 \edef\next{\macrolist}\expandafter\endgroup\next}
5644 % We need some trickery to remove the optional spaces around the equal
5645 % sign. Just make them active and then expand them all to nothing.
5646 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5647 \def\aliasxxx #1{\aliasyyy#1\relax}
5648 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5649 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5650 \expandafter\noexpand\csname#2\endcsname}%
5651 \expandafter\endgroup\next}
5654 \message{cross references,}
5659 \newif\ifhavexrefs % True if xref values are known.
5660 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5662 % @inforef is relatively simple.
5663 \def\inforef #1{\inforefzzz #1,,,,**}
5664 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5665 node \samp{\ignorespaces#1{}}}
5667 % @node's job is to define \lastnode.
5668 \def\node{\ENVcheck\parsearg\nodezzz}
5669 \def\nodezzz#1{\nodexxx [#1,]}
5670 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5672 \let\lastnode=\relax
5674 % The sectioning commands (@chapter, etc.) call these.
5676 \ifx\lastnode\relax\else
5677 \expandafter\expandafter\expandafter\setref{\lastnode}%
5678 {Ysectionnumberandtype}%
5679 \global\let\lastnode=\relax
5682 \def\unnumbnoderef{%
5683 \ifx\lastnode\relax\else
5684 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5685 \global\let\lastnode=\relax
5688 \def\appendixnoderef{%
5689 \ifx\lastnode\relax\else
5690 \expandafter\expandafter\expandafter\setref{\lastnode}%
5691 {Yappendixletterandtype}%
5692 \global\let\lastnode=\relax
5697 % @anchor{NAME} -- define xref target at arbitrary point.
5699 \newcount\savesfregister
5700 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5701 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5702 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5704 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5705 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5706 % to set \indexdummies so commands such as @code in a section title
5707 % aren't expanded. It would be nicer not to expand the titles in the
5708 % first place, but there's so many layers that that is hard to do.
5713 \dosetq{#1-title}{Ytitle}%
5714 \dosetq{#1-pg}{Ypagenumber}%
5715 \dosetq{#1-snt}{#2}%
5718 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5719 % the node name, #2 the name of the Info cross-reference, #3 the printed
5720 % node name, #4 the name of the Info file, #5 the name of the printed
5721 % manual. All but the node name can be omitted.
5723 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5724 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5725 \def\ref#1{\xrefX[#1,,,,,,,]}
5726 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5728 \def\printedmanual{\ignorespaces #5}%
5729 \def\printednodename{\ignorespaces #3}%
5730 \setbox1=\hbox{\printedmanual}%
5731 \setbox0=\hbox{\printednodename}%
5733 % No printed node name was explicitly given.
5734 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5735 % Use the node name inside the square brackets.
5736 \def\printednodename{\ignorespaces #1}%
5738 % Use the actual chapter/section title appear inside
5739 % the square brackets. Use the real section title if we have it.
5741 % It is in another manual, so we don't have it.
5742 \def\printednodename{\ignorespaces #1}%
5745 % We know the real title if we have the xref values.
5746 \def\printednodename{\refx{#1-title}{}}%
5748 % Otherwise just copy the Info node name.
5749 \def\printednodename{\ignorespaces #1}%
5755 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5756 % insert empty discretionaries after hyphens, which means that it will
5757 % not find a line break at a hyphen in a node names. Since some manuals
5758 % are best written with fairly long node names, containing hyphens, this
5759 % is a loss. Therefore, we give the text of the node name again, so it
5760 % is as if TeX is seeing it for the first time.
5764 {\normalturnoffactive
5765 \ifnum\filenamelength>0
5766 \startlink attr{/Border [0 0 0]}%
5767 goto file{\the\filename.pdf} name{#1}%
5769 \startlink attr{/Border [0 0 0]}%
5777 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5779 % _ (for example) has to be the character _ for the purposes of the
5780 % control sequence corresponding to the node, but it has to expand
5781 % into the usual \leavevmode...\vrule stuff for purposes of
5782 % printing. So we \turnoffactive for the \refx-snt, back on for the
5783 % printing, back off for the \refx-pg.
5784 {\normalturnoffactive
5785 % Only output a following space if the -snt ref is nonempty; for
5786 % @unnumbered and @anchor, it won't be.
5787 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5788 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5791 [\printednodename],\space
5793 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5798 % \dosetq is the interface for calls from other macros
5800 % Use \normalturnoffactive so that punctuation chars such as underscore
5801 % and backslash work in node names. (\turnoffactive doesn't do \.)
5804 \normalturnoffactive
5805 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5812 % \internalsetq {foo}{page} expands into
5813 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5814 % When the aux file is read, ' is the escape character
5816 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5818 % Things to be expanded by \internalsetq
5820 \def\Ypagenumber{\folio}
5822 \def\Ytitle{\thissection}
5826 \def\Ysectionnumberandtype{%
5827 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5828 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5829 \else \ifnum \subsubsecno=0 %
5830 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5832 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5835 \def\Yappendixletterandtype{%
5836 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5837 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5838 \else \ifnum \subsubsecno=0 %
5839 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5841 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5846 % Use TeX 3.0's \inputlineno to get the line number, for better error
5847 % messages, but if we're using an old version of TeX, don't do anything.
5849 \ifx\inputlineno\thisisundefined
5850 \let\linenumber = \empty % Non-3.0.
5852 \def\linenumber{\the\inputlineno:\space}
5855 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5856 % If its value is nonempty, SUFFIX is output afterward.
5859 \expandafter\ifx\csname X#1\endcsname\relax
5860 % If not defined, say something at least.
5861 \angleleft un\-de\-fined\angleright
5864 \message{\linenumber Undefined cross reference `#1'.}%
5867 \global\warnedxrefstrue
5868 \message{Cross reference values unknown; you must run TeX again.}%
5873 % It's defined, so just use it.
5874 \csname X#1\endcsname
5876 #2% Output the suffix in any case.
5879 % This is the macro invoked by entries in the aux file.
5881 \def\xrdef#1{\begingroup
5882 % Reenable \ as an escape while reading the second argument.
5884 \afterassignment\endgroup
5885 \expandafter\gdef\csname X#1\endcsname
5888 % Read the last existing aux file, if any. No error if none exists.
5889 \def\readauxfile{\begingroup
5890 \catcode`\^^@=\other
5891 \catcode`\^^A=\other
5892 \catcode`\^^B=\other
5893 \catcode`\^^C=\other
5894 \catcode`\^^D=\other
5895 \catcode`\^^E=\other
5896 \catcode`\^^F=\other
5897 \catcode`\^^G=\other
5898 \catcode`\^^H=\other
5899 \catcode`\^^K=\other
5900 \catcode`\^^L=\other
5901 \catcode`\^^N=\other
5902 \catcode`\^^P=\other
5903 \catcode`\^^Q=\other
5904 \catcode`\^^R=\other
5905 \catcode`\^^S=\other
5906 \catcode`\^^T=\other
5907 \catcode`\^^U=\other
5908 \catcode`\^^V=\other
5909 \catcode`\^^W=\other
5910 \catcode`\^^X=\other
5911 \catcode`\^^Z=\other
5912 \catcode`\^^[=\other
5913 \catcode`\^^\=\other
5914 \catcode`\^^]=\other
5915 \catcode`\^^^=\other
5916 \catcode`\^^_=\other
5919 % It was suggested to define this as 7, which would allow ^^e4 etc.
5920 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5921 % supported in the main text, it doesn't seem desirable. Furthermore,
5922 % that is not enough: for node names that actually contain a ^
5923 % character, we would end up writing a line like this: 'xrdef {'hat
5924 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5925 % argument, and \hat is not an expandable control sequence. It could
5926 % all be worked out, but why? Either we support ^^ or we don't.
5928 % The other change necessary for this was to define \auxhat:
5929 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5930 % and then to call \auxhat in \setq.
5943 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5944 % Make the characters 128-255 be printing characters
5948 \catcode\count 1=\other
5949 \advance\count 1 by 1
5950 \ifnum \count 1<256 \loop \fi
5953 % The aux file uses ' as the escape (for now).
5954 % Turn off \ as an escape so we do not lose on
5955 % entries which were dumped with control sequences in their names.
5956 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5957 % Reference to such entries still does not work the way one would wish,
5958 % but at least they do not bomb out when the aux file is read in.
5965 \openin 1 \jobname.aux
5969 \global\havexrefstrue
5970 \global\warnedobstrue
5972 % Open the new aux file. TeX will close it automatically at exit.
5973 \openout\auxfile=\jobname.aux
5979 \newcount \footnoteno
5981 % The trailing space in the following definition for supereject is
5982 % vital for proper filling; pages come out unaligned when you do a
5983 % pagealignmacro call if that space before the closing brace is
5984 % removed. (Generally, numeric constants should always be followed by a
5985 % space to prevent strange expansion errors.)
5986 \def\supereject{\par\penalty -20000\footnoteno =0 }
5988 % @footnotestyle is meaningful for info output only.
5989 \let\footnotestyle=\comment
5991 \let\ptexfootnote=\footnote
5995 % Auto-number footnotes. Otherwise like plain.
5997 \global\advance\footnoteno by \@ne
5998 \edef\thisfootno{$^{\the\footnoteno}$}%
6000 % In case the footnote comes at the end of a sentence, preserve the
6001 % extra spacing after we do the footnote number.
6003 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
6005 % Remove inadvertent blank space before typesetting the footnote number.
6011 % Don't bother with the trickery in plain.tex to not require the
6012 % footnote text as a parameter. Our footnotes don't need to be so general.
6014 % Oh yes, they do; otherwise, @ifset and anything else that uses
6015 % \parseargline fail inside footnotes because the tokens are fixed when
6016 % the footnote is read. --karl, 16nov96.
6018 \long\gdef\footnotezzz{\insert\footins\bgroup
6019 % We want to typeset this text as a normal paragraph, even if the
6020 % footnote reference occurs in (for example) a display environment.
6021 % So reset some parameters.
6022 \interlinepenalty\interfootnotelinepenalty
6023 \splittopskip\ht\strutbox % top baseline for broken footnotes
6024 \splitmaxdepth\dp\strutbox
6025 \floatingpenalty\@MM
6030 \parindent\defaultparindent
6034 % Because we use hanging indentation in footnotes, a @noindent appears
6035 % to exdent this text, so make it be a no-op. makeinfo does not use
6036 % hanging indentation so @noindent can still be needed within footnote
6037 % text after an @example or the like (not that this is good style).
6038 \let\noindent = \relax
6040 % Hang the footnote text off the number. Use \everypar in case the
6041 % footnote extends for more than one paragraph.
6042 \everypar = {\hang}%
6043 \textindent{\thisfootno}%
6045 % Don't crash into the line above the footnote text. Since this
6046 % expands into a box, it must come within the paragraph, lest it
6047 % provide a place where TeX can split the footnote.
6049 \futurelet\next\fo@t
6051 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
6052 \else\let\next\f@t\fi \next}
6053 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
6054 \def\f@t#1{#1\@foot}
6055 \def\@foot{\strut\par\egroup}
6057 }%end \catcode `\@=11
6059 % @| inserts a changebar to the left of the current line. It should
6060 % surround any changed text. This approach does *not* work if the
6061 % change spans more than two lines of output. To handle that, we would
6062 % have adopt a much more difficult approach (putting marks into the main
6063 % vertical list for the beginning and end of each change).
6066 % \vadjust can only be used in horizontal mode.
6069 % Append this vertical mode material after the current line in the output.
6071 % We want to insert a rule with the height and depth of the current
6072 % leading; that is exactly what \strutbox is supposed to record.
6073 \vskip-\baselineskip
6075 % \vadjust-items are inserted at the left edge of the type. So
6076 % the \llap here moves out into the left-hand margin.
6079 % For a thicker or thinner bar, change the `1pt'.
6080 \vrule height\baselineskip width1pt
6082 % This is the space between the bar and the text.
6088 % For a final copy, take out the rectangles
6089 % that mark overfull boxes (in case you have decided
6090 % that the text looks ok even though it passes the margin).
6092 \def\finalout{\overfullrule=0pt}
6094 % @image. We use the macros from epsf.tex to support this.
6095 % If epsf.tex is not installed and @image is used, we complain.
6097 % Check for and read epsf.tex up front. If we read it only at @image
6098 % time, we might be inside a group, and then its definitions would get
6099 % undone and the next image would fail.
6100 \openin 1 = epsf.tex
6103 % Do not bother showing banner with post-v2.7 epsf.tex (available in
6104 % doc/epsf.tex until it shows up on ctan).
6105 \def\epsfannounce{\toks0 = }%
6109 % We will only complain once about lack of epsf.tex.
6110 \newif\ifwarnednoepsf
6111 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6112 work. It is also included in the Texinfo distribution, or you can get
6113 it from ftp://tug.org/tex/epsf.tex.}
6116 \ifx\epsfbox\undefined
6117 \ifwarnednoepsf \else
6118 \errhelp = \noepsfhelp
6119 \errmessage{epsf.tex not found, images will be ignored}%
6120 \global\warnednoepsftrue
6123 \imagexxx #1,,,,,\finish
6127 % Arguments to @image:
6128 % #1 is (mandatory) image filename; we tack on .eps extension.
6129 % #2 is (optional) width, #3 is (optional) height.
6130 % #4 is (ignored optional) html alt text.
6131 % #5 is (ignored optional) extension.
6132 % #6 is just the usual extra ignored arg for parsing this stuff.
6134 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6135 \catcode`\^^M = 5 % in case we're inside an example
6136 \normalturnoffactive % allow _ et al. in names
6137 % If the image is by itself, center it.
6141 % Usually we'll have text after the image which will insert
6142 % \parskip glue, so insert it here too to equalize the space
6144 \nobreak\vskip\parskip
6151 \dopdfimage{#1}{#2}{#3}%
6153 % \epsfbox itself resets \epsf?size at each figure.
6154 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6155 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6159 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6163 \message{localization,}
6166 % @documentlanguage is usually given very early, just after
6167 % @setfilename. If done too late, it may not override everything
6168 % properly. Single argument is the language abbreviation.
6169 % It would be nice if we could set up a hyphenation file here.
6171 \def\documentlanguage{\parsearg\dodocumentlanguage}
6172 \def\dodocumentlanguage#1{%
6173 \tex % read txi-??.tex file in plain TeX.
6174 % Read the file if it exists.
6175 \openin 1 txi-#1.tex
6177 \errhelp = \nolanghelp
6178 \errmessage{Cannot read language file txi-#1.tex}%
6181 \def\temp{\input txi-#1.tex }%
6186 \newhelp\nolanghelp{The given language definition file cannot be found or
6187 is empty. Maybe you need to install it? In the current directory
6188 should work if nowhere else does.}
6191 % @documentencoding should change something in TeX eventually, most
6192 % likely, but for now just recognize it.
6193 \let\documentencoding = \comment
6196 % Page size parameters.
6198 \newdimen\defaultparindent \defaultparindent = 15pt
6200 \chapheadingskip = 15pt plus 4pt minus 2pt
6201 \secheadingskip = 12pt plus 3pt minus 2pt
6202 \subsecheadingskip = 9pt plus 2pt minus 2pt
6204 % Prevent underfull vbox error messages.
6207 % Don't be so finicky about underfull hboxes, either.
6210 % Following George Bush, just get rid of widows and orphans.
6214 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6215 % using an old version of TeX, don't do anything. We want the amount of
6216 % stretch added to depend on the line length, hence the dependence on
6217 % \hsize. We call this whenever the paper size is set.
6219 \def\setemergencystretch{%
6220 \ifx\emergencystretch\thisisundefined
6221 % Allow us to assign to \emergencystretch anyway.
6222 \def\emergencystretch{\dimen0}%
6224 \emergencystretch = .15\hsize
6228 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6229 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6230 % physical page width.
6232 % We also call \setleading{\textleading}, so the caller should define
6233 % \textleading. The caller should also set \parskip.
6235 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6238 \splittopskip = \topskip
6241 \advance\vsize by \topskip
6242 \outervsize = \vsize
6243 \advance\outervsize by 2\topandbottommargin
6244 \pageheight = \vsize
6247 \outerhsize = \hsize
6248 \advance\outerhsize by 0.5in
6251 \normaloffset = #4\relax
6252 \bindingoffset = #5\relax
6255 \pdfpageheight #7\relax
6256 \pdfpagewidth #8\relax
6259 \setleading{\textleading}
6261 \parindent = \defaultparindent
6262 \setemergencystretch
6265 % Use `small' versions.
6267 \def\smallenvironments{%
6268 \let\smalldisplay = \smalldisplayx
6269 \let\smallexample = \smalllispx
6270 \let\smallformat = \smallformatx
6271 \let\smalllisp = \smalllispx
6274 % @letterpaper (the default).
6275 \def\letterpaper{{\globaldefs = 1
6276 \parskip = 3pt plus 2pt minus 1pt
6277 \textleading = 13.2pt
6279 % If page is nothing but text, make it come out even.
6280 \internalpagesizes{46\baselineskip}{6in}%
6282 {\bindingoffset}{36pt}%
6286 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6287 \def\smallbook{{\globaldefs = 1
6288 \parskip = 2pt plus 1pt
6291 \internalpagesizes{7.5in}{5in}%
6293 {\bindingoffset}{16pt}%
6296 \lispnarrowing = 0.3in
6299 \contentsrightmargin = 0pt
6300 \defbodyindent = .5cm
6304 % Use @afourpaper to print on European A4 paper.
6305 \def\afourpaper{{\globaldefs = 1
6306 \parskip = 3pt plus 2pt minus 1pt
6307 \textleading = 13.2pt
6309 % Double-side printing via postscript on Laserjet 4050
6310 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6311 % To change the settings for a different printer or situation, adjust
6312 % \normaloffset until the front-side and back-side texts align. Then
6313 % do the same for \bindingoffset. You can set these for testing in
6314 % your texinfo source file like this:
6316 % \global\normaloffset = -6mm
6317 % \global\bindingoffset = 10mm
6319 \internalpagesizes{51\baselineskip}{160mm}
6320 {\voffset}{\hoffset}%
6321 {\bindingoffset}{44pt}%
6326 \contentsrightmargin = 0pt
6327 \defbodyindent = 5mm
6330 % Use @afivepaper to print on European A5 paper.
6331 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6332 % He also recommends making @example and @lisp be small.
6333 \def\afivepaper{{\globaldefs = 1
6334 \parskip = 2pt plus 1pt minus 0.1pt
6335 \textleading = 12.5pt
6337 \internalpagesizes{160mm}{120mm}%
6338 {\voffset}{\hoffset}%
6339 {\bindingoffset}{8pt}%
6342 \lispnarrowing = 0.2in
6345 \contentsrightmargin = 0pt
6346 \defbodyindent = 2mm
6352 % A specific text layout, 24x15cm overall, intended for A4 paper.
6353 \def\afourlatex{{\globaldefs = 1
6355 \internalpagesizes{237mm}{150mm}%
6357 {\bindingoffset}{7mm}%
6360 % Must explicitly reset to 0 because we call \afourpaper.
6364 % Use @afourwide to print on A4 paper in landscape format.
6365 \def\afourwide{{\globaldefs = 1
6367 \internalpagesizes{241mm}{165mm}%
6368 {\voffset}{-2.95mm}%
6369 {\bindingoffset}{7mm}%
6374 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6375 % Perhaps we should allow setting the margins, \topskip, \parskip,
6376 % and/or leading, also. Or perhaps we should compute them somehow.
6378 \def\pagesizes{\parsearg\pagesizesxxx}
6379 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6380 \def\pagesizesyyy#1,#2,#3\finish{{%
6381 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6384 \parskip = 3pt plus 2pt minus 1pt
6385 \setleading{\textleading}%
6388 \advance\dimen0 by \voffset
6391 \advance\dimen2 by \normaloffset
6393 \internalpagesizes{#1}{\hsize}%
6394 {\voffset}{\normaloffset}%
6395 {\bindingoffset}{44pt}%
6399 % Set default to letter.
6404 \message{and turning on texinfo input format.}
6406 % Define macros to output various characters with catcode for normal text.
6416 \def\normaldoublequote{"}
6419 \def\normalunderscore{_}
6420 \def\normalverticalbar{|}
6422 \def\normalgreater{>}
6424 \def\normaldollar{$}%$ font-lock fix
6426 % This macro is used to make a character print one way in ttfont
6427 % where it can probably just be output, and another way in other fonts,
6428 % where something hairier probably needs to be done.
6430 % #1 is what to print if we are indeed using \tt; #2 is what to print
6431 % otherwise. Since all the Computer Modern typewriter fonts have zero
6432 % interword stretch (and shrink), and it is reasonable to expect all
6433 % typewriter fonts to have this, we can check that font parameter.
6435 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6437 % Same as above, but check for italic font. Actually this also catches
6438 % non-italic slanted fonts since it is impossible to distinguish them from
6439 % italic fonts. But since this is only used by $ and it uses \sl anyway
6440 % this is not a problem.
6441 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6443 % Turn off all special characters except @
6444 % (and those which the user can use as if they were ordinary).
6445 % Most of these we simply print from the \tt font, but for some, we can
6446 % use math or other variants that look better in normal text.
6449 \def\activedoublequote{{\tt\char34}}
6450 \let"=\activedoublequote
6452 \def~{{\tt\char126}}
6458 \def_{\ifusingtt\normalunderscore\_}
6459 % Subroutine for the previous macro.
6460 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6463 \def|{{\tt\char124}}
6471 \def+{{\tt \char 43}}
6473 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6474 %\catcode 27=\active
6475 %\def^^[{$\diamondsuit$}
6477 % Set up an active definition for =, but don't enable it most of the time.
6478 {\catcode`\==\active
6479 \global\def={{\tt \char 61}}}
6484 % If a .fmt file is being used, characters that might appear in a file
6485 % name cannot be active until we have parsed the command line.
6486 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6487 % \otherifyactive is called near the end of this file.
6488 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6492 % \rawbackslashxx output one backslash character in current font
6493 \global\chardef\rawbackslashxx=`\\
6494 %{\catcode`\\=\other
6495 %@gdef@rawbackslashxx{\}}
6497 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6498 {\catcode`\\=\active
6499 @gdef@rawbackslash{@let\=@rawbackslashxx }}
6501 % \normalbackslash outputs one backslash in fixed width font.
6502 \def\normalbackslash{{\tt\rawbackslashxx}}
6504 % \catcode 17=0 % Define control-q
6507 % Used sometimes to turn off (effectively) the active characters
6508 % even after parsing them.
6509 @def@turnoffactive{@let"=@normaldoublequote
6510 @let\=@realbackslash
6513 @let_=@normalunderscore
6514 @let|=@normalverticalbar
6516 @let>=@normalgreater
6518 @let$=@normaldollar}%$ font-lock fix
6520 % Same as @turnoffactive except for \.
6521 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6523 % Make _ and + \other characters, temporarily.
6524 % This is canceled by @fixbackslash.
6527 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6528 % That is what \eatinput is for; after that, the `\' should revert to printing
6531 @gdef@eatinput input texinfo{@fixbackslash}
6532 @global@let\ = @eatinput
6534 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6535 % the first `\{ in the file would cause an error. This macro tries to fix
6536 % that, assuming it is called before the first `\' could plausibly occur.
6537 % Also back turn on active characters that might appear in the input
6538 % file name, in case not using a pre-dumped format.
6540 @gdef@fixbackslash{%
6541 @ifx\@eatinput @let\ = @normalbackslash @fi
6546 % Say @foo, not \foo, in error messages.
6549 % These look ok in all fonts, so just make them not special.
6550 @catcode`@& = @other
6551 @catcode`@# = @other
6552 @catcode`@% = @other
6554 @c Set initial fonts.
6560 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6561 @c page-delimiter: "^\\\\message"
6562 @c time-stamp-start: "def\\\\texinfoversion{"
6563 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6564 @c time-stamp-end: "}"