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-23.10}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 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, to some
60 % extent. You can get the existing language-specific files from the
61 % full Texinfo distribution.
63 \message{Loading texinfo [version \texinfoversion]:}
65 % If in a .fmt file, print the version number
66 % and turn on active characters that we couldn't do earlier because
67 % they might have appeared in the input file name.
68 \everyjob{\message{[Texinfo version \texinfoversion]}%
69 \catcode`+=\active \catcode`\_=\active}
74 % We never want plain's outer \+ definition in Texinfo.
75 % For @tex, we can use \tabalign.
78 % Save some parts of plain tex whose names we will redefine.
80 \let\ptexbullet=\bullet
98 % If this character appears in an error message or help string, it
99 % starts a new line in the output.
102 % Set up fixed words for English if not already set.
103 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
104 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
105 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
106 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
107 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
108 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
109 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
110 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
111 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
112 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
113 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
114 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
115 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
116 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
117 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
118 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
119 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
120 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
121 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
123 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
124 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
125 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
126 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
127 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
128 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
129 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
130 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
131 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
132 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
133 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
134 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
136 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
137 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
138 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
139 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
140 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
141 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
142 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
144 % In some macros, we cannot use the `\? notation---the left quote is
145 % in some cases the escape char.
146 \chardef\colonChar = `\:
147 \chardef\commaChar = `\,
148 \chardef\dotChar = `\.
149 \chardef\equalChar = `\=
150 \chardef\exclamChar= `\!
151 \chardef\questChar = `\?
152 \chardef\semiChar = `\;
153 \chardef\spaceChar = `\ %
154 \chardef\underChar = `\_
160 % True if #1 is the empty string, i.e., called like `\ifempty{}'.
162 \def\ifempty#1{\ifemptyx #1\emptymarkA\emptymarkB}%
163 \def\ifemptyx#1#2\emptymarkB{\ifx #1\emptymarkA}%
166 \hyphenation{ap-pen-dix}
167 \hyphenation{mini-buf-fer mini-buf-fers}
169 \hyphenation{white-space}
171 % Margin to add to right of even pages, to left of odd pages.
172 \newdimen\bindingoffset
173 \newdimen\normaloffset
174 \newdimen\pagewidth \newdimen\pageheight
176 % Sometimes it is convenient to have everything in the transcript file
177 % and nothing on the terminal. We don't just call \tracingall here,
178 % since that produces some useless output on the terminal. We also make
179 % some effort to order the tracing commands to reduce output in the log
180 % file; cf. trace.sty in LaTeX.
182 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
186 \tracinglostchars2 % 2 gives us more in etex
191 \showboxbreadth\maxdimen \showboxdepth\maxdimen
192 \ifx\eTeXversion\undefined\else % etex gives us more logging
199 \tracingcommands3 % 3 gives us more in etex
200 \errorcontextlines\maxdimen
203 % add check for \lastpenalty to plain's definitions. If the last thing
204 % we did was a \nobreak, we don't want to insert more space.
206 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
207 \removelastskip\penalty-50\smallskip\fi\fi}
208 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
209 \removelastskip\penalty-100\medskip\fi\fi}
210 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
211 \removelastskip\penalty-200\bigskip\fi\fi}
213 % For @cropmarks command.
214 % Do @cropmarks to get crop marks.
217 \let\cropmarks = \cropmarkstrue
219 % Dimensions to add cropmarks at corners.
220 % Added by P. A. MacKay, 12 Nov. 1986
222 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
223 \newdimen\cornerlong \cornerlong=1pc
224 \newdimen\cornerthick \cornerthick=.3pt
225 \newdimen\topandbottommargin \topandbottommargin=.75in
227 % Main output routine.
229 \output = {\onepageout{\pagecontents\PAGE}}
234 % \onepageout takes a vbox as an argument. Note that \pagecontents
235 % does insertions, but you have to call it yourself.
237 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
239 \ifodd\pageno \advance\hoffset by \bindingoffset
240 \else \advance\hoffset by -\bindingoffset\fi
242 % Do this outside of the \shipout so @code etc. will be expanded in
243 % the headline as they should be, not taken literally (outputting ''code).
244 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
245 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
248 % Have to do this stuff outside the \shipout because we want it to
249 % take effect in \write's, yet the group defined by the \vbox ends
250 % before the \shipout runs.
252 \escapechar = `\\ % use backslash in output files.
253 \indexdummies % don't expand commands in the output.
254 \normalturnoffactive % \ in index entries must not stay \, e.g., if
255 % the page break happens to be in the middle of an example.
257 % Do this early so pdf references go to the beginning of the page.
258 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
260 \ifcropmarks \vbox to \outervsize\bgroup
262 \vskip-\topandbottommargin
264 \line{\ewtop\hfil\ewtop}%
267 \vbox{\moveleft\cornerthick\nstop}%
269 \vbox{\moveright\cornerthick\nstop}%
272 \vskip\topandbottommargin
274 \hfil % center the page within the outer (page) hsize.
275 \ifodd\pageno\hskip\bindingoffset\fi
281 \ifdim\ht\footlinebox > 0pt
282 % Only leave this space if the footline is nonempty.
283 % (We lessened \vsize for it in \oddfootingxxx.)
284 % The \baselineskip=24pt in plain's \makefootline has no effect.
285 \vskip 2\baselineskip
290 \egroup % end of \vbox\bgroup
291 \hfil\egroup % end of (centering) \line\bgroup
292 \vskip\topandbottommargin plus1fill minus1fill
293 \boxmaxdepth = \cornerthick
296 \vbox{\moveleft\cornerthick\nsbot}%
298 \vbox{\moveright\cornerthick\nsbot}%
301 \line{\ewbot\hfil\ewbot}%
303 \egroup % \vbox from first cropmarks clause
305 }% end of \shipout\vbox
306 }% end of group with \normalturnoffactive
308 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
311 \newinsert\margin \dimen\margin=\maxdimen
313 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
315 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
316 % marginal hacks, juha@viisa.uucp (Juha Takala)
317 \ifvoid\margin\else % marginal info is present
318 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
319 \dimen@=\dp#1 \unvbox#1
320 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
321 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
324 % Here are the rules for the cropmarks. Note that they are
325 % offset so that the space between them is truly \outerhsize or \outervsize
326 % (P. A. MacKay, 12 November, 1986)
328 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
330 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
331 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
333 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
335 % Parse an argument, then pass it to #1. The argument is the rest of
336 % the input line (except we remove a trailing comment). #1 should be a
337 % macro which expects an ordinary undelimited TeX argument.
343 \futurelet\temp\parseargx
346 % If the next token is an obeyed space (from an @example environment or
347 % the like), remove it and recurse. Otherwise, we're done.
349 % \obeyedspace is defined far below, after the definition of \sepspaces.
350 \ifx\obeyedspace\temp
351 \expandafter\parseargdiscardspace
353 \expandafter\parseargline
357 % Remove a single space (as the delimiter token to the macro call).
359 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
362 \gdef\parseargline#1^^M{%
363 \endgroup % End of the group started in \parsearg.
365 % First remove any @c comment, then any @comment.
366 % Result of each macro is put in \toks0.
367 \argremovec #1\c\relax %
368 \expandafter\argremovecomment \the\toks0 \comment\relax %
370 % Call the caller's macro, saved as \next in \parsearg.
371 \expandafter\next\expandafter{\the\toks0}%
375 % Since all \c{,omment} does is throw away the argument, we can let TeX
376 % do that for us. The \relax here is matched by the \relax in the call
377 % in \parseargline; it could be more or less anything, its purpose is
378 % just to delimit the argument to the \c.
379 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
380 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
382 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
383 % @end itemize @c foo
384 % will have two active spaces as part of the argument with the
385 % `itemize'. Here we remove all active spaces from #1, and assign the
388 % This loses if there are any *other* active characters besides spaces
389 % in the argument -- _ ^ +, for example -- since they get expanded.
390 % Fortunately, Texinfo does not define any such commands. (If it ever
391 % does, the catcode of the characters in questionwill have to be changed
392 % here.) But this means we cannot call \removeactivespaces as part of
393 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
394 % that \parsearg gets might well have any character at all in it.
396 \def\removeactivespaces#1{%
400 \global\toks0 = \expandafter{\temp}%
404 % Change the active space to expand to nothing.
408 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
412 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
414 %% These are used to keep @begin/@end levels from running away
415 %% Call \inENV within environments (after a \begingroup)
416 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
418 \ifENV\errmessage{Still within an environment; press RETURN to continue}
419 \endgroup\fi} % This is not perfect, but it should reduce lossage
421 % @begin foo is the same as @foo, for now.
422 \newhelp\EMsimple{Press RETURN to continue.}
424 \outer\def\begin{\parsearg\beginxxx}
427 \expandafter\ifx\csname #1\endcsname\relax
428 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
429 \csname #1\endcsname\fi}
431 % @end foo executes the definition of \Efoo.
433 \def\end{\parsearg\endxxx}
435 \removeactivespaces{#1}%
436 \edef\endthing{\the\toks0}%
438 \expandafter\ifx\csname E\endthing\endcsname\relax
439 \expandafter\ifx\csname \endthing\endcsname\relax
440 % There's no \foo, i.e., no ``environment'' foo.
442 \errmessage{Undefined command `@end \endthing'}%
444 \unmatchedenderror\endthing
447 % Everything's ok; the right environment has been started.
448 \csname E\endthing\endcsname
452 % There is an environment #1, but it hasn't been started. Give an error.
454 \def\unmatchedenderror#1{%
456 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
459 % Define the control sequence \E#1 to give an unmatched @end error.
461 \def\defineunmatchedend#1{%
462 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
466 %% Simple single-character @ commands
469 % Kludge this until the fonts are right (grr).
472 % This is turned off because it was never documented
473 % and you can use @w{...} around a quote to suppress ligatures.
474 %% Define @` and @' to be the same as ` and '
475 %% but suppressing ligatures.
479 % Used to generate quoted braces.
480 \def\mylbrace {{\tt\char123}}
481 \def\myrbrace {{\tt\char125}}
485 % Definitions to produce actual \{ & \} command in an index.
486 \catcode`\{ = \other \catcode`\} = \other
487 \catcode`\[ = 1 \catcode`\] = 2
488 \catcode`\@ = 0 \catcode`\\ = \other
493 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
494 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
497 \def\ringaccent#1{{\accent23 #1}}
501 \let\acuteaccent = \' % workaround aux file using ' as escape
503 % Other special characters: @questiondown @exclamdown
504 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
505 \def\questiondown{?`}
508 % Dotless i and dotless j, used for accents.
513 \ifx\temp\imacro \ptexi
514 \else\ifx\temp\jmacro \j
515 \else \errmessage{@dotless can be used only with i or j}%
519 % Be sure we're in horizontal mode when doing a tie, since we make space
520 % equivalent to this in @example-like environments. Otherwise, a space
521 % at the beginning of a line will start with \penalty -- and
522 % since \penalty is valid in vertical mode, we'd end up putting the
523 % penalty on the vertical list instead of in the new paragraph.
525 % Avoid using \@M directly, because that causes trouble
526 % if the definition is written into an index file.
527 \global\let\tiepenalty = \@M
528 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
531 % @: forces normal size whitespace following.
532 \def\:{\spacefactor=1000 }
534 % @* forces a line break.
535 \def\*{\hfil\break\hbox{}\ignorespaces}
537 % @. is an end-of-sentence period.
538 \def\.{.\spacefactor=3000 }
540 % @! is an end-of-sentence bang.
541 \def\!{!\spacefactor=3000 }
543 % @? is an end-of-sentence query.
544 \def\?{?\spacefactor=3000 }
546 % @w prevents a word break. Without the \leavevmode, @w at the
547 % beginning of a paragraph, when TeX is still in vertical mode, would
548 % produce a whole line of output instead of starting the paragraph.
549 \def\w#1{\leavevmode\hbox{#1}}
551 % @group ... @end group forces ... to be all on one page, by enclosing
552 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
553 % to keep its height that of a normal line. According to the rules for
554 % \topskip (p.114 of the TeXbook), the glue inserted is
555 % max (\topskip - \ht (first item), 0). If that height is large,
556 % therefore, no glue is inserted, and the space between the headline and
557 % the text is small, which looks bad.
559 \def\group{\begingroup
560 \ifnum\catcode13=\active \else
561 \errhelp = \groupinvalidhelp
562 \errmessage{@group invalid in context where filling is enabled}%
565 % The \vtop we start below produces a box with normal height and large
566 % depth; thus, TeX puts \baselineskip glue before it, and (when the
567 % next line of text is done) \lineskip glue after it. (See p.82 of
568 % the TeXbook.) Thus, space below is not quite equal to space
569 % above. But it's pretty close.
571 \egroup % End the \vtop.
572 \endgroup % End the \group.
576 % We have to put a strut on the last line in case the @group is in
577 % the midst of an example, rather than completely enclosing it.
578 % Otherwise, the interline space between the last line of the group
579 % and the first line afterwards is too small. But we can't put the
580 % strut in \Egroup, since there it would be on a line by itself.
581 % Hence this just inserts a strut at the beginning of each line.
582 \everypar = {\strut}%
584 % Since we have a strut on every line, we don't need any of TeX's
585 % normal interline spacing.
588 % OK, but now we have to do something about blank
589 % lines in the input in @example-like environments, which normally
590 % just turn into \lisppar, which will insert no space now that we've
591 % turned off the interline space. Simplest is to make them be an
594 \edef\par{\leavevmode \par}%
596 % Reset ^^M's definition to new definition of \par.
600 % Do @comment since we are called inside an environment such as
601 % @example, where each end-of-line in the input causes an
602 % end-of-line in the output. We don't want the end-of-line after
603 % the `@group' to put extra space in the output. Since @group
604 % should appear on a line by itself (according to the Texinfo
605 % manual), we don't worry about eating any user text.
609 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
610 % message, so this ends up printing `@group can only ...'.
612 \newhelp\groupinvalidhelp{%
613 group can only be used in environments such as @example,^^J%
614 where each line of input produces a line of output.}
616 % @need space-in-mils
617 % forces a page break if there is not space-in-mils remaining.
619 \newdimen\mil \mil=0.001in
621 \def\need{\parsearg\needx}
623 % Old definition--didn't work.
624 %\def\needx #1{\par %
625 %% This method tries to make TeX break the page naturally
626 %% if the depth of the box does not fit.
628 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
633 % Ensure vertical mode, so we don't make a big box in the middle of a
637 % If the @need value is less than one line space, it's useless.
639 \dimen2 = \ht\strutbox
640 \advance\dimen2 by \dp\strutbox
641 \ifdim\dimen0 > \dimen2
643 % Do a \strut just to make the height of this box be normal, so the
644 % normal leading is inserted relative to the preceding line.
645 % And a page break here is fine.
646 \vtop to #1\mil{\strut\vfil}%
648 % TeX does not even consider page breaks if a penalty added to the
649 % main vertical list is 10000 or more. But in order to see if the
650 % empty box we just added fits on the page, we must make it consider
651 % page breaks. On the other hand, we don't want to actually break the
652 % page after the empty box. So we use a penalty of 9999.
654 % There is an extremely small chance that TeX will actually break the
655 % page at this \penalty, if there are no other feasible breakpoints in
656 % sight. (If the user is using lots of big @group commands, which
657 % almost-but-not-quite fill up a page, TeX will have a hard time doing
658 % good page breaking, for example.) However, I could not construct an
659 % example where a page broke at this \penalty; if it happens in a real
660 % document, then we can reconsider our strategy.
663 % Back up by the size of the box, whether we did a page break or not.
666 % Do not allow a page break right after this kern.
671 % @br forces paragraph break
675 % @dots{} output an ellipsis using the current font.
676 % We do .5em per period so that it has the same spacing in a typewriter
677 % font as three actual period characters.
682 \hskip 0pt plus 0.25fil minus 0.25fil
684 \hskip 0pt plus 0.5fil minus 0.5fil
688 % @enddots{} is an end-of-sentence ellipsis.
693 \hskip 0pt plus 0.25fil minus 0.25fil
695 \hskip 0pt plus 0.5fil minus 0.5fil
701 % @page forces the start of a new page
703 \def\page{\par\vfill\supereject}
706 % outputs text on separate line in roman font, starting at standard page margin
708 % This records the amount of indent in the innermost environment.
709 % That's how much \exdent should take out.
710 \newskip\exdentamount
712 % This defn is used inside fill environments such as @defun.
713 \def\exdent{\parsearg\exdentyyy}
714 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
716 % This defn is used inside nofill environments such as @example.
717 \def\nofillexdent{\parsearg\nofillexdentyyy}
718 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
719 \leftline{\hskip\leftskip{\rm#1}}}}
721 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
722 % paragraph. For more general purposes, use the \margin insertion
723 % class. WHICH is `l' or `r'.
725 \newskip\inmarginspacing \inmarginspacing=1cm
726 \def\strutdepth{\dp\strutbox}
728 \def\doinmargin#1#2{\strut\vadjust{%
731 \vtop to \strutdepth{%
732 \baselineskip=\strutdepth
734 % if you have multiple lines of stuff to put here, you'll need to
735 % make the vbox yourself of the appropriate size.
737 \llap{\ignorespaces #2\hskip\inmarginspacing}%
739 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
744 \def\inleftmargin{\doinmargin l}
745 \def\inrightmargin{\doinmargin r}
747 % @inmargin{TEXT [, RIGHT-TEXT]}
748 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
749 % else use TEXT for both).
751 \def\inmargin#1{\parseinmargin #1,,\finish}
752 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
753 \setbox0 = \hbox{\ignorespaces #2}%
755 \def\lefttext{#1}% have both texts
758 \def\lefttext{#1}% have only one text
763 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
765 \def\temp{\inleftmargin\lefttext}%
770 % @include file insert text of that file as input.
771 % Allow normal characters that we make active in the argument (a file name).
772 \def\include{\begingroup
781 \parsearg\includezzz}
782 % Restore active chars for included file.
783 \def\includezzz#1{\endgroup\begingroup
784 % Read the included file in a group so nested @include's work.
786 \let\value=\expandablevalue
793 % outputs that line, centered.
795 \def\center{\parsearg\docenter}
797 \ifhmode \hfil\break \fi
798 \advance\hsize by -\leftskip
799 \advance\hsize by -\rightskip
800 \line{\hfil \ignorespaces#1\unskip \hfil}%
804 % @sp n outputs n lines of vertical space
806 \def\sp{\parsearg\spxxx}
807 \def\spxxx #1{\vskip #1\baselineskip}
809 % @comment ...line which is ignored...
810 % @c is the same as @comment
811 % @ignore ... @end ignore is another way to write a comment
813 \def\comment{\begingroup \catcode`\^^M=\other%
814 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
816 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
820 % @paragraphindent NCHARS
821 % We'll use ems for NCHARS, close enough.
822 % We cannot implement @paragraphindent asis, though.
824 \def\asisword{asis} % no translation, these are keywords
827 \def\paragraphindent{\parsearg\doparagraphindent}
828 \def\doparagraphindent#1{%
833 \defaultparindent = 0pt
835 \defaultparindent = #1em
838 \parindent = \defaultparindent
841 % @exampleindent NCHARS
842 % We'll use ems for NCHARS like @paragraphindent.
843 % It seems @exampleindent asis isn't necessary, but
844 % I preserve it to make it similar to @paragraphindent.
845 \def\exampleindent{\parsearg\doexampleindent}
846 \def\doexampleindent#1{%
853 \lispnarrowing = #1em
858 % @asis just yields its argument. Used with @table, for example.
862 % @math outputs its argument in math mode.
863 % We don't use $'s directly in the definition of \math because we need
864 % to set catcodes according to plain TeX first, to allow for subscripts,
865 % superscripts, special math chars, etc.
867 \let\implicitmath = $%$ font-lock fix
869 % One complication: _ usually means subscripts, but it could also mean
870 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
871 % _ within @math be active (mathcode "8000), and distinguish by seeing
872 % if the current family is \slfam, which is what @var uses.
874 {\catcode\underChar = \active
875 \gdef\mathunderscore{%
876 \catcode\underChar=\active
877 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
880 % Another complication: we want \\ (and @\) to output a \ character.
881 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
882 % this is not advertised and we don't care. Texinfo does not
883 % otherwise define @\.
885 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
886 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
890 \mathcode`\_="8000 \mathunderscore
891 \let\\ = \mathbackslash
893 \implicitmath\finishmath}
894 \def\finishmath#1{#1\implicitmath\Etex}
896 % Some active characters (such as <) are spaced differently in math.
897 % We have to reset their definitions in case the @math was an
898 % argument to a command which set the catcodes (such as @item or @section).
913 % @bullet and @minus need the same treatment as @math, just above.
914 \def\bullet{\implicitmath\ptexbullet\implicitmath}
915 \def\minus{\implicitmath-\implicitmath}
917 % @refill is a no-op.
920 % If working on a large document in chapters, it is convenient to
921 % be able to disable indexing, cross-referencing, and contents, for test runs.
922 % This is done with @novalidate (before @setfilename).
924 \newif\iflinks \linkstrue % by default we want the aux files.
925 \let\novalidate = \linksfalse
927 % @setfilename is done at the beginning of every texinfo file.
928 % So open here the files we need to have open while reading the input.
929 % This makes it possible to make a .fmt file for texinfo.
933 \fi % \openindices needs to do some work in any case.
935 \fixbackslash % Turn off hack to swallow `\input texinfo'.
936 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
938 % If texinfo.cnf is present on the system, read it.
939 % Useful for site-wide @afourpaper, etc.
940 % Just to be on the safe side, close the input stream before the \input.
941 \openin 1 texinfo.cnf
942 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
946 \comment % Ignore the actual filename.
949 % Called from \setfilename.
961 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
965 % adobe `portable' document format
969 \newcount\filenamelength
978 \newif\ifpdfmakepagedest
980 \ifx\pdfoutput\undefined
982 \let\pdfmkdest = \gobble
983 \let\pdfurl = \gobble
984 \let\endlink = \relax
985 \let\linkcolor = \relax
986 \let\pdfmakeoutlines = \relax
991 \def\dopdfimage#1#2#3{%
993 \def\imageheight{#3}%
994 % without \immediate, pdftex seg faults when the same image is
995 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
996 \ifnum\pdftexversion < 14
1001 \ifx\empty\imagewidth\else width \imagewidth \fi
1002 \ifx\empty\imageheight\else height \imageheight \fi
1003 \ifnum\pdftexversion<13
1008 \ifnum\pdftexversion < 14 \else
1009 \pdfrefximage \pdflastximage
1011 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
1013 \let\linkcolor = \Blue % was Cyan, but that seems light?
1014 \def\endlink{\Black\pdfendlink}
1015 % Adding outlines to PDF; macros for calculating structure of outlines
1016 % come from Petr Olsak
1017 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1018 \else \csname#1\endcsname \fi}
1019 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1020 \advance\tempnum by1
1021 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1022 \def\pdfmakeoutlines{{%
1023 \openin 1 \jobname.toc
1024 \ifeof 1\else\begingroup
1026 % Thanh's hack / proper braces in bookmarks
1027 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1028 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1030 \def\chapentry ##1##2##3{}
1031 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
1032 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
1033 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
1034 \let\appendixentry = \chapentry
1035 \let\unnumbchapentry = \chapentry
1036 \let\unnumbsecentry = \secentry
1037 \let\unnumbsubsecentry = \subsecentry
1038 \let\unnumbsubsubsecentry = \subsubsecentry
1040 \def\chapentry ##1##2##3{%
1041 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1042 \def\secentry ##1##2##3##4{%
1043 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1044 \def\subsecentry ##1##2##3##4##5{%
1045 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1046 \def\subsubsecentry ##1##2##3##4##5##6{%
1047 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1048 \let\appendixentry = \chapentry
1049 \let\unnumbchapentry = \chapentry
1050 \let\unnumbsecentry = \secentry
1051 \let\unnumbsubsecentry = \subsecentry
1052 \let\unnumbsubsubsecentry = \subsubsecentry
1054 % Make special characters normal for writing to the pdf file.
1062 \def\makelinks #1,{%
1063 \def\params{#1}\def\E{END}%
1065 \let\nextmakelinks=\relax
1067 \let\nextmakelinks=\makelinks
1068 \ifnum\lnkcount>0,\fi
1070 \startlink attr{/Border [0 0 0]}
1071 goto name{\pdfmkpgn{\the\pgn}}%
1073 \advance\lnkcount by 1%
1078 \def\picknum#1{\expandafter\pn#1}
1089 \def\ppn#1{\pgn=#1\gobble}
1090 \def\ppnn{\pgn=\first}
1091 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1092 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1093 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1094 \ifx\PP\D\let\nextsp\relax
1095 \else\let\nextsp\skipspaces
1096 \ifx\p\space\else\addtokens{\filename}{\PP}%
1097 \advance\filenamelength by 1
1101 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1102 \ifnum\pdftexversion < 14
1103 \let \startlink \pdfannotlink
1105 \let \startlink \pdfstartlink
1109 \normalturnoffactive\def\@{@}%
1110 \let\value=\expandablevalue
1112 \startlink attr{/Border [0 0 0]}%
1113 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1116 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1117 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1118 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1119 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1121 \expandafter\poptoks\the\toksA|ENDTOKS|
1123 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1124 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1125 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1127 \ifnum0=\countA\else\makelink\fi
1128 \ifx\first.\let\next=\done\else
1130 \addtokens{\toksB}{\the\toksD}
1131 \ifx\first,\addtokens{\toksB}{\space}\fi
1133 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1135 \def\makelink{\addtokens{\toksB}%
1136 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1138 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1139 \linkcolor #1\endlink}
1140 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1141 \fi % \ifx\pdfoutput
1145 % Font-change commands.
1147 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1148 % So we set up a \sf analogous to plain's \rm, etc.
1150 \def\sf{\fam=\sffam \tensf}
1151 \let\li = \sf % Sometimes we call it \li, not \sf.
1153 % We don't need math for this one.
1157 \newdimen\textleading \textleading = 13.2pt
1159 % Set the baselineskip to #1, and the lineskip and strut size
1160 % correspondingly. There is no deep meaning behind these magic numbers
1161 % used as factors; they just match (closely enough) what Knuth defined.
1163 \def\lineskipfactor{.08333}
1164 \def\strutheightpercent{.70833}
1165 \def\strutdepthpercent {.29167}
1168 \normalbaselineskip = #1\relax
1169 \normallineskip = \lineskipfactor\normalbaselineskip
1171 \setbox\strutbox =\hbox{%
1172 \vrule width0pt height\strutheightpercent\baselineskip
1173 depth \strutdepthpercent \baselineskip
1177 % Set the font macro #1 to the font named #2, adding on the
1178 % specified font prefix (normally `cm').
1179 % #3 is the font's design size, #4 is a scale factor
1180 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1182 % Use cm as the default font prefix.
1183 % To specify the font prefix, you must define \fontprefix
1184 % before you read in texinfo.tex.
1185 \ifx\fontprefix\undefined
1188 % Support font families that don't use the same naming scheme as CM.
1190 \def\rmbshape{bx} %where the normal face is bold
1195 \def\ttslshape{sltt}
1205 \newcount\mainmagstep
1207 % not really supported.
1208 \mainmagstep=\magstep1
1209 \setfont\textrm\rmshape{12}{1000}
1210 \setfont\texttt\ttshape{12}{1000}
1212 \mainmagstep=\magstephalf
1213 \setfont\textrm\rmshape{10}{\mainmagstep}
1214 \setfont\texttt\ttshape{10}{\mainmagstep}
1216 % Instead of cmb10, you may want to use cmbx10.
1217 % cmbx10 is a prettier font on its own, but cmb10
1218 % looks better when embedded in a line with cmr10
1219 % (in Bob's opinion).
1220 \setfont\textbf\bfshape{10}{\mainmagstep}
1221 \setfont\textit\itshape{10}{\mainmagstep}
1222 \setfont\textsl\slshape{10}{\mainmagstep}
1223 \setfont\textsf\sfshape{10}{\mainmagstep}
1224 \setfont\textsc\scshape{10}{\mainmagstep}
1225 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1226 \font\texti=cmmi10 scaled \mainmagstep
1227 \font\textsy=cmsy10 scaled \mainmagstep
1229 % A few fonts for @defun, etc.
1230 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1231 \setfont\deftt\ttshape{10}{\magstep1}
1232 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1234 % Fonts for indices, footnotes, small examples (9pt).
1235 \setfont\smallrm\rmshape{9}{1000}
1236 \setfont\smalltt\ttshape{9}{1000}
1237 \setfont\smallbf\bfshape{10}{900}
1238 \setfont\smallit\itshape{9}{1000}
1239 \setfont\smallsl\slshape{9}{1000}
1240 \setfont\smallsf\sfshape{9}{1000}
1241 \setfont\smallsc\scshape{10}{900}
1242 \setfont\smallttsl\ttslshape{10}{900}
1246 % Fonts for small examples (8pt).
1247 \setfont\smallerrm\rmshape{8}{1000}
1248 \setfont\smallertt\ttshape{8}{1000}
1249 \setfont\smallerbf\bfshape{10}{800}
1250 \setfont\smallerit\itshape{8}{1000}
1251 \setfont\smallersl\slshape{8}{1000}
1252 \setfont\smallersf\sfshape{8}{1000}
1253 \setfont\smallersc\scshape{10}{800}
1254 \setfont\smallerttsl\ttslshape{10}{800}
1255 \font\smalleri=cmmi8
1256 \font\smallersy=cmsy8
1258 % Fonts for title page:
1259 \setfont\titlerm\rmbshape{12}{\magstep3}
1260 \setfont\titleit\itbshape{10}{\magstep4}
1261 \setfont\titlesl\slbshape{10}{\magstep4}
1262 \setfont\titlett\ttbshape{12}{\magstep3}
1263 \setfont\titlettsl\ttslshape{10}{\magstep4}
1264 \setfont\titlesf\sfbshape{17}{\magstep1}
1265 \let\titlebf=\titlerm
1266 \setfont\titlesc\scbshape{10}{\magstep4}
1267 \font\titlei=cmmi12 scaled \magstep3
1268 \font\titlesy=cmsy10 scaled \magstep4
1269 \def\authorrm{\secrm}
1270 \def\authortt{\sectt}
1272 % Chapter (and unnumbered) fonts (17.28pt).
1273 \setfont\chaprm\rmbshape{12}{\magstep2}
1274 \setfont\chapit\itbshape{10}{\magstep3}
1275 \setfont\chapsl\slbshape{10}{\magstep3}
1276 \setfont\chaptt\ttbshape{12}{\magstep2}
1277 \setfont\chapttsl\ttslshape{10}{\magstep3}
1278 \setfont\chapsf\sfbshape{17}{1000}
1280 \setfont\chapsc\scbshape{10}{\magstep3}
1281 \font\chapi=cmmi12 scaled \magstep2
1282 \font\chapsy=cmsy10 scaled \magstep3
1284 % Section fonts (14.4pt).
1285 \setfont\secrm\rmbshape{12}{\magstep1}
1286 \setfont\secit\itbshape{10}{\magstep2}
1287 \setfont\secsl\slbshape{10}{\magstep2}
1288 \setfont\sectt\ttbshape{12}{\magstep1}
1289 \setfont\secttsl\ttslshape{10}{\magstep2}
1290 \setfont\secsf\sfbshape{12}{\magstep1}
1292 \setfont\secsc\scbshape{10}{\magstep2}
1293 \font\seci=cmmi12 scaled \magstep1
1294 \font\secsy=cmsy10 scaled \magstep2
1296 % Subsection fonts (13.15pt).
1297 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1298 \setfont\ssecit\itbshape{10}{1315}
1299 \setfont\ssecsl\slbshape{10}{1315}
1300 \setfont\ssectt\ttbshape{12}{\magstephalf}
1301 \setfont\ssecttsl\ttslshape{10}{1315}
1302 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1304 \setfont\ssecsc\scbshape{10}{\magstep1}
1305 \font\sseci=cmmi12 scaled \magstephalf
1306 \font\ssecsy=cmsy10 scaled 1315
1307 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1308 % but that is not a standard magnification.
1310 % In order for the font changes to affect most math symbols and letters,
1311 % we have to define the \textfont of the standard families. Since
1312 % texinfo doesn't allow for producing subscripts and superscripts except
1313 % in the main text, we don't bother to reset \scriptfont and
1314 % \scriptscriptfont (which would also require loading a lot more fonts).
1316 \def\resetmathfonts{%
1317 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1318 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1319 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1322 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1323 % of just \STYLE. We do this so that font changes will continue to work
1324 % in math mode, where it is the current \fam that is relevant in most
1325 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1326 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1327 % redefine \bf itself.
1329 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1330 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1331 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1332 \resetmathfonts \setleading{\textleading}}
1334 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1335 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1336 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1337 \let\tenttsl=\titlettsl
1338 \resetmathfonts \setleading{25pt}}
1339 \def\titlefont#1{{\titlefonts\rm #1}}
1341 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1342 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1343 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1344 \resetmathfonts \setleading{19pt}}
1346 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1347 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1348 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1349 \resetmathfonts \setleading{16pt}}
1351 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1352 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1353 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1354 \resetmathfonts \setleading{15pt}}
1355 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1357 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1358 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1359 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1360 \let\tenttsl=\smallttsl
1361 \resetmathfonts \setleading{10.5pt}}
1363 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1364 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1365 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1366 \let\tenttsl=\smallerttsl
1367 \resetmathfonts \setleading{9.5pt}}
1368 \let\smallexamplefonts = \smallerfonts
1370 % Set up the default fonts, so we can use them for creating boxes.
1374 % Define these so they can be easily changed for other fonts.
1375 \def\angleleft{$\langle$}
1376 \def\angleright{$\rangle$}
1378 % Count depth in font-changes, for error checks
1379 \newcount\fontdepth \fontdepth=0
1381 % Fonts for short table of contents.
1382 \setfont\shortcontrm\rmshape{12}{1000}
1383 \setfont\shortcontbf\bxshape{12}{1000}
1384 \setfont\shortcontsl\slshape{12}{1000}
1385 \setfont\shortconttt\ttshape{12}{1000}
1387 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1388 %% serif) and @ii for TeX italic
1390 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1391 % unless the following character is such as not to need one.
1392 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1393 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1394 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1397 \let\var=\smartslanted
1398 \let\dfn=\smartslanted
1399 \let\emph=\smartitalic
1400 \let\cite=\smartslanted
1405 % We can't just use \exhyphenpenalty, because that only has effect at
1406 % the end of a paragraph. Restore normal hyphenation at the end of the
1407 % group within which \nohyphenation is presumably called.
1409 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1410 \def\restorehyphenation{\hyphenchar\font = `- }
1412 % Set sfcode to normal for the chars that usually have another value.
1413 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1414 % sometimes \x has an active definition that messes things up.
1417 \def\frenchspacing{%
1418 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1419 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1424 {\tt \rawbackslash \frenchspacing #1}%
1428 \def\samp#1{`\tclose{#1}'\null}
1429 \setfont\keyrm\rmshape{8}{1000}
1431 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1432 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1433 \vbox{\hrule\kern-0.4pt
1434 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1436 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1437 % The old definition, with no lozenge:
1438 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1439 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1441 % @file, @option are the same as @samp.
1445 % @code is a modification of @t,
1446 % which makes spaces the same size as normal in the surrounding text.
1449 % Change normal interword space to be same as for the current font.
1450 \spaceskip = \fontdimen2\font
1452 % Switch to typewriter.
1455 % But `\ ' produces the large typewriter interword space.
1456 \def\ {{\spaceskip = 0pt{} }}%
1458 % Turn off hyphenation.
1468 % We *must* turn on hyphenation at `-' and `_' in \code.
1469 % Otherwise, it is too hard to avoid overfull hboxes
1470 % in the Emacs manual, the Library manual, etc.
1472 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1473 % both hyphenation at - and hyphenation within words.
1474 % We must therefore turn them both off (\tclose does that)
1475 % and arrange explicitly to hyphenate at a dash.
1481 \global\def\code{\begingroup
1482 \catcode`\-=\active \let-\codedash
1483 \catcode`\_=\active \let_\codeunder
1487 % If we end up with any active - characters when handling the index,
1488 % just treat them as a normal -.
1489 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1493 \def\codedash{-\discretionary{}{}{}}
1495 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1496 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1497 % will therefore expand the active definition of _, which is us
1498 % (inside @code that is), therefore an endless loop.
1500 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1501 \else\normalunderscore \fi
1502 \discretionary{}{}{}}%
1505 \def\codex #1{\tclose{#1}\endgroup}
1507 % @kbd is like @code, except that if the argument is just one @key command,
1508 % then @kbd has no effect.
1510 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1511 % `example' (@kbd uses ttsl only inside of @example and friends),
1512 % or `code' (@kbd uses normal tty font always).
1513 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1514 \def\kbdinputstylexxx#1{%
1516 \ifx\arg\worddistinct
1517 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1518 \else\ifx\arg\wordexample
1519 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1520 \else\ifx\arg\wordcode
1521 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1523 \errhelp = \EMsimple
1524 \errmessage{Unknown @kbdinputstyle `\arg'}%
1527 \def\worddistinct{distinct}
1528 \def\wordexample{example}
1531 % Default is `distinct.'
1532 \kbdinputstyle distinct
1535 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1536 \ifx\one\xkey\ifx\threex\three \key{#2}%
1537 \else{\tclose{\kbdfont\look}}\fi
1538 \else{\tclose{\kbdfont\look}}\fi}
1540 % For @url, @env, @command quotes seem unnecessary, so use \code.
1545 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1546 % second argument specifying the text to display and an optional third
1547 % arg as text to display instead of (rather than in addition to) the url
1548 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1549 % a hypertex \special here.
1551 \def\uref#1{\douref #1,,,\finish}
1552 \def\douref#1,#2,#3,#4\finish{\begingroup
1555 \setbox0 = \hbox{\ignorespaces #3}%
1557 \unhbox0 % third arg given, show only that
1559 \setbox0 = \hbox{\ignorespaces #2}%
1562 \unhbox0 % PDF: 2nd arg given, show only it
1564 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1567 \code{#1}% only url given, so show it
1573 % rms does not like angle brackets --karl, 17may97.
1574 % So now @email is just like @uref, unless we are pdf.
1576 %\def\email#1{\angleleft{\tt #1}\angleright}
1578 \def\email#1{\doemail#1,,\finish}
1579 \def\doemail#1,#2,#3\finish{\begingroup
1582 \setbox0 = \hbox{\ignorespaces #2}%
1583 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1590 % Check if we are currently using a typewriter font. Since all the
1591 % Computer Modern typewriter fonts have zero interword stretch (and
1592 % shrink), and it is reasonable to expect all typewriter fonts to have
1593 % this property, we can check that font parameter.
1595 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1597 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1598 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1600 \def\dmn#1{\thinspace #1}
1602 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1604 % @l was never documented to mean ``switch to the Lisp font'',
1605 % and it is not used as such in any manual I can find. We need it for
1606 % Polish suppressed-l. --karl, 22sep96.
1607 %\def\l#1{{\li #1}\null}
1609 % Explicit font changes: @r, @sc, undocumented @ii.
1610 \def\r#1{{\rm #1}} % roman font
1611 \def\sc#1{{\smallcaps#1}} % smallcaps font
1612 \def\ii#1{{\it #1}} % italic font
1614 % @acronym downcases the argument and prints in smallcaps.
1615 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1617 % @pounds{} is a sterling sign.
1618 \def\pounds{{\it\$}}
1621 \message{page headings,}
1623 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1624 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1626 % First the title page. Must do @settitle before @titlepage.
1628 \newif\iffinishedtitlepage
1630 % Do an implicit @contents or @shortcontents after @end titlepage if the
1631 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1633 \newif\ifsetcontentsaftertitlepage
1634 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1635 \newif\ifsetshortcontentsaftertitlepage
1636 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1638 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1639 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1640 \endgroup\page\hbox{}\page}
1642 \def\titlepage{\begingroup \parindent=0pt \textfonts
1643 \let\subtitlerm=\tenrm
1644 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1646 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
1649 % Leave some space at the very top of the page.
1650 \vglue\titlepagetopglue
1652 % Now you can print the title using @title.
1653 \def\title{\parsearg\titlezzz}%
1654 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1655 % print a rule at the page bottom also.
1656 \finishedtitlepagefalse
1657 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1658 % No rule at page bottom unless we print one at the top with @title.
1659 \finishedtitlepagetrue
1661 % Now you can put text using @subtitle.
1662 \def\subtitle{\parsearg\subtitlezzz}%
1663 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1665 % @author should come last, but may come many times.
1666 \def\author{\parsearg\authorzzz}%
1667 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1668 {\authorfont \leftline{##1}}}%
1670 % Most title ``pages'' are actually two pages long, with space
1671 % at the top of the second. We don't want the ragged left on the second.
1672 \let\oldpage = \page
1674 \iffinishedtitlepage\else
1678 \let\page = \oldpage
1680 % \def\page{\oldpage \hbox{}}
1684 \iffinishedtitlepage\else
1687 % It is important to do the page break before ending the group,
1688 % because the headline and footline are only empty inside the group.
1689 % If we use the new definition of \page, we always get a blank page
1690 % after the title page, which we certainly don't want.
1694 % Need this before the \...aftertitlepage checks so that if they are
1695 % in effect the toc pages will come out with page numbers.
1698 % If they want short, they certainly want long too.
1699 \ifsetshortcontentsaftertitlepage
1702 \global\let\shortcontents = \relax
1703 \global\let\contents = \relax
1706 \ifsetcontentsaftertitlepage
1708 \global\let\contents = \relax
1709 \global\let\shortcontents = \relax
1713 \def\finishtitlepage{%
1714 \vskip4pt \hrule height 2pt width \hsize
1715 \vskip\titlepagebottomglue
1716 \finishedtitlepagetrue
1719 %%% Set up page headings and footings.
1721 \let\thispage=\folio
1723 \newtoks\evenheadline % headline on even pages
1724 \newtoks\oddheadline % headline on odd pages
1725 \newtoks\evenfootline % footline on even pages
1726 \newtoks\oddfootline % footline on odd pages
1728 % Now make Tex use those variables
1729 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1730 \else \the\evenheadline \fi}}
1731 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1732 \else \the\evenfootline \fi}\HEADINGShook}
1733 \let\HEADINGShook=\relax
1735 % Commands to set those variables.
1736 % For example, this is what @headings on does
1737 % @evenheading @thistitle|@thispage|@thischapter
1738 % @oddheading @thischapter|@thispage|@thistitle
1739 % @evenfooting @thisfile||
1740 % @oddfooting ||@thisfile
1742 \def\evenheading{\parsearg\evenheadingxxx}
1743 \def\oddheading{\parsearg\oddheadingxxx}
1744 \def\everyheading{\parsearg\everyheadingxxx}
1746 \def\evenfooting{\parsearg\evenfootingxxx}
1747 \def\oddfooting{\parsearg\oddfootingxxx}
1748 \def\everyfooting{\parsearg\everyfootingxxx}
1752 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1753 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1754 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1756 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1757 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1758 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1760 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1762 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1763 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1764 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1766 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1767 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1768 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1770 % Leave some space for the footline. Hopefully ok to assume
1771 % @evenfooting will not be used by itself.
1772 \global\advance\pageheight by -\baselineskip
1773 \global\advance\vsize by -\baselineskip
1776 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1778 }% unbind the catcode of @.
1780 % @headings double turns headings on for double-sided printing.
1781 % @headings single turns headings on for single-sided printing.
1782 % @headings off turns them off.
1783 % @headings on same as @headings double, retained for compatibility.
1784 % @headings after turns on double-sided headings after this page.
1785 % @headings doubleafter turns on double-sided headings after this page.
1786 % @headings singleafter turns on single-sided headings after this page.
1787 % By default, they are off at the start of a document,
1788 % and turned `on' after @end titlepage.
1790 \def\headings #1 {\csname HEADINGS#1\endcsname}
1793 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1794 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1796 % When we turn headings on, set the page number to 1.
1797 % For double-sided printing, put current file name in lower left corner,
1798 % chapter name on inside top of right hand pages, document
1799 % title on inside top of left hand pages, and page numbers on outside top
1800 % edge of all pages.
1801 \def\HEADINGSdouble{
1803 \global\evenfootline={\hfil}
1804 \global\oddfootline={\hfil}
1805 \global\evenheadline={\line{\folio\hfil\thistitle}}
1806 \global\oddheadline={\line{\thischapter\hfil\folio}}
1807 \global\let\contentsalignmacro = \chapoddpage
1809 \let\contentsalignmacro = \chappager
1811 % For single-sided printing, chapter title goes across top left of page,
1812 % page number on top right.
1813 \def\HEADINGSsingle{
1815 \global\evenfootline={\hfil}
1816 \global\oddfootline={\hfil}
1817 \global\evenheadline={\line{\thischapter\hfil\folio}}
1818 \global\oddheadline={\line{\thischapter\hfil\folio}}
1819 \global\let\contentsalignmacro = \chappager
1821 \def\HEADINGSon{\HEADINGSdouble}
1823 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1824 \let\HEADINGSdoubleafter=\HEADINGSafter
1825 \def\HEADINGSdoublex{%
1826 \global\evenfootline={\hfil}
1827 \global\oddfootline={\hfil}
1828 \global\evenheadline={\line{\folio\hfil\thistitle}}
1829 \global\oddheadline={\line{\thischapter\hfil\folio}}
1830 \global\let\contentsalignmacro = \chapoddpage
1833 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1834 \def\HEADINGSsinglex{%
1835 \global\evenfootline={\hfil}
1836 \global\oddfootline={\hfil}
1837 \global\evenheadline={\line{\thischapter\hfil\folio}}
1838 \global\oddheadline={\line{\thischapter\hfil\folio}}
1839 \global\let\contentsalignmacro = \chappager
1842 % Subroutines used in generating headings
1843 % This produces Day Month Year style of output.
1844 % Only define if not already defined, in case a txi-??.tex file has set
1845 % up a different format (e.g., txi-cs.tex does this).
1846 \ifx\today\undefined
1850 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1851 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1852 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1857 % @settitle line... specifies the title of the document, for headings.
1858 % It generates no output of its own.
1859 \def\thistitle{\putwordNoTitle}
1860 \def\settitle{\parsearg\settitlezzz}
1861 \def\settitlezzz #1{\gdef\thistitle{#1}}
1865 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1867 % default indentation of table text
1868 \newdimen\tableindent \tableindent=.8in
1869 % default indentation of @itemize and @enumerate text
1870 \newdimen\itemindent \itemindent=.3in
1871 % margin between end of table item and start of table text.
1872 \newdimen\itemmargin \itemmargin=.1in
1874 % used internally for \itemindent minus \itemmargin
1877 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1879 % They also define \itemindex
1880 % to index the item name in whatever manner is desired (perhaps none).
1882 \newif\ifitemxneedsnegativevskip
1884 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1886 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1887 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1889 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1890 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1892 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1893 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1895 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1898 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1901 \def\itemzzz #1{\begingroup %
1902 \advance\hsize by -\rightskip
1903 \advance\hsize by -\tableindent
1904 \setbox0=\hbox{\itemfont{#1}}%
1906 \nobreak % This prevents a break before @itemx.
1908 % If the item text does not fit in the space we have, put it on a line
1909 % by itself, and do not allow a page break either before or after that
1910 % line. We do not start a paragraph here because then if the next
1911 % command is, e.g., @kindex, the whatsit would get put into the
1912 % horizontal list on a line by itself, resulting in extra blank space.
1913 \ifdim \wd0>\itemmax
1915 % Make this a paragraph so we get the \parskip glue and wrapping,
1916 % but leave it ragged-right.
1918 \advance\leftskip by-\tableindent
1919 \advance\hsize by\tableindent
1920 \advance\rightskip by0pt plus1fil
1921 \leavevmode\unhbox0\par
1924 % We're going to be starting a paragraph, but we don't want the
1925 % \parskip glue -- logically it's part of the @item we just started.
1926 \nobreak \vskip-\parskip
1928 % Stop a page break at the \parskip glue coming up. (Unfortunately
1929 % we can't prevent a possible page break at the following
1930 % \baselineskip glue.) However, if what follows is an environment
1931 % such as @example, there will be no \parskip glue; then
1932 % the negative vskip we just would cause the example and the item to
1933 % crash together. So we use this bizarre value of 10001 as a signal
1934 % to \aboveenvbreak to insert \parskip glue after all.
1935 % (Possibly there are other commands that could be followed by
1936 % @example which need the same treatment, but not section titles; or
1937 % maybe section titles are the only special case and they should be
1941 \itemxneedsnegativevskipfalse
1943 % The item text fits into the space. Start a paragraph, so that the
1944 % following text (if any) will end up on the same line.
1946 % Do this with kerns and \unhbox so that if there is a footnote in
1947 % the item text, it can migrate to the main vertical list and
1948 % eventually be printed.
1949 \nobreak\kern-\tableindent
1950 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1952 \nobreak\kern\dimen0
1954 \itemxneedsnegativevskiptrue
1958 \def\item{\errmessage{@item while not in a table}}
1959 \def\itemx{\errmessage{@itemx while not in a table}}
1960 \def\kitem{\errmessage{@kitem while not in a table}}
1961 \def\kitemx{\errmessage{@kitemx while not in a table}}
1962 \def\xitem{\errmessage{@xitem while not in a table}}
1963 \def\xitemx{\errmessage{@xitemx while not in a table}}
1965 % Contains a kludge to get @end[description] to work.
1966 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1968 % @table, @ftable, @vtable.
1969 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1970 {\obeylines\obeyspaces%
1971 \gdef\tablex #1^^M{%
1972 \tabley\dontindex#1 \endtabley}}
1974 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1975 {\obeylines\obeyspaces%
1976 \gdef\ftablex #1^^M{%
1977 \tabley\fnitemindex#1 \endtabley
1978 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1979 \let\Etable=\relax}}
1981 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1982 {\obeylines\obeyspaces%
1983 \gdef\vtablex #1^^M{%
1984 \tabley\vritemindex#1 \endtabley
1985 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1986 \let\Etable=\relax}}
1989 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1990 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1993 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1994 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1996 \def\tablez #1#2#3#4#5#6{%
1999 \def\Edescription{\Etable}% Necessary kludge.
2001 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
2002 \ifnum 0#4>0 \tableindent=#4\mil \fi %
2003 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
2005 \itemmax=\tableindent %
2006 \advance \itemmax by -\itemmargin %
2007 \advance \leftskip by \tableindent %
2008 \exdentamount=\tableindent
2010 \parskip = \smallskipamount
2011 \ifdim \parskip=0pt \parskip=2pt \fi%
2012 \def\Etable{\endgraf\afterenvbreak\endgroup}%
2013 \let\item = \internalBitem %
2014 \let\itemx = \internalBitemx %
2015 \let\kitem = \internalBkitem %
2016 \let\kitemx = \internalBkitemx %
2017 \let\xitem = \internalBxitem %
2018 \let\xitemx = \internalBxitemx %
2021 % This is the counter used by @enumerate, which is really @itemize
2025 \def\itemize{\parsearg\itemizezzz}
2027 \def\itemizezzz #1{%
2028 \begingroup % ended by the @end itemize
2029 \itemizey {#1}{\Eitemize}
2032 \def\itemizey #1#2{%
2034 \itemmax=\itemindent %
2035 \advance \itemmax by -\itemmargin %
2036 \advance \leftskip by \itemindent %
2037 \exdentamount=\itemindent
2039 \parskip = \smallskipamount %
2040 \ifdim \parskip=0pt \parskip=2pt \fi%
2041 \def#2{\endgraf\afterenvbreak\endgroup}%
2042 \def\itemcontents{#1}%
2043 \let\item=\itemizeitem}
2045 % \splitoff TOKENS\endmark defines \first to be the first token in
2046 % TOKENS, and \rest to be the remainder.
2048 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2050 % Allow an optional argument of an uppercase letter, lowercase letter,
2051 % or number, to specify the first label in the enumerated list. No
2052 % argument is the same as `1'.
2054 \def\enumerate{\parsearg\enumeratezzz}
2055 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2056 \def\enumeratey #1 #2\endenumeratey{%
2057 \begingroup % ended by the @end enumerate
2059 % If we were given no argument, pretend we were given `1'.
2061 \ifx\thearg\empty \def\thearg{1}\fi
2063 % Detect if the argument is a single token. If so, it might be a
2064 % letter. Otherwise, the only valid thing it can be is a number.
2065 % (We will always have one token, because of the test we just made.
2066 % This is a good thing, since \splitoff doesn't work given nothing at
2067 % all -- the first parameter is undelimited.)
2068 \expandafter\splitoff\thearg\endmark
2070 % Only one token in the argument. It could still be anything.
2071 % A ``lowercase letter'' is one whose \lccode is nonzero.
2072 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2073 % not equal to itself.
2074 % Otherwise, we assume it's a number.
2076 % We need the \relax at the end of the \ifnum lines to stop TeX from
2077 % continuing to look for a <number>.
2079 \ifnum\lccode\expandafter`\thearg=0\relax
2080 \numericenumerate % a number (we hope)
2083 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2084 \lowercaseenumerate % lowercase letter
2086 \uppercaseenumerate % uppercase letter
2090 % Multiple tokens in the argument. We hope it's a number.
2095 % An @enumerate whose labels are integers. The starting integer is
2098 \def\numericenumerate{%
2100 \startenumeration{\the\itemno}%
2103 % The starting (lowercase) letter is in \thearg.
2104 \def\lowercaseenumerate{%
2105 \itemno = \expandafter`\thearg
2107 % Be sure we're not beyond the end of the alphabet.
2109 \errmessage{No more lowercase letters in @enumerate; get a bigger
2116 % The starting (uppercase) letter is in \thearg.
2117 \def\uppercaseenumerate{%
2118 \itemno = \expandafter`\thearg
2120 % Be sure we're not beyond the end of the alphabet.
2122 \errmessage{No more uppercase letters in @enumerate; get a bigger
2129 % Call itemizey, adding a period to the first argument and supplying the
2130 % common last two arguments. Also subtract one from the initial value in
2131 % \itemno, since @item increments \itemno.
2133 \def\startenumeration#1{%
2134 \advance\itemno by -1
2135 \itemizey{#1.}\Eenumerate\flushcr
2138 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2141 \def\alphaenumerate{\enumerate{a}}
2142 \def\capsenumerate{\enumerate{A}}
2143 \def\Ealphaenumerate{\Eenumerate}
2144 \def\Ecapsenumerate{\Eenumerate}
2146 % Definition of @item while inside @itemize.
2149 \advance\itemno by 1
2150 {\let\par=\endgraf \smallbreak}%
2151 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2152 {\parskip=0in \hskip 0pt
2153 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2154 \vadjust{\penalty 1200}}%
2157 % @multitable macros
2158 % Amy Hendrickson, 8/18/94, 3/6/96
2160 % @multitable ... @end multitable will make as many columns as desired.
2161 % Contents of each column will wrap at width given in preamble. Width
2162 % can be specified either with sample text given in a template line,
2163 % or in percent of \hsize, the current width of text on page.
2165 % Table can continue over pages but will only break between lines.
2169 % Either define widths of columns in terms of percent of \hsize:
2170 % @multitable @columnfractions .25 .3 .45
2173 % Numbers following @columnfractions are the percent of the total
2174 % current hsize to be used for each column. You may use as many
2175 % columns as desired.
2178 % Or use a template:
2179 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2181 % using the widest term desired in each column.
2183 % For those who want to use more than one line's worth of words in
2184 % the preamble, break the line within one argument and it
2185 % will parse correctly, i.e.,
2187 % @multitable {Column 1 template} {Column 2 template} {Column 3
2190 % @multitable {Column 1 template} {Column 2 template}
2191 % {Column 3 template}
2193 % Each new table line starts with @item, each subsequent new column
2194 % starts with @tab. Empty columns may be produced by supplying @tab's
2195 % with nothing between them for as many times as empty columns are needed,
2196 % ie, @tab@tab@tab will produce two empty columns.
2198 % @item, @tab, @multitable or @end multitable do not need to be on their
2199 % own lines, but it will not hurt if they are.
2201 % Sample multitable:
2203 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2204 % @item first col stuff @tab second col stuff @tab third col
2211 % @item first col stuff @tab second col stuff
2212 % @tab Many paragraphs of text may be used in any column.
2214 % They will wrap at the width determined by the template.
2215 % @item@tab@tab This will be in third column.
2218 % Default dimensions may be reset by user.
2219 % @multitableparskip is vertical space between paragraphs in table.
2220 % @multitableparindent is paragraph indent in table.
2221 % @multitablecolmargin is horizontal space to be left between columns.
2222 % @multitablelinespace is space to leave between table items, baseline
2224 % 0pt means it depends on current normal line spacing.
2226 \newskip\multitableparskip
2227 \newskip\multitableparindent
2228 \newdimen\multitablecolspace
2229 \newskip\multitablelinespace
2230 \multitableparskip=0pt
2231 \multitableparindent=6pt
2232 \multitablecolspace=12pt
2233 \multitablelinespace=0pt
2235 % Macros used to set up halign preamble:
2237 \let\endsetuptable\relax
2238 \def\xendsetuptable{\endsetuptable}
2239 \let\columnfractions\relax
2240 \def\xcolumnfractions{\columnfractions}
2243 % #1 is the part of the @columnfraction before the decimal point, which
2244 % is presumably either 0 or the empty string (but we don't check, we
2245 % just throw it away). #2 is the decimal part, which we use as the
2246 % percent of \hsize for this column.
2247 \def\pickupwholefraction#1.#2 {%
2248 \global\advance\colcount by 1
2249 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2256 \ifx\firstarg\xendsetuptable
2259 \ifx\firstarg\xcolumnfractions
2260 \global\setpercenttrue
2263 \let\go\pickupwholefraction
2265 \global\advance\colcount by 1
2266 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2267 % separator; typically that is always in the input, anyway.
2268 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2271 \ifx\go\pickupwholefraction
2272 % Put the argument back for the \pickupwholefraction call, so
2273 % we'll always have a period there to be parsed.
2274 \def\go{\pickupwholefraction#1}%
2276 \let\go = \setuptable
2282 % @multitable ... @end multitable definitions:
2284 \def\multitable{\parsearg\dotable}
2285 \def\dotable#1{\bgroup
2287 \let\item=\crcrwithfootnotes
2288 % A \tab used to include \hskip1sp. But then the space in a template
2289 % line is not enough. That is bad. So let's go back to just & until
2290 % we encounter the problem it was intended to solve again. --karl,
2291 % nathan@acm.org, 20apr99.
2293 \let\startfootins=\startsavedfootnote
2296 \setmultitablespacing
2297 \parskip=\multitableparskip
2298 \parindent=\multitableparindent
2302 \global\setpercentfalse
2303 \crcrwithfootnotes\crcr
2307 % To parse everything between @multitable and @item:
2308 \setuptable#1 \endsetuptable
2310 % \everycr will reset column counter, \colcount, at the end of
2311 % each line. Every column entry will cause \colcount to advance by one.
2312 % The table preamble
2313 % looks at the current \colcount to find the correct column width.
2316 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2317 % Maybe so, but it also creates really weird page breaks when the table
2318 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2319 % manifests itself, so it can be fixed for real --karl.
2320 \global\colcount=0\relax}}%
2322 % This preamble sets up a generic column definition, which will
2323 % be used as many times as user calls for columns.
2324 % \vtop will set a single line and will also let text wrap and
2325 % continue for many paragraphs if desired.
2326 \halign\bgroup&\global\advance\colcount by 1\relax
2327 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2329 % In order to keep entries from bumping into each other
2330 % we will add a \leftskip of \multitablecolspace to all columns after
2333 % If a template has been used, we will add \multitablecolspace
2334 % to the width of each template entry.
2336 % If the user has set preamble in terms of percent of \hsize we will
2337 % use that dimension as the width of the column, and the \leftskip
2338 % will keep entries from bumping into each other. Table will start at
2339 % left margin and final column will justify at right margin.
2341 % Make sure we don't inherit \rightskip from the outer environment.
2344 % The first column will be indented with the surrounding text.
2345 \advance\hsize by\leftskip
2348 % If user has not set preamble in terms of percent of \hsize
2349 % we will advance \hsize by \multitablecolspace.
2350 \advance\hsize by \multitablecolspace
2352 % In either case we will make \leftskip=\multitablecolspace:
2353 \leftskip=\multitablecolspace
2355 % Ignoring space at the beginning and end avoids an occasional spurious
2356 % blank line, when TeX decides to break the line at the space before the
2357 % box from the multistrut, so the strut ends up on a line by itself.
2359 % @multitable @columnfractions .11 .89
2361 % @tab Legal holiday which is valid in major parts of the whole country.
2362 % Is automatically provided with highlighting sequences respectively marking
2364 \noindent\ignorespaces##\unskip\multistrut}\cr
2367 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2368 % If so, do nothing. If not, give it an appropriate dimension based on
2369 % current baselineskip.
2370 \ifdim\multitablelinespace=0pt
2371 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2372 \global\advance\multitablelinespace by-\ht0
2373 %% strut to put in table in case some entry doesn't have descenders,
2374 %% to keep lines equally spaced
2375 \let\multistrut = \strut
2377 %% FIXME: what is \box0 supposed to be?
2378 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2380 %% Test to see if parskip is larger than space between lines of
2381 %% table. If not, do nothing.
2382 %% If so, set to same dimension as multitablelinespace.
2383 \ifdim\multitableparskip>\multitablelinespace
2384 \global\multitableparskip=\multitablelinespace
2385 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2386 %% than skip between lines in the table.
2388 \ifdim\multitableparskip=0pt
2389 \global\multitableparskip=\multitablelinespace
2390 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2391 %% than skip between lines in the table.
2394 % In case a @footnote appears inside an alignment, save the footnote
2395 % text to a box and make the \insert when a row of the table is
2396 % finished. Otherwise, the insertion is lost, it never migrates to the
2397 % main vertical list. --kasal, 22jan03.
2399 \newbox\savedfootnotes
2401 % \dotable \let's \startfootins to this, so that \dofootnote will call
2402 % it instead of starting the insertion right away.
2403 \def\startsavedfootnote{%
2404 \global\setbox\savedfootnotes = \vbox\bgroup
2405 \unvbox\savedfootnotes
2407 \def\crcrwithfootnotes{%
2409 \ifvoid\savedfootnotes \else
2410 \noalign{\insert\footins{\box\savedfootnotes}}%
2414 \message{conditionals,}
2415 % Prevent errors for section commands.
2416 % Used in @ignore and in failing conditionals.
2417 \def\ignoresections{%
2419 \let\unnumbered=\relax
2421 \let\unnumberedsec=\relax
2422 \let\unnumberedsection=\relax
2423 \let\unnumberedsubsec=\relax
2424 \let\unnumberedsubsection=\relax
2425 \let\unnumberedsubsubsec=\relax
2426 \let\unnumberedsubsubsection=\relax
2429 \let\subsubsec=\relax
2430 \let\subsection=\relax
2431 \let\subsubsection=\relax
2432 \let\appendix=\relax
2433 \let\appendixsec=\relax
2434 \let\appendixsection=\relax
2435 \let\appendixsubsec=\relax
2436 \let\appendixsubsection=\relax
2437 \let\appendixsubsubsec=\relax
2438 \let\appendixsubsubsection=\relax
2439 \let\contents=\relax
2440 \let\smallbook=\relax
2441 \let\titlepage=\relax
2444 % Used in nested conditionals, where we have to parse the Texinfo source
2445 % and so want to turn off most commands, in case they are used
2448 % We use \empty instead of \relax for the @def... commands, so that \end
2449 % doesn't throw an error. For instance:
2455 % The @end deffn is going to get expanded, because we're trying to allow
2456 % nested conditionals. But we don't want to expand the actual @deffn,
2457 % since it might be syntactically correct and intended to be ignored.
2458 % Since \end checks for \relax, using \empty does not cause an error.
2460 \def\ignoremorecommands{%
2461 \let\defcodeindex = \relax
2463 \let\defcvx = \empty
2464 \let\Edefcv = \empty
2466 \let\deffnx = \empty
2467 \let\Edeffn = \empty
2468 \let\defindex = \relax
2469 \let\defivar = \empty
2470 \let\defivarx = \empty
2471 \let\Edefivar = \empty
2472 \let\defmac = \empty
2473 \let\defmacx = \empty
2474 \let\Edefmac = \empty
2475 \let\defmethod = \empty
2476 \let\defmethodx = \empty
2477 \let\Edefmethod = \empty
2479 \let\defopx = \empty
2480 \let\Edefop = \empty
2481 \let\defopt = \empty
2482 \let\defoptx = \empty
2483 \let\Edefopt = \empty
2484 \let\defspec = \empty
2485 \let\defspecx = \empty
2486 \let\Edefspec = \empty
2488 \let\deftpx = \empty
2489 \let\Edeftp = \empty
2490 \let\deftypefn = \empty
2491 \let\deftypefnx = \empty
2492 \let\Edeftypefn = \empty
2493 \let\deftypefun = \empty
2494 \let\deftypefunx = \empty
2495 \let\Edeftypefun = \empty
2496 \let\deftypeivar = \empty
2497 \let\deftypeivarx = \empty
2498 \let\Edeftypeivar = \empty
2499 \let\deftypemethod = \empty
2500 \let\deftypemethodx = \empty
2501 \let\Edeftypemethod = \empty
2502 \let\deftypeop = \empty
2503 \let\deftypeopx = \empty
2504 \let\Edeftypeop = \empty
2505 \let\deftypevar = \empty
2506 \let\deftypevarx = \empty
2507 \let\Edeftypevar = \empty
2508 \let\deftypevr = \empty
2509 \let\deftypevrx = \empty
2510 \let\Edeftypevr = \empty
2512 \let\defunx = \empty
2513 \let\Edefun = \empty
2514 \let\defvar = \empty
2515 \let\defvarx = \empty
2516 \let\Edefvar = \empty
2518 \let\defvrx = \empty
2519 \let\Edefvr = \empty
2522 \let\evenfooting = \relax
2523 \let\evenheading = \relax
2524 \let\everyfooting = \relax
2525 \let\everyheading = \relax
2526 \let\headings = \relax
2527 \let\include = \relax
2529 \let\lowersections = \relax
2530 \let\oddfooting = \relax
2531 \let\oddheading = \relax
2532 \let\printindex = \relax
2534 \let\raisesections = \relax
2537 \let\setchapternewpage = \relax
2538 \let\setchapterstyle = \relax
2539 \let\settitle = \relax
2541 \let\verbatiminclude = \relax
2545 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2547 \def\direntry{\doignore{direntry}}
2548 \def\documentdescriptionword{documentdescription}
2549 \def\documentdescription{\doignore{documentdescription}}
2550 \def\html{\doignore{html}}
2551 \def\ifhtml{\doignore{ifhtml}}
2552 \def\ifinfo{\doignore{ifinfo}}
2553 \def\ifnottex{\doignore{ifnottex}}
2554 \def\ifplaintext{\doignore{ifplaintext}}
2555 \def\ifxml{\doignore{ifxml}}
2556 \def\ignore{\doignore{ignore}}
2557 \def\menu{\doignore{menu}}
2558 \def\xml{\doignore{xml}}
2560 % @dircategory CATEGORY -- specify a category of the dir file
2561 % which this file should belong to. Ignore this in TeX.
2562 \let\dircategory = \comment
2564 % Ignore text until a line `@end #1'.
2566 \def\doignore#1{\begingroup
2567 % Don't complain about control sequences we have declared \outer.
2570 % Define a command to swallow text until we reach `@end #1'.
2571 % This @ is a catcode 12 token (that is the normal catcode of @ in
2572 % this texinfo.tex file). We change the catcode of @ below to match.
2573 \long\def\doignoretext##1@end #1{\enddoignore}%
2575 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2576 \catcode\spaceChar = 10
2578 % Ignore braces, too, so mismatched braces don't cause trouble.
2582 % We must not have @c interpreted as a control sequence.
2585 \def\ignoreword{#1}%
2586 \ifx\ignoreword\documentdescriptionword
2587 % The c kludge breaks documentdescription, since
2588 % `documentdescription' contains a `c'. Means not everything will
2589 % be ignored inside @documentdescription, but oh well...
2591 % Make the letter c a comment character so that the rest of the line
2592 % will be ignored. This way, the document can have (for example)
2594 % and the @end ifinfo will be properly ignored.
2595 % (We've just changed @ to catcode 12.)
2599 % And now expand the command defined above.
2603 % What we do to finish off ignored text.
2605 \def\enddoignore{\endgroup\ignorespaces}%
2607 \newif\ifwarnedobs\warnedobsfalse
2609 \ifwarnedobs\relax\else
2610 % We need to warn folks that they may have trouble with TeX 3.0.
2611 % This uses \immediate\write16 rather than \message to get newlines.
2612 \immediate\write16{}
2613 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2614 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2615 \immediate\write16{If you are running another version of TeX, relax.}
2616 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2617 \immediate\write16{ Then upgrade your TeX installation if you can.}
2618 \immediate\write16{ (See ftp://ftp.gnu.org/non-gnu/TeX.README.)}
2619 \immediate\write16{If you are stuck with version 3.0, run the}
2620 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2621 \immediate\write16{ to use a workaround.}
2622 \immediate\write16{}
2623 \global\warnedobstrue
2627 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2628 % workaround (which requires the file ``dummy.tfm'' to be installed),
2629 % uncomment the following line:
2630 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2632 % Ignore text, except that we keep track of conditional commands for
2633 % purposes of nesting, up to an `@end #1' command.
2635 \def\nestedignore#1{%
2637 % We must actually expand the ignored text to look for the @end
2638 % command, so that nested ignore constructs work. Thus, we put the
2639 % text into a \vbox and then do nothing with the result. To minimize
2640 % the chance of memory overflow, we follow the approach outlined on
2641 % page 401 of the TeXbook.
2643 \setbox0 = \vbox\bgroup
2644 % Don't complain about control sequences we have declared \outer.
2647 % Define `@end #1' to end the box, which will in turn undefine the
2648 % @end command again.
2649 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2651 % We are going to be parsing Texinfo commands. Most cause no
2652 % trouble when they are used incorrectly, but some commands do
2653 % complicated argument parsing or otherwise get confused, so we
2656 % We can't do anything about stray @-signs, unfortunately;
2657 % they'll produce `undefined control sequence' errors.
2660 % Set the current font to be \nullfont, a TeX primitive, and define
2661 % all the font commands to also use \nullfont. We don't use
2662 % dummy.tfm, as suggested in the TeXbook, because some sites
2663 % might not have that installed. Therefore, math mode will still
2664 % produce output, but that should be an extremely small amount of
2665 % stuff compared to the main input.
2668 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2669 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2670 \let\tensf=\nullfont
2671 % Similarly for index fonts.
2672 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2673 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2674 \let\smallsf=\nullfont
2675 % Similarly for smallexample fonts.
2676 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2677 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2678 \let\smallersf=\nullfont
2680 % Don't complain when characters are missing from the fonts.
2681 \tracinglostchars = 0
2683 % Don't bother to do space factor calculations.
2686 % Don't report underfull hboxes.
2689 % Do minimal line-breaking.
2690 \pretolerance = 10000
2692 % Do not execute instructions in @tex.
2693 \def\tex{\doignore{tex}}%
2694 % Do not execute macro definitions.
2695 % `c' is a comment character, so the word `macro' will get cut off.
2696 \def\macro{\doignore{ma}}%
2699 % @set VAR sets the variable VAR to an empty value.
2700 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2702 % Since we want to separate VAR from REST-OF-LINE (which might be
2703 % empty), we can't just use \parsearg; we have to insert a space of our
2704 % own to delimit the rest of the line, and then take it out again if we
2705 % didn't need it. Make sure the catcode of space is correct to avoid
2706 % losing inside @example, for instance.
2708 \def\set{\begingroup\catcode` =10
2709 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2711 \def\setxxx#1{\setyyy#1 \endsetyyy}
2712 \def\setyyy#1 #2\endsetyyy{%
2714 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2715 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2719 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2720 % \next or other control sequences that we've defined might get us into
2721 % an infinite loop. Consider `@set foo @cite{bar}'.
2722 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2724 % @clear VAR clears (i.e., unsets) the variable VAR.
2726 \def\clear{\parsearg\clearxxx}
2727 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2729 % @value{foo} gets the text saved in variable foo.
2731 \catcode`\_ = \active
2733 % We might end up with active _ or - characters in the argument if
2734 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2735 % such active characters to their normal equivalents.
2736 \gdef\value{\begingroup
2737 \catcode`\-=\other \catcode`\_=\other
2738 \indexbreaks \let_\normalunderscore
2741 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2743 % We have this subroutine so that we can handle at least some @value's
2744 % properly in indexes (we \let\value to this in \indexdummies). Ones
2745 % whose names contain - or _ still won't work, but we can't do anything
2746 % about that. The command has to be fully expandable (if the variable
2747 % is set), since the result winds up in the index file. This means that
2748 % if the variable's value contains other Texinfo commands, it's almost
2749 % certain it will fail (although perhaps we could fix that with
2750 % sufficient work to do a one-level expansion on the result, instead of
2753 \def\expandablevalue#1{%
2754 \expandafter\ifx\csname SET#1\endcsname\relax
2755 {[No value for ``#1'']}%
2756 \message{Variable `#1', used in @value, is not set.}%
2758 \csname SET#1\endcsname
2762 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2765 \def\ifset{\parsearg\doifset}
2767 \expandafter\ifx\csname SET#1\endcsname\relax
2768 \let\next=\ifsetfail
2770 \let\next=\ifsetsucceed
2774 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2775 \def\ifsetfail{\nestedignore{ifset}}
2776 \defineunmatchedend{ifset}
2778 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2779 % defined with @set, or has been undefined with @clear.
2781 \def\ifclear{\parsearg\doifclear}
2783 \expandafter\ifx\csname SET#1\endcsname\relax
2784 \let\next=\ifclearsucceed
2786 \let\next=\ifclearfail
2790 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2791 \def\ifclearfail{\nestedignore{ifclear}}
2792 \defineunmatchedend{ifclear}
2794 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2795 % read the text following, through the first @end iftex (etc.). Make
2796 % `@end iftex' (etc.) valid only after an @iftex.
2798 \def\iftex{\conditionalsucceed{iftex}}
2799 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2800 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2801 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2802 \defineunmatchedend{iftex}
2803 \defineunmatchedend{ifnothtml}
2804 \defineunmatchedend{ifnotinfo}
2805 \defineunmatchedend{ifnotplaintext}
2807 % True conditional. Since \set globally defines its variables, we can
2808 % just start and end a group (to keep the @end definition undefined at
2811 \def\conditionalsucceed#1{\begingroup
2812 \expandafter\def\csname E#1\endcsname{\endgroup}%
2815 % @defininfoenclose.
2816 \let\definfoenclose=\comment
2820 % Index generation facilities
2822 % Define \newwrite to be identical to plain tex's \newwrite
2823 % except not \outer, so it can be used within \newindex.
2825 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2827 % \newindex {foo} defines an index named foo.
2828 % It automatically defines \fooindex such that
2829 % \fooindex ...rest of line... puts an entry in the index foo.
2830 % It also defines \fooindfile to be the number of the output channel for
2831 % the file that accumulates this index. The file's extension is foo.
2832 % The name of an index should be no more than 2 characters long
2833 % for the sake of vms.
2837 \expandafter\newwrite \csname#1indfile\endcsname
2838 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2840 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2841 \noexpand\doindex{#1}}
2844 % @defindex foo == \newindex{foo}
2846 \def\defindex{\parsearg\newindex}
2848 % Define @defcodeindex, like @defindex except put all entries in @code.
2850 \def\defcodeindex{\parsearg\newcodeindex}
2852 \def\newcodeindex#1{%
2854 \expandafter\newwrite \csname#1indfile\endcsname
2855 \openout \csname#1indfile\endcsname \jobname.#1
2857 \expandafter\xdef\csname#1index\endcsname{%
2858 \noexpand\docodeindex{#1}}%
2862 % @synindex foo bar makes index foo feed into index bar.
2863 % Do this instead of @defindex foo if you don't want it as a separate index.
2865 % @syncodeindex foo bar similar, but put all entries made for index foo
2868 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2869 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2871 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2872 % #3 the target index (bar).
2873 \def\dosynindex#1#2#3{%
2874 % Only do \closeout if we haven't already done it, else we'll end up
2875 % closing the target index.
2876 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2877 % The \closeout helps reduce unnecessary open files; the limit on the
2878 % Acorn RISC OS is a mere 16 files.
2879 \expandafter\closeout\csname#2indfile\endcsname
2880 \expandafter\let\csname\donesynindex#2\endcsname = 1
2882 % redefine \fooindfile:
2883 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2884 \expandafter\let\csname#2indfile\endcsname=\temp
2885 % redefine \fooindex:
2886 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2889 % Define \doindex, the driver for all \fooindex macros.
2890 % Argument #1 is generated by the calling \fooindex macro,
2891 % and it is "foo", the name of the index.
2893 % \doindex just uses \parsearg; it calls \doind for the actual work.
2894 % This is because \doind is more useful to call from other macros.
2896 % There is also \dosubind {index}{topic}{subtopic}
2897 % which makes an entry in a two-level index such as the operation index.
2899 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2900 \def\singleindexer #1{\doind{\indexname}{#1}}
2902 % like the previous two, but they put @code around the argument.
2903 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2904 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2906 % Define \#1 as \realbackslash #1\space, thus effectively preventing its
2907 % expansion. This is used only for control words, not control
2908 % characters, because the \space would be incorrect for control
2909 % characters, but is needed to separate the control word from whatever
2912 % This can be used both for control words that take an argument and
2913 % those that do not. If it does take an argument, then it'll be
2914 % followed by {arg} in the input, which will dutifully get written to
2915 % the index (or wherever).
2917 \def\definedummyword#1{%
2918 \expandafter\def\csname #1\endcsname{\realbackslash #1\space}%
2921 % Take care of Texinfo commands that can appear in an index entry.
2922 % Since there are some commands we want to expand, and others we don't,
2923 % we have to laboriously prevent expansion for those that we don't.
2926 \def\ {\realbackslash }%
2927 \def\@{@}% change to @@ when we switch to @ as escape char in aux files.
2928 % Need these in case \tex is in effect and \{ is a \delimiter again.
2929 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2930 % braces and backslashes are used only as delimiters.
2933 \def\_{{\realbackslash _}}%
2934 \normalturnoffactive
2937 \def\,{\realbackslash ,}%
2938 \def\"{\realbackslash "}%
2939 \def\`{\realbackslash `}%
2940 \def\'{\realbackslash acuteaccent }% workaround aux file using ' as escape
2941 \def\^{\realbackslash ^}%
2942 \def\~{\realbackslash ~}%
2943 \def\={\realbackslash =}%
2944 \definedummyword{u}%
2945 \definedummyword{v}%
2946 \definedummyword{H}%
2947 \definedummyword{dotaccent}%
2948 \definedummyword{ringaccent}%
2949 \definedummyword{tieaccent}%
2950 \definedummyword{ubaraccent}%
2951 \definedummyword{udotaccent}%
2952 \definedummyword{dotless}%
2954 % Other non-English letters.
2955 \definedummyword{AA}%
2956 \definedummyword{AE}%
2957 \definedummyword{L}%
2958 \definedummyword{OE}%
2959 \definedummyword{O}%
2960 \definedummyword{aa}%
2961 \definedummyword{ae}%
2962 \definedummyword{l}%
2963 \definedummyword{oe}%
2964 \definedummyword{o}%
2965 \definedummyword{ss}%
2967 % Although these internal commands shouldn't show up, sometimes they do.
2968 \definedummyword{bf}%
2969 \definedummyword{gtr}%
2970 \definedummyword{hat}%
2971 \definedummyword{less}%
2972 \definedummyword{sf}%
2973 \definedummyword{sl}%
2974 \definedummyword{tclose}%
2975 \definedummyword{tt}%
2977 % Texinfo font commands.
2978 \definedummyword{b}%
2979 \definedummyword{i}%
2980 \definedummyword{r}%
2981 \definedummyword{sc}%
2982 \definedummyword{t}%
2984 \definedummyword{TeX}%
2985 \definedummyword{acronym}%
2986 \definedummyword{cite}%
2987 \definedummyword{code}%
2988 \definedummyword{command}%
2989 \definedummyword{dfn}%
2990 \definedummyword{dots}%
2991 \definedummyword{emph}%
2992 \definedummyword{env}%
2993 \definedummyword{file}%
2994 \definedummyword{kbd}%
2995 \definedummyword{key}%
2996 \definedummyword{math}%
2997 \definedummyword{option}%
2998 \definedummyword{samp}%
2999 \definedummyword{strong}%
3000 \definedummyword{uref}%
3001 \definedummyword{url}%
3002 \definedummyword{var}%
3003 \definedummyword{w}%
3005 % These math commands don't seem likely to be used in index entries.
3006 \definedummyword{copyright}%
3007 \definedummyword{equiv}%
3008 \definedummyword{error}%
3009 \definedummyword{expansion}%
3010 \definedummyword{point}%
3011 \definedummyword{print}%
3012 \definedummyword{result}%
3014 % Handle some cases of @value -- where the variable name does not
3015 % contain - or _, and the value does not contain any
3016 % (non-fully-expandable) commands.
3017 \let\value = \expandablevalue
3019 % Normal spaces, not active ones.
3022 % No macro expansion.
3026 % If an index command is used in an @example environment, any spaces
3027 % therein should become regular spaces in the raw index file, not the
3028 % expansion of \tie (\leavevmode \penalty \@M \ ).
3030 \gdef\unsepspaces{\obeyspaces\let =\space}}
3033 % \indexnofonts is used when outputting the strings to sort the index
3034 % by. Therefore, it eliminates all control sequences and just writes
3035 % whatever the best ASCII sort string would be for a given command
3036 % (usually its argument).
3038 \def\indexdummytex{TeX}
3039 \def\indexdummydots{...}
3044 % how to handle braces?
3045 \def\_{\normalunderscore}%
3057 \let\dotaccent=\asis
3058 \let\ringaccent=\asis
3059 \let\tieaccent=\asis
3060 \let\ubaraccent=\asis
3061 \let\udotaccent=\asis
3064 % Other non-English letters.
3077 \def\questiondown{?}%
3079 % Don't no-op \tt, since it isn't a user-level command
3080 % and is used in the definitions of the active chars like <, >, |, etc.
3081 % Likewise with the other plain tex font commands.
3084 % Texinfo font commands.
3091 \let\TeX=\indexdummytex
3097 \let\dots=\indexdummydots
3113 % To define \realbackslash, we must make \ not be an escape.
3114 % We must first make another character (@) an escape
3115 % so we do not become unable to do a definition.
3117 {\catcode`\@=0 \catcode`\\=\other
3118 @gdef@realbackslash{\}}
3120 \let\indexbackslash=0 %overridden during \printindex.
3121 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3123 % For \ifx comparisons.
3124 \def\emptymacro{\empty}
3126 % Most index entries go through here, but \dosubind is the general case.
3128 \def\doind#1#2{\dosubind{#1}{#2}\empty}
3130 % Workhorse for all \fooindexes.
3131 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3132 % \empty if called from \doind, as we usually are. The main exception
3133 % is with defuns, which call us directly.
3135 \def\dosubind#1#2#3{%
3136 % Put the index entry in the margin if desired.
3137 \ifx\SETmarginindex\relax\else
3138 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
3141 \count255=\lastpenalty
3143 \indexdummies % Must do this here, since \bf, etc expand at this stage
3146 \let\folio = 0% We will expand all macros now EXCEPT \folio.
3147 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3148 % so it will be output as is; and it will print as backslash.
3152 % If third arg is present, precede it with space in sort key.
3153 \ifx\thirdarg\emptymacro
3154 \let\subentry = \empty
3159 % First process the index entry with all font commands turned
3160 % off to get the string to sort by.
3161 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
3163 % Now the real index entry with the fonts.
3166 % If the third (subentry) arg is present, add it to the index
3168 \ifx\thirdarg\emptymacro \else
3169 \toks0 = \expandafter{\the\toks0{#3}}%
3172 % Set up the complete index entry, with both the sort key and
3173 % the original text, including any font commands. We write
3174 % three arguments to \entry to the .?? file (four in the
3175 % subentry case), texindex reduces to two when writing the .??s
3178 \write\csname#1indfile\endcsname{%
3179 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3182 % If a skip is the last thing on the list now, preserve it
3183 % by backing up by \lastskip, doing the \write, then inserting
3184 % the skip again. Otherwise, the whatsit generated by the
3185 % \write will make \lastskip zero. The result is that sequences
3190 % will have extra space inserted, because the \medbreak in the
3191 % start of the @defun won't see the skip inserted by the @end of
3192 % the previous defun.
3194 % But don't do any of this if we're not in vertical mode. We
3195 % don't want to do a \vskip and prematurely end a paragraph.
3197 % Avoid page breaks due to these extra skips, too.
3202 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
3205 \temp % do the write
3208 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3216 % The index entry written in the file actually looks like
3217 % \entry {sortstring}{page}{topic}
3219 % \entry {sortstring}{page}{topic}{subtopic}
3220 % The texindex program reads in these files and writes files
3221 % containing these kinds of lines:
3223 % before the first topic whose initial is c
3224 % \entry {topic}{pagelist}
3225 % for a topic that is used without subtopics
3227 % for the beginning of a topic that is used with subtopics
3228 % \secondary {subtopic}{pagelist}
3229 % for each subtopic.
3231 % Define the user-accessible indexing commands
3232 % @findex, @vindex, @kindex, @cindex.
3234 \def\findex {\fnindex}
3235 \def\kindex {\kyindex}
3236 \def\cindex {\cpindex}
3237 \def\vindex {\vrindex}
3238 \def\tindex {\tpindex}
3239 \def\pindex {\pgindex}
3241 \def\cindexsub {\begingroup\obeylines\cindexsub}
3243 \gdef\cindexsub "#1" #2^^M{\endgroup %
3244 \dosubind{cp}{#2}{#1}}}
3246 % Define the macros used in formatting output of the sorted index material.
3248 % @printindex causes a particular index (the ??s file) to get printed.
3249 % It does not print any chapter heading (usually an @unnumbered).
3251 \def\printindex{\parsearg\doprintindex}
3252 \def\doprintindex#1{\begingroup
3253 \dobreak \chapheadingskip{10000}%
3259 % See if the index file exists and is nonempty.
3260 % Change catcode of @ here so that if the index file contains
3262 % as its first line, TeX doesn't complain about mismatched braces
3263 % (because it thinks @} is a control sequence).
3265 \openin 1 \jobname.#1s
3267 % \enddoublecolumns gets confused if there is no text in the index,
3268 % and it loses the chapter title and the aux file entries for the
3269 % index. The easiest way to prevent this problem is to make sure
3270 % there is some text.
3271 \putwordIndexNonexistent
3274 % If the index file exists but is empty, then \openin leaves \ifeof
3275 % false. We have to make TeX try to read something from the file, so
3276 % it can discover if there is anything in it.
3279 \putwordIndexIsEmpty
3281 % Index files are almost Texinfo source, but we use \ as the escape
3282 % character. It would be better to use @, but that's too big a change
3283 % to make right now.
3284 \def\indexbackslash{\rawbackslashxx}%
3295 % These macros are used by the sorted index file itself.
3296 % Change them to control the appearance of the index.
3299 % Some minor font changes for the special characters.
3300 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3302 % Remove any glue we may have, we'll be inserting our own.
3305 % We like breaks before the index initials, so insert a bonus.
3308 % Typeset the initial. Making this add up to a whole number of
3309 % baselineskips increases the chance of the dots lining up from column
3310 % to column. It still won't often be perfect, because of the stretch
3311 % we need before each entry, but it's better.
3313 % No shrink because it confuses \balancecolumns.
3314 \vskip 1.67\baselineskip plus .5\baselineskip
3315 \leftline{\secbf #1}%
3316 \vskip .33\baselineskip plus .1\baselineskip
3318 % Do our best not to break after the initial.
3322 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3323 % flush to the right margin. It is used for index and table of contents
3324 % entries. The paragraph is indented by \leftskip.
3326 \def\entry#1#2{\begingroup
3328 % Start a new paragraph if necessary, so our assignments below can't
3329 % affect previous text.
3332 % Do not fill out the last line with white space.
3335 % No extra space above this paragraph.
3338 % Do not prefer a separate line ending with a hyphen to fewer lines.
3339 \finalhyphendemerits = 0
3341 % \hangindent is only relevant when the entry text and page number
3342 % don't both fit on one line. In that case, bob suggests starting the
3343 % dots pretty far over on the line. Unfortunately, a large
3344 % indentation looks wrong when the entry text itself is broken across
3345 % lines. So we use a small indentation and put up with long leaders.
3347 % \hangafter is reset to 1 (which is the value we want) at the start
3348 % of each paragraph, so we need not do anything with that.
3351 % When the entry text needs to be broken, just fill out the first line
3353 \rightskip = 0pt plus1fil
3355 % A bit of stretch before each entry for the benefit of balancing columns.
3358 % Start a ``paragraph'' for the index entry so the line breaking
3359 % parameters we've set above will have an effect.
3362 % Insert the text of the index entry. TeX will do line-breaking on it.
3364 % The following is kludged to not output a line of dots in the index if
3365 % there are no page numbers. The next person who breaks this will be
3366 % cursed by a Unix daemon.
3369 \edef\tempc{\tempa}%
3370 \edef\tempd{\tempb}%
3371 \ifx\tempc\tempd\ \else%
3373 % If we must, put the page number on a line of its own, and fill out
3374 % this line with blank space. (The \hfil is overwhelmed with the
3375 % fill leaders glue in \indexdotfill if the page number does fit.)
3377 \null\nobreak\indexdotfill % Have leaders before the page number.
3379 % The `\ ' here is removed by the implicit \unskip that TeX does as
3380 % part of (the primitive) \par. Without it, a spurious underfull
3383 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3385 \ #2% The page number ends the paragraph.
3391 % Like \dotfill except takes at least 1 em.
3392 \def\indexdotfill{\cleaders
3393 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3395 \def\primary #1{\line{#1\hfil}}
3397 \newskip\secondaryindent \secondaryindent=0.5cm
3398 \def\secondary#1#2{{%
3403 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3405 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3412 % Define two-column mode, which we use to typeset indexes.
3413 % Adapted from the TeXbook, page 416, which is to say,
3414 % the manmac.tex format used to print the TeXbook itself.
3418 \newdimen\doublecolumnhsize
3420 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3421 % Grab any single-column material above us.
3424 % Here is a possibility not foreseen in manmac: if we accumulate a
3425 % whole lot of material, we might end up calling this \output
3426 % routine twice in a row (see the doublecol-lose test, which is
3427 % essentially a couple of indexes with @setchapternewpage off). In
3428 % that case we just ship out what is in \partialpage with the normal
3429 % output routine. Generally, \partialpage will be empty when this
3430 % runs and this will be a no-op. See the indexspread.tex test case.
3431 \ifvoid\partialpage \else
3432 \onepageout{\pagecontents\partialpage}%
3435 \global\setbox\partialpage = \vbox{%
3436 % Unvbox the main output page.
3438 \kern-\topskip \kern\baselineskip
3441 \eject % run that output routine to set \partialpage
3443 % Use the double-column output routine for subsequent pages.
3444 \output = {\doublecolumnout}%
3446 % Change the page size parameters. We could do this once outside this
3447 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3448 % format, but then we repeat the same computation. Repeating a couple
3449 % of assignments once per index is clearly meaningless for the
3450 % execution time, so we may as well do it in one place.
3452 % First we halve the line length, less a little for the gutter between
3453 % the columns. We compute the gutter based on the line length, so it
3454 % changes automatically with the paper format. The magic constant
3455 % below is chosen so that the gutter has the same value (well, +-<1pt)
3456 % as it did when we hard-coded it.
3458 % We put the result in a separate register, \doublecolumhsize, so we
3459 % can restore it in \pagesofar, after \hsize itself has (potentially)
3462 \doublecolumnhsize = \hsize
3463 \advance\doublecolumnhsize by -.04154\hsize
3464 \divide\doublecolumnhsize by 2
3465 \hsize = \doublecolumnhsize
3467 % Double the \vsize as well. (We don't need a separate register here,
3468 % since nobody clobbers \vsize.)
3472 % The double-column output routine for all double-column pages except
3475 \def\doublecolumnout{%
3476 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3477 % Get the available space for the double columns -- the normal
3478 % (undoubled) page height minus any material left over from the
3482 \advance\dimen@ by -\ht\partialpage
3484 % box0 will be the left-hand column, box2 the right.
3485 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3486 \onepageout\pagesofar
3488 \penalty\outputpenalty
3491 % Re-output the contents of the output page -- any previous material,
3492 % followed by the two boxes we just split, in box0 and box2.
3496 \hsize = \doublecolumnhsize
3497 \wd0=\hsize \wd2=\hsize
3498 \hbox to\pagewidth{\box0\hfil\box2}%
3501 % All done with double columns.
3502 \def\enddoublecolumns{%
3504 % Split the last of the double-column material. Leave it on the
3505 % current page, no automatic page break.
3508 % If we end up splitting too much material for the current page,
3509 % though, there will be another page break right after this \output
3510 % invocation ends. Having called \balancecolumns once, we do not
3511 % want to call it again. Therefore, reset \output to its normal
3512 % definition right away. (We hope \balancecolumns will never be
3513 % called on to balance too much material, but if it is, this makes
3514 % the output somewhat more palatable.)
3515 \global\output = {\onepageout{\pagecontents\PAGE}}%
3518 \endgroup % started in \begindoublecolumns
3520 % \pagegoal was set to the doubled \vsize above, since we restarted
3521 % the current page. We're now back to normal single-column
3522 % typesetting, so reset \pagegoal to the normal \vsize (after the
3523 % \endgroup where \vsize got restored).
3527 % Called at the end of the double column material.
3528 \def\balancecolumns{%
3529 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3531 \advance\dimen@ by \topskip
3532 \advance\dimen@ by-\baselineskip
3533 \divide\dimen@ by 2 % target to split to
3534 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3535 \splittopskip = \topskip
3536 % Loop until we get a decent breakpoint.
3540 \global\setbox3 = \copy0
3541 \global\setbox1 = \vsplit3 to \dimen@
3543 \global\advance\dimen@ by 1pt
3546 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3547 \setbox0=\vbox to\dimen@{\unvbox1}%
3548 \setbox2=\vbox to\dimen@{\unvbox3}%
3552 \catcode`\@ = \other
3555 \message{sectioning,}
3556 % Chapters, sections, etc.
3559 \newcount\secno \secno=0
3560 \newcount\subsecno \subsecno=0
3561 \newcount\subsubsecno \subsubsecno=0
3563 % This counter is funny since it counts through charcodes of letters A, B, ...
3564 \newcount\appendixno \appendixno = `\@
3565 % \def\appendixletter{\char\the\appendixno}
3566 % We do the following for the sake of pdftex, which needs the actual
3567 % letter in the expansion, not just typeset.
3568 \def\appendixletter{%
3569 \ifnum\appendixno=`A A%
3570 \else\ifnum\appendixno=`B B%
3571 \else\ifnum\appendixno=`C C%
3572 \else\ifnum\appendixno=`D D%
3573 \else\ifnum\appendixno=`E E%
3574 \else\ifnum\appendixno=`F F%
3575 \else\ifnum\appendixno=`G G%
3576 \else\ifnum\appendixno=`H H%
3577 \else\ifnum\appendixno=`I I%
3578 \else\ifnum\appendixno=`J J%
3579 \else\ifnum\appendixno=`K K%
3580 \else\ifnum\appendixno=`L L%
3581 \else\ifnum\appendixno=`M M%
3582 \else\ifnum\appendixno=`N N%
3583 \else\ifnum\appendixno=`O O%
3584 \else\ifnum\appendixno=`P P%
3585 \else\ifnum\appendixno=`Q Q%
3586 \else\ifnum\appendixno=`R R%
3587 \else\ifnum\appendixno=`S S%
3588 \else\ifnum\appendixno=`T T%
3589 \else\ifnum\appendixno=`U U%
3590 \else\ifnum\appendixno=`V V%
3591 \else\ifnum\appendixno=`W W%
3592 \else\ifnum\appendixno=`X X%
3593 \else\ifnum\appendixno=`Y Y%
3594 \else\ifnum\appendixno=`Z Z%
3595 % The \the is necessary, despite appearances, because \appendixletter is
3596 % expanded while writing the .toc file. \char\appendixno is not
3597 % expandable, thus it is written literally, thus all appendixes come out
3598 % with the same letter (or @) in the toc without it.
3599 \else\char\the\appendixno
3600 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3601 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3603 % Each @chapter defines this as the name of the chapter.
3604 % page headings and footings can use it. @section does likewise.
3608 \newcount\absseclevel % used to calculate proper heading level
3609 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3611 % @raisesections: treat @section as chapter, @subsection as section, etc.
3612 \def\raisesections{\global\advance\secbase by -1}
3613 \let\up=\raisesections % original BFox name
3615 % @lowersections: treat @chapter as section, @section as subsection, etc.
3616 \def\lowersections{\global\advance\secbase by 1}
3617 \let\down=\lowersections % original BFox name
3619 % Choose a numbered-heading macro
3620 % #1 is heading level if unmodified by @raisesections or @lowersections
3621 % #2 is text for heading
3622 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3628 \numberedsubseczzz{#2}
3630 \numberedsubsubseczzz{#2}
3632 \ifnum \absseclevel<0
3635 \numberedsubsubseczzz{#2}
3640 % like \numhead, but chooses appendix heading levels
3641 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3645 \appendixsectionzzz{#2}
3647 \appendixsubseczzz{#2}
3649 \appendixsubsubseczzz{#2}
3651 \ifnum \absseclevel<0
3654 \appendixsubsubseczzz{#2}
3659 % like \numhead, but chooses numberless heading levels
3660 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3664 \unnumberedseczzz{#2}
3666 \unnumberedsubseczzz{#2}
3668 \unnumberedsubsubseczzz{#2}
3670 \ifnum \absseclevel<0
3673 \unnumberedsubsubseczzz{#2}
3678 % @chapter, @appendix, @unnumbered.
3679 \def\thischaptername{No Chapter Title}
3680 \outer\def\chapter{\parsearg\chapteryyy}
3681 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3682 \def\chapterzzz #1{%
3683 \secno=0 \subsecno=0 \subsubsecno=0
3684 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3685 \chapmacro {#1}{\the\chapno}%
3686 \gdef\thissection{#1}%
3687 \gdef\thischaptername{#1}%
3688 % We don't substitute the actual chapter name into \thischapter
3689 % because we don't want its macros evaluated now.
3690 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3691 \writetocentry{chap}{#1}{{\the\chapno}}
3693 \global\let\section = \numberedsec
3694 \global\let\subsection = \numberedsubsec
3695 \global\let\subsubsection = \numberedsubsubsec
3698 % we use \chapno to avoid indenting back
3699 \def\appendixbox#1{%
3700 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}%
3701 \hbox to \wd0{#1\hss}}
3703 \outer\def\appendix{\parsearg\appendixyyy}
3704 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3705 \def\appendixzzz #1{%
3706 \secno=0 \subsecno=0 \subsubsecno=0
3707 \global\advance \appendixno by 1
3708 \message{\putwordAppendix\space \appendixletter}%
3709 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}%
3710 \gdef\thissection{#1}%
3711 \gdef\thischaptername{#1}%
3712 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3713 \writetocentry{appendix}{#1}{{\appendixletter}}
3715 \global\let\section = \appendixsec
3716 \global\let\subsection = \appendixsubsec
3717 \global\let\subsubsection = \appendixsubsubsec
3720 % @centerchap is like @unnumbered, but the heading is centered.
3721 \outer\def\centerchap{\parsearg\centerchapyyy}
3722 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3724 % @top is like @unnumbered.
3725 \outer\def\top{\parsearg\unnumberedyyy}
3727 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3728 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3729 \def\unnumberedzzz #1{%
3730 \secno=0 \subsecno=0 \subsubsecno=0
3732 % This used to be simply \message{#1}, but TeX fully expands the
3733 % argument to \message. Therefore, if #1 contained @-commands, TeX
3734 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3735 % expanded @cite (which turns out to cause errors because \cite is meant
3736 % to be executed, not expanded).
3738 % Anyway, we don't want the fully-expanded definition of @cite to appear
3739 % as a result of the \message, we just want `@cite' itself. We use
3740 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3741 % simply yielding the contents of <toks register>. (We also do this for
3743 \toks0 = {#1}\message{(\the\toks0)}%
3745 \unnumbchapmacro {#1}%
3746 \gdef\thischapter{#1}\gdef\thissection{#1}%
3747 \writetocentry{unnumbchap}{#1}{{\the\chapno}}
3749 \global\let\section = \unnumberedsec
3750 \global\let\subsection = \unnumberedsubsec
3751 \global\let\subsubsection = \unnumberedsubsubsec
3755 \outer\def\numberedsec{\parsearg\secyyy}
3756 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3758 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3759 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3760 \writetocentry{sec}{#1}{{\the\chapno}{\the\secno}}
3765 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3766 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3767 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3768 \def\appendixsectionzzz #1{%
3769 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3770 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3771 \writetocentry{sec}{#1}{{\appendixletter}{\the\secno}}
3776 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3777 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3778 \def\unnumberedseczzz #1{%
3779 \plainsecheading {#1}\gdef\thissection{#1}%
3780 \writetocentry{unnumbsec}{#1}{{\the\chapno}{\the\secno}}
3786 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3787 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3788 \def\numberedsubseczzz #1{%
3789 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3790 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3791 \writetocentry{subsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3796 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3797 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3798 \def\appendixsubseczzz #1{%
3799 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3800 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3801 \writetocentry{subsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}}
3806 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3807 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3808 \def\unnumberedsubseczzz #1{%
3809 \plainsubsecheading {#1}\gdef\thissection{#1}%
3810 \writetocentry{unnumbsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3816 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3817 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3818 \def\numberedsubsubseczzz #1{%
3819 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3820 \subsubsecheading {#1}
3821 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3822 \writetocentry{subsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3827 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3828 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3829 \def\appendixsubsubseczzz #1{%
3830 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3831 \subsubsecheading {#1}
3832 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3833 \writetocentry{subsubsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3838 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3839 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3840 \def\unnumberedsubsubseczzz #1{%
3841 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3842 \writetocentry{unnumbsubsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3847 % These are variants which are not "outer", so they can appear in @ifinfo.
3848 % Actually, they should now be obsolete; ordinary section commands should work.
3849 \def\infotop{\parsearg\unnumberedzzz}
3850 \def\infounnumbered{\parsearg\unnumberedzzz}
3851 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3852 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3853 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3855 \def\infoappendix{\parsearg\appendixzzz}
3856 \def\infoappendixsec{\parsearg\appendixseczzz}
3857 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3858 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3860 \def\infochapter{\parsearg\chapterzzz}
3861 \def\infosection{\parsearg\sectionzzz}
3862 \def\infosubsection{\parsearg\subsectionzzz}
3863 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3865 % These macros control what the section commands do, according
3866 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3867 % Define them by default for a numbered chapter.
3868 \global\let\section = \numberedsec
3869 \global\let\subsection = \numberedsubsec
3870 \global\let\subsubsection = \numberedsubsubsec
3872 % Define @majorheading, @heading and @subheading
3874 % NOTE on use of \vbox for chapter headings, section headings, and such:
3875 % 1) We use \vbox rather than the earlier \line to permit
3876 % overlong headings to fold.
3877 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3878 % heading is obnoxious; this forbids it.
3879 % 3) Likewise, headings look best if no \parindent is used, and
3880 % if justification is not attempted. Hence \raggedright.
3883 \def\majorheading{\parsearg\majorheadingzzz}
3884 \def\majorheadingzzz #1{%
3885 {\advance\chapheadingskip by 10pt \chapbreak }%
3886 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3887 \parindent=0pt\raggedright
3888 \rm #1\hfill}}\bigskip \par\penalty 200}
3890 \def\chapheading{\parsearg\chapheadingzzz}
3891 \def\chapheadingzzz #1{\chapbreak %
3892 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3893 \parindent=0pt\raggedright
3894 \rm #1\hfill}}\bigskip \par\penalty 200}
3896 % @heading, @subheading, @subsubheading.
3897 \def\heading{\parsearg\plainsecheading}
3898 \def\subheading{\parsearg\plainsubsecheading}
3899 \def\subsubheading{\parsearg\plainsubsubsecheading}
3901 % These macros generate a chapter, section, etc. heading only
3902 % (including whitespace, linebreaking, etc. around it),
3903 % given all the information in convenient, parsed form.
3905 %%% Args are the skip and penalty (usually negative)
3906 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3908 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3910 %%% Define plain chapter starts, and page on/off switching for it
3911 % Parameter controlling skip before chapter headings (if needed)
3913 \newskip\chapheadingskip
3915 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3916 \def\chappager{\par\vfill\supereject}
3917 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3919 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3922 \global\let\contentsalignmacro = \chappager
3923 \global\let\pchapsepmacro=\chapbreak
3924 \global\let\pagealignmacro=\chappager}
3927 \global\let\contentsalignmacro = \chappager
3928 \global\let\pchapsepmacro=\chappager
3929 \global\let\pagealignmacro=\chappager
3930 \global\def\HEADINGSon{\HEADINGSsingle}}
3933 \global\let\contentsalignmacro = \chapoddpage
3934 \global\let\pchapsepmacro=\chapoddpage
3935 \global\let\pagealignmacro=\chapoddpage
3936 \global\def\HEADINGSon{\HEADINGSdouble}}
3941 \global\let\chapmacro=\chfplain
3942 \global\let\unnumbchapmacro=\unnchfplain
3943 \global\let\centerchapmacro=\centerchfplain}
3945 % Plain chapter opening.
3946 % #1 is the text, #2 the chapter number or empty if unnumbered.
3952 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3953 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3954 \hangindent = \wd0 \centerparametersmaybe
3957 \nobreak\bigskip % no page break after a chapter title
3961 % Plain opening for unnumbered.
3962 \def\unnchfplain#1{\chfplain{#1}{}}
3964 % @centerchap -- centered and unnumbered.
3965 \let\centerparametersmaybe = \relax
3966 \def\centerchfplain#1{{%
3967 \def\centerparametersmaybe{%
3968 \advance\rightskip by 3\rightskip
3969 \leftskip = \rightskip
3975 \CHAPFplain % The default
3977 \def\unnchfopen #1{%
3978 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3979 \parindent=0pt\raggedright
3980 \rm #1\hfill}}\bigskip \par\nobreak
3983 \def\chfopen #1#2{\chapoddpage {\chapfonts
3984 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3988 \def\centerchfopen #1{%
3989 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3991 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3995 \global\let\chapmacro=\chfopen
3996 \global\let\unnumbchapmacro=\unnchfopen
3997 \global\let\centerchapmacro=\centerchfopen}
4001 \newskip\secheadingskip
4002 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
4003 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
4004 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
4006 % Subsection titles.
4007 \newskip \subsecheadingskip
4008 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
4009 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
4010 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
4012 % Subsubsection titles.
4013 \let\subsubsecheadingskip = \subsecheadingskip
4014 \let\subsubsecheadingbreak = \subsecheadingbreak
4015 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
4016 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
4019 % Print any size section title.
4021 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
4022 % number (maybe empty), #3 the text.
4023 \def\sectionheading#1#2#3{%
4025 \expandafter\advance\csname #1headingskip\endcsname by \parskip
4026 \csname #1headingbreak\endcsname
4029 % Switch to the right set of fonts.
4030 \csname #1fonts\endcsname \rm
4032 % Only insert the separating space if we have a section number.
4034 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
4036 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4037 \hangindent = \wd0 % zero if no section number
4040 % Add extra space after the heading -- either a line space or a
4041 % paragraph space, whichever is more. (Some people like to set
4042 % \parskip to large values for some reason.)
4044 \ifdim\parskip>\normalbaselineskip
4047 \kern\normalbaselineskip
4054 % Table of contents.
4057 % Write an entry to the toc file, opening it if necessary.
4058 % Called from @chapter, etc. We supply {\folio} at the end of the
4059 % argument, which will end up as the last argument to the \...entry macro.
4061 % Usage: \writetocentry{chap}{The Name of The Game}{{\the\chapno}}
4062 % We open the .toc file for writing here instead of at @setfilename (or
4063 % any other fixed time) so that @contents can be anywhere in the document.
4065 \newif\iftocfileopened
4066 \def\writetocentry#1#2#3{%
4067 \iftocfileopened\else
4068 \immediate\openout\tocfile = \jobname.toc
4069 \global\tocfileopenedtrue
4074 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}#3{\folio}}}%
4078 % Tell \shipout to create a page destination if we're doing pdf, which
4079 % will be the target of the links in the table of contents. We can't
4080 % just do it on every page because the title pages are numbered 1 and
4081 % 2 (the page numbers aren't printed), and so are the first two pages
4082 % of the document. Thus, we'd have two destinations named `1', and
4084 \ifpdf \pdfmakepagedesttrue \fi
4087 \newskip\contentsrightmargin \contentsrightmargin=1in
4088 \newcount\savepageno
4089 \newcount\lastnegativepageno \lastnegativepageno = -1
4091 % Finish up the main text and prepare to read what we've written
4094 \def\startcontents#1{%
4095 % If @setchapternewpage on, and @headings double, the contents should
4096 % start on an odd page, unlike chapters. Thus, we maintain
4097 % \contentsalignmacro in parallel with \pagealignmacro.
4098 % From: Torbjorn Granlund <tege@matematik.su.se>
4100 \immediate\closeout\tocfile
4102 % Don't need to put `Contents' or `Short Contents' in the headline.
4103 % It is abundantly clear what they are.
4104 \unnumbchapmacro{#1}\def\thischapter{}%
4105 \savepageno = \pageno
4106 \begingroup % Set up to handle contents files properly.
4107 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4108 % We can't do this, because then an actual ^ in a section
4109 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4110 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4111 \raggedbottom % Worry more about breakpoints than the bottom.
4112 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4114 % Roman numerals for page numbers.
4115 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
4119 % Normal (long) toc.
4121 \startcontents{\putwordTOC}%
4122 \openin 1 \jobname.toc
4128 \contentsalignmacro % in case @setchapternewpage odd is in effect
4131 \lastnegativepageno = \pageno
4132 \pageno = \savepageno
4135 % And just the chapters.
4136 \def\summarycontents{%
4137 \startcontents{\putwordShortTOC}%
4139 \let\chapentry = \shortchapentry
4140 \let\appendixentry = \shortappendixentry
4141 \let\unnumbchapentry = \shortunnumberedentry
4142 % We want a true roman here for the page numbers.
4144 \let\rm=\shortcontrm \let\bf=\shortcontbf
4145 \let\sl=\shortcontsl \let\tt=\shortconttt
4147 \hyphenpenalty = 10000
4148 \advance\baselineskip by 1pt % Open it up a little.
4149 \def\secentry ##1##2##3##4{}
4150 \def\subsecentry ##1##2##3##4##5{}
4151 \def\subsubsecentry ##1##2##3##4##5##6{}
4152 \let\unnumbsecentry = \secentry
4153 \let\unnumbsubsecentry = \subsecentry
4154 \let\unnumbsubsubsecentry = \subsubsecentry
4155 \openin 1 \jobname.toc
4161 \contentsalignmacro % in case @setchapternewpage odd is in effect
4163 \lastnegativepageno = \pageno
4164 \pageno = \savepageno
4166 \let\shortcontents = \summarycontents
4169 \pdfcatalog{/PageMode /UseOutlines}%
4172 % These macros generate individual entries in the table of contents.
4173 % The first argument is the chapter or section name.
4174 % The last argument is the page number.
4175 % The arguments in between are the chapter number, section number, ...
4177 % Chapters, in the main contents.
4178 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4180 % Chapters, in the short toc.
4181 % See comments in \dochapentry re vbox and related settings.
4182 \def\shortchapentry#1#2#3{%
4183 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4186 % Appendices, in the main contents.
4187 \def\appendixentry#1#2#3{%
4188 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}}
4190 % Appendices, in the short toc.
4191 \let\shortappendixentry = \shortchapentry
4193 % Typeset the label for a chapter or appendix for the short contents.
4194 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4195 % We could simplify the code here by writing out an \appendixentry
4196 % command in the toc file for appendices, instead of using \chapentry
4197 % for both, but it doesn't seem worth it.
4199 \newdimen\shortappendixwidth
4201 \def\shortchaplabel#1{%
4202 % This space should be enough, since a single number is .5em, and the
4203 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4204 % But use \hss just in case.
4205 % (This space doesn't include the extra space that gets added after
4206 % the label; that gets put in by \shortchapentry above.)
4208 \hbox to \dimen0{#1\hss}%
4211 % Unnumbered chapters.
4212 \def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}}
4213 \def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}}
4216 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4217 \def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4220 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4221 \def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}}
4223 % And subsubsections.
4224 \def\subsubsecentry#1#2#3#4#5#6{%
4225 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4226 \def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}}
4228 % This parameter controls the indentation of the various levels.
4229 \newdimen\tocindent \tocindent = 3pc
4231 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4234 % If the toc has to be broken over pages, we want it to be at chapters
4235 % if at all possible; hence the \penalty.
4236 \def\dochapentry#1#2{%
4237 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4240 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4242 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4245 \def\dosecentry#1#2{\begingroup
4246 \secentryfonts \leftskip=\tocindent
4247 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4250 \def\dosubsecentry#1#2{\begingroup
4251 \subsecentryfonts \leftskip=2\tocindent
4252 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4255 \def\dosubsubsecentry#1#2{\begingroup
4256 \subsubsecentryfonts \leftskip=3\tocindent
4257 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4260 % Final typesetting of a toc entry; we use the same \entry macro as for
4261 % the index entries, but we want to suppress hyphenation here. (We
4262 % can't do that in the \entry macro, since index entries might consist
4263 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4264 \def\tocentry#1#2{\begingroup
4265 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4266 % Do not use \turnoffactive in these arguments. Since the toc is
4267 % typeset in cmr, characters such as _ would come out wrong; we
4268 % have to do the usual translation tricks.
4272 % Space between chapter (or whatever) number and the title.
4273 \def\labelspace{\hskip1em \relax}
4275 \def\dopageno#1{{\rm #1}}
4276 \def\doshortpageno#1{{\rm #1}}
4278 \def\chapentryfonts{\secfonts \rm}
4279 \def\secentryfonts{\textfonts}
4280 \let\subsecentryfonts = \textfonts
4281 \let\subsubsecentryfonts = \textfonts
4284 \message{environments,}
4285 % @foo ... @end foo.
4287 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4289 % Since these characters are used in examples, it should be an even number of
4290 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4293 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4294 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4295 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4296 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4298 % The @error{} command.
4299 % Adapted from the TeXbook's \boxit.
4303 {\tentt \global\dimen0 = 3em}% Width of the box.
4304 \dimen2 = .55pt % Thickness of rules
4305 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4306 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4308 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4309 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4310 \advance\hsize by -2\dimen2 % Rules.
4312 \hrule height\dimen2
4313 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4314 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4315 \kern3pt\vrule width\dimen2}% Space to right.
4316 \hrule height\dimen2}
4319 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4321 % @tex ... @end tex escapes into raw Tex temporarily.
4322 % One exception: @ is still an escape character, so that @end tex works.
4323 % But \@ or @@ will get a plain tex @ character.
4325 \def\tex{\begingroup
4326 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4327 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4328 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4339 \let\bullet=\ptexbullet
4344 \let\equiv=\ptexequiv
4353 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4354 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4356 \let\Etex=\endgroup}
4358 % Define @lisp ... @end lisp.
4359 % @lisp does a \begingroup so it can rebind things,
4360 % including the definition of @end lisp (which normally is erroneous).
4362 % Amount to narrow the margins by for @lisp.
4363 \newskip\lispnarrowing \lispnarrowing=0.4in
4365 % This is the definition that ^^M gets inside @lisp, @example, and other
4366 % such environments. \null is better than a space, since it doesn't
4368 \def\lisppar{\null\endgraf}
4370 % Make each space character in the input produce a normal interword
4371 % space in the output. Don't allow a line break at this space, as this
4372 % is used only in environments like @example, where each line of input
4373 % should produce a line of output anyway.
4376 \gdef\sepspaces{\obeyspaces\let =\tie}}
4378 % Define \obeyedspace to be our active space, whatever it is. This is
4379 % for use in \parsearg.
4381 \global\let\obeyedspace= }
4383 % This space is always present above and below environments.
4384 \newskip\envskipamount \envskipamount = 0pt
4386 % Make spacing and below environment symmetrical. We use \parskip here
4387 % to help in doing that, since in @example-like environments \parskip
4388 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4389 % start of the next paragraph will insert \parskip.
4391 \def\aboveenvbreak{{%
4392 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4393 \ifnum \lastpenalty=10000 \else
4394 \advance\envskipamount by \parskip
4396 \ifdim\lastskip<\envskipamount
4398 % it's not a good place to break if the last penalty was \nobreak
4400 \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4401 \vskip\envskipamount
4406 \let\afterenvbreak = \aboveenvbreak
4408 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4409 \let\nonarrowing=\relax
4411 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4412 % environment contents.
4413 \font\circle=lcircle10
4415 \newdimen\cartouter\newdimen\cartinner
4416 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4417 \circthick=\fontdimen8\circle
4419 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4420 \def\ctr{{\hskip 6pt\circle\char'010}}
4421 \def\cbl{{\circle\char'012\hskip -6pt}}
4422 \def\cbr{{\hskip 6pt\circle\char'011}}
4423 \def\carttop{\hbox to \cartouter{\hskip\lskip
4424 \ctl\leaders\hrule height\circthick\hfil\ctr
4426 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4427 \cbl\leaders\hrule height\circthick\hfil\cbr
4430 \newskip\lskip\newskip\rskip
4434 \lskip=\leftskip \rskip=\rightskip
4435 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4436 \cartinner=\hsize \advance\cartinner by-\lskip
4437 \advance\cartinner by-\rskip
4439 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4440 % side, and for 6pt waste from
4441 % each corner char, and rule thickness
4442 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4443 % Flag to tell @lisp, etc., not to narrow margin.
4444 \let\nonarrowing=\comment
4446 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4455 \baselineskip=\normbskip
4456 \lineskip=\normlskip
4472 % This macro is called at the beginning of all the @example variants,
4476 \inENV % This group ends at the end of the body
4477 \hfuzz = 12pt % Don't be fussy
4478 \sepspaces % Make spaces be word-separators rather than space tokens.
4479 \let\par = \lisppar % don't ignore blank lines
4480 \obeylines % each line of input is a line of output
4483 \emergencystretch = 0pt % don't try to avoid overfull boxes
4484 % @cartouche defines \nonarrowing to inhibit narrowing
4485 % at next level down.
4486 \ifx\nonarrowing\relax
4487 \advance \leftskip by \lispnarrowing
4488 \exdentamount=\lispnarrowing
4489 \let\exdent=\nofillexdent
4490 \let\nonarrowing=\relax
4494 % Define the \E... control sequence only if we are inside the particular
4495 % environment, so the error checking in \end will work.
4497 % To end an @example-like environment, we first end the paragraph (via
4498 % \afterenvbreak's vertical glue), and then the group. That way we keep
4499 % the zero \parskip that the environments set -- \parskip glue will be
4500 % inserted at the beginning of the next paragraph in the document, after
4503 \def\nonfillfinish{\afterenvbreak\endgroup}
4505 % @lisp: indented, narrowed, typewriter font.
4506 \def\lisp{\begingroup
4508 \let\Elisp = \nonfillfinish
4510 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4511 \gobble % eat return
4514 % @example: Same as @lisp.
4515 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4517 % @small... is usually equivalent to the non-small (@smallbook
4518 % redefines). We must call \example (or whatever) last in the
4519 % definition, since it reads the return following the @example (or
4520 % whatever) command.
4522 % This actually allows (for example) @end display inside an
4523 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4525 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4526 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4527 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4528 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4530 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4531 % Originally contributed by Pavel@xerox.
4532 \def\smalllispx{\begingroup
4533 \def\Esmalllisp{\nonfillfinish\endgroup}%
4534 \def\Esmallexample{\nonfillfinish\endgroup}%
4539 % @display: same as @lisp except keep current font.
4541 \def\display{\begingroup
4543 \let\Edisplay = \nonfillfinish
4547 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4549 \def\smalldisplayx{\begingroup
4550 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4551 \smallexamplefonts \rm
4555 % @format: same as @display except don't narrow margins.
4557 \def\format{\begingroup
4558 \let\nonarrowing = t
4560 \let\Eformat = \nonfillfinish
4564 % @smallformat (when @smallbook): @format plus smaller fonts.
4566 \def\smallformatx{\begingroup
4567 \def\Esmallformat{\nonfillfinish\endgroup}%
4568 \smallexamplefonts \rm
4572 % @flushleft (same as @format).
4574 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4578 \def\flushright{\begingroup
4579 \let\nonarrowing = t
4581 \let\Eflushright = \nonfillfinish
4582 \advance\leftskip by 0pt plus 1fill
4587 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4588 % and narrows the margins.
4591 \begingroup\inENV %This group ends at the end of the @quotation body
4592 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4594 % We have retained a nonzero parskip for the environment, since we're
4595 % doing normal filling. So to avoid extra space below the environment...
4596 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4598 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4599 \ifx\nonarrowing\relax
4600 \advance\leftskip by \lispnarrowing
4601 \advance\rightskip by \lispnarrowing
4602 \exdentamount = \lispnarrowing
4603 \let\nonarrowing = \relax
4608 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4609 % If we want to allow any <char> as delimiter,
4610 % we need the curly braces so that makeinfo sees the @verb command, eg:
4611 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4613 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4615 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4616 % active too. Otherwise, they get lost as the first character on a
4619 \do\ \do\\\do\{\do\}\do\$\do\&%
4620 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4621 \do\<\do\>\do\|\do\@\do+\do\"%
4625 \def\uncatcodespecials{%
4626 \def\do##1{\catcode`##1=12}\dospecials}
4628 % [Knuth] pp. 380,381,391
4629 % Disable Spanish ligatures ?` and !` of \tt font
4631 \catcode`\`=\active\gdef`{\relax\lq}
4634 % Setup for the @verb command.
4636 % Eight spaces for a tab
4638 \catcode`\^^I=\active
4639 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4643 \tt % easiest (and conventionally used) font for verbatim
4644 \def\par{\leavevmode\endgraf}%
4647 % Respect line breaks,
4648 % print special symbols as themselves, and
4649 % make each space count
4650 % must do in this order:
4651 \obeylines \uncatcodespecials \sepspaces
4654 % Setup for the @verbatim environment
4656 % Real tab expansion
4657 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4659 \def\starttabbox{\setbox0=\hbox\bgroup}
4661 \catcode`\^^I=\active
4663 \catcode`\^^I=\active
4664 \def^^I{\leavevmode\egroup
4665 \dimen0=\wd0 % the width so far, or since the previous tab
4666 \divide\dimen0 by\tabw
4667 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4668 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4669 \wd0=\dimen0 \box0 \starttabbox
4673 \def\setupverbatim{%
4674 % Easiest (and conventionally used) font for verbatim
4676 \def\par{\leavevmode\egroup\box0\endgraf}%
4679 % Respect line breaks,
4680 % print special symbols as themselves, and
4681 % make each space count
4682 % must do in this order:
4683 \obeylines \uncatcodespecials \sepspaces
4684 \everypar{\starttabbox}%
4687 % Do the @verb magic: verbatim text is quoted by unique
4688 % delimiter characters. Before first delimiter expect a
4689 % right brace, after last delimiter expect closing brace:
4691 % \def\doverb'{'<char>#1<char>'}'{#1}
4693 % [Knuth] p. 382; only eat outer {}
4695 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4696 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4699 \def\verb{\begingroup\setupverb\doverb}
4702 % Do the @verbatim magic: define the macro \doverbatim so that
4703 % the (first) argument ends when '@end verbatim' is reached, ie:
4705 % \def\doverbatim#1@end verbatim{#1}
4707 % For Texinfo it's a lot easier than for LaTeX,
4708 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4709 % we need not redefine '\', '{' and '}'.
4711 % Inspired by LaTeX's verbatim command set [latex.ltx]
4712 %% Include LaTeX hack for completeness -- never know
4714 %% \catcode`|=0 \catcode`[=1
4715 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4716 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4717 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4723 % ignore everything up to the first ^^M, that's the newline at the end
4724 % of the @verbatim input line itself. Otherwise we get an extra blank
4725 % line in the output.
4726 \gdef\doverbatim#1^^M#2@end verbatim{#2\end{verbatim}}%
4730 \def\Everbatim{\nonfillfinish\endgroup}%
4733 \advance\leftskip by -\defbodyindent
4734 \begingroup\setupverbatim\doverbatim
4737 % @verbatiminclude FILE - insert text of file in verbatim environment.
4739 % Allow normal characters that we make active in the argument (a file name).
4740 \def\verbatiminclude{%
4750 \parsearg\doverbatiminclude
4752 \def\setupverbatiminclude{%
4755 \advance\leftskip by -\defbodyindent
4756 \begingroup\setupverbatim
4759 \def\doverbatiminclude#1{%
4760 % Restore active chars for included file.
4763 \let\value=\expandablevalue
4765 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4771 % @copying ... @end copying.
4772 % Save the text away for @insertcopying later. Many commands won't be
4773 % allowed in this context, but that's ok.
4775 % We save the uninterpreted tokens, rather than creating a box.
4776 % Saving the text in a box would be much easier, but then all the
4777 % typesetting commands (@smallbook, font changes, etc.) have to be done
4778 % beforehand -- and a) we want @copying to be done first in the source
4779 % file; b) letting users define the frontmatter in as flexible order as
4780 % possible is very desirable.
4782 \def\copying{\begingroup
4783 % Define a command to swallow text until we reach `@end copying'.
4784 % \ is the escape char in this texinfo.tex file, so it is the
4785 % delimiter for the command; @ will be the escape char when we read
4786 % it, but that doesn't matter.
4787 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4789 % We must preserve ^^M's in the input file; see \insertcopying below.
4790 \catcode`\^^M = \active
4794 % What we do to finish off the copying text.
4796 \def\enddocopying{\endgroup\ignorespaces}
4798 % @insertcopying. Here we must play games with ^^M's. On the one hand,
4799 % we need them to delimit commands such as `@end quotation', so they
4800 % must be active. On the other hand, we certainly don't want every
4801 % end-of-line to be a \par, as would happen with the normal active
4802 % definition of ^^M. On the third hand, two ^^M's in a row should still
4805 % Our approach is to make ^^M insert a space and a penalty1 normally;
4806 % then it can also check if \lastpenalty=1. If it does, then manually
4809 % This messes up the normal definitions of @c[omment], so we redefine
4810 % it. Similarly for @ignore. (These commands are used in the gcc
4811 % manual for man page generation.)
4813 % Seems pretty fragile, most line-oriented commands will presumably
4814 % fail, but for the limited use of getting the copying text (which
4815 % should be quite simple) inserted, we can hope it's ok.
4817 {\catcode`\^^M=\active %
4818 \gdef\insertcopying{\begingroup %
4819 \parindent = 0pt % looks wrong on title page
4821 \ifnum \lastpenalty=1 %
4828 % Fix @c[omment] for catcode 13 ^^M's.
4829 \def\c##1^^M{\ignorespaces}%
4832 % Don't bother jumping through all the hoops that \doignore does, it
4833 % would be very hard since the catcodes are already set.
4834 \long\def\ignore##1\end ignore{\ignorespaces}%
4843 % Allow user to change definition object font (\df) internally
4844 \def\setdeffont#1 {\csname DEF#1\endcsname}
4846 \newskip\defbodyindent \defbodyindent=.4in
4847 \newskip\defargsindent \defargsindent=50pt
4848 \newskip\deflastargmargin \deflastargmargin=18pt
4850 \newcount\parencount
4852 % We want ()&[] to print specially on the defun line.
4855 \catcode`\(=\active \catcode`\)=\active
4857 \catcode`\[=\active \catcode`\]=\active
4860 % Make control sequences which act like normal parenthesis chars.
4861 \let\lparen = ( \let\rparen = )
4863 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4865 % Be sure that we always have a definition for `(', etc. For example,
4866 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4867 % so TeX would otherwise complain about undefined control sequence.
4868 \global\let(=\lparen \global\let)=\rparen
4869 \global\let[=\lbrack \global\let]=\rbrack
4871 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4872 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4873 % This is used to turn on special parens
4874 % but make & act ordinary (given that it's active).
4875 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4877 % Definitions of (, ) and & used in args for functions.
4878 % This is the definition of ( outside of all parentheses.
4879 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4880 \global\advance\parencount by 1
4883 % This is the definition of ( when already inside a level of parens.
4884 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4886 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4887 % also in that case restore the outer-level definition of (.
4888 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4889 \global\advance \parencount by -1 }
4890 % If we encounter &foo, then turn on ()-hacking afterwards
4891 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
4893 \gdef\normalparens{\boldbrax\let&=\ampnr}
4894 } % End of definition inside \activeparens
4895 %% These parens (in \boldbrax) actually are a little bolder than the
4896 %% contained text. This is especially needed for [ and ]
4897 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4898 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4900 \def\lbrb{{\bf\char`\[}}
4901 \def\rbrb{{\bf\char`\]}}
4903 % Active &'s sneak into the index arguments, so make sure it's defined.
4905 \catcode`& = \active
4906 \global\let& = \ampnr
4909 % \defname, which formats the name of the @def (not the args).
4910 % #1 is the function name.
4911 % #2 is the type of definition, such as "Function".
4914 % How we'll output the type name. Putting it in brackets helps
4915 % distinguish it from the body text that may end up on the next line
4920 \def\defnametype{[\rm #2]}%
4923 % Get the values of \leftskip and \rightskip as they were outside the @def...
4925 \advance\dimen2 by -\defbodyindent
4927 % Figure out values for the paragraph shape.
4928 \setbox0=\hbox{\hskip \deflastargmargin{\defnametype}}%
4929 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4930 \dimen1=\hsize \advance \dimen1 by -\defargsindent % size for continuations
4931 \parshape 2 0in \dimen0 \defargsindent \dimen1
4933 % Output arg 2 ("Function" or some such) but stuck inside a box of
4934 % width 0 so it does not interfere with linebreaking.
4937 {% Adjust \hsize to exclude the ambient margins,
4938 % so that \rightline will obey them.
4939 \advance \hsize by -\dimen2
4940 \dimen3 = 0pt % was -1.25pc
4941 \rlap{\rightline{\defnametype\kern\dimen3}}%
4944 % Allow all lines to be underfull without complaint:
4945 \tolerance=10000 \hbadness=10000
4946 \advance\leftskip by -\defbodyindent
4947 \exdentamount=\defbodyindent
4948 {\df #1}\enskip % output function name
4949 % \defunargs will be called next to output the arguments, if any.
4952 % Common pieces to start any @def...
4953 % #1 is the \E... control sequence to end the definition (which we define).
4954 % #2 is the \...x control sequence (which our caller defines).
4955 % #3 is the control sequence to process the header, such as \defunheader.
4957 \def\parsebodycommon#1#2#3{%
4959 % If there are two @def commands in a row, we'll have a \nobreak,
4960 % which is there to keep the function description together with its
4961 % header. But if there's nothing but headers, we want to allow a
4963 \ifnum\lastpenalty=10000 \penalty0 \fi
4966 % Define the \E... end token that this defining construct specifies
4967 % so that it will exit this group.
4968 \def#1{\endgraf\endgroup\medbreak}%
4971 \advance\leftskip by \defbodyindent
4972 \exdentamount=\defbodyindent
4975 % Common part of the \...x definitions.
4977 \def\defxbodycommon{%
4978 % As with \parsebodycommon above, allow line break if we have multiple
4979 % x headers in a row. It's not a great place, though.
4980 \ifnum\lastpenalty=10000 \penalty1000 \fi
4982 \begingroup\obeylines
4985 % Process body of @defun, @deffn, @defmac, etc.
4987 \def\defparsebody#1#2#3{%
4988 \parsebodycommon{#1}{#2}{#3}%
4989 \def#2{\defxbodycommon \activeparens \spacesplit#3}%
4990 \catcode\equalChar=\active
4991 \begingroup\obeylines\activeparens
4995 % #1, #2, #3 are the common arguments (see \parsebodycommon above).
4996 % #4, delimited by the space, is the class name.
4998 \def\defmethparsebody#1#2#3#4 {%
4999 \parsebodycommon{#1}{#2}{#3}%
5000 \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}%
5001 \begingroup\obeylines\activeparens
5002 % The \empty here prevents misinterpretation of a construct such as
5003 % @deffn {whatever} {Enharmonic comma}
5004 % See comments at \deftpparsebody, although in our case we don't have
5005 % to remove the \empty afterwards, since it is empty.
5006 \spacesplit{#3{#4}}\empty
5009 % Used for @deftypemethod and @deftypeivar.
5010 % #1, #2, #3 are the common arguments (see \defparsebody).
5011 % #4, delimited by a space, is the class name.
5012 % #5 is the method's return type.
5014 \def\deftypemethparsebody#1#2#3#4 #5 {%
5015 \parsebodycommon{#1}{#2}{#3}%
5016 \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}%
5017 \begingroup\obeylines\activeparens
5018 \spacesplit{#3{#4}{#5}}%
5021 % Used for @deftypeop. The change from \deftypemethparsebody is an
5022 % extra argument at the beginning which is the `category', instead of it
5023 % being the hardwired string `Method' or `Instance Variable'. We have
5024 % to account for this both in the \...x definition and in parsing the
5025 % input at hand. Thus also need a control sequence (passed as #5) for
5026 % the \E... definition to assign the category name to.
5028 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
5029 \parsebodycommon{#1}{#2}{#3}%
5030 \def#2##1 ##2 ##3 {\def#4{##1}%
5031 \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}%
5032 \begingroup\obeylines\activeparens
5033 \spacesplit{#3{#5}{#6}}%
5037 \def\defopparsebody #1#2#3#4#5 {%
5038 \parsebodycommon{#1}{#2}{#3}%
5039 \def#2##1 ##2 {\def#4{##1}%
5040 \defxbodycommon \activeparens \spacesplit{#3{##2}}}%
5041 \begingroup\obeylines\activeparens
5042 \spacesplit{#3{#5}}%
5045 % These parsing functions are similar to the preceding ones
5046 % except that they do not make parens into active characters.
5047 % These are used for "variables" since they have no arguments.
5049 \def\defvarparsebody #1#2#3{%
5050 \parsebodycommon{#1}{#2}{#3}%
5051 \def#2{\defxbodycommon \spacesplit#3}%
5052 \catcode\equalChar=\active
5053 \begingroup\obeylines
5058 \def\defopvarparsebody #1#2#3#4#5 {%
5059 \parsebodycommon{#1}{#2}{#3}%
5060 \def#2##1 ##2 {\def#4{##1}%
5061 \defxbodycommon \spacesplit{#3{##2}}}%
5062 \begingroup\obeylines
5063 \spacesplit{#3{#5}}%
5066 \def\defvrparsebody#1#2#3#4 {%
5067 \parsebodycommon{#1}{#2}{#3}%
5068 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5069 \begingroup\obeylines
5070 \spacesplit{#3{#4}}%
5073 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
5074 % type is just `struct', because we lose the braces in `{struct
5075 % termios}' when \spacesplit reads its undelimited argument. Sigh.
5076 % \let\deftpparsebody=\defvrparsebody
5078 % So, to get around this, we put \empty in with the type name. That
5079 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5080 % won't strip off the braces.
5082 \def\deftpparsebody #1#2#3#4 {%
5083 \parsebodycommon{#1}{#2}{#3}%
5084 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5085 \begingroup\obeylines
5086 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
5089 % Fine, but then we have to eventually remove the \empty *and* the
5090 % braces (if any). That's what this does.
5092 \def\removeemptybraces\empty#1\relax{#1}
5094 % After \spacesplit has done its work, this is called -- #1 is the final
5095 % thing to call, #2 the type name (which starts with \empty), and #3
5096 % (which might be empty) the arguments.
5098 \def\parsetpheaderline#1#2#3{%
5099 #1{\removeemptybraces#2\relax}{#3}%
5102 % Split up #2 (the rest of the input line) at the first space token.
5103 % call #1 with two arguments:
5104 % the first is all of #2 before the space token,
5105 % the second is all of #2 after that space token.
5106 % If #2 contains no space token, all of it is passed as the first arg
5107 % and the second is passed as empty.
5110 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}%
5111 \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{%
5121 % First, define the processing that is wanted for arguments of \defun
5122 % Use this to expand the args and terminate the paragraph they make up
5124 \def\defunargs#1{\functionparens \sl
5125 % Expand, preventing hyphenation at `-' chars.
5126 % Note that groups don't affect changes in \hyphenchar.
5127 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5128 {\tensl\hyphenchar\font=0}%
5130 {\tensl\hyphenchar\font=45}%
5131 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
5132 \interlinepenalty=10000
5133 \advance\rightskip by 0pt plus 1fil
5134 \endgraf\nobreak\vskip -\parskip\nobreak
5137 \def\deftypefunargs #1{%
5138 % Expand, preventing hyphenation at `-' chars.
5139 % Note that groups don't affect changes in \hyphenchar.
5140 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
5142 \tclose{#1}% avoid \code because of side effects on active chars
5143 \interlinepenalty=10000
5144 \advance\rightskip by 0pt plus 1fil
5145 \endgraf\nobreak\vskip -\parskip\nobreak
5148 % Do complete processing of one @defun or @defunx line already parsed.
5150 % @deffn Command forward-char nchars
5152 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
5154 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
5155 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
5156 \catcode\equalChar=\other % Turn off change made in \defparsebody
5159 % @defun == @deffn Function
5161 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5163 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5164 \begingroup\defname {#1}{\putwordDeffunc}%
5165 \defunargs {#2}\endgroup %
5166 \catcode\equalChar=\other % Turn off change made in \defparsebody
5169 % @deftypefun int foobar (int @var{foo}, float @var{bar})
5171 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
5173 % #1 is the data type. #2 is the name and args.
5174 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
5175 % #1 is the data type, #2 the name, #3 the args.
5176 \def\deftypefunheaderx #1#2 #3\relax{%
5177 \doind {fn}{\code{#2}}% Make entry in function index
5178 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
5179 \deftypefunargs {#3}\endgroup %
5180 \catcode\equalChar=\other % Turn off change made in \defparsebody
5183 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
5185 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
5187 % \defheaderxcond#1\relax$.$
5188 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
5189 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
5191 % #1 is the classification. #2 is the data type. #3 is the name and args.
5192 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
5193 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5194 \def\deftypefnheaderx #1#2#3 #4\relax{%
5195 \doind {fn}{\code{#3}}% Make entry in function index
5197 \normalparens % notably, turn off `&' magic, which prevents
5198 % at least some C++ text from working
5199 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
5200 \deftypefunargs {#4}\endgroup %
5201 \catcode\equalChar=\other % Turn off change made in \defparsebody
5204 % @defmac == @deffn Macro
5206 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5208 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5209 \begingroup\defname {#1}{\putwordDefmac}%
5210 \defunargs {#2}\endgroup %
5211 \catcode\equalChar=\other % Turn off change made in \defparsebody
5214 % @defspec == @deffn Special Form
5216 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5218 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5219 \begingroup\defname {#1}{\putwordDefspec}%
5220 \defunargs {#2}\endgroup %
5221 \catcode\equalChar=\other % Turn off change made in \defparsebody
5224 % @defop CATEGORY CLASS OPERATION ARG...
5226 \def\defop #1 {\def\defoptype{#1}%
5227 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5229 \def\defopheader#1#2#3{%
5230 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
5231 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
5232 \defunargs {#3}\endgroup %
5235 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5237 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5238 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5241 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5242 \def\deftypeopheader#1#2#3#4{%
5243 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5245 \defname{\defheaderxcond#2\relax$.$#3}
5246 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5247 \deftypefunargs{#4}%
5251 % @deftypemethod CLASS TYPE METHOD ARG...
5253 \def\deftypemethod{%
5254 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5256 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5257 \def\deftypemethodheader#1#2#3#4{%
5258 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5260 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5261 \deftypefunargs{#4}%
5265 % @deftypeivar CLASS TYPE VARNAME
5268 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5270 % #1 is the class name, #2 the data type, #3 the variable name.
5271 \def\deftypeivarheader#1#2#3{%
5272 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5274 \defname{\defheaderxcond#2\relax$.$#3}
5275 {\putwordInstanceVariableof\ \code{#1}}%
5280 % @defmethod == @defop Method
5282 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5284 % #1 is the class name, #2 the method name, #3 the args.
5285 \def\defmethodheader#1#2#3{%
5286 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5288 \defname{#2}{\putwordMethodon\ \code{#1}}%
5293 % @defcv {Class Option} foo-class foo-flag
5295 \def\defcv #1 {\def\defcvtype{#1}%
5296 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5298 \def\defcvarheader #1#2#3{%
5299 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5300 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5301 \defvarargs {#3}\endgroup %
5304 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5306 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5308 \def\defivarheader#1#2#3{%
5309 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5311 \defname{#2}{\putwordInstanceVariableof\ #1}%
5317 % First, define the processing that is wanted for arguments of @defvar.
5318 % This is actually simple: just print them in roman.
5319 % This must expand the args and terminate the paragraph they make up
5320 \def\defvarargs #1{\normalparens #1%
5321 \interlinepenalty=10000
5322 \endgraf\nobreak\vskip -\parskip\nobreak}
5324 % @defvr Counter foo-count
5326 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5328 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5329 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5331 % @defvar == @defvr Variable
5333 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5335 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5336 \begingroup\defname {#1}{\putwordDefvar}%
5337 \defvarargs {#2}\endgroup %
5340 % @defopt == @defvr {User Option}
5342 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5344 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5345 \begingroup\defname {#1}{\putwordDefopt}%
5346 \defvarargs {#2}\endgroup %
5349 % @deftypevar int foobar
5351 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5353 % #1 is the data type. #2 is the name, perhaps followed by text that
5354 % is actually part of the data type, which should not be put into the index.
5355 \def\deftypevarheader #1#2{%
5356 \dovarind#2 \relax% Make entry in variables index
5357 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5358 \interlinepenalty=10000
5359 \endgraf\nobreak\vskip -\parskip\nobreak
5361 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5363 % @deftypevr {Global Flag} int enable
5365 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5367 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5368 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5369 \interlinepenalty=10000
5370 \endgraf\nobreak\vskip -\parskip\nobreak
5374 % Args are printed in bold, a slight difference from @defvar.
5376 \def\deftpargs #1{\bf \defvarargs{#1}}
5378 % @deftp Class window height width ...
5380 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5382 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5383 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5385 % These definitions are used if you use @defunx (etc.)
5386 % anywhere other than immediately after a @defun or @defunx.
5388 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5389 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5390 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5391 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5392 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5393 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5394 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5395 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5396 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5397 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5398 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5399 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5400 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5401 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5402 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5403 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5404 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5405 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5406 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5412 % To do this right we need a feature of e-TeX, \scantokens,
5413 % which we arrange to emulate with a temporary file in ordinary TeX.
5414 \ifx\eTeXversion\undefined
5415 \newwrite\macscribble
5417 \begingroup \newlinechar`\^^M
5418 % Undo catcode changes of \startcontents and \doprintindex
5419 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5420 % Append \endinput to make sure that TeX does not see the ending newline.
5421 \toks0={#1\endinput}%
5422 \immediate\openout\macscribble=\jobname.tmp
5423 \immediate\write\macscribble{\the\toks0}%
5424 \immediate\closeout\macscribble
5425 \let\xeatspaces\eatspaces
5431 \begingroup \newlinechar`\^^M
5432 % Undo catcode changes of \startcontents and \doprintindex
5433 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5434 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5437 \newcount\paramno % Count of parameters
5438 \newtoks\macname % Macro name
5439 \newif\ifrecursive % Is it recursive?
5440 \def\macrolist{} % List of all defined macros in the form
5441 % \do\macro1\do\macro2...
5444 % Thisdoes \let #1 = #2, except with \csnames.
5446 \expandafter\expandafter
5448 \expandafter\expandafter
5450 \csname#2\endcsname}
5452 % Trim leading and trailing spaces off a string.
5453 % Concepts from aro-bend problem 15 (see CTAN).
5455 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5456 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5457 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5459 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5462 % Trim a single trailing ^^M off a string.
5463 {\catcode`\^^M=\other \catcode`\Q=3%
5464 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5465 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5466 \gdef\eatcrb#1Q#2Q{#1}%
5469 % Macro bodies are absorbed as an argument in a context where
5470 % all characters are catcode 10, 11 or 12, except \ which is active
5471 % (as in normal texinfo). It is necessary to change the definition of \.
5473 % It's necessary to have hard CRs when the macro is executed. This is
5474 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5475 % body, and then making it the \newlinechar in \scanmacro.
5477 \def\macrobodyctxt{%
5488 \catcode`\^^M=\other
5502 % \mbodybackslash is the definition of \ in @macro bodies.
5503 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5504 % where N is the macro parameter number.
5505 % We define \csname macarg.\endcsname to be \realbackslash, so
5506 % \\ in macro replacement text gets you a backslash.
5508 {\catcode`@=0 @catcode`@\=@active
5509 @gdef@usembodybackslash{@let\=@mbodybackslash}
5510 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5512 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5514 \def\macro{\recursivefalse\parsearg\macroxxx}
5515 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5518 \getargs{#1}% now \macname is the macname and \argl the arglist
5519 \ifx\argl\empty % no arguments
5522 \expandafter\parsemargdef \argl;%
5524 \if1\csname ismacro.\the\macname\endcsname
5525 \message{Warning: redefining \the\macname}%
5527 \expandafter\ifx\csname \the\macname\endcsname \relax
5528 \else \errmessage{Macro name \the\macname\space already defined}\fi
5529 \global\cslet{macsave.\the\macname}{\the\macname}%
5530 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5531 % Add the macroname to \macrolist
5532 \toks0 = \expandafter{\macrolist\do}%
5533 \xdef\macrolist{\the\toks0
5534 \expandafter\noexpand\csname\the\macname\endcsname}%
5536 \begingroup \macrobodyctxt
5537 \ifrecursive \expandafter\parsermacbody
5538 \else \expandafter\parsemacbody
5541 \def\unmacro{\parsearg\dounmacro}
5543 \if1\csname ismacro.#1\endcsname
5544 \global\cslet{#1}{macsave.#1}%
5545 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5546 % Remove the macro name from \macrolist:
5548 \expandafter\let\csname#1\endcsname \relax
5550 \xdef\macrolist{\macrolist}%
5553 \errmessage{Macro #1 not defined}%
5557 % Called by \do from \dounmacro on each macro. The idea is to omit any
5558 % macro definitions that have been changed to \relax.
5564 \noexpand\do \noexpand #1%
5568 % This makes use of the obscure feature that if the last token of a
5569 % <parameter list> is #, then the preceding argument is delimited by
5570 % an opening brace, and that opening brace is not consumed.
5571 \def\getargs#1{\getargsxxx#1{}}
5572 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5573 \def\getmacname #1 #2\relax{\macname={#1}}
5574 \def\getmacargs#1{\def\argl{#1}}
5576 % Parse the optional {params} list. Set up \paramno and \paramlist
5577 % so \defmacro knows what to do. Define \macarg.blah for each blah
5578 % in the params list, to be ##N where N is the position in that list.
5579 % That gets used by \mbodybackslash (above).
5581 % We need to get `macro parameter char #' into several definitions.
5582 % The technique used is stolen from LaTeX: let \hash be something
5583 % unexpandable, insert that wherever you need a #, and then redefine
5584 % it to # just before using the token list produced.
5586 % The same technique is used to protect \eatspaces till just before
5587 % the macro is used.
5589 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5590 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5591 \def\parsemargdefxxx#1,{%
5592 \if#1;\let\next=\relax
5593 \else \let\next=\parsemargdefxxx
5594 \advance\paramno by 1%
5595 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5596 {\xeatspaces{\hash\the\paramno}}%
5597 \edef\paramlist{\paramlist\hash\the\paramno,}%
5600 % These two commands read recursive and nonrecursive macro bodies.
5601 % (They're different since rec and nonrec macros end differently.)
5603 \long\def\parsemacbody#1@end macro%
5604 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5605 \long\def\parsermacbody#1@end rmacro%
5606 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5608 % This defines the macro itself. There are six cases: recursive and
5609 % nonrecursive macros of zero, one, and many arguments.
5610 % Much magic with \expandafter here.
5611 % \xdef is used so that macro definitions will survive the file
5612 % they're defined in; @include reads the file inside a group.
5614 \let\hash=##% convert placeholders to macro parameter chars
5618 \expandafter\xdef\csname\the\macname\endcsname{%
5619 \noexpand\scanmacro{\temp}}%
5621 \expandafter\xdef\csname\the\macname\endcsname{%
5622 \bgroup\noexpand\macroargctxt
5623 \noexpand\braceorline
5624 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5625 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5626 \egroup\noexpand\scanmacro{\temp}}%
5628 \expandafter\xdef\csname\the\macname\endcsname{%
5629 \bgroup\noexpand\macroargctxt
5630 \noexpand\csname\the\macname xx\endcsname}%
5631 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5632 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5633 \expandafter\expandafter
5635 \expandafter\expandafter
5636 \csname\the\macname xxx\endcsname
5637 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5642 \expandafter\xdef\csname\the\macname\endcsname{%
5643 \noexpand\norecurse{\the\macname}%
5644 \noexpand\scanmacro{\temp}\egroup}%
5646 \expandafter\xdef\csname\the\macname\endcsname{%
5647 \bgroup\noexpand\macroargctxt
5648 \noexpand\braceorline
5649 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5650 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5652 \noexpand\norecurse{\the\macname}%
5653 \noexpand\scanmacro{\temp}\egroup}%
5655 \expandafter\xdef\csname\the\macname\endcsname{%
5656 \bgroup\noexpand\macroargctxt
5657 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5658 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5659 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5660 \expandafter\expandafter
5662 \expandafter\expandafter
5663 \csname\the\macname xxx\endcsname
5666 \noexpand\norecurse{\the\macname}%
5667 \noexpand\scanmacro{\temp}\egroup}%
5671 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5673 % \braceorline decides whether the next nonwhitespace character is a
5674 % {. If so it reads up to the closing }, if not, it reads the whole
5675 % line. Whatever was read is then fed to the next control sequence
5676 % as an argument (by \parsebrace or \parsearg)
5677 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5678 \def\braceorlinexxx{%
5679 \ifx\nchar\bgroup\else
5680 \expandafter\parsearg
5683 % We mant to disable all macros during \shipout so that they are not
5684 % expanded by \write.
5685 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5686 \edef\next{\macrolist}\expandafter\endgroup\next}
5690 % We need some trickery to remove the optional spaces around the equal
5691 % sign. Just make them active and then expand them all to nothing.
5692 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5693 \def\aliasxxx #1{\aliasyyy#1\relax}
5694 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5695 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5696 \expandafter\noexpand\csname#2\endcsname}%
5697 \expandafter\endgroup\next}
5700 \message{cross references,}
5705 \newif\ifhavexrefs % True if xref values are known.
5706 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5708 % @inforef is relatively simple.
5709 \def\inforef #1{\inforefzzz #1,,,,**}
5710 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5711 node \samp{\ignorespaces#1{}}}
5713 % @node's job is to define \lastnode.
5714 \def\node{\ENVcheck\parsearg\nodezzz}
5715 \def\nodezzz#1{\nodexxx [#1,]}
5716 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5718 \let\lastnode=\relax
5720 % The sectioning commands (@chapter, etc.) call these.
5722 \ifx\lastnode\relax\else
5723 \expandafter\expandafter\expandafter\setref{\lastnode}%
5724 {Ysectionnumberandtype}%
5725 \global\let\lastnode=\relax
5728 \def\unnumbnoderef{%
5729 \ifx\lastnode\relax\else
5730 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5731 \global\let\lastnode=\relax
5734 \def\appendixnoderef{%
5735 \ifx\lastnode\relax\else
5736 \expandafter\expandafter\expandafter\setref{\lastnode}%
5737 {Yappendixletterandtype}%
5738 \global\let\lastnode=\relax
5743 % @anchor{NAME} -- define xref target at arbitrary point.
5745 \newcount\savesfregister
5746 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5747 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5748 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5750 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5751 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5752 % to set \indexdummies so commands such as @code in a section title
5753 % aren't expanded. It would be nicer not to expand the titles in the
5754 % first place, but there's so many layers that that is hard to do.
5759 \dosetq{#1-title}{Ytitle}%
5760 \dosetq{#1-pg}{Ypagenumber}%
5761 \dosetq{#1-snt}{#2}%
5764 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5765 % the node name, #2 the name of the Info cross-reference, #3 the printed
5766 % node name, #4 the name of the Info file, #5 the name of the printed
5767 % manual. All but the node name can be omitted.
5769 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5770 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5771 \def\ref#1{\xrefX[#1,,,,,,,]}
5772 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5774 \def\printedmanual{\ignorespaces #5}%
5775 \def\printednodename{\ignorespaces #3}%
5776 \setbox1=\hbox{\printedmanual}%
5777 \setbox0=\hbox{\printednodename}%
5779 % No printed node name was explicitly given.
5780 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5781 % Use the node name inside the square brackets.
5782 \def\printednodename{\ignorespaces #1}%
5784 % Use the actual chapter/section title appear inside
5785 % the square brackets. Use the real section title if we have it.
5787 % It is in another manual, so we don't have it.
5788 \def\printednodename{\ignorespaces #1}%
5791 % We know the real title if we have the xref values.
5792 \def\printednodename{\refx{#1-title}{}}%
5794 % Otherwise just copy the Info node name.
5795 \def\printednodename{\ignorespaces #1}%
5801 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5802 % insert empty discretionaries after hyphens, which means that it will
5803 % not find a line break at a hyphen in a node names. Since some manuals
5804 % are best written with fairly long node names, containing hyphens, this
5805 % is a loss. Therefore, we give the text of the node name again, so it
5806 % is as if TeX is seeing it for the first time.
5810 {\normalturnoffactive
5811 \ifnum\filenamelength>0
5812 \startlink attr{/Border [0 0 0]}%
5813 goto file{\the\filename.pdf} name{#1}%
5815 \startlink attr{/Border [0 0 0]}%
5823 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5825 % _ (for example) has to be the character _ for the purposes of the
5826 % control sequence corresponding to the node, but it has to expand
5827 % into the usual \leavevmode...\vrule stuff for purposes of
5828 % printing. So we \turnoffactive for the \refx-snt, back on for the
5829 % printing, back off for the \refx-pg.
5830 {\normalturnoffactive
5831 % Only output a following space if the -snt ref is nonempty; for
5832 % @unnumbered and @anchor, it won't be.
5833 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5834 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5837 [\printednodename],\space
5839 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5844 % \dosetq is the interface for calls from other macros
5846 % Use \normalturnoffactive so that punctuation chars such as underscore
5847 % and backslash work in node names. (\turnoffactive doesn't do \.)
5850 \normalturnoffactive
5851 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5858 % \internalsetq {foo}{page} expands into
5859 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5860 % When the aux file is read, ' is the escape character
5862 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5864 % Things to be expanded by \internalsetq
5866 \def\Ypagenumber{\folio}
5868 \def\Ytitle{\thissection}
5872 \def\Ysectionnumberandtype{%
5873 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5874 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5875 \else \ifnum \subsubsecno=0 %
5876 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5878 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5881 \def\Yappendixletterandtype{%
5882 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5883 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5884 \else \ifnum \subsubsecno=0 %
5885 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5887 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5892 % Use TeX 3.0's \inputlineno to get the line number, for better error
5893 % messages, but if we're using an old version of TeX, don't do anything.
5895 \ifx\inputlineno\thisisundefined
5896 \let\linenumber = \empty % Non-3.0.
5898 \def\linenumber{\the\inputlineno:\space}
5901 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5902 % If its value is nonempty, SUFFIX is output afterward.
5907 \expandafter\global\expandafter\let\expandafter\thisrefX
5908 \csname X#1\endcsname
5911 % If not defined, say something at least.
5912 \angleleft un\-de\-fined\angleright
5915 \message{\linenumber Undefined cross reference `#1'.}%
5918 \global\warnedxrefstrue
5919 \message{Cross reference values unknown; you must run TeX again.}%
5924 % It's defined, so just use it.
5927 #2% Output the suffix in any case.
5930 % This is the macro invoked by entries in the aux file.
5932 \def\xrdef#1{\begingroup
5933 % Reenable \ as an escape while reading the second argument.
5935 \afterassignment\endgroup
5936 \expandafter\gdef\csname X#1\endcsname
5939 % Read the last existing aux file, if any. No error if none exists.
5940 \def\readauxfile{\begingroup
5941 \catcode`\^^@=\other
5942 \catcode`\^^A=\other
5943 \catcode`\^^B=\other
5944 \catcode`\^^C=\other
5945 \catcode`\^^D=\other
5946 \catcode`\^^E=\other
5947 \catcode`\^^F=\other
5948 \catcode`\^^G=\other
5949 \catcode`\^^H=\other
5950 \catcode`\^^K=\other
5951 \catcode`\^^L=\other
5952 \catcode`\^^N=\other
5953 \catcode`\^^P=\other
5954 \catcode`\^^Q=\other
5955 \catcode`\^^R=\other
5956 \catcode`\^^S=\other
5957 \catcode`\^^T=\other
5958 \catcode`\^^U=\other
5959 \catcode`\^^V=\other
5960 \catcode`\^^W=\other
5961 \catcode`\^^X=\other
5962 \catcode`\^^Z=\other
5963 \catcode`\^^[=\other
5964 \catcode`\^^\=\other
5965 \catcode`\^^]=\other
5966 \catcode`\^^^=\other
5967 \catcode`\^^_=\other
5970 % It was suggested to define this as 7, which would allow ^^e4 etc.
5971 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5972 % supported in the main text, it doesn't seem desirable. Furthermore,
5973 % that is not enough: for node names that actually contain a ^
5974 % character, we would end up writing a line like this: 'xrdef {'hat
5975 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5976 % argument, and \hat is not an expandable control sequence. It could
5977 % all be worked out, but why? Either we support ^^ or we don't.
5979 % The other change necessary for this was to define \auxhat:
5980 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5981 % and then to call \auxhat in \setq.
5994 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5995 % Make the characters 128-255 be printing characters
5999 \catcode\count 1=\other
6000 \advance\count 1 by 1
6001 \ifnum \count 1<256 \loop \fi
6004 % The aux file uses ' as the escape (for now).
6005 % Turn off \ as an escape so we do not lose on
6006 % entries which were dumped with control sequences in their names.
6007 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
6008 % Reference to such entries still does not work the way one would wish,
6009 % but at least they do not bomb out when the aux file is read in.
6016 \openin 1 \jobname.aux
6020 \global\havexrefstrue
6021 \global\warnedobstrue
6023 % Open the new aux file. TeX will close it automatically at exit.
6024 \openout\auxfile=\jobname.aux
6030 \newcount \footnoteno
6032 % The trailing space in the following definition for supereject is
6033 % vital for proper filling; pages come out unaligned when you do a
6034 % pagealignmacro call if that space before the closing brace is
6035 % removed. (Generally, numeric constants should always be followed by a
6036 % space to prevent strange expansion errors.)
6037 \def\supereject{\par\penalty -20000\footnoteno =0 }
6039 % @footnotestyle is meaningful for info output only.
6040 \let\footnotestyle=\comment
6042 \let\ptexfootnote=\footnote
6046 % Auto-number footnotes. Otherwise like plain.
6048 \global\advance\footnoteno by \@ne
6049 \edef\thisfootno{$^{\the\footnoteno}$}%
6051 % In case the footnote comes at the end of a sentence, preserve the
6052 % extra spacing after we do the footnote number.
6054 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
6056 % Remove inadvertent blank space before typesetting the footnote number.
6062 % Don't bother with the trickery in plain.tex to not require the
6063 % footnote text as a parameter. Our footnotes don't need to be so general.
6065 % Oh yes, they do; otherwise, @ifset and anything else that uses
6066 % \parseargline fail inside footnotes because the tokens are fixed when
6067 % the footnote is read. --karl, 16nov96.
6069 % The start of the footnote looks usually like this:
6070 \gdef\startfootins{\insert\footins\bgroup}
6072 % ... but this macro is redefined inside @multitable.
6076 % We want to typeset this text as a normal paragraph, even if the
6077 % footnote reference occurs in (for example) a display environment.
6078 % So reset some parameters.
6080 \interlinepenalty\interfootnotelinepenalty
6081 \splittopskip\ht\strutbox % top baseline for broken footnotes
6082 \splitmaxdepth\dp\strutbox
6083 \floatingpenalty\@MM
6088 \parindent\defaultparindent
6092 % Because we use hanging indentation in footnotes, a @noindent appears
6093 % to exdent this text, so make it be a no-op. makeinfo does not use
6094 % hanging indentation so @noindent can still be needed within footnote
6095 % text after an @example or the like (not that this is good style).
6096 \let\noindent = \relax
6098 % Hang the footnote text off the number. Use \everypar in case the
6099 % footnote extends for more than one paragraph.
6100 \everypar = {\hang}%
6101 \textindent{\thisfootno}%
6103 % Don't crash into the line above the footnote text. Since this
6104 % expands into a box, it must come within the paragraph, lest it
6105 % provide a place where TeX can split the footnote.
6107 \futurelet\next\fo@t
6109 }%end \catcode `\@=11
6111 % @| inserts a changebar to the left of the current line. It should
6112 % surround any changed text. This approach does *not* work if the
6113 % change spans more than two lines of output. To handle that, we would
6114 % have adopt a much more difficult approach (putting marks into the main
6115 % vertical list for the beginning and end of each change).
6118 % \vadjust can only be used in horizontal mode.
6121 % Append this vertical mode material after the current line in the output.
6123 % We want to insert a rule with the height and depth of the current
6124 % leading; that is exactly what \strutbox is supposed to record.
6125 \vskip-\baselineskip
6127 % \vadjust-items are inserted at the left edge of the type. So
6128 % the \llap here moves out into the left-hand margin.
6131 % For a thicker or thinner bar, change the `1pt'.
6132 \vrule height\baselineskip width1pt
6134 % This is the space between the bar and the text.
6140 % For a final copy, take out the rectangles
6141 % that mark overfull boxes (in case you have decided
6142 % that the text looks ok even though it passes the margin).
6144 \def\finalout{\overfullrule=0pt}
6146 % @image. We use the macros from epsf.tex to support this.
6147 % If epsf.tex is not installed and @image is used, we complain.
6149 % Check for and read epsf.tex up front. If we read it only at @image
6150 % time, we might be inside a group, and then its definitions would get
6151 % undone and the next image would fail.
6152 \openin 1 = epsf.tex
6155 % Do not bother showing banner with epsf.tex v2.7k (available in
6156 % doc/epsf.tex and on ctan).
6157 \def\epsfannounce{\toks0 = }%
6161 % We will only complain once about lack of epsf.tex.
6162 \newif\ifwarnednoepsf
6163 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6164 work. It is also included in the Texinfo distribution, or you can get
6165 it from ftp://tug.org/tex/epsf.tex.}
6168 \ifx\epsfbox\undefined
6169 \ifwarnednoepsf \else
6170 \errhelp = \noepsfhelp
6171 \errmessage{epsf.tex not found, images will be ignored}%
6172 \global\warnednoepsftrue
6175 \imagexxx #1,,,,,\finish
6179 % Arguments to @image:
6180 % #1 is (mandatory) image filename; we tack on .eps extension.
6181 % #2 is (optional) width, #3 is (optional) height.
6182 % #4 is (ignored optional) html alt text.
6183 % #5 is (ignored optional) extension.
6184 % #6 is just the usual extra ignored arg for parsing this stuff.
6186 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6187 \catcode`\^^M = 5 % in case we're inside an example
6188 \normalturnoffactive % allow _ et al. in names
6189 % If the image is by itself, center it.
6193 % Usually we'll have text after the image which will insert
6194 % \parskip glue, so insert it here too to equalize the space
6196 \nobreak\vskip\parskip
6203 \dopdfimage{#1}{#2}{#3}%
6205 % \epsfbox itself resets \epsf?size at each figure.
6206 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6207 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6211 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6215 \message{localization,}
6218 % @documentlanguage is usually given very early, just after
6219 % @setfilename. If done too late, it may not override everything
6220 % properly. Single argument is the language abbreviation.
6221 % It would be nice if we could set up a hyphenation file here.
6223 \def\documentlanguage{\parsearg\dodocumentlanguage}
6224 \def\dodocumentlanguage#1{%
6225 \tex % read txi-??.tex file in plain TeX.
6226 % Read the file if it exists.
6227 \openin 1 txi-#1.tex
6229 \errhelp = \nolanghelp
6230 \errmessage{Cannot read language file txi-#1.tex}%
6233 \def\temp{\input txi-#1.tex }%
6238 \newhelp\nolanghelp{The given language definition file cannot be found or
6239 is empty. Maybe you need to install it? In the current directory
6240 should work if nowhere else does.}
6243 % @documentencoding should change something in TeX eventually, most
6244 % likely, but for now just recognize it.
6245 \let\documentencoding = \comment
6248 % Page size parameters.
6250 \newdimen\defaultparindent \defaultparindent = 15pt
6252 \chapheadingskip = 15pt plus 4pt minus 2pt
6253 \secheadingskip = 12pt plus 3pt minus 2pt
6254 \subsecheadingskip = 9pt plus 2pt minus 2pt
6256 % Prevent underfull vbox error messages.
6259 % Don't be so finicky about underfull hboxes, either.
6262 % Following George Bush, just get rid of widows and orphans.
6266 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6267 % using an old version of TeX, don't do anything. We want the amount of
6268 % stretch added to depend on the line length, hence the dependence on
6269 % \hsize. We call this whenever the paper size is set.
6271 \def\setemergencystretch{%
6272 \ifx\emergencystretch\thisisundefined
6273 % Allow us to assign to \emergencystretch anyway.
6274 \def\emergencystretch{\dimen0}%
6276 \emergencystretch = .15\hsize
6280 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6281 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6282 % physical page width.
6284 % We also call \setleading{\textleading}, so the caller should define
6285 % \textleading. The caller should also set \parskip.
6287 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6290 \splittopskip = \topskip
6293 \advance\vsize by \topskip
6294 \outervsize = \vsize
6295 \advance\outervsize by 2\topandbottommargin
6296 \pageheight = \vsize
6299 \outerhsize = \hsize
6300 \advance\outerhsize by 0.5in
6303 \normaloffset = #4\relax
6304 \bindingoffset = #5\relax
6307 \pdfpageheight #7\relax
6308 \pdfpagewidth #8\relax
6311 \setleading{\textleading}
6313 \parindent = \defaultparindent
6314 \setemergencystretch
6317 % Use `small' versions.
6319 \def\smallenvironments{%
6320 \let\smalldisplay = \smalldisplayx
6321 \let\smallexample = \smalllispx
6322 \let\smallformat = \smallformatx
6323 \let\smalllisp = \smalllispx
6326 % @letterpaper (the default).
6327 \def\letterpaper{{\globaldefs = 1
6328 \parskip = 3pt plus 2pt minus 1pt
6329 \textleading = 13.2pt
6331 % If page is nothing but text, make it come out even.
6332 \internalpagesizes{46\baselineskip}{6in}%
6334 {\bindingoffset}{36pt}%
6338 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6339 \def\smallbook{{\globaldefs = 1
6340 \parskip = 2pt plus 1pt
6343 \internalpagesizes{7.5in}{5in}%
6345 {\bindingoffset}{16pt}%
6348 \lispnarrowing = 0.3in
6351 \contentsrightmargin = 0pt
6352 \defbodyindent = .5cm
6356 % Use @afourpaper to print on European A4 paper.
6357 \def\afourpaper{{\globaldefs = 1
6358 \parskip = 3pt plus 2pt minus 1pt
6359 \textleading = 13.2pt
6361 % Double-side printing via postscript on Laserjet 4050
6362 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6363 % To change the settings for a different printer or situation, adjust
6364 % \normaloffset until the front-side and back-side texts align. Then
6365 % do the same for \bindingoffset. You can set these for testing in
6366 % your texinfo source file like this:
6368 % \global\normaloffset = -6mm
6369 % \global\bindingoffset = 10mm
6371 \internalpagesizes{51\baselineskip}{160mm}
6372 {\voffset}{\hoffset}%
6373 {\bindingoffset}{44pt}%
6378 \contentsrightmargin = 0pt
6379 \defbodyindent = 5mm
6382 % Use @afivepaper to print on European A5 paper.
6383 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6384 % He also recommends making @example and @lisp be small.
6385 \def\afivepaper{{\globaldefs = 1
6386 \parskip = 2pt plus 1pt minus 0.1pt
6387 \textleading = 12.5pt
6389 \internalpagesizes{160mm}{120mm}%
6390 {\voffset}{\hoffset}%
6391 {\bindingoffset}{8pt}%
6394 \lispnarrowing = 0.2in
6397 \contentsrightmargin = 0pt
6398 \defbodyindent = 2mm
6404 % A specific text layout, 24x15cm overall, intended for A4 paper.
6405 \def\afourlatex{{\globaldefs = 1
6407 \internalpagesizes{237mm}{150mm}%
6409 {\bindingoffset}{7mm}%
6412 % Must explicitly reset to 0 because we call \afourpaper.
6416 % Use @afourwide to print on A4 paper in landscape format.
6417 \def\afourwide{{\globaldefs = 1
6419 \internalpagesizes{241mm}{165mm}%
6420 {\voffset}{-2.95mm}%
6421 {\bindingoffset}{7mm}%
6426 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6427 % Perhaps we should allow setting the margins, \topskip, \parskip,
6428 % and/or leading, also. Or perhaps we should compute them somehow.
6430 \def\pagesizes{\parsearg\pagesizesxxx}
6431 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6432 \def\pagesizesyyy#1,#2,#3\finish{{%
6433 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6436 \parskip = 3pt plus 2pt minus 1pt
6437 \setleading{\textleading}%
6440 \advance\dimen0 by \voffset
6443 \advance\dimen2 by \normaloffset
6445 \internalpagesizes{#1}{\hsize}%
6446 {\voffset}{\normaloffset}%
6447 {\bindingoffset}{44pt}%
6451 % Set default to letter.
6456 \message{and turning on texinfo input format.}
6458 % Define macros to output various characters with catcode for normal text.
6468 \def\normaldoublequote{"}
6471 \def\normalunderscore{_}
6472 \def\normalverticalbar{|}
6474 \def\normalgreater{>}
6476 \def\normaldollar{$}%$ font-lock fix
6478 % This macro is used to make a character print one way in ttfont
6479 % where it can probably just be output, and another way in other fonts,
6480 % where something hairier probably needs to be done.
6482 % #1 is what to print if we are indeed using \tt; #2 is what to print
6483 % otherwise. Since all the Computer Modern typewriter fonts have zero
6484 % interword stretch (and shrink), and it is reasonable to expect all
6485 % typewriter fonts to have this, we can check that font parameter.
6487 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6489 % Same as above, but check for italic font. Actually this also catches
6490 % non-italic slanted fonts since it is impossible to distinguish them from
6491 % italic fonts. But since this is only used by $ and it uses \sl anyway
6492 % this is not a problem.
6493 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6495 % Turn off all special characters except @
6496 % (and those which the user can use as if they were ordinary).
6497 % Most of these we simply print from the \tt font, but for some, we can
6498 % use math or other variants that look better in normal text.
6501 \def\activedoublequote{{\tt\char34}}
6502 \let"=\activedoublequote
6504 \def~{{\tt\char126}}
6510 \def_{\ifusingtt\normalunderscore\_}
6511 % Subroutine for the previous macro.
6512 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6515 \def|{{\tt\char124}}
6523 \def+{{\tt \char 43}}
6525 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6527 % Set up an active definition for =, but don't enable it most of the time.
6528 {\catcode`\==\active
6529 \global\def={{\tt \char 61}}}
6534 % If a .fmt file is being used, characters that might appear in a file
6535 % name cannot be active until we have parsed the command line.
6536 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6537 % \otherifyactive is called near the end of this file.
6538 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6542 % \rawbackslashxx output one backslash character in current font
6543 \global\chardef\rawbackslashxx=`\\
6544 %{\catcode`\\=\other
6545 %@gdef@rawbackslashxx{\}}
6547 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6548 {\catcode`\\=\active
6549 @gdef@rawbackslash{@let\=@rawbackslashxx }}
6551 % \normalbackslash outputs one backslash in fixed width font.
6552 \def\normalbackslash{{\tt\rawbackslashxx}}
6556 % Used sometimes to turn off (effectively) the active characters
6557 % even after parsing them.
6558 @def@turnoffactive{@let"=@normaldoublequote
6559 @let\=@realbackslash
6562 @let_=@normalunderscore
6563 @let|=@normalverticalbar
6565 @let>=@normalgreater
6567 @let$=@normaldollar}%$ font-lock fix
6569 % Same as @turnoffactive except for \.
6570 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6572 % Make _ and + \other characters, temporarily.
6573 % This is canceled by @fixbackslash.
6576 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6577 % That is what \eatinput is for; after that, the `\' should revert to printing
6580 @gdef@eatinput input texinfo{@fixbackslash}
6581 @global@let\ = @eatinput
6583 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6584 % the first `\{ in the file would cause an error. This macro tries to fix
6585 % that, assuming it is called before the first `\' could plausibly occur.
6586 % Also back turn on active characters that might appear in the input
6587 % file name, in case not using a pre-dumped format.
6589 @gdef@fixbackslash{%
6590 @ifx\@eatinput @let\ = @normalbackslash @fi
6595 % Say @foo, not \foo, in error messages.
6598 % These look ok in all fonts, so just make them not special.
6599 @catcode`@& = @other
6600 @catcode`@# = @other
6601 @catcode`@% = @other
6603 @c Set initial fonts.
6609 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6610 @c page-delimiter: "^\\\\message"
6611 @c time-stamp-start: "def\\\\texinfoversion{"
6612 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6613 @c time-stamp-end: "}"