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{2002-09-29.15}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
11 % This texinfo.tex file is free software; you can redistribute it and/or
12 % modify it under the terms of the GNU General Public License as
13 % published by the Free Software Foundation; either version 2, or (at
14 % your option) any later version.
16 % This texinfo.tex file is distributed in the hope that it will be
17 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 % General Public License for more details.
21 % You should have received a copy of the GNU General Public License
22 % along with this texinfo.tex file; see the file COPYING. If not, write
23 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 % Boston, MA 02111-1307, USA.
26 % In other words, you are welcome to use, share and improve this program.
27 % You are forbidden to forbid anyone else to use, share and improve
28 % what you give them. Help stamp out software-hoarding!
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % ftp://ftp.gnu.org/gnu/texinfo.tex
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 % ftp://texinfo.org/texinfo/texinfo.tex
35 % ftp://tug.org/tex/texinfo.tex
36 % (and all CTAN mirrors, see http://www.ctan.org),
37 % and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
39 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
41 % The texinfo.tex in any given Texinfo distribution could well be out
42 % of date, so if that's what you're using, please check.
44 % Send bug reports to bug-texinfo@gnu.org. Please include including a
45 % complete document in each bug report with which we can reproduce the
46 % problem. Patches are, of course, greatly appreciated.
48 % To process a Texinfo manual with TeX, it's most reliable to use the
49 % texi2dvi shell script that comes with the distribution. For a simple
50 % manual foo.texi, however, you can get away with this:
55 % dvips foo.dvi -o # or whatever; this makes foo.ps.
56 % The extra TeX runs get the cross-reference information correct.
57 % Sometimes one run after texindex suffices, and sometimes you need more
58 % than two; texi2dvi does it as many times as necessary.
60 % It is possible to adapt texinfo.tex for other languages. You can get
61 % the existing language-specific files from the 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}
71 % Save some parts of plain tex whose names we will redefine.
73 \let\ptexbullet=\bullet
87 % We never want plain's outer \+ definition in Texinfo.
88 % For @tex, we can use \tabalign.
94 % If this character appears in an error message or help string, it
95 % starts a new line in the output.
98 % Set up fixed words for English if not already set.
99 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
100 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
101 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
102 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
103 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
104 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
105 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
106 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
107 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
108 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
109 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
110 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
111 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
112 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
113 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
114 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
115 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
116 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
117 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
119 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
120 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
121 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
122 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
123 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
124 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
125 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
126 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
127 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
128 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
129 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
130 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
132 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
133 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
134 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
135 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
136 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
137 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
138 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
144 \hyphenation{ap-pen-dix}
145 \hyphenation{mini-buf-fer mini-buf-fers}
147 \hyphenation{white-space}
149 % Margin to add to right of even pages, to left of odd pages.
150 \newdimen \bindingoffset
151 \newdimen \normaloffset
152 \newdimen\pagewidth \newdimen\pageheight
154 % Sometimes it is convenient to have everything in the transcript file
155 % and nothing on the terminal. We don't just call \tracingall here,
156 % since that produces some useless output on the terminal.
158 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
159 \ifx\eTeXversion\undefined
160 \def\loggingall{\tracingcommands2 \tracingstats2
161 \tracingpages1 \tracingoutput1 \tracinglostchars1
162 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
163 \showboxbreadth\maxdimen\showboxdepth\maxdimen
166 \def\loggingall{\tracingcommands3 \tracingstats2
167 \tracingpages1 \tracingoutput1 \tracinglostchars1
168 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
169 \tracingscantokens1 \tracingassigns1 \tracingifs1
170 \tracinggroups1 \tracingnesting2
171 \showboxbreadth\maxdimen\showboxdepth\maxdimen
175 % add check for \lastpenalty to plain's definitions. If the last thing
176 % we did was a \nobreak, we don't want to insert more space.
178 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
179 \removelastskip\penalty-50\smallskip\fi\fi}
180 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
181 \removelastskip\penalty-100\medskip\fi\fi}
182 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
183 \removelastskip\penalty-200\bigskip\fi\fi}
185 % For @cropmarks command.
186 % Do @cropmarks to get crop marks.
189 \let\cropmarks = \cropmarkstrue
191 % Dimensions to add cropmarks at corners.
192 % Added by P. A. MacKay, 12 Nov. 1986
194 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
195 \newdimen\cornerlong \cornerlong=1pc
196 \newdimen\cornerthick \cornerthick=.3pt
197 \newdimen\topandbottommargin \topandbottommargin=.75in
199 % Main output routine.
201 \output = {\onepageout{\pagecontents\PAGE}}
206 % \onepageout takes a vbox as an argument. Note that \pagecontents
207 % does insertions, but you have to call it yourself.
209 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
211 \ifodd\pageno \advance\hoffset by \bindingoffset
212 \else \advance\hoffset by -\bindingoffset\fi
214 % Do this outside of the \shipout so @code etc. will be expanded in
215 % the headline as they should be, not taken literally (outputting ''code).
216 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
217 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
220 % Have to do this stuff outside the \shipout because we want it to
221 % take effect in \write's, yet the group defined by the \vbox ends
222 % before the \shipout runs.
224 \escapechar = `\\ % use backslash in output files.
225 \indexdummies % don't expand commands in the output.
226 \normalturnoffactive % \ in index entries must not stay \, e.g., if
227 % the page break happens to be in the middle of an example.
229 % Do this early so pdf references go to the beginning of the page.
230 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
232 \ifcropmarks \vbox to \outervsize\bgroup
234 \vskip-\topandbottommargin
236 \line{\ewtop\hfil\ewtop}%
239 \vbox{\moveleft\cornerthick\nstop}%
241 \vbox{\moveright\cornerthick\nstop}%
244 \vskip\topandbottommargin
246 \hfil % center the page within the outer (page) hsize.
247 \ifodd\pageno\hskip\bindingoffset\fi
253 \ifdim\ht\footlinebox > 0pt
254 % Only leave this space if the footline is nonempty.
255 % (We lessened \vsize for it in \oddfootingxxx.)
256 % The \baselineskip=24pt in plain's \makefootline has no effect.
257 \vskip 2\baselineskip
262 \egroup % end of \vbox\bgroup
263 \hfil\egroup % end of (centering) \line\bgroup
264 \vskip\topandbottommargin plus1fill minus1fill
265 \boxmaxdepth = \cornerthick
268 \vbox{\moveleft\cornerthick\nsbot}%
270 \vbox{\moveright\cornerthick\nsbot}%
273 \line{\ewbot\hfil\ewbot}%
275 \egroup % \vbox from first cropmarks clause
277 }% end of \shipout\vbox
278 }% end of group with \turnoffactive
280 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
283 \newinsert\margin \dimen\margin=\maxdimen
285 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
287 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
288 % marginal hacks, juha@viisa.uucp (Juha Takala)
289 \ifvoid\margin\else % marginal info is present
290 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
291 \dimen@=\dp#1 \unvbox#1
292 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
293 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
296 % Here are the rules for the cropmarks. Note that they are
297 % offset so that the space between them is truly \outerhsize or \outervsize
298 % (P. A. MacKay, 12 November, 1986)
300 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
302 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
303 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
305 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
307 % Parse an argument, then pass it to #1. The argument is the rest of
308 % the input line (except we remove a trailing comment). #1 should be a
309 % macro which expects an ordinary undelimited TeX argument.
315 \futurelet\temp\parseargx
318 % If the next token is an obeyed space (from an @example environment or
319 % the like), remove it and recurse. Otherwise, we're done.
321 % \obeyedspace is defined far below, after the definition of \sepspaces.
322 \ifx\obeyedspace\temp
323 \expandafter\parseargdiscardspace
325 \expandafter\parseargline
329 % Remove a single space (as the delimiter token to the macro call).
331 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
334 \gdef\parseargline#1^^M{%
335 \endgroup % End of the group started in \parsearg.
337 % First remove any @c comment, then any @comment.
338 % Result of each macro is put in \toks0.
339 \argremovec #1\c\relax %
340 \expandafter\argremovecomment \the\toks0 \comment\relax %
342 % Call the caller's macro, saved as \next in \parsearg.
343 \expandafter\next\expandafter{\the\toks0}%
347 % Since all \c{,omment} does is throw away the argument, we can let TeX
348 % do that for us. The \relax here is matched by the \relax in the call
349 % in \parseargline; it could be more or less anything, its purpose is
350 % just to delimit the argument to the \c.
351 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
352 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
354 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
355 % @end itemize @c foo
356 % will have two active spaces as part of the argument with the
357 % `itemize'. Here we remove all active spaces from #1, and assign the
360 % This loses if there are any *other* active characters besides spaces
361 % in the argument -- _ ^ +, for example -- since they get expanded.
362 % Fortunately, Texinfo does not define any such commands. (If it ever
363 % does, the catcode of the characters in questionwill have to be changed
364 % here.) But this means we cannot call \removeactivespaces as part of
365 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
366 % that \parsearg gets might well have any character at all in it.
368 \def\removeactivespaces#1{%
372 \global\toks0 = \expandafter{\temp}%
376 % Change the active space to expand to nothing.
380 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
384 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
386 %% These are used to keep @begin/@end levels from running away
387 %% Call \inENV within environments (after a \begingroup)
388 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
390 \ifENV\errmessage{Still within an environment; press RETURN to continue}
391 \endgroup\fi} % This is not perfect, but it should reduce lossage
393 % @begin foo is the same as @foo, for now.
394 \newhelp\EMsimple{Press RETURN to continue.}
396 \outer\def\begin{\parsearg\beginxxx}
399 \expandafter\ifx\csname #1\endcsname\relax
400 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
401 \csname #1\endcsname\fi}
403 % @end foo executes the definition of \Efoo.
405 \def\end{\parsearg\endxxx}
407 \removeactivespaces{#1}%
408 \edef\endthing{\the\toks0}%
410 \expandafter\ifx\csname E\endthing\endcsname\relax
411 \expandafter\ifx\csname \endthing\endcsname\relax
412 % There's no \foo, i.e., no ``environment'' foo.
414 \errmessage{Undefined command `@end \endthing'}%
416 \unmatchedenderror\endthing
419 % Everything's ok; the right environment has been started.
420 \csname E\endthing\endcsname
424 % There is an environment #1, but it hasn't been started. Give an error.
426 \def\unmatchedenderror#1{%
428 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
431 % Define the control sequence \E#1 to give an unmatched @end error.
433 \def\defineunmatchedend#1{%
434 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
438 % Single-spacing is done by various environments (specifically, in
439 % \nonfillstart and \quotations).
440 \newskip\singlespaceskip \singlespaceskip = 12.5pt
442 % Why was this kern here? It messes up equalizing space above and below
443 % environments. --karl, 6may93
444 %{\advance \baselineskip by -\singlespaceskip
445 %\kern \baselineskip}%
446 \setleading\singlespaceskip
449 %% Simple single-character @ commands
452 % Kludge this until the fonts are right (grr).
455 % This is turned off because it was never documented
456 % and you can use @w{...} around a quote to suppress ligatures.
457 %% Define @` and @' to be the same as ` and '
458 %% but suppressing ligatures.
462 % Used to generate quoted braces.
463 \def\mylbrace {{\tt\char123}}
464 \def\myrbrace {{\tt\char125}}
468 % Definitions to produce actual \{ & \} command in an index.
469 \catcode`\{ = 12 \catcode`\} = 12
470 \catcode`\[ = 1 \catcode`\] = 2
471 \catcode`\@ = 0 \catcode`\\ = 12
476 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
477 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
480 \def\ringaccent#1{{\accent23 #1}}
485 % Other special characters: @questiondown @exclamdown
486 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
487 \def\questiondown{?`}
490 % Dotless i and dotless j, used for accents.
495 \ifx\temp\imacro \ptexi
496 \else\ifx\temp\jmacro \j
497 \else \errmessage{@dotless can be used only with i or j}%
501 % Be sure we're in horizontal mode when doing a tie, since we make space
502 % equivalent to this in @example-like environments. Otherwise, a space
503 % at the beginning of a line will start with \penalty -- and
504 % since \penalty is valid in vertical mode, we'd end up putting the
505 % penalty on the vertical list instead of in the new paragraph.
507 % Avoid using \@M directly, because that causes trouble
508 % if the definition is written into an index file.
509 \global\let\tiepenalty = \@M
510 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
513 % @: forces normal size whitespace following.
514 \def\:{\spacefactor=1000 }
516 % @* forces a line break.
517 \def\*{\hfil\break\hbox{}\ignorespaces}
519 % @. is an end-of-sentence period.
520 \def\.{.\spacefactor=3000 }
522 % @! is an end-of-sentence bang.
523 \def\!{!\spacefactor=3000 }
525 % @? is an end-of-sentence query.
526 \def\?{?\spacefactor=3000 }
528 % @w prevents a word break. Without the \leavevmode, @w at the
529 % beginning of a paragraph, when TeX is still in vertical mode, would
530 % produce a whole line of output instead of starting the paragraph.
531 \def\w#1{\leavevmode\hbox{#1}}
533 % @group ... @end group forces ... to be all on one page, by enclosing
534 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
535 % to keep its height that of a normal line. According to the rules for
536 % \topskip (p.114 of the TeXbook), the glue inserted is
537 % max (\topskip - \ht (first item), 0). If that height is large,
538 % therefore, no glue is inserted, and the space between the headline and
539 % the text is small, which looks bad.
541 \def\group{\begingroup
542 \ifnum\catcode13=\active \else
543 \errhelp = \groupinvalidhelp
544 \errmessage{@group invalid in context where filling is enabled}%
547 % The \vtop we start below produces a box with normal height and large
548 % depth; thus, TeX puts \baselineskip glue before it, and (when the
549 % next line of text is done) \lineskip glue after it. (See p.82 of
550 % the TeXbook.) Thus, space below is not quite equal to space
551 % above. But it's pretty close.
553 \egroup % End the \vtop.
554 \endgroup % End the \group.
558 % We have to put a strut on the last line in case the @group is in
559 % the midst of an example, rather than completely enclosing it.
560 % Otherwise, the interline space between the last line of the group
561 % and the first line afterwards is too small. But we can't put the
562 % strut in \Egroup, since there it would be on a line by itself.
563 % Hence this just inserts a strut at the beginning of each line.
564 \everypar = {\strut}%
566 % Since we have a strut on every line, we don't need any of TeX's
567 % normal interline spacing.
570 % OK, but now we have to do something about blank
571 % lines in the input in @example-like environments, which normally
572 % just turn into \lisppar, which will insert no space now that we've
573 % turned off the interline space. Simplest is to make them be an
576 \edef\par{\leavevmode \par}%
578 % Reset ^^M's definition to new definition of \par.
582 % Do @comment since we are called inside an environment such as
583 % @example, where each end-of-line in the input causes an
584 % end-of-line in the output. We don't want the end-of-line after
585 % the `@group' to put extra space in the output. Since @group
586 % should appear on a line by itself (according to the Texinfo
587 % manual), we don't worry about eating any user text.
591 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
592 % message, so this ends up printing `@group can only ...'.
594 \newhelp\groupinvalidhelp{%
595 group can only be used in environments such as @example,^^J%
596 where each line of input produces a line of output.}
598 % @need space-in-mils
599 % forces a page break if there is not space-in-mils remaining.
601 \newdimen\mil \mil=0.001in
603 \def\need{\parsearg\needx}
605 % Old definition--didn't work.
606 %\def\needx #1{\par %
607 %% This method tries to make TeX break the page naturally
608 %% if the depth of the box does not fit.
610 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
615 % Ensure vertical mode, so we don't make a big box in the middle of a
619 % If the @need value is less than one line space, it's useless.
621 \dimen2 = \ht\strutbox
622 \advance\dimen2 by \dp\strutbox
623 \ifdim\dimen0 > \dimen2
625 % Do a \strut just to make the height of this box be normal, so the
626 % normal leading is inserted relative to the preceding line.
627 % And a page break here is fine.
628 \vtop to #1\mil{\strut\vfil}%
630 % TeX does not even consider page breaks if a penalty added to the
631 % main vertical list is 10000 or more. But in order to see if the
632 % empty box we just added fits on the page, we must make it consider
633 % page breaks. On the other hand, we don't want to actually break the
634 % page after the empty box. So we use a penalty of 9999.
636 % There is an extremely small chance that TeX will actually break the
637 % page at this \penalty, if there are no other feasible breakpoints in
638 % sight. (If the user is using lots of big @group commands, which
639 % almost-but-not-quite fill up a page, TeX will have a hard time doing
640 % good page breaking, for example.) However, I could not construct an
641 % example where a page broke at this \penalty; if it happens in a real
642 % document, then we can reconsider our strategy.
645 % Back up by the size of the box, whether we did a page break or not.
648 % Do not allow a page break right after this kern.
653 % @br forces paragraph break
657 % @dots{} output an ellipsis using the current font.
658 % We do .5em per period so that it has the same spacing in a typewriter
659 % font as three actual period characters.
664 \hskip 0pt plus 0.25fil minus 0.25fil
666 \hskip 0pt plus 0.5fil minus 0.5fil
670 % @enddots{} is an end-of-sentence ellipsis.
675 \hskip 0pt plus 0.25fil minus 0.25fil
677 \hskip 0pt plus 0.5fil minus 0.5fil
683 % @page forces the start of a new page
685 \def\page{\par\vfill\supereject}
688 % outputs text on separate line in roman font, starting at standard page margin
690 % This records the amount of indent in the innermost environment.
691 % That's how much \exdent should take out.
692 \newskip\exdentamount
694 % This defn is used inside fill environments such as @defun.
695 \def\exdent{\parsearg\exdentyyy}
696 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
698 % This defn is used inside nofill environments such as @example.
699 \def\nofillexdent{\parsearg\nofillexdentyyy}
700 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
701 \leftline{\hskip\leftskip{\rm#1}}}}
703 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
704 % paragraph. For more general purposes, use the \margin insertion
705 % class. WHICH is `l' or `r'.
707 \newskip\inmarginspacing \inmarginspacing=1cm
708 \def\strutdepth{\dp\strutbox}
710 \def\doinmargin#1#2{\strut\vadjust{%
713 \vtop to \strutdepth{%
714 \baselineskip=\strutdepth
716 % if you have multiple lines of stuff to put here, you'll need to
717 % make the vbox yourself of the appropriate size.
719 \llap{\ignorespaces #2\hskip\inmarginspacing}%
721 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
726 \def\inleftmargin{\doinmargin l}
727 \def\inrightmargin{\doinmargin r}
729 % @inmargin{TEXT [, RIGHT-TEXT]}
730 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
731 % else use TEXT for both).
733 \def\inmargin#1{\parseinmargin #1,,\finish}
734 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
735 \setbox0 = \hbox{\ignorespaces #2}%
737 \def\lefttext{#1}% have both texts
740 \def\lefttext{#1}% have only one text
745 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
747 \def\temp{\inleftmargin\lefttext}%
752 % @include file insert text of that file as input.
753 % Allow normal characters that we make active in the argument (a file name).
754 \def\include{\begingroup
763 \parsearg\includezzz}
764 % Restore active chars for included file.
765 \def\includezzz#1{\endgroup\begingroup
766 % Read the included file in a group so nested @include's work.
773 % @center line outputs that line, centered
775 \def\center{\parsearg\centerzzz}
776 \def\centerzzz #1{{\advance\hsize by -\leftskip
777 \advance\hsize by -\rightskip
780 % @sp n outputs n lines of vertical space
782 \def\sp{\parsearg\spxxx}
783 \def\spxxx #1{\vskip #1\baselineskip}
785 % @comment ...line which is ignored...
786 % @c is the same as @comment
787 % @ignore ... @end ignore is another way to write a comment
789 \def\comment{\begingroup \catcode`\^^M=\other%
790 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
792 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
796 % @paragraphindent NCHARS
797 % We'll use ems for NCHARS, close enough.
798 % We cannot implement @paragraphindent asis, though.
800 \def\asisword{asis} % no translation, these are keywords
803 \def\paragraphindent{\parsearg\doparagraphindent}
804 \def\doparagraphindent#1{%
809 \defaultparindent = 0pt
811 \defaultparindent = #1em
814 \parindent = \defaultparindent
817 % @exampleindent NCHARS
818 % We'll use ems for NCHARS like @paragraphindent.
819 % It seems @exampleindent asis isn't necessary, but
820 % I preserve it to make it similar to @paragraphindent.
821 \def\exampleindent{\parsearg\doexampleindent}
822 \def\doexampleindent#1{%
829 \lispnarrowing = #1em
834 % @asis just yields its argument. Used with @table, for example.
838 % @math outputs its argument in math mode.
839 % We don't use $'s directly in the definition of \math because we need
840 % to set catcodes according to plain TeX first, to allow for subscripts,
841 % superscripts, special math chars, etc.
843 % @math does not do math typesetting in section titles, index
844 % entries, and other such contexts where the catcodes are set before
845 % @math gets a chance to work. This could perhaps be fixed, but for now
846 % at least we can have real math in the main text, where it's needed most.
848 \let\implicitmath = $%$ font-lock fix
850 % One complication: _ usually means subscripts, but it could also mean
851 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
852 % _ within @math be active (mathcode "8000), and distinguish by seeing
853 % if the current family is \slfam, which is what @var uses.
855 {\catcode95 = \active % 95 = _
856 \gdef\mathunderscore{%
858 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
861 % Another complication: we want \\ (and @\) to output a \ character.
862 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
863 % this is not advertised and we don't care. Texinfo does not
864 % otherwise define @\.
866 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
867 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
871 \mathcode`\_="8000 \mathunderscore
872 \let\\ = \mathbackslash
873 \implicitmath\finishmath}
874 \def\finishmath#1{#1\implicitmath\Etex}
876 % @bullet and @minus need the same treatment as @math, just above.
877 \def\bullet{\implicitmath\ptexbullet\implicitmath}
878 \def\minus{\implicitmath-\implicitmath}
880 % @refill is a no-op.
883 % If working on a large document in chapters, it is convenient to
884 % be able to disable indexing, cross-referencing, and contents, for test runs.
885 % This is done with @novalidate (before @setfilename).
887 \newif\iflinks \linkstrue % by default we want the aux files.
888 \let\novalidate = \linksfalse
890 % @setfilename is done at the beginning of every texinfo file.
891 % So open here the files we need to have open while reading the input.
892 % This makes it possible to make a .fmt file for texinfo.
896 \fi % \openindices needs to do some work in any case.
898 \fixbackslash % Turn off hack to swallow `\input texinfo'.
899 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
901 % If texinfo.cnf is present on the system, read it.
902 % Useful for site-wide @afourpaper, etc.
903 % Just to be on the safe side, close the input stream before the \input.
904 \openin 1 texinfo.cnf
905 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
909 \comment % Ignore the actual filename.
912 % Called from \setfilename.
924 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
928 % adobe `portable' document format
932 \newcount\filenamelength
941 \newif\ifpdfmakepagedest
943 \ifx\pdfoutput\undefined
945 \let\pdfmkdest = \gobble
946 \let\pdfurl = \gobble
947 \let\endlink = \relax
948 \let\linkcolor = \relax
949 \let\pdfmakeoutlines = \relax
954 \def\dopdfimage#1#2#3{%
956 \def\imageheight{#3}%
957 % without \immediate, pdftex seg faults when the same image is
958 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
959 \ifnum\pdftexversion < 14
964 \ifx\empty\imagewidth\else width \imagewidth \fi
965 \ifx\empty\imageheight\else height \imageheight \fi
966 \ifnum\pdftexversion<13
971 \ifnum\pdftexversion < 14 \else
972 \pdfrefximage \pdflastximage
974 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
976 \let\linkcolor = \Blue % was Cyan, but that seems light?
977 \def\endlink{\Black\pdfendlink}
978 % Adding outlines to PDF; macros for calculating structure of outlines
979 % come from Petr Olsak
980 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
981 \else \csname#1\endcsname \fi}
982 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
984 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
985 \def\pdfmakeoutlines{{%
986 \openin 1 \jobname.toc
987 \ifeof 1\else\begingroup
989 % Thanh's hack / proper braces in bookmarks
990 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
991 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
993 \def\chapentry ##1##2##3{}
994 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
995 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
996 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
997 \let\appendixentry = \chapentry
998 \let\unnumbchapentry = \chapentry
999 \let\unnumbsecentry = \secentry
1000 \let\unnumbsubsecentry = \subsecentry
1001 \let\unnumbsubsubsecentry = \subsubsecentry
1003 \def\chapentry ##1##2##3{%
1004 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1005 \def\secentry ##1##2##3##4{%
1006 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1007 \def\subsecentry ##1##2##3##4##5{%
1008 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1009 \def\subsubsecentry ##1##2##3##4##5##6{%
1010 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1011 \let\appendixentry = \chapentry
1012 \let\unnumbchapentry = \chapentry
1013 \let\unnumbsecentry = \secentry
1014 \let\unnumbsubsecentry = \subsecentry
1015 \let\unnumbsubsubsecentry = \subsubsecentry
1017 % Make special characters normal for writing to the pdf file.
1025 \def\makelinks #1,{%
1026 \def\params{#1}\def\E{END}%
1028 \let\nextmakelinks=\relax
1030 \let\nextmakelinks=\makelinks
1031 \ifnum\lnkcount>0,\fi
1033 \startlink attr{/Border [0 0 0]}
1034 goto name{\pdfmkpgn{\the\pgn}}%
1036 \advance\lnkcount by 1%
1041 \def\picknum#1{\expandafter\pn#1}
1052 \def\ppn#1{\pgn=#1\gobble}
1053 \def\ppnn{\pgn=\first}
1054 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1055 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1056 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1057 \ifx\PP\D\let\nextsp\relax
1058 \else\let\nextsp\skipspaces
1059 \ifx\p\space\else\addtokens{\filename}{\PP}%
1060 \advance\filenamelength by 1
1064 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1065 \ifnum\pdftexversion < 14
1066 \let \startlink \pdfannotlink
1068 \let \startlink \pdfstartlink
1072 \normalturnoffactive\def\@{@}%
1073 \let\value=\expandablevalue
1075 \startlink attr{/Border [0 0 0]}%
1076 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1079 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1080 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1081 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1082 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1084 \expandafter\poptoks\the\toksA|ENDTOKS|
1086 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1087 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1088 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1090 \ifnum0=\countA\else\makelink\fi
1091 \ifx\first.\let\next=\done\else
1093 \addtokens{\toksB}{\the\toksD}
1094 \ifx\first,\addtokens{\toksB}{\space}\fi
1096 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1098 \def\makelink{\addtokens{\toksB}%
1099 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1101 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1102 \linkcolor #1\endlink}
1103 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1104 \fi % \ifx\pdfoutput
1108 % Font-change commands.
1110 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1111 % So we set up a \sf analogous to plain's \rm, etc.
1113 \def\sf{\fam=\sffam \tensf}
1114 \let\li = \sf % Sometimes we call it \li, not \sf.
1116 % We don't need math for this one.
1120 \newdimen\textleading \textleading = 13.2pt
1122 % Set the baselineskip to #1, and the lineskip and strut size
1123 % correspondingly. There is no deep meaning behind these magic numbers
1124 % used as factors; they just match (closely enough) what Knuth defined.
1126 \def\lineskipfactor{.08333}
1127 \def\strutheightpercent{.70833}
1128 \def\strutdepthpercent {.29167}
1131 \normalbaselineskip = #1\relax
1132 \normallineskip = \lineskipfactor\normalbaselineskip
1134 \setbox\strutbox =\hbox{%
1135 \vrule width0pt height\strutheightpercent\baselineskip
1136 depth \strutdepthpercent \baselineskip
1140 % Set the font macro #1 to the font named #2, adding on the
1141 % specified font prefix (normally `cm').
1142 % #3 is the font's design size, #4 is a scale factor
1143 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1145 % Use cm as the default font prefix.
1146 % To specify the font prefix, you must define \fontprefix
1147 % before you read in texinfo.tex.
1148 \ifx\fontprefix\undefined
1151 % Support font families that don't use the same naming scheme as CM.
1153 \def\rmbshape{bx} %where the normal face is bold
1158 \def\ttslshape{sltt}
1168 \newcount\mainmagstep
1170 % not really supported.
1171 \mainmagstep=\magstep1
1172 \setfont\textrm\rmshape{12}{1000}
1173 \setfont\texttt\ttshape{12}{1000}
1175 \mainmagstep=\magstephalf
1176 \setfont\textrm\rmshape{10}{\mainmagstep}
1177 \setfont\texttt\ttshape{10}{\mainmagstep}
1179 % Instead of cmb10, you many want to use cmbx10.
1180 % cmbx10 is a prettier font on its own, but cmb10
1181 % looks better when embedded in a line with cmr10.
1182 \setfont\textbf\bfshape{10}{\mainmagstep}
1183 \setfont\textit\itshape{10}{\mainmagstep}
1184 \setfont\textsl\slshape{10}{\mainmagstep}
1185 \setfont\textsf\sfshape{10}{\mainmagstep}
1186 \setfont\textsc\scshape{10}{\mainmagstep}
1187 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1188 \font\texti=cmmi10 scaled \mainmagstep
1189 \font\textsy=cmsy10 scaled \mainmagstep
1191 % A few fonts for @defun, etc.
1192 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1193 \setfont\deftt\ttshape{10}{\magstep1}
1194 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1196 % Fonts for indices, footnotes, small examples (9pt).
1197 \setfont\smallrm\rmshape{9}{1000}
1198 \setfont\smalltt\ttshape{9}{1000}
1199 \setfont\smallbf\bfshape{10}{900}
1200 \setfont\smallit\itshape{9}{1000}
1201 \setfont\smallsl\slshape{9}{1000}
1202 \setfont\smallsf\sfshape{9}{1000}
1203 \setfont\smallsc\scshape{10}{900}
1204 \setfont\smallttsl\ttslshape{10}{900}
1208 % Fonts for small examples (8pt).
1209 \setfont\smallerrm\rmshape{8}{1000}
1210 \setfont\smallertt\ttshape{8}{1000}
1211 \setfont\smallerbf\bfshape{10}{800}
1212 \setfont\smallerit\itshape{8}{1000}
1213 \setfont\smallersl\slshape{8}{1000}
1214 \setfont\smallersf\sfshape{8}{1000}
1215 \setfont\smallersc\scshape{10}{800}
1216 \setfont\smallerttsl\ttslshape{10}{800}
1217 \font\smalleri=cmmi8
1218 \font\smallersy=cmsy8
1220 % Fonts for title page:
1221 \setfont\titlerm\rmbshape{12}{\magstep3}
1222 \setfont\titleit\itbshape{10}{\magstep4}
1223 \setfont\titlesl\slbshape{10}{\magstep4}
1224 \setfont\titlett\ttbshape{12}{\magstep3}
1225 \setfont\titlettsl\ttslshape{10}{\magstep4}
1226 \setfont\titlesf\sfbshape{17}{\magstep1}
1227 \let\titlebf=\titlerm
1228 \setfont\titlesc\scbshape{10}{\magstep4}
1229 \font\titlei=cmmi12 scaled \magstep3
1230 \font\titlesy=cmsy10 scaled \magstep4
1231 \def\authorrm{\secrm}
1233 % Chapter (and unnumbered) fonts (17.28pt).
1234 \setfont\chaprm\rmbshape{12}{\magstep2}
1235 \setfont\chapit\itbshape{10}{\magstep3}
1236 \setfont\chapsl\slbshape{10}{\magstep3}
1237 \setfont\chaptt\ttbshape{12}{\magstep2}
1238 \setfont\chapttsl\ttslshape{10}{\magstep3}
1239 \setfont\chapsf\sfbshape{17}{1000}
1241 \setfont\chapsc\scbshape{10}{\magstep3}
1242 \font\chapi=cmmi12 scaled \magstep2
1243 \font\chapsy=cmsy10 scaled \magstep3
1245 % Section fonts (14.4pt).
1246 \setfont\secrm\rmbshape{12}{\magstep1}
1247 \setfont\secit\itbshape{10}{\magstep2}
1248 \setfont\secsl\slbshape{10}{\magstep2}
1249 \setfont\sectt\ttbshape{12}{\magstep1}
1250 \setfont\secttsl\ttslshape{10}{\magstep2}
1251 \setfont\secsf\sfbshape{12}{\magstep1}
1253 \setfont\secsc\scbshape{10}{\magstep2}
1254 \font\seci=cmmi12 scaled \magstep1
1255 \font\secsy=cmsy10 scaled \magstep2
1257 % Subsection fonts (13.15pt).
1258 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1259 \setfont\ssecit\itbshape{10}{1315}
1260 \setfont\ssecsl\slbshape{10}{1315}
1261 \setfont\ssectt\ttbshape{12}{\magstephalf}
1262 \setfont\ssecttsl\ttslshape{10}{1315}
1263 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1265 \setfont\ssecsc\scbshape{10}{\magstep1}
1266 \font\sseci=cmmi12 scaled \magstephalf
1267 \font\ssecsy=cmsy10 scaled 1315
1268 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1269 % but that is not a standard magnification.
1271 % In order for the font changes to affect most math symbols and letters,
1272 % we have to define the \textfont of the standard families. Since
1273 % texinfo doesn't allow for producing subscripts and superscripts except
1274 % in the main text, we don't bother to reset \scriptfont and
1275 % \scriptscriptfont (which would also require loading a lot more fonts).
1277 \def\resetmathfonts{%
1278 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1279 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1280 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1283 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1284 % of just \STYLE. We do this so that font changes will continue to work
1285 % in math mode, where it is the current \fam that is relevant in most
1286 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1287 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1288 % redefine \bf itself.
1290 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1291 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1292 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1293 \resetmathfonts \setleading{\textleading}}
1295 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1296 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1297 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1298 \let\tenttsl=\titlettsl
1299 \resetmathfonts \setleading{25pt}}
1300 \def\titlefont#1{{\titlefonts\rm #1}}
1302 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1303 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1304 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1305 \resetmathfonts \setleading{19pt}}
1307 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1308 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1309 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1310 \resetmathfonts \setleading{16pt}}
1312 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1313 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1314 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1315 \resetmathfonts \setleading{15pt}}
1316 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1318 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1319 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1320 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1321 \let\tenttsl=\smallttsl
1322 \resetmathfonts \setleading{10.5pt}}
1324 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1325 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1326 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1327 \let\tenttsl=\smallerttsl
1328 \resetmathfonts \setleading{9.5pt}}
1329 \let\smallexamplefonts = \smallerfonts
1331 % Set up the default fonts, so we can use them for creating boxes.
1335 % Define these so they can be easily changed for other fonts.
1336 \def\angleleft{$\langle$}
1337 \def\angleright{$\rangle$}
1339 % Count depth in font-changes, for error checks
1340 \newcount\fontdepth \fontdepth=0
1342 % Fonts for short table of contents.
1343 \setfont\shortcontrm\rmshape{12}{1000}
1344 \setfont\shortcontbf\bxshape{12}{1000}
1345 \setfont\shortcontsl\slshape{12}{1000}
1347 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1348 %% serif) and @ii for TeX italic
1350 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1351 % unless the following character is such as not to need one.
1352 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1353 \def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx}
1354 \def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx}
1357 \let\var=\smartslanted
1358 \let\dfn=\smartslanted
1359 \let\emph=\smartitalic
1360 \let\cite=\smartslanted
1365 % We can't just use \exhyphenpenalty, because that only has effect at
1366 % the end of a paragraph. Restore normal hyphenation at the end of the
1367 % group within which \nohyphenation is presumably called.
1369 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1370 \def\restorehyphenation{\hyphenchar\font = `- }
1373 {\tt \rawbackslash \frenchspacing #1}%
1377 \def\samp#1{`\tclose{#1}'\null}
1378 \setfont\keyrm\rmshape{8}{1000}
1380 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1381 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1382 \vbox{\hrule\kern-0.4pt
1383 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1385 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1386 % The old definition, with no lozenge:
1387 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1388 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1390 % @file, @option are the same as @samp.
1394 % @code is a modification of @t,
1395 % which makes spaces the same size as normal in the surrounding text.
1398 % Change normal interword space to be same as for the current font.
1399 \spaceskip = \fontdimen2\font
1401 % Switch to typewriter.
1404 % But `\ ' produces the large typewriter interword space.
1405 \def\ {{\spaceskip = 0pt{} }}%
1407 % Turn off hyphenation.
1417 % We *must* turn on hyphenation at `-' and `_' in \code.
1418 % Otherwise, it is too hard to avoid overfull hboxes
1419 % in the Emacs manual, the Library manual, etc.
1421 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1422 % both hyphenation at - and hyphenation within words.
1423 % We must therefore turn them both off (\tclose does that)
1424 % and arrange explicitly to hyphenate at a dash.
1430 \global\def\code{\begingroup
1431 \catcode`\-=\active \let-\codedash
1432 \catcode`\_=\active \let_\codeunder
1436 % If we end up with any active - characters when handling the index,
1437 % just treat them as a normal -.
1438 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1442 \def\codedash{-\discretionary{}{}{}}
1444 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1445 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1446 % will therefore expand the active definition of _, which is us
1447 % (inside @code that is), therefore an endless loop.
1449 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1450 \else\normalunderscore \fi
1451 \discretionary{}{}{}}%
1454 \def\codex #1{\tclose{#1}\endgroup}
1456 % @kbd is like @code, except that if the argument is just one @key command,
1457 % then @kbd has no effect.
1459 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1460 % `example' (@kbd uses ttsl only inside of @example and friends),
1461 % or `code' (@kbd uses normal tty font always).
1462 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1463 \def\kbdinputstylexxx#1{%
1465 \ifx\arg\worddistinct
1466 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1467 \else\ifx\arg\wordexample
1468 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1469 \else\ifx\arg\wordcode
1470 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1473 \def\worddistinct{distinct}
1474 \def\wordexample{example}
1477 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1478 % the catcodes are wrong for parsearg to work.)
1479 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1482 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1483 \ifx\one\xkey\ifx\threex\three \key{#2}%
1484 \else{\tclose{\kbdfont\look}}\fi
1485 \else{\tclose{\kbdfont\look}}\fi}
1487 % For @url, @env, @command quotes seem unnecessary, so use \code.
1492 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1493 % second argument specifying the text to display and an optional third
1494 % arg as text to display instead of (rather than in addition to) the url
1495 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1496 % a hypertex \special here.
1498 \def\uref#1{\douref #1,,,\finish}
1499 \def\douref#1,#2,#3,#4\finish{\begingroup
1502 \setbox0 = \hbox{\ignorespaces #3}%
1504 \unhbox0 % third arg given, show only that
1506 \setbox0 = \hbox{\ignorespaces #2}%
1509 \unhbox0 % PDF: 2nd arg given, show only it
1511 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1514 \code{#1}% only url given, so show it
1520 % rms does not like angle brackets --karl, 17may97.
1521 % So now @email is just like @uref, unless we are pdf.
1523 %\def\email#1{\angleleft{\tt #1}\angleright}
1525 \def\email#1{\doemail#1,,\finish}
1526 \def\doemail#1,#2,#3\finish{\begingroup
1529 \setbox0 = \hbox{\ignorespaces #2}%
1530 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1537 % Check if we are currently using a typewriter font. Since all the
1538 % Computer Modern typewriter fonts have zero interword stretch (and
1539 % shrink), and it is reasonable to expect all typewriter fonts to have
1540 % this property, we can check that font parameter.
1542 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1544 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1545 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1547 \def\dmn#1{\thinspace #1}
1549 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1551 % @l was never documented to mean ``switch to the Lisp font'',
1552 % and it is not used as such in any manual I can find. We need it for
1553 % Polish suppressed-l. --karl, 22sep96.
1554 %\def\l#1{{\li #1}\null}
1556 % Explicit font changes: @r, @sc, undocumented @ii.
1557 \def\r#1{{\rm #1}} % roman font
1558 \def\sc#1{{\smallcaps#1}} % smallcaps font
1559 \def\ii#1{{\it #1}} % italic font
1561 % @acronym downcases the argument and prints in smallcaps.
1562 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1564 % @pounds{} is a sterling sign.
1565 \def\pounds{{\it\$}}
1568 \message{page headings,}
1570 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1571 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1573 % First the title page. Must do @settitle before @titlepage.
1575 \newif\iffinishedtitlepage
1577 % Do an implicit @contents or @shortcontents after @end titlepage if the
1578 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1580 \newif\ifsetcontentsaftertitlepage
1581 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1582 \newif\ifsetshortcontentsaftertitlepage
1583 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1585 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1586 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1587 \endgroup\page\hbox{}\page}
1589 \def\titlepage{\begingroup \parindent=0pt \textfonts
1590 \let\subtitlerm=\tenrm
1591 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1593 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1595 % Leave some space at the very top of the page.
1596 \vglue\titlepagetopglue
1598 % Now you can print the title using @title.
1599 \def\title{\parsearg\titlezzz}%
1600 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1601 % print a rule at the page bottom also.
1602 \finishedtitlepagefalse
1603 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1604 % No rule at page bottom unless we print one at the top with @title.
1605 \finishedtitlepagetrue
1607 % Now you can put text using @subtitle.
1608 \def\subtitle{\parsearg\subtitlezzz}%
1609 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1611 % @author should come last, but may come many times.
1612 \def\author{\parsearg\authorzzz}%
1613 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1614 {\authorfont \leftline{##1}}}%
1616 % Most title ``pages'' are actually two pages long, with space
1617 % at the top of the second. We don't want the ragged left on the second.
1618 \let\oldpage = \page
1620 \iffinishedtitlepage\else
1624 \let\page = \oldpage
1626 % \def\page{\oldpage \hbox{}}
1630 \iffinishedtitlepage\else
1633 % It is important to do the page break before ending the group,
1634 % because the headline and footline are only empty inside the group.
1635 % If we use the new definition of \page, we always get a blank page
1636 % after the title page, which we certainly don't want.
1640 % Need this before the \...aftertitlepage checks so that if they are
1641 % in effect the toc pages will come out with page numbers.
1644 % If they want short, they certainly want long too.
1645 \ifsetshortcontentsaftertitlepage
1648 \global\let\shortcontents = \relax
1649 \global\let\contents = \relax
1652 \ifsetcontentsaftertitlepage
1654 \global\let\contents = \relax
1655 \global\let\shortcontents = \relax
1659 \def\finishtitlepage{%
1660 \vskip4pt \hrule height 2pt width \hsize
1661 \vskip\titlepagebottomglue
1662 \finishedtitlepagetrue
1665 %%% Set up page headings and footings.
1667 \let\thispage=\folio
1669 \newtoks\evenheadline % headline on even pages
1670 \newtoks\oddheadline % headline on odd pages
1671 \newtoks\evenfootline % footline on even pages
1672 \newtoks\oddfootline % footline on odd pages
1674 % Now make Tex use those variables
1675 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1676 \else \the\evenheadline \fi}}
1677 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1678 \else \the\evenfootline \fi}\HEADINGShook}
1679 \let\HEADINGShook=\relax
1681 % Commands to set those variables.
1682 % For example, this is what @headings on does
1683 % @evenheading @thistitle|@thispage|@thischapter
1684 % @oddheading @thischapter|@thispage|@thistitle
1685 % @evenfooting @thisfile||
1686 % @oddfooting ||@thisfile
1688 \def\evenheading{\parsearg\evenheadingxxx}
1689 \def\oddheading{\parsearg\oddheadingxxx}
1690 \def\everyheading{\parsearg\everyheadingxxx}
1692 \def\evenfooting{\parsearg\evenfootingxxx}
1693 \def\oddfooting{\parsearg\oddfootingxxx}
1694 \def\everyfooting{\parsearg\everyfootingxxx}
1698 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1699 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1700 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1702 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1703 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1704 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1706 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1708 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1709 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1710 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1712 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1713 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1714 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1716 % Leave some space for the footline. Hopefully ok to assume
1717 % @evenfooting will not be used by itself.
1718 \global\advance\pageheight by -\baselineskip
1719 \global\advance\vsize by -\baselineskip
1722 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1724 }% unbind the catcode of @.
1726 % @headings double turns headings on for double-sided printing.
1727 % @headings single turns headings on for single-sided printing.
1728 % @headings off turns them off.
1729 % @headings on same as @headings double, retained for compatibility.
1730 % @headings after turns on double-sided headings after this page.
1731 % @headings doubleafter turns on double-sided headings after this page.
1732 % @headings singleafter turns on single-sided headings after this page.
1733 % By default, they are off at the start of a document,
1734 % and turned `on' after @end titlepage.
1736 \def\headings #1 {\csname HEADINGS#1\endcsname}
1739 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1740 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1742 % When we turn headings on, set the page number to 1.
1743 % For double-sided printing, put current file name in lower left corner,
1744 % chapter name on inside top of right hand pages, document
1745 % title on inside top of left hand pages, and page numbers on outside top
1746 % edge of all pages.
1747 \def\HEADINGSdouble{
1749 \global\evenfootline={\hfil}
1750 \global\oddfootline={\hfil}
1751 \global\evenheadline={\line{\folio\hfil\thistitle}}
1752 \global\oddheadline={\line{\thischapter\hfil\folio}}
1753 \global\let\contentsalignmacro = \chapoddpage
1755 \let\contentsalignmacro = \chappager
1757 % For single-sided printing, chapter title goes across top left of page,
1758 % page number on top right.
1759 \def\HEADINGSsingle{
1761 \global\evenfootline={\hfil}
1762 \global\oddfootline={\hfil}
1763 \global\evenheadline={\line{\thischapter\hfil\folio}}
1764 \global\oddheadline={\line{\thischapter\hfil\folio}}
1765 \global\let\contentsalignmacro = \chappager
1767 \def\HEADINGSon{\HEADINGSdouble}
1769 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1770 \let\HEADINGSdoubleafter=\HEADINGSafter
1771 \def\HEADINGSdoublex{%
1772 \global\evenfootline={\hfil}
1773 \global\oddfootline={\hfil}
1774 \global\evenheadline={\line{\folio\hfil\thistitle}}
1775 \global\oddheadline={\line{\thischapter\hfil\folio}}
1776 \global\let\contentsalignmacro = \chapoddpage
1779 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1780 \def\HEADINGSsinglex{%
1781 \global\evenfootline={\hfil}
1782 \global\oddfootline={\hfil}
1783 \global\evenheadline={\line{\thischapter\hfil\folio}}
1784 \global\oddheadline={\line{\thischapter\hfil\folio}}
1785 \global\let\contentsalignmacro = \chappager
1788 % Subroutines used in generating headings
1789 % This produces Day Month Year style of output.
1790 % Only define if not already defined, in case a txi-??.tex file has set
1791 % up a different format (e.g., txi-cs.tex does this).
1792 \ifx\today\undefined
1796 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1797 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1798 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1803 % @settitle line... specifies the title of the document, for headings.
1804 % It generates no output of its own.
1805 \def\thistitle{\putwordNoTitle}
1806 \def\settitle{\parsearg\settitlezzz}
1807 \def\settitlezzz #1{\gdef\thistitle{#1}}
1811 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1813 % default indentation of table text
1814 \newdimen\tableindent \tableindent=.8in
1815 % default indentation of @itemize and @enumerate text
1816 \newdimen\itemindent \itemindent=.3in
1817 % margin between end of table item and start of table text.
1818 \newdimen\itemmargin \itemmargin=.1in
1820 % used internally for \itemindent minus \itemmargin
1823 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1825 % They also define \itemindex
1826 % to index the item name in whatever manner is desired (perhaps none).
1828 \newif\ifitemxneedsnegativevskip
1830 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1832 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1833 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1835 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1836 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1838 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1839 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1841 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1844 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1847 \def\itemzzz #1{\begingroup %
1848 \advance\hsize by -\rightskip
1849 \advance\hsize by -\tableindent
1850 \setbox0=\hbox{\itemfont{#1}}%
1852 \nobreak % This prevents a break before @itemx.
1854 % If the item text does not fit in the space we have, put it on a line
1855 % by itself, and do not allow a page break either before or after that
1856 % line. We do not start a paragraph here because then if the next
1857 % command is, e.g., @kindex, the whatsit would get put into the
1858 % horizontal list on a line by itself, resulting in extra blank space.
1859 \ifdim \wd0>\itemmax
1861 % Make this a paragraph so we get the \parskip glue and wrapping,
1862 % but leave it ragged-right.
1864 \advance\leftskip by-\tableindent
1865 \advance\hsize by\tableindent
1866 \advance\rightskip by0pt plus1fil
1867 \leavevmode\unhbox0\par
1870 % We're going to be starting a paragraph, but we don't want the
1871 % \parskip glue -- logically it's part of the @item we just started.
1872 \nobreak \vskip-\parskip
1874 % Stop a page break at the \parskip glue coming up. Unfortunately
1875 % we can't prevent a possible page break at the following
1876 % \baselineskip glue.
1879 \itemxneedsnegativevskipfalse
1881 % The item text fits into the space. Start a paragraph, so that the
1882 % following text (if any) will end up on the same line.
1884 % Do this with kerns and \unhbox so that if there is a footnote in
1885 % the item text, it can migrate to the main vertical list and
1886 % eventually be printed.
1887 \nobreak\kern-\tableindent
1888 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1890 \nobreak\kern\dimen0
1892 \itemxneedsnegativevskiptrue
1896 \def\item{\errmessage{@item while not in a table}}
1897 \def\itemx{\errmessage{@itemx while not in a table}}
1898 \def\kitem{\errmessage{@kitem while not in a table}}
1899 \def\kitemx{\errmessage{@kitemx while not in a table}}
1900 \def\xitem{\errmessage{@xitem while not in a table}}
1901 \def\xitemx{\errmessage{@xitemx while not in a table}}
1903 % Contains a kludge to get @end[description] to work.
1904 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1906 % @table, @ftable, @vtable.
1907 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1908 {\obeylines\obeyspaces%
1909 \gdef\tablex #1^^M{%
1910 \tabley\dontindex#1 \endtabley}}
1912 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1913 {\obeylines\obeyspaces%
1914 \gdef\ftablex #1^^M{%
1915 \tabley\fnitemindex#1 \endtabley
1916 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1917 \let\Etable=\relax}}
1919 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1920 {\obeylines\obeyspaces%
1921 \gdef\vtablex #1^^M{%
1922 \tabley\vritemindex#1 \endtabley
1923 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1924 \let\Etable=\relax}}
1927 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1928 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1931 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1932 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1934 \def\tablez #1#2#3#4#5#6{%
1937 \def\Edescription{\Etable}% Necessary kludge.
1939 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1940 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1941 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1943 \itemmax=\tableindent %
1944 \advance \itemmax by -\itemmargin %
1945 \advance \leftskip by \tableindent %
1946 \exdentamount=\tableindent
1948 \parskip = \smallskipamount
1949 \ifdim \parskip=0pt \parskip=2pt \fi%
1950 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1951 \let\item = \internalBitem %
1952 \let\itemx = \internalBitemx %
1953 \let\kitem = \internalBkitem %
1954 \let\kitemx = \internalBkitemx %
1955 \let\xitem = \internalBxitem %
1956 \let\xitemx = \internalBxitemx %
1959 % This is the counter used by @enumerate, which is really @itemize
1963 \def\itemize{\parsearg\itemizezzz}
1965 \def\itemizezzz #1{%
1966 \begingroup % ended by the @end itemize
1967 \itemizey {#1}{\Eitemize}
1970 \def\itemizey #1#2{%
1972 \itemmax=\itemindent %
1973 \advance \itemmax by -\itemmargin %
1974 \advance \leftskip by \itemindent %
1975 \exdentamount=\itemindent
1977 \parskip = \smallskipamount %
1978 \ifdim \parskip=0pt \parskip=2pt \fi%
1979 \def#2{\endgraf\afterenvbreak\endgroup}%
1980 \def\itemcontents{#1}%
1981 \let\item=\itemizeitem}
1983 % Set sfcode to normal for the chars that usually have another value.
1984 % These are `.?!:;,'
1985 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1986 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1988 % \splitoff TOKENS\endmark defines \first to be the first token in
1989 % TOKENS, and \rest to be the remainder.
1991 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1993 % Allow an optional argument of an uppercase letter, lowercase letter,
1994 % or number, to specify the first label in the enumerated list. No
1995 % argument is the same as `1'.
1997 \def\enumerate{\parsearg\enumeratezzz}
1998 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1999 \def\enumeratey #1 #2\endenumeratey{%
2000 \begingroup % ended by the @end enumerate
2002 % If we were given no argument, pretend we were given `1'.
2004 \ifx\thearg\empty \def\thearg{1}\fi
2006 % Detect if the argument is a single token. If so, it might be a
2007 % letter. Otherwise, the only valid thing it can be is a number.
2008 % (We will always have one token, because of the test we just made.
2009 % This is a good thing, since \splitoff doesn't work given nothing at
2010 % all -- the first parameter is undelimited.)
2011 \expandafter\splitoff\thearg\endmark
2013 % Only one token in the argument. It could still be anything.
2014 % A ``lowercase letter'' is one whose \lccode is nonzero.
2015 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2016 % not equal to itself.
2017 % Otherwise, we assume it's a number.
2019 % We need the \relax at the end of the \ifnum lines to stop TeX from
2020 % continuing to look for a <number>.
2022 \ifnum\lccode\expandafter`\thearg=0\relax
2023 \numericenumerate % a number (we hope)
2026 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2027 \lowercaseenumerate % lowercase letter
2029 \uppercaseenumerate % uppercase letter
2033 % Multiple tokens in the argument. We hope it's a number.
2038 % An @enumerate whose labels are integers. The starting integer is
2041 \def\numericenumerate{%
2043 \startenumeration{\the\itemno}%
2046 % The starting (lowercase) letter is in \thearg.
2047 \def\lowercaseenumerate{%
2048 \itemno = \expandafter`\thearg
2050 % Be sure we're not beyond the end of the alphabet.
2052 \errmessage{No more lowercase letters in @enumerate; get a bigger
2059 % The starting (uppercase) letter is in \thearg.
2060 \def\uppercaseenumerate{%
2061 \itemno = \expandafter`\thearg
2063 % Be sure we're not beyond the end of the alphabet.
2065 \errmessage{No more uppercase letters in @enumerate; get a bigger
2072 % Call itemizey, adding a period to the first argument and supplying the
2073 % common last two arguments. Also subtract one from the initial value in
2074 % \itemno, since @item increments \itemno.
2076 \def\startenumeration#1{%
2077 \advance\itemno by -1
2078 \itemizey{#1.}\Eenumerate\flushcr
2081 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2084 \def\alphaenumerate{\enumerate{a}}
2085 \def\capsenumerate{\enumerate{A}}
2086 \def\Ealphaenumerate{\Eenumerate}
2087 \def\Ecapsenumerate{\Eenumerate}
2089 % Definition of @item while inside @itemize.
2092 \advance\itemno by 1
2093 {\let\par=\endgraf \smallbreak}%
2094 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2095 {\parskip=0in \hskip 0pt
2096 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2097 \vadjust{\penalty 1200}}%
2100 % @multitable macros
2101 % Amy Hendrickson, 8/18/94, 3/6/96
2103 % @multitable ... @end multitable will make as many columns as desired.
2104 % Contents of each column will wrap at width given in preamble. Width
2105 % can be specified either with sample text given in a template line,
2106 % or in percent of \hsize, the current width of text on page.
2108 % Table can continue over pages but will only break between lines.
2112 % Either define widths of columns in terms of percent of \hsize:
2113 % @multitable @columnfractions .25 .3 .45
2116 % Numbers following @columnfractions are the percent of the total
2117 % current hsize to be used for each column. You may use as many
2118 % columns as desired.
2121 % Or use a template:
2122 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2124 % using the widest term desired in each column.
2126 % For those who want to use more than one line's worth of words in
2127 % the preamble, break the line within one argument and it
2128 % will parse correctly, i.e.,
2130 % @multitable {Column 1 template} {Column 2 template} {Column 3
2133 % @multitable {Column 1 template} {Column 2 template}
2134 % {Column 3 template}
2136 % Each new table line starts with @item, each subsequent new column
2137 % starts with @tab. Empty columns may be produced by supplying @tab's
2138 % with nothing between them for as many times as empty columns are needed,
2139 % ie, @tab@tab@tab will produce two empty columns.
2141 % @item, @tab, @multitable or @end multitable do not need to be on their
2142 % own lines, but it will not hurt if they are.
2144 % Sample multitable:
2146 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2147 % @item first col stuff @tab second col stuff @tab third col
2154 % @item first col stuff @tab second col stuff
2155 % @tab Many paragraphs of text may be used in any column.
2157 % They will wrap at the width determined by the template.
2158 % @item@tab@tab This will be in third column.
2161 % Default dimensions may be reset by user.
2162 % @multitableparskip is vertical space between paragraphs in table.
2163 % @multitableparindent is paragraph indent in table.
2164 % @multitablecolmargin is horizontal space to be left between columns.
2165 % @multitablelinespace is space to leave between table items, baseline
2167 % 0pt means it depends on current normal line spacing.
2169 \newskip\multitableparskip
2170 \newskip\multitableparindent
2171 \newdimen\multitablecolspace
2172 \newskip\multitablelinespace
2173 \multitableparskip=0pt
2174 \multitableparindent=6pt
2175 \multitablecolspace=12pt
2176 \multitablelinespace=0pt
2178 % Macros used to set up halign preamble:
2180 \let\endsetuptable\relax
2181 \def\xendsetuptable{\endsetuptable}
2182 \let\columnfractions\relax
2183 \def\xcolumnfractions{\columnfractions}
2186 % #1 is the part of the @columnfraction before the decimal point, which
2187 % is presumably either 0 or the empty string (but we don't check, we
2188 % just throw it away). #2 is the decimal part, which we use as the
2189 % percent of \hsize for this column.
2190 \def\pickupwholefraction#1.#2 {%
2191 \global\advance\colcount by 1
2192 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2199 \ifx\firstarg\xendsetuptable
2202 \ifx\firstarg\xcolumnfractions
2203 \global\setpercenttrue
2206 \let\go\pickupwholefraction
2208 \global\advance\colcount by 1
2209 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2210 % typically that is always in the input, anyway.
2211 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2214 \ifx\go\pickupwholefraction
2215 % Put the argument back for the \pickupwholefraction call, so
2216 % we'll always have a period there to be parsed.
2217 \def\go{\pickupwholefraction#1}%
2219 \let\go = \setuptable
2225 % This used to have \hskip1sp. But then the space in a template line is
2226 % not enough. That is bad. So let's go back to just & until we
2227 % encounter the problem it was intended to solve again.
2228 % --karl, nathan@acm.org, 20apr99.
2231 % @multitable ... @end multitable definitions:
2233 \def\multitable{\parsearg\dotable}
2234 \def\dotable#1{\bgroup
2239 \setmultitablespacing
2240 \parskip=\multitableparskip
2241 \parindent=\multitableparindent
2244 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2246 % To parse everything between @multitable and @item:
2247 \setuptable#1 \endsetuptable
2249 % \everycr will reset column counter, \colcount, at the end of
2250 % each line. Every column entry will cause \colcount to advance by one.
2251 % The table preamble
2252 % looks at the current \colcount to find the correct column width.
2255 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2256 % Maybe so, but it also creates really weird page breaks when the table
2257 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2258 % manifests itself, so it can be fixed for real --karl.
2259 \global\colcount=0\relax}}%
2261 % This preamble sets up a generic column definition, which will
2262 % be used as many times as user calls for columns.
2263 % \vtop will set a single line and will also let text wrap and
2264 % continue for many paragraphs if desired.
2265 \halign\bgroup&\global\advance\colcount by 1\relax
2266 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2268 % In order to keep entries from bumping into each other
2269 % we will add a \leftskip of \multitablecolspace to all columns after
2272 % If a template has been used, we will add \multitablecolspace
2273 % to the width of each template entry.
2275 % If the user has set preamble in terms of percent of \hsize we will
2276 % use that dimension as the width of the column, and the \leftskip
2277 % will keep entries from bumping into each other. Table will start at
2278 % left margin and final column will justify at right margin.
2280 % Make sure we don't inherit \rightskip from the outer environment.
2283 % The first column will be indented with the surrounding text.
2284 \advance\hsize by\leftskip
2287 % If user has not set preamble in terms of percent of \hsize
2288 % we will advance \hsize by \multitablecolspace.
2289 \advance\hsize by \multitablecolspace
2291 % In either case we will make \leftskip=\multitablecolspace:
2292 \leftskip=\multitablecolspace
2294 % Ignoring space at the beginning and end avoids an occasional spurious
2295 % blank line, when TeX decides to break the line at the space before the
2296 % box from the multistrut, so the strut ends up on a line by itself.
2298 % @multitable @columnfractions .11 .89
2300 % @tab Legal holiday which is valid in major parts of the whole country.
2301 % Is automatically provided with highlighting sequences respectively marking
2303 \noindent\ignorespaces##\unskip\multistrut}\cr
2306 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2307 % If so, do nothing. If not, give it an appropriate dimension based on
2308 % current baselineskip.
2309 \ifdim\multitablelinespace=0pt
2310 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2311 \global\advance\multitablelinespace by-\ht0
2312 %% strut to put in table in case some entry doesn't have descenders,
2313 %% to keep lines equally spaced
2314 \let\multistrut = \strut
2316 %% FIXME: what is \box0 supposed to be?
2317 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2319 %% Test to see if parskip is larger than space between lines of
2320 %% table. If not, do nothing.
2321 %% If so, set to same dimension as multitablelinespace.
2322 \ifdim\multitableparskip>\multitablelinespace
2323 \global\multitableparskip=\multitablelinespace
2324 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2325 %% than skip between lines in the table.
2327 \ifdim\multitableparskip=0pt
2328 \global\multitableparskip=\multitablelinespace
2329 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2330 %% than skip between lines in the table.
2334 \message{conditionals,}
2335 % Prevent errors for section commands.
2336 % Used in @ignore and in failing conditionals.
2337 \def\ignoresections{%
2339 \let\unnumbered=\relax
2341 \let\unnumberedsec=\relax
2342 \let\unnumberedsection=\relax
2343 \let\unnumberedsubsec=\relax
2344 \let\unnumberedsubsection=\relax
2345 \let\unnumberedsubsubsec=\relax
2346 \let\unnumberedsubsubsection=\relax
2349 \let\subsubsec=\relax
2350 \let\subsection=\relax
2351 \let\subsubsection=\relax
2352 \let\appendix=\relax
2353 \let\appendixsec=\relax
2354 \let\appendixsection=\relax
2355 \let\appendixsubsec=\relax
2356 \let\appendixsubsection=\relax
2357 \let\appendixsubsubsec=\relax
2358 \let\appendixsubsubsection=\relax
2359 \let\contents=\relax
2360 \let\smallbook=\relax
2361 \let\titlepage=\relax
2364 % Used in nested conditionals, where we have to parse the Texinfo source
2365 % and so want to turn off most commands, in case they are used
2368 \def\ignoremorecommands{%
2369 \let\defcodeindex = \relax
2372 \let\deffnx = \relax
2373 \let\defindex = \relax
2374 \let\defivar = \relax
2375 \let\defmac = \relax
2376 \let\defmethod = \relax
2378 \let\defopt = \relax
2379 \let\defspec = \relax
2381 \let\deftypefn = \relax
2382 \let\deftypefun = \relax
2383 \let\deftypeivar = \relax
2384 \let\deftypeop = \relax
2385 \let\deftypevar = \relax
2386 \let\deftypevr = \relax
2388 \let\defvar = \relax
2392 \let\printindex = \relax
2394 \let\settitle = \relax
2395 \let\setchapternewpage = \relax
2396 \let\setchapterstyle = \relax
2397 \let\everyheading = \relax
2398 \let\evenheading = \relax
2399 \let\oddheading = \relax
2400 \let\everyfooting = \relax
2401 \let\evenfooting = \relax
2402 \let\oddfooting = \relax
2403 \let\headings = \relax
2404 \let\include = \relax
2405 \let\lowersections = \relax
2407 \let\raisesections = \relax
2414 % Ignore @ignore, @ifhtml, @ifinfo, @ifplaintext, @ifnottex, @html, @menu,
2415 % @direntry, and @documentdescription.
2417 \def\ignore{\doignore{ignore}}
2418 \def\ifhtml{\doignore{ifhtml}}
2419 \def\ifinfo{\doignore{ifinfo}}
2420 \def\ifplaintext{\doignore{ifplaintext}}
2421 \def\ifnottex{\doignore{ifnottex}}
2422 \def\html{\doignore{html}}
2423 \def\menu{\doignore{menu}}
2424 \def\direntry{\doignore{direntry}}
2425 \def\documentdescription{\doignore{documentdescription}}
2426 \def\documentdescriptionword{documentdescription}
2428 % @dircategory CATEGORY -- specify a category of the dir file
2429 % which this file should belong to. Ignore this in TeX.
2430 \let\dircategory = \comment
2432 % Ignore text until a line `@end #1'.
2434 \def\doignore#1{\begingroup
2435 % Don't complain about control sequences we have declared \outer.
2438 % Define a command to swallow text until we reach `@end #1'.
2439 % This @ is a catcode 12 token (that is the normal catcode of @ in
2440 % this texinfo.tex file). We change the catcode of @ below to match.
2441 \long\def\doignoretext##1@end #1{\enddoignore}%
2443 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2446 % Ignore braces, too, so mismatched braces don't cause trouble.
2450 % We must not have @c interpreted as a control sequence.
2453 \def\ignoreword{#1}%
2454 \ifx\ignoreword\documentdescriptionword
2455 % The c kludge breaks documentdescription, since
2456 % `documentdescription' contains a `c'. Means not everything will
2457 % be ignored inside @documentdescription, but oh well...
2459 % Make the letter c a comment character so that the rest of the line
2460 % will be ignored. This way, the document can have (for example)
2462 % and the @end ifinfo will be properly ignored.
2463 % (We've just changed @ to catcode 12.)
2467 % And now expand the command defined above.
2471 % What we do to finish off ignored text.
2473 \def\enddoignore{\endgroup\ignorespaces}%
2475 \newif\ifwarnedobs\warnedobsfalse
2477 \ifwarnedobs\relax\else
2478 % We need to warn folks that they may have trouble with TeX 3.0.
2479 % This uses \immediate\write16 rather than \message to get newlines.
2480 \immediate\write16{}
2481 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2482 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2483 \immediate\write16{If you are running another version of TeX, relax.}
2484 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2485 \immediate\write16{ Then upgrade your TeX installation if you can.}
2486 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2487 \immediate\write16{If you are stuck with version 3.0, run the}
2488 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2489 \immediate\write16{ to use a workaround.}
2490 \immediate\write16{}
2491 \global\warnedobstrue
2495 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2496 % workaround (which requires the file ``dummy.tfm'' to be installed),
2497 % uncomment the following line:
2498 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2500 % Ignore text, except that we keep track of conditional commands for
2501 % purposes of nesting, up to an `@end #1' command.
2503 \def\nestedignore#1{%
2505 % We must actually expand the ignored text to look for the @end
2506 % command, so that nested ignore constructs work. Thus, we put the
2507 % text into a \vbox and then do nothing with the result. To minimize
2508 % the change of memory overflow, we follow the approach outlined on
2509 % page 401 of the TeXbook: make the current font be a dummy font.
2511 \setbox0 = \vbox\bgroup
2512 % Don't complain about control sequences we have declared \outer.
2515 % Define `@end #1' to end the box, which will in turn undefine the
2516 % @end command again.
2517 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2519 % We are going to be parsing Texinfo commands. Most cause no
2520 % trouble when they are used incorrectly, but some commands do
2521 % complicated argument parsing or otherwise get confused, so we
2524 % We can't do anything about stray @-signs, unfortunately;
2525 % they'll produce `undefined control sequence' errors.
2528 % Set the current font to be \nullfont, a TeX primitive, and define
2529 % all the font commands to also use \nullfont. We don't use
2530 % dummy.tfm, as suggested in the TeXbook, because not all sites
2531 % might have that installed. Therefore, math mode will still
2532 % produce output, but that should be an extremely small amount of
2533 % stuff compared to the main input.
2536 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2537 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2538 \let\tensf=\nullfont
2539 % Similarly for index fonts.
2540 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2541 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2542 \let\smallsf=\nullfont
2543 % Similarly for smallexample fonts.
2544 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2545 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2546 \let\smallersf=\nullfont
2548 % Don't complain when characters are missing from the fonts.
2549 \tracinglostchars = 0
2551 % Don't bother to do space factor calculations.
2554 % Don't report underfull hboxes.
2557 % Do minimal line-breaking.
2558 \pretolerance = 10000
2560 % Do not execute instructions in @tex
2561 \def\tex{\doignore{tex}}%
2562 % Do not execute macro definitions.
2563 % `c' is a comment character, so the word `macro' will get cut off.
2564 \def\macro{\doignore{ma}}%
2567 % @set VAR sets the variable VAR to an empty value.
2568 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2570 % Since we want to separate VAR from REST-OF-LINE (which might be
2571 % empty), we can't just use \parsearg; we have to insert a space of our
2572 % own to delimit the rest of the line, and then take it out again if we
2573 % didn't need it. Make sure the catcode of space is correct to avoid
2574 % losing inside @example, for instance.
2576 \def\set{\begingroup\catcode` =10
2577 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2579 \def\setxxx#1{\setyyy#1 \endsetyyy}
2580 \def\setyyy#1 #2\endsetyyy{%
2582 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2583 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2587 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2588 % \next or other control sequences that we've defined might get us into
2589 % an infinite loop. Consider `@set foo @cite{bar}'.
2590 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2592 % @clear VAR clears (i.e., unsets) the variable VAR.
2594 \def\clear{\parsearg\clearxxx}
2595 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2597 % @value{foo} gets the text saved in variable foo.
2599 \catcode`\_ = \active
2601 % We might end up with active _ or - characters in the argument if
2602 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2603 % such active characters to their normal equivalents.
2604 \gdef\value{\begingroup
2605 \catcode`\-=12 \catcode`\_=12
2606 \indexbreaks \let_\normalunderscore
2609 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2611 % We have this subroutine so that we can handle at least some @value's
2612 % properly in indexes (we \let\value to this in \indexdummies). Ones
2613 % whose names contain - or _ still won't work, but we can't do anything
2614 % about that. The command has to be fully expandable, since the result
2615 % winds up in the index file. This means that if the variable's value
2616 % contains other Texinfo commands, it's almost certain it will fail
2617 % (although perhaps we could fix that with sufficient work to do a
2618 % one-level expansion on the result, instead of complete).
2620 \def\expandablevalue#1{%
2621 \expandafter\ifx\csname SET#1\endcsname\relax
2622 {[No value for ``#1'']}%
2624 \csname SET#1\endcsname
2628 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2631 \def\ifset{\parsearg\ifsetxxx}
2633 \expandafter\ifx\csname SET#1\endcsname\relax
2634 \expandafter\ifsetfail
2636 \expandafter\ifsetsucceed
2639 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2640 \def\ifsetfail{\nestedignore{ifset}}
2641 \defineunmatchedend{ifset}
2643 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2644 % defined with @set, or has been undefined with @clear.
2646 \def\ifclear{\parsearg\ifclearxxx}
2647 \def\ifclearxxx #1{%
2648 \expandafter\ifx\csname SET#1\endcsname\relax
2649 \expandafter\ifclearsucceed
2651 \expandafter\ifclearfail
2654 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2655 \def\ifclearfail{\nestedignore{ifclear}}
2656 \defineunmatchedend{ifclear}
2658 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2659 % read the text following, through the first @end iftex (etc.). Make
2660 % `@end iftex' (etc.) valid only after an @iftex.
2662 \def\iftex{\conditionalsucceed{iftex}}
2663 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2664 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2665 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2666 \defineunmatchedend{iftex}
2667 \defineunmatchedend{ifnothtml}
2668 \defineunmatchedend{ifnotinfo}
2669 \defineunmatchedend{ifnotplaintext}
2671 % We can't just want to start a group at @iftex (etc.) and end it at
2672 % @end iftex, since then @set commands inside the conditional have no
2673 % effect (they'd get reverted at the end of the group). So we must
2674 % define \Eiftex to redefine itself to be its previous value. (We can't
2675 % just define it to fail again with an ``unmatched end'' error, since
2676 % the @ifset might be nested.)
2678 \def\conditionalsucceed#1{%
2680 % Remember the current value of \E#1.
2681 \let\nece{prevE#1} = \nece{E#1}%
2683 % At the `@end #1', redefine \E#1 to be its previous value.
2684 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2689 % We need to expand lots of \csname's, but we don't want to expand the
2690 % control sequences after we've constructed them.
2692 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2694 % @defininfoenclose.
2695 \let\definfoenclose=\comment
2699 % Index generation facilities
2701 % Define \newwrite to be identical to plain tex's \newwrite
2702 % except not \outer, so it can be used within \newindex.
2704 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2706 % \newindex {foo} defines an index named foo.
2707 % It automatically defines \fooindex such that
2708 % \fooindex ...rest of line... puts an entry in the index foo.
2709 % It also defines \fooindfile to be the number of the output channel for
2710 % the file that accumulates this index. The file's extension is foo.
2711 % The name of an index should be no more than 2 characters long
2712 % for the sake of vms.
2716 \expandafter\newwrite \csname#1indfile\endcsname
2717 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2719 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2720 \noexpand\doindex{#1}}
2723 % @defindex foo == \newindex{foo}
2725 \def\defindex{\parsearg\newindex}
2727 % Define @defcodeindex, like @defindex except put all entries in @code.
2729 \def\defcodeindex{\parsearg\newcodeindex}
2731 \def\newcodeindex#1{%
2733 \expandafter\newwrite \csname#1indfile\endcsname
2734 \openout \csname#1indfile\endcsname \jobname.#1
2736 \expandafter\xdef\csname#1index\endcsname{%
2737 \noexpand\docodeindex{#1}}%
2741 % @synindex foo bar makes index foo feed into index bar.
2742 % Do this instead of @defindex foo if you don't want it as a separate index.
2744 % @syncodeindex foo bar similar, but put all entries made for index foo
2747 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2748 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2750 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2751 % #3 the target index (bar).
2752 \def\dosynindex#1#2#3{%
2753 % Only do \closeout if we haven't already done it, else we'll end up
2754 % closing the target index.
2755 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2756 % The \closeout helps reduce unnecessary open files; the limit on the
2757 % Acorn RISC OS is a mere 16 files.
2758 \expandafter\closeout\csname#2indfile\endcsname
2759 \expandafter\let\csname\donesynindex#2\endcsname = 1
2761 % redefine \fooindfile:
2762 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2763 \expandafter\let\csname#2indfile\endcsname=\temp
2764 % redefine \fooindex:
2765 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2768 % Define \doindex, the driver for all \fooindex macros.
2769 % Argument #1 is generated by the calling \fooindex macro,
2770 % and it is "foo", the name of the index.
2772 % \doindex just uses \parsearg; it calls \doind for the actual work.
2773 % This is because \doind is more useful to call from other macros.
2775 % There is also \dosubind {index}{topic}{subtopic}
2776 % which makes an entry in a two-level index such as the operation index.
2778 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2779 \def\singleindexer #1{\doind{\indexname}{#1}}
2781 % like the previous two, but they put @code around the argument.
2782 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2783 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2785 % Take care of texinfo commands likely to appear in an index entry.
2786 % (Must be a way to avoid doing expansion at all, and thus not have to
2787 % laboriously list every single command here.)
2791 \def\@{@}% change to @@ when we switch to @ as escape char in aux files.
2792 % Need these in case \tex is in effect and \{ is a \delimiter again.
2793 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2794 % braces and backslashes are used only as delimiters.
2797 \def\_{{\realbackslash _}}%
2798 \normalturnoffactive
2800 % Take care of the plain tex accent commands.
2801 \def\,##1{\realbackslash ,{##1}}%
2802 \def\"{\realbackslash "}%
2803 \def\`{\realbackslash `}%
2804 \def\'{\realbackslash '}%
2805 \def\^{\realbackslash ^}%
2806 \def\~{\realbackslash ~}%
2807 \def\={\realbackslash =}%
2808 \def\b{\realbackslash b}%
2809 \def\c{\realbackslash c}%
2810 \def\d{\realbackslash d}%
2811 \def\u{\realbackslash u}%
2812 \def\v{\realbackslash v}%
2813 \def\H{\realbackslash H}%
2814 \def\dotless##1{\realbackslash dotless {##1}}%
2815 % Take care of the plain tex special European modified letters.
2816 \def\AA{\realbackslash AA}%
2817 \def\AE{\realbackslash AE}%
2818 \def\L{\realbackslash L}%
2819 \def\OE{\realbackslash OE}%
2820 \def\O{\realbackslash O}%
2821 \def\aa{\realbackslash aa}%
2822 \def\ae{\realbackslash ae}%
2823 \def\l{\realbackslash l}%
2824 \def\oe{\realbackslash oe}%
2825 \def\o{\realbackslash o}%
2826 \def\ss{\realbackslash ss}%
2828 % Although these internals commands shouldn't show up, sometimes they do.
2829 \def\bf{\realbackslash bf }%
2830 \def\gtr{\realbackslash gtr}%
2831 \def\hat{\realbackslash hat}%
2832 \def\less{\realbackslash less}%
2833 %\def\rm{\realbackslash rm }%
2834 \def\sf{\realbackslash sf}%
2835 \def\sl{\realbackslash sl }%
2836 \def\tclose##1{\realbackslash tclose {##1}}%
2837 \def\tt{\realbackslash tt}%
2839 \def\b##1{\realbackslash b {##1}}%
2840 \def\i##1{\realbackslash i {##1}}%
2841 \def\sc##1{\realbackslash sc {##1}}%
2842 \def\t##1{\realbackslash t {##1}}%
2843 \def\r##1{\realbackslash r {##1}}%
2845 \def\TeX{\realbackslash TeX}%
2846 \def\acronym##1{\realbackslash acronym {##1}}%
2847 \def\cite##1{\realbackslash cite {##1}}%
2848 \def\code##1{\realbackslash code {##1}}%
2849 \def\command##1{\realbackslash command {##1}}%
2850 \def\dfn##1{\realbackslash dfn {##1}}%
2851 \def\dots{\realbackslash dots }%
2852 \def\emph##1{\realbackslash emph {##1}}%
2853 \def\env##1{\realbackslash env {##1}}%
2854 \def\file##1{\realbackslash file {##1}}%
2855 \def\kbd##1{\realbackslash kbd {##1}}%
2856 \def\key##1{\realbackslash key {##1}}%
2857 \def\math##1{\realbackslash math {##1}}%
2858 \def\option##1{\realbackslash option {##1}}%
2859 \def\samp##1{\realbackslash samp {##1}}%
2860 \def\strong##1{\realbackslash strong {##1}}%
2861 \def\uref##1{\realbackslash uref {##1}}%
2862 \def\url##1{\realbackslash url {##1}}%
2863 \def\var##1{\realbackslash var {##1}}%
2864 \def\w{\realbackslash w }%
2866 % These math commands don't seem likely to be used in index entries.
2867 \def\copyright{\realbackslash copyright}%
2868 \def\equiv{\realbackslash equiv}%
2869 \def\error{\realbackslash error}%
2870 \def\expansion{\realbackslash expansion}%
2871 \def\point{\realbackslash point}%
2872 \def\print{\realbackslash print}%
2873 \def\result{\realbackslash result}%
2875 % Handle some cases of @value -- where the variable name does not
2876 % contain - or _, and the value does not contain any
2877 % (non-fully-expandable) commands.
2878 \let\value = \expandablevalue
2881 % Turn off macro expansion
2885 % If an index command is used in an @example environment, any spaces
2886 % therein should become regular spaces in the raw index file, not the
2887 % expansion of \tie (\leavevmode \penalty \@M \ ).
2889 \gdef\unsepspaces{\obeyspaces\let =\space}}
2891 % \indexnofonts no-ops all font-change commands.
2892 % This is used when outputting the strings to sort the index by.
2893 \def\indexdummyfont#1{#1}
2894 \def\indexdummytex{TeX}
2895 \def\indexdummydots{...}
2899 % how to handle braces?
2900 \def\_{\normalunderscore}%
2902 \let\,=\indexdummyfont
2903 \let\"=\indexdummyfont
2904 \let\`=\indexdummyfont
2905 \let\'=\indexdummyfont
2906 \let\^=\indexdummyfont
2907 \let\~=\indexdummyfont
2908 \let\==\indexdummyfont
2909 \let\b=\indexdummyfont
2910 \let\c=\indexdummyfont
2911 \let\d=\indexdummyfont
2912 \let\u=\indexdummyfont
2913 \let\v=\indexdummyfont
2914 \let\H=\indexdummyfont
2915 \let\dotless=\indexdummyfont
2916 % Take care of the plain tex special European modified letters.
2929 % Don't no-op \tt, since it isn't a user-level command
2930 % and is used in the definitions of the active chars like <, >, |, etc.
2931 % Likewise with the other plain tex font commands.
2932 %\let\tt=\indexdummyfont
2934 \let\b=\indexdummyfont
2935 \let\i=\indexdummyfont
2936 \let\r=\indexdummyfont
2937 \let\sc=\indexdummyfont
2938 \let\t=\indexdummyfont
2940 \let\TeX=\indexdummytex
2941 \let\acronym=\indexdummyfont
2942 \let\cite=\indexdummyfont
2943 \let\code=\indexdummyfont
2944 \let\command=\indexdummyfont
2945 \let\dfn=\indexdummyfont
2946 \let\dots=\indexdummydots
2947 \let\emph=\indexdummyfont
2948 \let\env=\indexdummyfont
2949 \let\file=\indexdummyfont
2950 \let\kbd=\indexdummyfont
2951 \let\key=\indexdummyfont
2952 \let\math=\indexdummyfont
2953 \let\option=\indexdummyfont
2954 \let\samp=\indexdummyfont
2955 \let\strong=\indexdummyfont
2956 \let\uref=\indexdummyfont
2957 \let\url=\indexdummyfont
2958 \let\var=\indexdummyfont
2959 \let\w=\indexdummyfont
2962 % To define \realbackslash, we must make \ not be an escape.
2963 % We must first make another character (@) an escape
2964 % so we do not become unable to do a definition.
2966 {\catcode`\@=0 \catcode`\\=\other
2967 @gdef@realbackslash{\}}
2969 \let\indexbackslash=0 %overridden during \printindex.
2970 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2972 % For \ifx comparisons.
2973 \def\emptymacro{\empty}
2975 % Most index entries go through here, but \dosubind is the general case.
2977 \def\doind#1#2{\dosubind{#1}{#2}\empty}
2979 % Workhorse for all \fooindexes.
2980 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2981 % \empty if called from \doind, as we usually are. The main exception
2982 % is with defuns, which call us directly.
2984 \def\dosubind#1#2#3{%
2985 % Put the index entry in the margin if desired.
2986 \ifx\SETmarginindex\relax\else
2987 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2990 \count255=\lastpenalty
2992 \indexdummies % Must do this here, since \bf, etc expand at this stage
2995 \let\folio = 0% We will expand all macros now EXCEPT \folio.
2996 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2997 % so it will be output as is; and it will print as backslash.
3001 % If third arg is present, precede it with space in sort key.
3002 \ifx\thirdarg\emptymacro
3003 \let\subentry = \empty
3008 % First process the index entry with all font commands turned
3009 % off to get the string to sort by.
3010 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
3012 % Now the real index entry with the fonts.
3015 % If the third (subentry) arg is present, add it to the index
3017 \ifx\thirdarg\emptymacro \else
3018 \toks0 = \expandafter{\the\toks0{#3}}%
3021 % Set up the complete index entry, with both the sort key and
3022 % the original text, including any font commands. We write
3023 % three arguments to \entry to the .?? file (four in the
3024 % subentry case), texindex reduces to two when writing the .??s
3027 \write\csname#1indfile\endcsname{%
3028 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3031 % If a skip is the last thing on the list now, preserve it
3032 % by backing up by \lastskip, doing the \write, then inserting
3033 % the skip again. Otherwise, the whatsit generated by the
3034 % \write will make \lastskip zero. The result is that sequences
3039 % will have extra space inserted, because the \medbreak in the
3040 % start of the @defun won't see the skip inserted by the @end of
3041 % the previous defun.
3043 % But don't do any of this if we're not in vertical mode. We
3044 % don't want to do a \vskip and prematurely end a paragraph.
3046 % Avoid page breaks due to these extra skips, too.
3051 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
3054 \temp % do the write
3057 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3065 % The index entry written in the file actually looks like
3066 % \entry {sortstring}{page}{topic}
3068 % \entry {sortstring}{page}{topic}{subtopic}
3069 % The texindex program reads in these files and writes files
3070 % containing these kinds of lines:
3072 % before the first topic whose initial is c
3073 % \entry {topic}{pagelist}
3074 % for a topic that is used without subtopics
3076 % for the beginning of a topic that is used with subtopics
3077 % \secondary {subtopic}{pagelist}
3078 % for each subtopic.
3080 % Define the user-accessible indexing commands
3081 % @findex, @vindex, @kindex, @cindex.
3083 \def\findex {\fnindex}
3084 \def\kindex {\kyindex}
3085 \def\cindex {\cpindex}
3086 \def\vindex {\vrindex}
3087 \def\tindex {\tpindex}
3088 \def\pindex {\pgindex}
3090 \def\cindexsub {\begingroup\obeylines\cindexsub}
3092 \gdef\cindexsub "#1" #2^^M{\endgroup %
3093 \dosubind{cp}{#2}{#1}}}
3095 % Define the macros used in formatting output of the sorted index material.
3097 % @printindex causes a particular index (the ??s file) to get printed.
3098 % It does not print any chapter heading (usually an @unnumbered).
3100 \def\printindex{\parsearg\doprintindex}
3101 \def\doprintindex#1{\begingroup
3102 \dobreak \chapheadingskip{10000}%
3108 % See if the index file exists and is nonempty.
3109 % Change catcode of @ here so that if the index file contains
3111 % as its first line, TeX doesn't complain about mismatched braces
3112 % (because it thinks @} is a control sequence).
3114 \openin 1 \jobname.#1s
3116 % \enddoublecolumns gets confused if there is no text in the index,
3117 % and it loses the chapter title and the aux file entries for the
3118 % index. The easiest way to prevent this problem is to make sure
3119 % there is some text.
3120 \putwordIndexNonexistent
3123 % If the index file exists but is empty, then \openin leaves \ifeof
3124 % false. We have to make TeX try to read something from the file, so
3125 % it can discover if there is anything in it.
3128 \putwordIndexIsEmpty
3130 % Index files are almost Texinfo source, but we use \ as the escape
3131 % character. It would be better to use @, but that's too big a change
3132 % to make right now.
3133 \def\indexbackslash{\rawbackslashxx}%
3144 % These macros are used by the sorted index file itself.
3145 % Change them to control the appearance of the index.
3148 % Some minor font changes for the special characters.
3149 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3151 % Remove any glue we may have, we'll be inserting our own.
3154 % We like breaks before the index initials, so insert a bonus.
3157 % Typeset the initial. Making this add up to a whole number of
3158 % baselineskips increases the chance of the dots lining up from column
3159 % to column. It still won't often be perfect, because of the stretch
3160 % we need before each entry, but it's better.
3162 % No shrink because it confuses \balancecolumns.
3163 \vskip 1.67\baselineskip plus .5\baselineskip
3164 \leftline{\secbf #1}%
3165 \vskip .33\baselineskip plus .1\baselineskip
3167 % Do our best not to break after the initial.
3171 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3172 % flush to the right margin. It is used for index and table of contents
3173 % entries. The paragraph is indented by \leftskip.
3175 \def\entry#1#2{\begingroup
3177 % Start a new paragraph if necessary, so our assignments below can't
3178 % affect previous text.
3181 % Do not fill out the last line with white space.
3184 % No extra space above this paragraph.
3187 % Do not prefer a separate line ending with a hyphen to fewer lines.
3188 \finalhyphendemerits = 0
3190 % \hangindent is only relevant when the entry text and page number
3191 % don't both fit on one line. In that case, bob suggests starting the
3192 % dots pretty far over on the line. Unfortunately, a large
3193 % indentation looks wrong when the entry text itself is broken across
3194 % lines. So we use a small indentation and put up with long leaders.
3196 % \hangafter is reset to 1 (which is the value we want) at the start
3197 % of each paragraph, so we need not do anything with that.
3200 % When the entry text needs to be broken, just fill out the first line
3202 \rightskip = 0pt plus1fil
3204 % A bit of stretch before each entry for the benefit of balancing columns.
3207 % Start a ``paragraph'' for the index entry so the line breaking
3208 % parameters we've set above will have an effect.
3211 % Insert the text of the index entry. TeX will do line-breaking on it.
3213 % The following is kludged to not output a line of dots in the index if
3214 % there are no page numbers. The next person who breaks this will be
3215 % cursed by a Unix daemon.
3218 \edef\tempc{\tempa}%
3219 \edef\tempd{\tempb}%
3220 \ifx\tempc\tempd\ \else%
3222 % If we must, put the page number on a line of its own, and fill out
3223 % this line with blank space. (The \hfil is overwhelmed with the
3224 % fill leaders glue in \indexdotfill if the page number does fit.)
3226 \null\nobreak\indexdotfill % Have leaders before the page number.
3228 % The `\ ' here is removed by the implicit \unskip that TeX does as
3229 % part of (the primitive) \par. Without it, a spurious underfull
3232 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3234 \ #2% The page number ends the paragraph.
3240 % Like \dotfill except takes at least 1 em.
3241 \def\indexdotfill{\cleaders
3242 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3244 \def\primary #1{\line{#1\hfil}}
3246 \newskip\secondaryindent \secondaryindent=0.5cm
3247 \def\secondary#1#2{{%
3252 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3254 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3261 % Define two-column mode, which we use to typeset indexes.
3262 % Adapted from the TeXbook, page 416, which is to say,
3263 % the manmac.tex format used to print the TeXbook itself.
3267 \newdimen\doublecolumnhsize
3269 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3270 % Grab any single-column material above us.
3273 % Here is a possibility not foreseen in manmac: if we accumulate a
3274 % whole lot of material, we might end up calling this \output
3275 % routine twice in a row (see the doublecol-lose test, which is
3276 % essentially a couple of indexes with @setchapternewpage off). In
3277 % that case we just ship out what is in \partialpage with the normal
3278 % output routine. Generally, \partialpage will be empty when this
3279 % runs and this will be a no-op. See the indexspread.tex test case.
3280 \ifvoid\partialpage \else
3281 \onepageout{\pagecontents\partialpage}%
3284 \global\setbox\partialpage = \vbox{%
3285 % Unvbox the main output page.
3287 \kern-\topskip \kern\baselineskip
3290 \eject % run that output routine to set \partialpage
3292 % Use the double-column output routine for subsequent pages.
3293 \output = {\doublecolumnout}%
3295 % Change the page size parameters. We could do this once outside this
3296 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3297 % format, but then we repeat the same computation. Repeating a couple
3298 % of assignments once per index is clearly meaningless for the
3299 % execution time, so we may as well do it in one place.
3301 % First we halve the line length, less a little for the gutter between
3302 % the columns. We compute the gutter based on the line length, so it
3303 % changes automatically with the paper format. The magic constant
3304 % below is chosen so that the gutter has the same value (well, +-<1pt)
3305 % as it did when we hard-coded it.
3307 % We put the result in a separate register, \doublecolumhsize, so we
3308 % can restore it in \pagesofar, after \hsize itself has (potentially)
3311 \doublecolumnhsize = \hsize
3312 \advance\doublecolumnhsize by -.04154\hsize
3313 \divide\doublecolumnhsize by 2
3314 \hsize = \doublecolumnhsize
3316 % Double the \vsize as well. (We don't need a separate register here,
3317 % since nobody clobbers \vsize.)
3321 % The double-column output routine for all double-column pages except
3324 \def\doublecolumnout{%
3325 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3326 % Get the available space for the double columns -- the normal
3327 % (undoubled) page height minus any material left over from the
3331 \advance\dimen@ by -\ht\partialpage
3333 % box0 will be the left-hand column, box2 the right.
3334 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3335 \onepageout\pagesofar
3337 \penalty\outputpenalty
3340 % Re-output the contents of the output page -- any previous material,
3341 % followed by the two boxes we just split, in box0 and box2.
3345 \hsize = \doublecolumnhsize
3346 \wd0=\hsize \wd2=\hsize
3347 \hbox to\pagewidth{\box0\hfil\box2}%
3350 % All done with double columns.
3351 \def\enddoublecolumns{%
3353 % Split the last of the double-column material. Leave it on the
3354 % current page, no automatic page break.
3357 % If we end up splitting too much material for the current page,
3358 % though, there will be another page break right after this \output
3359 % invocation ends. Having called \balancecolumns once, we do not
3360 % want to call it again. Therefore, reset \output to its normal
3361 % definition right away. (We hope \balancecolumns will never be
3362 % called on to balance too much material, but if it is, this makes
3363 % the output somewhat more palatable.)
3364 \global\output = {\onepageout{\pagecontents\PAGE}}%
3367 \endgroup % started in \begindoublecolumns
3369 % \pagegoal was set to the doubled \vsize above, since we restarted
3370 % the current page. We're now back to normal single-column
3371 % typesetting, so reset \pagegoal to the normal \vsize (after the
3372 % \endgroup where \vsize got restored).
3376 % Called at the end of the double column material.
3377 \def\balancecolumns{%
3378 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3380 \advance\dimen@ by \topskip
3381 \advance\dimen@ by-\baselineskip
3382 \divide\dimen@ by 2 % target to split to
3383 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3384 \splittopskip = \topskip
3385 % Loop until we get a decent breakpoint.
3389 \global\setbox3 = \copy0
3390 \global\setbox1 = \vsplit3 to \dimen@
3392 \global\advance\dimen@ by 1pt
3395 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3396 \setbox0=\vbox to\dimen@{\unvbox1}%
3397 \setbox2=\vbox to\dimen@{\unvbox3}%
3401 \catcode`\@ = \other
3404 \message{sectioning,}
3405 % Chapters, sections, etc.
3408 \newcount\secno \secno=0
3409 \newcount\subsecno \subsecno=0
3410 \newcount\subsubsecno \subsubsecno=0
3412 % This counter is funny since it counts through charcodes of letters A, B, ...
3413 \newcount\appendixno \appendixno = `\@
3414 % \def\appendixletter{\char\the\appendixno}
3415 % We do the following for the sake of pdftex, which needs the actual
3416 % letter in the expansion, not just typeset.
3417 \def\appendixletter{%
3418 \ifnum\appendixno=`A A%
3419 \else\ifnum\appendixno=`B B%
3420 \else\ifnum\appendixno=`C C%
3421 \else\ifnum\appendixno=`D D%
3422 \else\ifnum\appendixno=`E E%
3423 \else\ifnum\appendixno=`F F%
3424 \else\ifnum\appendixno=`G G%
3425 \else\ifnum\appendixno=`H H%
3426 \else\ifnum\appendixno=`I I%
3427 \else\ifnum\appendixno=`J J%
3428 \else\ifnum\appendixno=`K K%
3429 \else\ifnum\appendixno=`L L%
3430 \else\ifnum\appendixno=`M M%
3431 \else\ifnum\appendixno=`N N%
3432 \else\ifnum\appendixno=`O O%
3433 \else\ifnum\appendixno=`P P%
3434 \else\ifnum\appendixno=`Q Q%
3435 \else\ifnum\appendixno=`R R%
3436 \else\ifnum\appendixno=`S S%
3437 \else\ifnum\appendixno=`T T%
3438 \else\ifnum\appendixno=`U U%
3439 \else\ifnum\appendixno=`V V%
3440 \else\ifnum\appendixno=`W W%
3441 \else\ifnum\appendixno=`X X%
3442 \else\ifnum\appendixno=`Y Y%
3443 \else\ifnum\appendixno=`Z Z%
3444 % The \the is necessary, despite appearances, because \appendixletter is
3445 % expanded while writing the .toc file. \char\appendixno is not
3446 % expandable, thus it is written literally, thus all appendixes come out
3447 % with the same letter (or @) in the toc without it.
3448 \else\char\the\appendixno
3449 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3450 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3452 % Each @chapter defines this as the name of the chapter.
3453 % page headings and footings can use it. @section does likewise.
3457 \newcount\absseclevel % used to calculate proper heading level
3458 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3460 % @raisesections: treat @section as chapter, @subsection as section, etc.
3461 \def\raisesections{\global\advance\secbase by -1}
3462 \let\up=\raisesections % original BFox name
3464 % @lowersections: treat @chapter as section, @section as subsection, etc.
3465 \def\lowersections{\global\advance\secbase by 1}
3466 \let\down=\lowersections % original BFox name
3468 % Choose a numbered-heading macro
3469 % #1 is heading level if unmodified by @raisesections or @lowersections
3470 % #2 is text for heading
3471 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3477 \numberedsubseczzz{#2}
3479 \numberedsubsubseczzz{#2}
3481 \ifnum \absseclevel<0
3484 \numberedsubsubseczzz{#2}
3489 % like \numhead, but chooses appendix heading levels
3490 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3494 \appendixsectionzzz{#2}
3496 \appendixsubseczzz{#2}
3498 \appendixsubsubseczzz{#2}
3500 \ifnum \absseclevel<0
3503 \appendixsubsubseczzz{#2}
3508 % like \numhead, but chooses numberless heading levels
3509 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3513 \unnumberedseczzz{#2}
3515 \unnumberedsubseczzz{#2}
3517 \unnumberedsubsubseczzz{#2}
3519 \ifnum \absseclevel<0
3522 \unnumberedsubsubseczzz{#2}
3527 % @chapter, @appendix, @unnumbered.
3528 \def\thischaptername{No Chapter Title}
3529 \outer\def\chapter{\parsearg\chapteryyy}
3530 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3531 \def\chapterzzz #1{%
3532 \secno=0 \subsecno=0 \subsubsecno=0
3533 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3534 \chapmacro {#1}{\the\chapno}%
3535 \gdef\thissection{#1}%
3536 \gdef\thischaptername{#1}%
3537 % We don't substitute the actual chapter name into \thischapter
3538 % because we don't want its macros evaluated now.
3539 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3541 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3545 \global\let\section = \numberedsec
3546 \global\let\subsection = \numberedsubsec
3547 \global\let\subsubsection = \numberedsubsubsec
3550 \outer\def\appendix{\parsearg\appendixyyy}
3551 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3552 \def\appendixzzz #1{%
3553 \secno=0 \subsecno=0 \subsubsecno=0
3554 \global\advance \appendixno by 1
3555 \message{\putwordAppendix\space \appendixletter}%
3556 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3557 \gdef\thissection{#1}%
3558 \gdef\thischaptername{#1}%
3559 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3561 \edef\temp{\noexpand\writetocentry{\realbackslash appendixentry{\the\toks0}%
3562 {\appendixletter}}}%
3565 \global\let\section = \appendixsec
3566 \global\let\subsection = \appendixsubsec
3567 \global\let\subsubsection = \appendixsubsubsec
3570 % @centerchap is like @unnumbered, but the heading is centered.
3571 \outer\def\centerchap{\parsearg\centerchapyyy}
3572 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3574 % @top is like @unnumbered.
3575 \outer\def\top{\parsearg\unnumberedyyy}
3577 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3578 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3579 \def\unnumberedzzz #1{%
3580 \secno=0 \subsecno=0 \subsubsecno=0
3582 % This used to be simply \message{#1}, but TeX fully expands the
3583 % argument to \message. Therefore, if #1 contained @-commands, TeX
3584 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3585 % expanded @cite (which turns out to cause errors because \cite is meant
3586 % to be executed, not expanded).
3588 % Anyway, we don't want the fully-expanded definition of @cite to appear
3589 % as a result of the \message, we just want `@cite' itself. We use
3590 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3591 % simply yielding the contents of <toks register>. (We also do this for
3593 \toks0 = {#1}\message{(\the\toks0)}%
3595 \unnumbchapmacro {#1}%
3596 \gdef\thischapter{#1}\gdef\thissection{#1}%
3598 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}{\the\chapno}}}%
3601 \global\let\section = \unnumberedsec
3602 \global\let\subsection = \unnumberedsubsec
3603 \global\let\subsubsection = \unnumberedsubsubsec
3607 \outer\def\numberedsec{\parsearg\secyyy}
3608 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3610 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3611 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3613 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3614 {\the\chapno}{\the\secno}}}%
3620 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3621 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3622 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3623 \def\appendixsectionzzz #1{%
3624 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3625 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3627 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3628 {\appendixletter}{\the\secno}}}%
3634 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3635 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3636 \def\unnumberedseczzz #1{%
3637 \plainsecheading {#1}\gdef\thissection{#1}%
3639 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry%
3640 {\the\toks0}{\the\chapno}{\the\secno}}}%
3647 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3648 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3649 \def\numberedsubseczzz #1{%
3650 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3651 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3653 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3654 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3660 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3661 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3662 \def\appendixsubseczzz #1{%
3663 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3664 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3666 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3667 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3673 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3674 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3675 \def\unnumberedsubseczzz #1{%
3676 \plainsubsecheading {#1}\gdef\thissection{#1}%
3678 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3679 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}}}%
3686 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3687 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3688 \def\numberedsubsubseczzz #1{%
3689 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3690 \subsubsecheading {#1}
3691 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3693 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3694 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3700 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3701 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3702 \def\appendixsubsubseczzz #1{%
3703 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3704 \subsubsecheading {#1}
3705 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3707 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3708 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3714 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3715 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3716 \def\unnumberedsubsubseczzz #1{%
3717 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3719 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3720 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3726 % These are variants which are not "outer", so they can appear in @ifinfo.
3727 % Actually, they should now be obsolete; ordinary section commands should work.
3728 \def\infotop{\parsearg\unnumberedzzz}
3729 \def\infounnumbered{\parsearg\unnumberedzzz}
3730 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3731 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3732 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3734 \def\infoappendix{\parsearg\appendixzzz}
3735 \def\infoappendixsec{\parsearg\appendixseczzz}
3736 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3737 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3739 \def\infochapter{\parsearg\chapterzzz}
3740 \def\infosection{\parsearg\sectionzzz}
3741 \def\infosubsection{\parsearg\subsectionzzz}
3742 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3744 % These macros control what the section commands do, according
3745 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3746 % Define them by default for a numbered chapter.
3747 \global\let\section = \numberedsec
3748 \global\let\subsection = \numberedsubsec
3749 \global\let\subsubsection = \numberedsubsubsec
3751 % Define @majorheading, @heading and @subheading
3753 % NOTE on use of \vbox for chapter headings, section headings, and such:
3754 % 1) We use \vbox rather than the earlier \line to permit
3755 % overlong headings to fold.
3756 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3757 % heading is obnoxious; this forbids it.
3758 % 3) Likewise, headings look best if no \parindent is used, and
3759 % if justification is not attempted. Hence \raggedright.
3762 \def\majorheading{\parsearg\majorheadingzzz}
3763 \def\majorheadingzzz #1{%
3764 {\advance\chapheadingskip by 10pt \chapbreak }%
3765 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3766 \parindent=0pt\raggedright
3767 \rm #1\hfill}}\bigskip \par\penalty 200}
3769 \def\chapheading{\parsearg\chapheadingzzz}
3770 \def\chapheadingzzz #1{\chapbreak %
3771 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3772 \parindent=0pt\raggedright
3773 \rm #1\hfill}}\bigskip \par\penalty 200}
3775 % @heading, @subheading, @subsubheading.
3776 \def\heading{\parsearg\plainsecheading}
3777 \def\subheading{\parsearg\plainsubsecheading}
3778 \def\subsubheading{\parsearg\plainsubsubsecheading}
3780 % These macros generate a chapter, section, etc. heading only
3781 % (including whitespace, linebreaking, etc. around it),
3782 % given all the information in convenient, parsed form.
3784 %%% Args are the skip and penalty (usually negative)
3785 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3787 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3789 %%% Define plain chapter starts, and page on/off switching for it
3790 % Parameter controlling skip before chapter headings (if needed)
3792 \newskip\chapheadingskip
3794 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3795 \def\chappager{\par\vfill\supereject}
3796 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3798 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3801 \global\let\contentsalignmacro = \chappager
3802 \global\let\pchapsepmacro=\chapbreak
3803 \global\let\pagealignmacro=\chappager}
3806 \global\let\contentsalignmacro = \chappager
3807 \global\let\pchapsepmacro=\chappager
3808 \global\let\pagealignmacro=\chappager
3809 \global\def\HEADINGSon{\HEADINGSsingle}}
3812 \global\let\contentsalignmacro = \chapoddpage
3813 \global\let\pchapsepmacro=\chapoddpage
3814 \global\let\pagealignmacro=\chapoddpage
3815 \global\def\HEADINGSon{\HEADINGSdouble}}
3820 \global\let\chapmacro=\chfplain
3821 \global\let\unnumbchapmacro=\unnchfplain
3822 \global\let\centerchapmacro=\centerchfplain}
3824 % Plain chapter opening.
3825 % #1 is the text, #2 the chapter number or empty if unnumbered.
3831 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3832 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3833 \hangindent = \wd0 \centerparametersmaybe
3836 \nobreak\bigskip % no page break after a chapter title
3840 % Plain opening for unnumbered.
3841 \def\unnchfplain#1{\chfplain{#1}{}}
3843 % @centerchap -- centered and unnumbered.
3844 \let\centerparametersmaybe = \relax
3845 \def\centerchfplain#1{{%
3846 \def\centerparametersmaybe{%
3847 \advance\rightskip by 3\rightskip
3848 \leftskip = \rightskip
3854 \CHAPFplain % The default
3856 \def\unnchfopen #1{%
3857 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3858 \parindent=0pt\raggedright
3859 \rm #1\hfill}}\bigskip \par\nobreak
3862 \def\chfopen #1#2{\chapoddpage {\chapfonts
3863 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3867 \def\centerchfopen #1{%
3868 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3870 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3874 \global\let\chapmacro=\chfopen
3875 \global\let\unnumbchapmacro=\unnchfopen
3876 \global\let\centerchapmacro=\centerchfopen}
3880 \newskip\secheadingskip
3881 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3882 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3883 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3885 % Subsection titles.
3886 \newskip \subsecheadingskip
3887 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3888 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3889 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3891 % Subsubsection titles.
3892 \let\subsubsecheadingskip = \subsecheadingskip
3893 \let\subsubsecheadingbreak = \subsecheadingbreak
3894 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3895 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3898 % Print any size section title.
3900 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3901 % number (maybe empty), #3 the text.
3902 \def\sectionheading#1#2#3{%
3904 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3905 \csname #1headingbreak\endcsname
3908 % Switch to the right set of fonts.
3909 \csname #1fonts\endcsname \rm
3911 % Only insert the separating space if we have a section number.
3913 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3915 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3916 \hangindent = \wd0 % zero if no section number
3919 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3924 % Table of contents.
3927 % Write an entry to the toc file, opening it if necessary.
3928 % Called from @chapter, etc. We supply {\folio} at the end of the
3929 % argument, which will end up as the last argument to the \...entry macro.
3931 % We open the .toc file here instead of at @setfilename or any other
3932 % fixed time so that @contents can be put in the document anywhere.
3934 \newif\iftocfileopened
3935 \def\writetocentry#1{%
3936 \iftocfileopened\else
3937 \immediate\openout\tocfile = \jobname.toc
3938 \global\tocfileopenedtrue
3940 \iflinks \write\tocfile{#1{\folio}}\fi
3942 % Tell \shipout to create a page destination if we're doing pdf, which
3943 % will be the target of the links in the table of contents. We can't
3944 % just do it on every page because the title pages are numbered 1 and
3945 % 2 (the page numbers aren't printed), and so are the first two pages
3946 % of the document. Thus, we'd have two destinations named `1', and
3948 \ifpdf \pdfmakepagedesttrue \fi
3951 \newskip\contentsrightmargin \contentsrightmargin=1in
3952 \newcount\savepageno
3953 \newcount\lastnegativepageno \lastnegativepageno = -1
3955 % Finish up the main text and prepare to read what we've written
3958 \def\startcontents#1{%
3959 % If @setchapternewpage on, and @headings double, the contents should
3960 % start on an odd page, unlike chapters. Thus, we maintain
3961 % \contentsalignmacro in parallel with \pagealignmacro.
3962 % From: Torbjorn Granlund <tege@matematik.su.se>
3964 \immediate\closeout\tocfile
3966 % Don't need to put `Contents' or `Short Contents' in the headline.
3967 % It is abundantly clear what they are.
3968 \unnumbchapmacro{#1}\def\thischapter{}%
3969 \savepageno = \pageno
3970 \begingroup % Set up to handle contents files properly.
3971 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3972 % We can't do this, because then an actual ^ in a section
3973 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3974 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3975 \raggedbottom % Worry more about breakpoints than the bottom.
3976 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3978 % Roman numerals for page numbers.
3979 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3983 % Normal (long) toc.
3985 \startcontents{\putwordTOC}%
3986 \openin 1 \jobname.toc
3992 \contentsalignmacro % in case @setchapternewpage odd is in effect
3995 \lastnegativepageno = \pageno
3996 \pageno = \savepageno
3999 % And just the chapters.
4000 \def\summarycontents{%
4001 \startcontents{\putwordShortTOC}%
4003 \let\chapentry = \shortchapentry
4004 \let\appendixentry = \shortappendixentry
4005 \let\unnumbchapentry = \shortunnumberedentry
4006 % We want a true roman here for the page numbers.
4008 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
4010 \hyphenpenalty = 10000
4011 \advance\baselineskip by 1pt % Open it up a little.
4012 \def\secentry ##1##2##3##4{}
4013 \def\subsecentry ##1##2##3##4##5{}
4014 \def\subsubsecentry ##1##2##3##4##5##6{}
4015 \let\unnumbsecentry = \secentry
4016 \let\unnumbsubsecentry = \subsecentry
4017 \let\unnumbsubsubsecentry = \subsubsecentry
4018 \openin 1 \jobname.toc
4024 \contentsalignmacro % in case @setchapternewpage odd is in effect
4026 \lastnegativepageno = \pageno
4027 \pageno = \savepageno
4029 \let\shortcontents = \summarycontents
4032 \pdfcatalog{/PageMode /UseOutlines}%
4035 % These macros generate individual entries in the table of contents.
4036 % The first argument is the chapter or section name.
4037 % The last argument is the page number.
4038 % The arguments in between are the chapter number, section number, ...
4040 % Chapters, in the main contents.
4041 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4043 % Chapters, in the short toc.
4044 % See comments in \dochapentry re vbox and related settings.
4045 \def\shortchapentry#1#2#3{%
4046 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4049 % Appendices, in the main contents.
4050 \def\appendixentry#1#2#3{\dochapentry{\putwordAppendix{} #2\labelspace#1}{#3}}
4052 % Appendices, in the short toc.
4053 \let\shortappendixentry = \shortchapentry
4055 % Typeset the label for a chapter or appendix for the short contents.
4056 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4057 % We could simplify the code here by writing out an \appendixentry
4058 % command in the toc file for appendices, instead of using \chapentry
4059 % for both, but it doesn't seem worth it.
4061 \newdimen\shortappendixwidth
4063 \def\shortchaplabel#1{%
4064 % This space should be enough, since a single number is .5em, and the
4065 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4066 % But use \hss just in case.
4067 % (This space doesn't include the extra space that gets added after
4068 % the label; that gets put in by \shortchapentry above.)
4070 \hbox to \dimen0{#1\hss}%
4073 % Unnumbered chapters.
4074 \def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}}
4075 \def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}}
4078 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4079 \def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4082 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4083 \def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}}
4085 % And subsubsections.
4086 \def\subsubsecentry#1#2#3#4#5#6{%
4087 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4088 \def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}}
4090 % This parameter controls the indentation of the various levels.
4091 \newdimen\tocindent \tocindent = 3pc
4093 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4096 % If the toc has to be broken over pages, we want it to be at chapters
4097 % if at all possible; hence the \penalty.
4098 \def\dochapentry#1#2{%
4099 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4102 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4104 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4107 \def\dosecentry#1#2{\begingroup
4108 \secentryfonts \leftskip=\tocindent
4109 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4112 \def\dosubsecentry#1#2{\begingroup
4113 \subsecentryfonts \leftskip=2\tocindent
4114 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4117 \def\dosubsubsecentry#1#2{\begingroup
4118 \subsubsecentryfonts \leftskip=3\tocindent
4119 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4122 % Final typesetting of a toc entry; we use the same \entry macro as for
4123 % the index entries, but we want to suppress hyphenation here. (We
4124 % can't do that in the \entry macro, since index entries might consist
4125 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4126 \def\tocentry#1#2{\begingroup
4127 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4128 % Do not use \turnoffactive in these arguments. Since the toc is
4129 % typeset in cmr, characters such as _ would come out wrong; we
4130 % have to do the usual translation tricks.
4134 % Space between chapter (or whatever) number and the title.
4135 \def\labelspace{\hskip1em \relax}
4137 \def\dopageno#1{{\rm #1}}
4138 \def\doshortpageno#1{{\rm #1}}
4140 \def\chapentryfonts{\secfonts \rm}
4141 \def\secentryfonts{\textfonts}
4142 \let\subsecentryfonts = \textfonts
4143 \let\subsubsecentryfonts = \textfonts
4146 \message{environments,}
4147 % @foo ... @end foo.
4149 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4151 % Since these characters are used in examples, it should be an even number of
4152 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4155 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4156 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4157 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4158 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4160 % The @error{} command.
4161 % Adapted from the TeXbook's \boxit.
4165 {\tentt \global\dimen0 = 3em}% Width of the box.
4166 \dimen2 = .55pt % Thickness of rules
4167 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4168 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4170 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4171 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4172 \advance\hsize by -2\dimen2 % Rules.
4174 \hrule height\dimen2
4175 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4176 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4177 \kern3pt\vrule width\dimen2}% Space to right.
4178 \hrule height\dimen2}
4181 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4183 % @tex ... @end tex escapes into raw Tex temporarily.
4184 % One exception: @ is still an escape character, so that @end tex works.
4185 % But \@ or @@ will get a plain tex @ character.
4187 \def\tex{\begingroup
4188 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4189 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4190 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4192 \catcode 43=12 % plus
4201 \let\bullet=\ptexbullet
4206 \let\equiv=\ptexequiv
4215 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4216 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4218 \let\Etex=\endgroup}
4220 % Define @lisp ... @end lisp.
4221 % @lisp does a \begingroup so it can rebind things,
4222 % including the definition of @end lisp (which normally is erroneous).
4224 % Amount to narrow the margins by for @lisp.
4225 \newskip\lispnarrowing \lispnarrowing=0.4in
4227 % This is the definition that ^^M gets inside @lisp, @example, and other
4228 % such environments. \null is better than a space, since it doesn't
4230 \def\lisppar{\null\endgraf}
4232 % Make each space character in the input produce a normal interword
4233 % space in the output. Don't allow a line break at this space, as this
4234 % is used only in environments like @example, where each line of input
4235 % should produce a line of output anyway.
4238 \gdef\sepspaces{\obeyspaces\let =\tie}}
4240 % Define \obeyedspace to be our active space, whatever it is. This is
4241 % for use in \parsearg.
4243 \global\let\obeyedspace= }
4245 % This space is always present above and below environments.
4246 \newskip\envskipamount \envskipamount = 0pt
4248 % Make spacing and below environment symmetrical. We use \parskip here
4249 % to help in doing that, since in @example-like environments \parskip
4250 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4251 % start of the next paragraph will insert \parskip
4253 \def\aboveenvbreak{{%
4254 \ifnum\lastpenalty < 10000
4255 \advance\envskipamount by \parskip
4257 \ifdim\lastskip<\envskipamount
4260 \vskip\envskipamount
4265 \let\afterenvbreak = \aboveenvbreak
4267 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4268 \let\nonarrowing=\relax
4270 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4271 % environment contents.
4272 \font\circle=lcircle10
4274 \newdimen\cartouter\newdimen\cartinner
4275 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4276 \circthick=\fontdimen8\circle
4278 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4279 \def\ctr{{\hskip 6pt\circle\char'010}}
4280 \def\cbl{{\circle\char'012\hskip -6pt}}
4281 \def\cbr{{\hskip 6pt\circle\char'011}}
4282 \def\carttop{\hbox to \cartouter{\hskip\lskip
4283 \ctl\leaders\hrule height\circthick\hfil\ctr
4285 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4286 \cbl\leaders\hrule height\circthick\hfil\cbr
4289 \newskip\lskip\newskip\rskip
4291 \long\def\cartouche{%
4293 \lskip=\leftskip \rskip=\rightskip
4294 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4295 \cartinner=\hsize \advance\cartinner by-\lskip
4296 \advance\cartinner by-\rskip
4298 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4299 % side, and for 6pt waste from
4300 % each corner char, and rule thickness
4301 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4302 % Flag to tell @lisp, etc., not to narrow margin.
4303 \let\nonarrowing=\comment
4305 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4314 \baselineskip=\normbskip
4315 \lineskip=\normlskip
4331 % This macro is called at the beginning of all the @example variants,
4335 \inENV % This group ends at the end of the body
4336 \hfuzz = 12pt % Don't be fussy
4337 \sepspaces % Make spaces be word-separators rather than space tokens.
4339 \let\par = \lisppar % don't ignore blank lines
4340 \obeylines % each line of input is a line of output
4343 \emergencystretch = 0pt % don't try to avoid overfull boxes
4344 % @cartouche defines \nonarrowing to inhibit narrowing
4345 % at next level down.
4346 \ifx\nonarrowing\relax
4347 \advance \leftskip by \lispnarrowing
4348 \exdentamount=\lispnarrowing
4349 \let\exdent=\nofillexdent
4350 \let\nonarrowing=\relax
4354 % Define the \E... control sequence only if we are inside the particular
4355 % environment, so the error checking in \end will work.
4357 % To end an @example-like environment, we first end the paragraph (via
4358 % \afterenvbreak's vertical glue), and then the group. That way we keep
4359 % the zero \parskip that the environments set -- \parskip glue will be
4360 % inserted at the beginning of the next paragraph in the document, after
4363 \def\nonfillfinish{\afterenvbreak\endgroup}
4365 % @lisp: indented, narrowed, typewriter font.
4366 \def\lisp{\begingroup
4368 \let\Elisp = \nonfillfinish
4370 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4371 \gobble % eat return
4374 % @example: Same as @lisp.
4375 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4377 % @small... is usually equivalent to the non-small (@smallbook
4378 % redefines). We must call \example (or whatever) last in the
4379 % definition, since it reads the return following the @example (or
4380 % whatever) command.
4382 % This actually allows (for example) @end display inside an
4383 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4385 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4386 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4387 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4388 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4390 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4391 % Originally contributed by Pavel@xerox.
4392 \def\smalllispx{\begingroup
4393 \def\Esmalllisp{\nonfillfinish\endgroup}%
4394 \def\Esmallexample{\nonfillfinish\endgroup}%
4399 % @display: same as @lisp except keep current font.
4401 \def\display{\begingroup
4403 \let\Edisplay = \nonfillfinish
4407 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4409 \def\smalldisplayx{\begingroup
4410 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4411 \smallexamplefonts \rm
4415 % @format: same as @display except don't narrow margins.
4417 \def\format{\begingroup
4418 \let\nonarrowing = t
4420 \let\Eformat = \nonfillfinish
4424 % @smallformat (when @smallbook): @format plus smaller fonts.
4426 \def\smallformatx{\begingroup
4427 \def\Esmallformat{\nonfillfinish\endgroup}%
4428 \smallexamplefonts \rm
4432 % @flushleft (same as @format).
4434 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4438 \def\flushright{\begingroup
4439 \let\nonarrowing = t
4441 \let\Eflushright = \nonfillfinish
4442 \advance\leftskip by 0pt plus 1fill
4447 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4448 % and narrows the margins.
4451 \begingroup\inENV %This group ends at the end of the @quotation body
4452 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4455 % We have retained a nonzero parskip for the environment, since we're
4456 % doing normal filling. So to avoid extra space below the environment...
4457 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4459 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4460 \ifx\nonarrowing\relax
4461 \advance\leftskip by \lispnarrowing
4462 \advance\rightskip by \lispnarrowing
4463 \exdentamount = \lispnarrowing
4464 \let\nonarrowing = \relax
4469 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4470 % If we want to allow any <char> as delimiter,
4471 % we need the curly braces so that makeinfo sees the @verb command, eg:
4472 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4474 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4476 % [Knuth] p. 344; only we need to do '@' too
4478 \do\ \do\\\do\@\do\{\do\}\do\$\do\&%
4479 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~}
4482 \def\uncatcodespecials{%
4483 \def\do##1{\catcode`##1=12}\dospecials}
4485 % [Knuth] pp. 380,381,391
4486 % Disable Spanish ligatures ?` and !` of \tt font
4488 \catcode`\`=\active\gdef`{\relax\lq}
4491 % Setup for the @verb command.
4493 % Eight spaces for a tab
4495 \catcode`\^^I=\active
4496 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4500 \tt % easiest (and conventionally used) font for verbatim
4501 \def\par{\leavevmode\endgraf}%
4504 % Respect line breaks,
4505 % print special symbols as themselves, and
4506 % make each space count
4507 % must do in this order:
4508 \obeylines \uncatcodespecials \sepspaces
4511 % Setup for the @verbatim environment
4513 % Real tab expansion
4514 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4516 \def\starttabbox{\setbox0=\hbox\bgroup}
4518 \catcode`\^^I=\active
4520 \catcode`\^^I=\active
4521 \def^^I{\leavevmode\egroup
4522 \dimen0=\wd0 % the width so far, or since the previous tab
4523 \divide\dimen0 by\tabw
4524 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4525 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4526 \wd0=\dimen0 \box0 \starttabbox
4530 \def\setupverbatim{%
4531 % Easiest (and conventionally used) font for verbatim
4533 \def\par{\leavevmode\egroup\box0\endgraf}%
4536 % Respect line breaks,
4537 % print special symbols as themselves, and
4538 % make each space count
4539 % must do in this order:
4540 \obeylines \uncatcodespecials \sepspaces
4541 \everypar{\starttabbox}%
4544 % Do the @verb magic: verbatim text is quoted by unique
4545 % delimiter characters. Before first delimiter expect a
4546 % right brace, after last delimiter expect closing brace:
4548 % \def\doverb'{'<char>#1<char>'}'{#1}
4550 % [Knuth] p. 382; only eat outer {}
4552 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4553 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4556 \def\verb{\begingroup\setupverb\doverb}
4559 % Do the @verbatim magic: define the macro \doverbatim so that
4560 % the (first) argument ends when '@end verbatim' is reached, ie:
4562 % \def\doverbatim#1@end verbatim{#1}
4564 % For Texinfo it's a lot easier than for LaTeX,
4565 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4566 % we need not redefine '\', '{' and '}'
4568 % Inspired by LaTeX's verbatim command set [latex.ltx]
4569 %% Include LaTeX hack for completeness -- never know
4571 %% \catcode`|=0 \catcode`[=1
4572 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4573 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4574 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4578 \gdef\doverbatim#1@end verbatim{#1\end{verbatim}}
4582 \def\Everbatim{\nonfillfinish\endgroup}%
4585 \advance\leftskip by -\defbodyindent
4586 \begingroup\setupverbatim\doverbatim
4589 % @verbatiminclude FILE - insert text of file in verbatim environment.
4591 % Allow normal characters that we make active in the argument (a file name).
4592 \def\verbatiminclude{%
4602 \parsearg\doverbatiminclude
4604 \def\setupverbatiminclude{%
4607 \advance\leftskip by -\defbodyindent
4608 \begingroup\setupverbatim
4611 \def\doverbatiminclude#1{%
4612 % Restore active chars for included file.
4616 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4617 \endgroup\nonfillfinish\endgroup
4620 % @copying ... @end copying.
4621 % Save the text away for @insertcopying later.
4625 \def\copying{\begingroup
4626 \parindent = 0pt % looks wrong on title page
4627 \def\Ecopying{\egroup\endgroup}%
4628 \global\setbox\copyingbox = \vbox\bgroup
4633 \def\insertcopying{\unvcopy\copyingbox}
4639 % Allow user to change definition object font (\df) internally
4640 \def\setdeffont #1 {\csname DEF#1\endcsname}
4642 \newskip\defbodyindent \defbodyindent=.4in
4643 \newskip\defargsindent \defargsindent=50pt
4644 \newskip\deftypemargin \deftypemargin=12pt
4645 \newskip\deflastargmargin \deflastargmargin=18pt
4647 \newcount\parencount
4648 % define \functionparens, which makes ( and ) and & do special things.
4649 % \functionparens affects the group it is contained in.
4651 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4652 \catcode`\[=\active \catcode`\]=\active}
4654 % Make control sequences which act like normal parenthesis chars.
4655 \let\lparen = ( \let\rparen = )
4657 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4659 % Be sure that we always have a definition for `(', etc. For example,
4660 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4661 % so TeX would otherwise complain about undefined control sequence.
4662 \global\let(=\lparen \global\let)=\rparen
4663 \global\let[=\lbrack \global\let]=\rbrack
4665 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4666 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4667 % This is used to turn on special parens
4668 % but make & act ordinary (given that it's active).
4669 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4671 % Definitions of (, ) and & used in args for functions.
4672 % This is the definition of ( outside of all parentheses.
4673 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4674 \global\advance\parencount by 1
4677 % This is the definition of ( when already inside a level of parens.
4678 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4680 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4681 % also in that case restore the outer-level definition of (.
4682 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4683 \global\advance \parencount by -1 }
4684 % If we encounter &foo, then turn on ()-hacking afterwards
4685 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
4687 \gdef\normalparens{\boldbrax\let&=\ampnr}
4688 } % End of definition inside \activeparens
4689 %% These parens (in \boldbrax) actually are a little bolder than the
4690 %% contained text. This is especially needed for [ and ]
4691 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4692 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4694 \def\lbrb{{\bf\char`\[}}
4695 \def\rbrb{{\bf\char`\]}}
4697 % Active &'s sneak into the index arguments, so make sure it's defined.
4700 \global\let& = \ampnr
4703 % First, defname, which formats the header line itself.
4704 % #1 should be the function name.
4705 % #2 should be the type of definition, such as "Function".
4708 % Get the values of \leftskip and \rightskip as they were
4709 % outside the @def...
4711 \advance\dimen2 by -\defbodyindent
4713 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4714 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4715 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4716 \parshape 2 0in \dimen0 \defargsindent \dimen1
4717 % Now output arg 2 ("Function" or some such)
4718 % ending at \deftypemargin from the right margin,
4719 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4720 {% Adjust \hsize to exclude the ambient margins,
4721 % so that \rightline will obey them.
4722 \advance \hsize by -\dimen2
4723 \rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4724 % Make all lines underfull and no complaints:
4725 \tolerance=10000 \hbadness=10000
4726 \advance\leftskip by -\defbodyindent
4727 \exdentamount=\defbodyindent
4728 {\df #1}\enskip % Generate function name
4731 % Common pieces to start any @def...
4732 % #1 is the \E... control sequence to end the definition (which we define).
4733 % #2 is the \...x control sequence (which our caller defines).
4734 % #3 is the control sequence to process the header, such as \defunheader.
4736 \def\parsebodycommon#1#2#3{%
4738 % If there are two @def commands in a row, we'll have a \nobreak,
4739 % which is there to keep the function description together with its
4740 % header. But if there's nothing but headers, we want to allow a
4742 \ifnum\lastpenalty = 10000 \penalty0 \fi
4745 % Define the \E... end token that this defining construct specifies
4746 % so that it will exit this group.
4747 \def#1{\endgraf\endgroup\medbreak}%
4750 \advance\leftskip by \defbodyindent
4751 \exdentamount=\defbodyindent
4754 % Process body of @defun, @deffn, @defmac, etc.
4756 \def\defparsebody#1#2#3{%
4757 \parsebodycommon{#1}{#2}{#3}%
4758 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4759 \catcode61=\active % 61 is `='
4760 \begingroup\obeylines\activeparens
4764 % #1, #2, #3 are the common arguments (see \defparsebody).
4765 % #4, delimited by the space, is the class name.
4767 \def\defmethparsebody#1#2#3#4 {%
4768 \parsebodycommon{#1}{#2}{#3}%
4769 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4770 \begingroup\obeylines\activeparens
4771 \spacesplit{#3{#4}}%
4774 % Used for @deftypemethod and @deftypeivar.
4775 % #1, #2, #3 are the common arguments (see \defparsebody).
4776 % #4, delimited by a space, is the class name.
4777 % #5 is the method's return type.
4779 \def\deftypemethparsebody#1#2#3#4 #5 {%
4780 \parsebodycommon{#1}{#2}{#3}%
4781 \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4782 \begingroup\obeylines\activeparens
4783 \spacesplit{#3{#4}{#5}}%
4786 % Used for @deftypeop. The change from \deftypemethparsebody is an
4787 % extra argument at the beginning which is the `category', instead of it
4788 % being the hardwired string `Method' or `Instance Variable'. We have
4789 % to account for this both in the \...x definition and in parsing the
4790 % input at hand. Thus also need a control sequence (passed as #5) for
4791 % the \E... definition to assign the category name to.
4793 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
4794 \parsebodycommon{#1}{#2}{#3}%
4795 \def#2##1 ##2 ##3 {%
4797 \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4798 \begingroup\obeylines\activeparens
4799 \spacesplit{#3{#5}{#6}}%
4803 \def\defopparsebody #1#2#3#4#5 {%
4804 \parsebodycommon{#1}{#2}{#3}%
4805 \def#2##1 ##2 {\def#4{##1}%
4806 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4807 \begingroup\obeylines\activeparens
4808 \spacesplit{#3{#5}}%
4811 % These parsing functions are similar to the preceding ones
4812 % except that they do not make parens into active characters.
4813 % These are used for "variables" since they have no arguments.
4815 \def\defvarparsebody #1#2#3{%
4816 \parsebodycommon{#1}{#2}{#3}%
4817 \def#2{\begingroup\obeylines\spacesplit#3}%
4818 \catcode61=\active %
4819 \begingroup\obeylines
4824 \def\defopvarparsebody #1#2#3#4#5 {%
4825 \parsebodycommon{#1}{#2}{#3}%
4826 \def#2##1 ##2 {\def#4{##1}%
4827 \begingroup\obeylines\spacesplit{#3{##2}}}%
4828 \begingroup\obeylines
4829 \spacesplit{#3{#5}}%
4832 \def\defvrparsebody#1#2#3#4 {%
4833 \parsebodycommon{#1}{#2}{#3}%
4834 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4835 \begingroup\obeylines
4836 \spacesplit{#3{#4}}%
4839 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4840 % type is just `struct', because we lose the braces in `{struct
4841 % termios}' when \spacesplit reads its undelimited argument. Sigh.
4842 % \let\deftpparsebody=\defvrparsebody
4844 % So, to get around this, we put \empty in with the type name. That
4845 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4846 % won't strip off the braces.
4848 \def\deftpparsebody #1#2#3#4 {%
4849 \parsebodycommon{#1}{#2}{#3}%
4850 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4851 \begingroup\obeylines
4852 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4855 % Fine, but then we have to eventually remove the \empty *and* the
4856 % braces (if any). That's what this does.
4858 \def\removeemptybraces\empty#1\relax{#1}
4860 % After \spacesplit has done its work, this is called -- #1 is the final
4861 % thing to call, #2 the type name (which starts with \empty), and #3
4862 % (which might be empty) the arguments.
4864 \def\parsetpheaderline#1#2#3{%
4865 #1{\removeemptybraces#2\relax}{#3}%
4868 % Split up #2 at the first space token.
4869 % call #1 with two arguments:
4870 % the first is all of #2 before the space token,
4871 % the second is all of #2 after that space token.
4872 % If #2 contains no space token, all of it is passed as the first arg
4873 % and the second is passed as empty.
4876 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4877 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4879 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4883 % First, define the processing that is wanted for arguments of \defun
4884 % Use this to expand the args and terminate the paragraph they make up
4886 \def\defunargs#1{\functionparens \sl
4887 % Expand, preventing hyphenation at `-' chars.
4888 % Note that groups don't affect changes in \hyphenchar.
4889 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4890 {\tensl\hyphenchar\font=0}%
4892 {\tensl\hyphenchar\font=45}%
4893 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4894 \interlinepenalty=10000
4895 \advance\rightskip by 0pt plus 1fil
4896 \endgraf\nobreak\vskip -\parskip\nobreak
4899 \def\deftypefunargs #1{%
4900 % Expand, preventing hyphenation at `-' chars.
4901 % Note that groups don't affect changes in \hyphenchar.
4902 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4904 \tclose{#1}% avoid \code because of side effects on active chars
4905 \interlinepenalty=10000
4906 \advance\rightskip by 0pt plus 1fil
4907 \endgraf\nobreak\vskip -\parskip\nobreak
4910 % Do complete processing of one @defun or @defunx line already parsed.
4912 % @deffn Command forward-char nchars
4914 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4916 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4917 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4918 \catcode 61=\other % Turn off change made in \defparsebody
4921 % @defun == @deffn Function
4923 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4925 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4926 \begingroup\defname {#1}{\putwordDeffunc}%
4927 \defunargs {#2}\endgroup %
4928 \catcode 61=\other % Turn off change made in \defparsebody
4931 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4933 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4935 % #1 is the data type. #2 is the name and args.
4936 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4937 % #1 is the data type, #2 the name, #3 the args.
4938 \def\deftypefunheaderx #1#2 #3\relax{%
4939 \doind {fn}{\code{#2}}% Make entry in function index
4940 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
4941 \deftypefunargs {#3}\endgroup %
4942 \catcode 61=\other % Turn off change made in \defparsebody
4945 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4947 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4949 % \defheaderxcond#1\relax$.$
4950 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4951 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
4953 % #1 is the classification. #2 is the data type. #3 is the name and args.
4954 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4955 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4956 \def\deftypefnheaderx #1#2#3 #4\relax{%
4957 \doind {fn}{\code{#3}}% Make entry in function index
4959 \normalparens % notably, turn off `&' magic, which prevents
4960 % at least some C++ text from working
4961 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
4962 \deftypefunargs {#4}\endgroup %
4963 \catcode 61=\other % Turn off change made in \defparsebody
4966 % @defmac == @deffn Macro
4968 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4970 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4971 \begingroup\defname {#1}{\putwordDefmac}%
4972 \defunargs {#2}\endgroup %
4973 \catcode 61=\other % Turn off change made in \defparsebody
4976 % @defspec == @deffn Special Form
4978 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4980 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4981 \begingroup\defname {#1}{\putwordDefspec}%
4982 \defunargs {#2}\endgroup %
4983 \catcode 61=\other % Turn off change made in \defparsebody
4986 % @defop CATEGORY CLASS OPERATION ARG...
4988 \def\defop #1 {\def\defoptype{#1}%
4989 \defopparsebody\Edefop\defopx\defopheader\defoptype}
4991 \def\defopheader#1#2#3{%
4992 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4993 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4994 \defunargs {#3}\endgroup %
4997 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4999 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5000 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5003 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5004 \def\deftypeopheader#1#2#3#4{%
5005 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5007 \defname{\defheaderxcond#2\relax$.$#3}
5008 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5009 \deftypefunargs{#4}%
5013 % @deftypemethod CLASS TYPE METHOD ARG...
5015 \def\deftypemethod{%
5016 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5018 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5019 \def\deftypemethodheader#1#2#3#4{%
5020 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5022 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5023 \deftypefunargs{#4}%
5027 % @deftypeivar CLASS TYPE VARNAME
5030 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5032 % #1 is the class name, #2 the data type, #3 the variable name.
5033 \def\deftypeivarheader#1#2#3{%
5034 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5036 \defname{\defheaderxcond#2\relax$.$#3}
5037 {\putwordInstanceVariableof\ \code{#1}}%
5042 % @defmethod == @defop Method
5044 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5046 % #1 is the class name, #2 the method name, #3 the args.
5047 \def\defmethodheader#1#2#3{%
5048 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5050 \defname{#2}{\putwordMethodon\ \code{#1}}%
5055 % @defcv {Class Option} foo-class foo-flag
5057 \def\defcv #1 {\def\defcvtype{#1}%
5058 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5060 \def\defcvarheader #1#2#3{%
5061 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5062 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5063 \defvarargs {#3}\endgroup %
5066 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5068 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5070 \def\defivarheader#1#2#3{%
5071 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5073 \defname{#2}{\putwordInstanceVariableof\ #1}%
5079 % First, define the processing that is wanted for arguments of @defvar.
5080 % This is actually simple: just print them in roman.
5081 % This must expand the args and terminate the paragraph they make up
5082 \def\defvarargs #1{\normalparens #1%
5083 \interlinepenalty=10000
5084 \endgraf\nobreak\vskip -\parskip\nobreak}
5086 % @defvr Counter foo-count
5088 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5090 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5091 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5093 % @defvar == @defvr Variable
5095 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5097 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5098 \begingroup\defname {#1}{\putwordDefvar}%
5099 \defvarargs {#2}\endgroup %
5102 % @defopt == @defvr {User Option}
5104 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5106 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5107 \begingroup\defname {#1}{\putwordDefopt}%
5108 \defvarargs {#2}\endgroup %
5111 % @deftypevar int foobar
5113 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5115 % #1 is the data type. #2 is the name, perhaps followed by text that
5116 % is actually part of the data type, which should not be put into the index.
5117 \def\deftypevarheader #1#2{%
5118 \dovarind#2 \relax% Make entry in variables index
5119 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5120 \interlinepenalty=10000
5121 \endgraf\nobreak\vskip -\parskip\nobreak
5123 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5125 % @deftypevr {Global Flag} int enable
5127 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5129 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5130 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5131 \interlinepenalty=10000
5132 \endgraf\nobreak\vskip -\parskip\nobreak
5136 % Args are printed in bold, a slight difference from @defvar.
5138 \def\deftpargs #1{\bf \defvarargs{#1}}
5140 % @deftp Class window height width ...
5142 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5144 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5145 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5147 % These definitions are used if you use @defunx (etc.)
5148 % anywhere other than immediately after a @defun or @defunx.
5150 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5151 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5152 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5153 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5154 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5155 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5156 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5157 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5158 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5159 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5160 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5161 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5162 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5163 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5164 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5165 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5166 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5167 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5168 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5174 % To do this right we need a feature of e-TeX, \scantokens,
5175 % which we arrange to emulate with a temporary file in ordinary TeX.
5176 \ifx\eTeXversion\undefined
5177 \newwrite\macscribble
5179 \begingroup \newlinechar`\^^M
5180 % Undo catcode changes of \startcontents and \doprintindex
5181 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5182 % Append \endinput to make sure that TeX does not see the ending newline.
5183 \toks0={#1\endinput}%
5184 \immediate\openout\macscribble=\jobname.tmp
5185 \immediate\write\macscribble{\the\toks0}%
5186 \immediate\closeout\macscribble
5187 \let\xeatspaces\eatspaces
5193 \begingroup \newlinechar`\^^M
5194 % Undo catcode changes of \startcontents and \doprintindex
5195 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5196 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5199 \newcount\paramno % Count of parameters
5200 \newtoks\macname % Macro name
5201 \newif\ifrecursive % Is it recursive?
5202 \def\macrolist{} % List of all defined macros in the form
5203 % \do\macro1\do\macro2...
5206 % Thisdoes \let #1 = #2, except with \csnames.
5208 \expandafter\expandafter
5210 \expandafter\expandafter
5212 \csname#2\endcsname}
5214 % Trim leading and trailing spaces off a string.
5215 % Concepts from aro-bend problem 15 (see CTAN).
5217 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5218 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5219 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5221 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5224 % Trim a single trailing ^^M off a string.
5225 {\catcode`\^^M=12\catcode`\Q=3%
5226 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5227 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5228 \gdef\eatcrb#1Q#2Q{#1}%
5231 % Macro bodies are absorbed as an argument in a context where
5232 % all characters are catcode 10, 11 or 12, except \ which is active
5233 % (as in normal texinfo). It is necessary to change the definition of \.
5235 % It's necessary to have hard CRs when the macro is executed. This is
5236 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5237 % body, and then making it the \newlinechar in \scanmacro.
5239 \def\macrobodyctxt{%
5264 % \mbodybackslash is the definition of \ in @macro bodies.
5265 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5266 % where N is the macro parameter number.
5267 % We define \csname macarg.\endcsname to be \realbackslash, so
5268 % \\ in macro replacement text gets you a backslash.
5270 {\catcode`@=0 @catcode`@\=@active
5271 @gdef@usembodybackslash{@let\=@mbodybackslash}
5272 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5274 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5276 \def\macro{\recursivefalse\parsearg\macroxxx}
5277 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5280 \getargs{#1}% now \macname is the macname and \argl the arglist
5281 \ifx\argl\empty % no arguments
5284 \expandafter\parsemargdef \argl;%
5286 \if1\csname ismacro.\the\macname\endcsname
5287 \message{Warning: redefining \the\macname}%
5289 \expandafter\ifx\csname \the\macname\endcsname \relax
5290 \else \errmessage{Macro name \the\macname\space already defined}\fi
5291 \global\cslet{macsave.\the\macname}{\the\macname}%
5292 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5293 % Add the macroname to \macrolist
5294 \toks0 = \expandafter{\macrolist\do}%
5295 \xdef\macrolist{\the\toks0
5296 \expandafter\noexpand\csname\the\macname\endcsname}%
5298 \begingroup \macrobodyctxt
5299 \ifrecursive \expandafter\parsermacbody
5300 \else \expandafter\parsemacbody
5303 \def\unmacro{\parsearg\unmacroxxx}
5305 \if1\csname ismacro.#1\endcsname
5306 \global\cslet{#1}{macsave.#1}%
5307 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5308 % Remove the macro name from \macrolist
5310 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5316 \toks0 = \expandafter{\newmacrolist\do}%
5317 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5319 \def\newmacrolist{}%
5320 % Execute macro list to define \newmacrolist
5322 \global\let\macrolist\newmacrolist
5325 \errmessage{Macro #1 not defined}%
5329 % This makes use of the obscure feature that if the last token of a
5330 % <parameter list> is #, then the preceding argument is delimited by
5331 % an opening brace, and that opening brace is not consumed.
5332 \def\getargs#1{\getargsxxx#1{}}
5333 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5334 \def\getmacname #1 #2\relax{\macname={#1}}
5335 \def\getmacargs#1{\def\argl{#1}}
5337 % Parse the optional {params} list. Set up \paramno and \paramlist
5338 % so \defmacro knows what to do. Define \macarg.blah for each blah
5339 % in the params list, to be ##N where N is the position in that list.
5340 % That gets used by \mbodybackslash (above).
5342 % We need to get `macro parameter char #' into several definitions.
5343 % The technique used is stolen from LaTeX: let \hash be something
5344 % unexpandable, insert that wherever you need a #, and then redefine
5345 % it to # just before using the token list produced.
5347 % The same technique is used to protect \eatspaces till just before
5348 % the macro is used.
5350 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5351 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5352 \def\parsemargdefxxx#1,{%
5353 \if#1;\let\next=\relax
5354 \else \let\next=\parsemargdefxxx
5355 \advance\paramno by 1%
5356 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5357 {\xeatspaces{\hash\the\paramno}}%
5358 \edef\paramlist{\paramlist\hash\the\paramno,}%
5361 % These two commands read recursive and nonrecursive macro bodies.
5362 % (They're different since rec and nonrec macros end differently.)
5364 \long\def\parsemacbody#1@end macro%
5365 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5366 \long\def\parsermacbody#1@end rmacro%
5367 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5369 % This defines the macro itself. There are six cases: recursive and
5370 % nonrecursive macros of zero, one, and many arguments.
5371 % Much magic with \expandafter here.
5372 % \xdef is used so that macro definitions will survive the file
5373 % they're defined in; @include reads the file inside a group.
5375 \let\hash=##% convert placeholders to macro parameter chars
5379 \expandafter\xdef\csname\the\macname\endcsname{%
5380 \noexpand\scanmacro{\temp}}%
5382 \expandafter\xdef\csname\the\macname\endcsname{%
5383 \bgroup\noexpand\macroargctxt
5384 \noexpand\braceorline
5385 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5386 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5387 \egroup\noexpand\scanmacro{\temp}}%
5389 \expandafter\xdef\csname\the\macname\endcsname{%
5390 \bgroup\noexpand\macroargctxt
5391 \noexpand\csname\the\macname xx\endcsname}%
5392 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5393 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5394 \expandafter\expandafter
5396 \expandafter\expandafter
5397 \csname\the\macname xxx\endcsname
5398 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5403 \expandafter\xdef\csname\the\macname\endcsname{%
5404 \noexpand\norecurse{\the\macname}%
5405 \noexpand\scanmacro{\temp}\egroup}%
5407 \expandafter\xdef\csname\the\macname\endcsname{%
5408 \bgroup\noexpand\macroargctxt
5409 \noexpand\braceorline
5410 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5411 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5413 \noexpand\norecurse{\the\macname}%
5414 \noexpand\scanmacro{\temp}\egroup}%
5416 \expandafter\xdef\csname\the\macname\endcsname{%
5417 \bgroup\noexpand\macroargctxt
5418 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5419 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5420 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5421 \expandafter\expandafter
5423 \expandafter\expandafter
5424 \csname\the\macname xxx\endcsname
5427 \noexpand\norecurse{\the\macname}%
5428 \noexpand\scanmacro{\temp}\egroup}%
5432 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5434 % \braceorline decides whether the next nonwhitespace character is a
5435 % {. If so it reads up to the closing }, if not, it reads the whole
5436 % line. Whatever was read is then fed to the next control sequence
5437 % as an argument (by \parsebrace or \parsearg)
5438 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5439 \def\braceorlinexxx{%
5440 \ifx\nchar\bgroup\else
5441 \expandafter\parsearg
5444 % We mant to disable all macros during \shipout so that they are not
5445 % expanded by \write.
5446 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5447 \edef\next{\macrolist}\expandafter\endgroup\next}
5451 % We need some trickery to remove the optional spaces around the equal
5452 % sign. Just make them active and then expand them all to nothing.
5453 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5454 \def\aliasxxx #1{\aliasyyy#1\relax}
5455 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5456 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5457 \expandafter\noexpand\csname#2\endcsname}%
5458 \expandafter\endgroup\next}
5461 \message{cross references,}
5466 \newif\ifhavexrefs % True if xref values are known.
5467 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5469 % @inforef is relatively simple.
5470 \def\inforef #1{\inforefzzz #1,,,,**}
5471 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5472 node \samp{\ignorespaces#1{}}}
5474 % @node's job is to define \lastnode.
5475 \def\node{\ENVcheck\parsearg\nodezzz}
5476 \def\nodezzz#1{\nodexxx [#1,]}
5477 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5479 \let\lastnode=\relax
5481 % The sectioning commands (@chapter, etc.) call these.
5483 \ifx\lastnode\relax\else
5484 \expandafter\expandafter\expandafter\setref{\lastnode}%
5485 {Ysectionnumberandtype}%
5486 \global\let\lastnode=\relax
5489 \def\unnumbnoderef{%
5490 \ifx\lastnode\relax\else
5491 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5492 \global\let\lastnode=\relax
5495 \def\appendixnoderef{%
5496 \ifx\lastnode\relax\else
5497 \expandafter\expandafter\expandafter\setref{\lastnode}%
5498 {Yappendixletterandtype}%
5499 \global\let\lastnode=\relax
5504 % @anchor{NAME} -- define xref target at arbitrary point.
5506 \newcount\savesfregister
5507 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5508 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5509 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5511 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5512 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5513 % to set \indexdummies so commands such as @code in a section title
5514 % aren't expanded. It would be nicer not to expand the titles in the
5515 % first place, but there's so many layers that that is hard to do.
5520 \dosetq{#1-title}{Ytitle}%
5521 \dosetq{#1-pg}{Ypagenumber}%
5522 \dosetq{#1-snt}{#2}%
5525 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5526 % the node name, #2 the name of the Info cross-reference, #3 the printed
5527 % node name, #4 the name of the Info file, #5 the name of the printed
5528 % manual. All but the node name can be omitted.
5530 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5531 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5532 \def\ref#1{\xrefX[#1,,,,,,,]}
5533 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5535 \def\printedmanual{\ignorespaces #5}%
5536 \def\printednodename{\ignorespaces #3}%
5537 \setbox1=\hbox{\printedmanual}%
5538 \setbox0=\hbox{\printednodename}%
5540 % No printed node name was explicitly given.
5541 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5542 % Use the node name inside the square brackets.
5543 \def\printednodename{\ignorespaces #1}%
5545 % Use the actual chapter/section title appear inside
5546 % the square brackets. Use the real section title if we have it.
5548 % It is in another manual, so we don't have it.
5549 \def\printednodename{\ignorespaces #1}%
5552 % We know the real title if we have the xref values.
5553 \def\printednodename{\refx{#1-title}{}}%
5555 % Otherwise just copy the Info node name.
5556 \def\printednodename{\ignorespaces #1}%
5562 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5563 % insert empty discretionaries after hyphens, which means that it will
5564 % not find a line break at a hyphen in a node names. Since some manuals
5565 % are best written with fairly long node names, containing hyphens, this
5566 % is a loss. Therefore, we give the text of the node name again, so it
5567 % is as if TeX is seeing it for the first time.
5571 {\normalturnoffactive
5572 \ifnum\filenamelength>0
5573 \startlink attr{/Border [0 0 0]}%
5574 goto file{\the\filename.pdf} name{#1}%
5576 \startlink attr{/Border [0 0 0]}%
5584 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5586 % _ (for example) has to be the character _ for the purposes of the
5587 % control sequence corresponding to the node, but it has to expand
5588 % into the usual \leavevmode...\vrule stuff for purposes of
5589 % printing. So we \turnoffactive for the \refx-snt, back on for the
5590 % printing, back off for the \refx-pg.
5591 {\normalturnoffactive
5592 % Only output a following space if the -snt ref is nonempty; for
5593 % @unnumbered and @anchor, it won't be.
5594 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5595 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5598 [\printednodename],\space
5600 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5605 % \dosetq is the interface for calls from other macros
5607 % Use \normalturnoffactive so that punctuation chars such as underscore
5608 % and backslash work in node names. (\turnoffactive doesn't do \.)
5611 \normalturnoffactive
5612 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5619 % \internalsetq {foo}{page} expands into
5620 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5621 % When the aux file is read, ' is the escape character
5623 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5625 % Things to be expanded by \internalsetq
5627 \def\Ypagenumber{\folio}
5629 \def\Ytitle{\thissection}
5633 \def\Ysectionnumberandtype{%
5634 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5635 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5636 \else \ifnum \subsubsecno=0 %
5637 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5639 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5642 \def\Yappendixletterandtype{%
5643 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5644 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5645 \else \ifnum \subsubsecno=0 %
5646 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5648 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5653 % Use TeX 3.0's \inputlineno to get the line number, for better error
5654 % messages, but if we're using an old version of TeX, don't do anything.
5656 \ifx\inputlineno\thisisundefined
5657 \let\linenumber = \empty % Non-3.0.
5659 \def\linenumber{\the\inputlineno:\space}
5662 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5663 % If its value is nonempty, SUFFIX is output afterward.
5666 \expandafter\ifx\csname X#1\endcsname\relax
5667 % If not defined, say something at least.
5668 \angleleft un\-de\-fined\angleright
5671 \message{\linenumber Undefined cross reference `#1'.}%
5674 \global\warnedxrefstrue
5675 \message{Cross reference values unknown; you must run TeX again.}%
5680 % It's defined, so just use it.
5681 \csname X#1\endcsname
5683 #2% Output the suffix in any case.
5686 % This is the macro invoked by entries in the aux file.
5688 \def\xrdef#1{\begingroup
5689 % Reenable \ as an escape while reading the second argument.
5691 \afterassignment\endgroup
5692 \expandafter\gdef\csname X#1\endcsname
5695 % Read the last existing aux file, if any. No error if none exists.
5696 \def\readauxfile{\begingroup
5697 \catcode`\^^@=\other
5698 \catcode`\^^A=\other
5699 \catcode`\^^B=\other
5700 \catcode`\^^C=\other
5701 \catcode`\^^D=\other
5702 \catcode`\^^E=\other
5703 \catcode`\^^F=\other
5704 \catcode`\^^G=\other
5705 \catcode`\^^H=\other
5706 \catcode`\^^K=\other
5707 \catcode`\^^L=\other
5708 \catcode`\^^N=\other
5709 \catcode`\^^P=\other
5710 \catcode`\^^Q=\other
5711 \catcode`\^^R=\other
5712 \catcode`\^^S=\other
5713 \catcode`\^^T=\other
5714 \catcode`\^^U=\other
5715 \catcode`\^^V=\other
5716 \catcode`\^^W=\other
5717 \catcode`\^^X=\other
5718 \catcode`\^^Z=\other
5719 \catcode`\^^[=\other
5720 \catcode`\^^\=\other
5721 \catcode`\^^]=\other
5722 \catcode`\^^^=\other
5723 \catcode`\^^_=\other
5726 % It was suggested to define this as 7, which would allow ^^e4 etc.
5727 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5728 % supported in the main text, it doesn't seem desirable. Furthermore,
5729 % that is not enough: for node names that actually contain a ^
5730 % character, we would end up writing a line like this: 'xrdef {'hat
5731 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5732 % argument, and \hat is not an expandable control sequence. It could
5733 % all be worked out, but why? Either we support ^^ or we don't.
5735 % The other change necessary for this was to define \auxhat:
5736 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5737 % and then to call \auxhat in \setq.
5750 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5751 % Make the characters 128-255 be printing characters
5755 \catcode\count 1=\other
5756 \advance\count 1 by 1
5757 \ifnum \count 1<256 \loop \fi
5760 % The aux file uses ' as the escape (for now).
5761 % Turn off \ as an escape so we do not lose on
5762 % entries which were dumped with control sequences in their names.
5763 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5764 % Reference to such entries still does not work the way one would wish,
5765 % but at least they do not bomb out when the aux file is read in.
5772 \openin 1 \jobname.aux
5776 \global\havexrefstrue
5777 \global\warnedobstrue
5779 % Open the new aux file. TeX will close it automatically at exit.
5780 \openout\auxfile=\jobname.aux
5786 \newcount \footnoteno
5788 % The trailing space in the following definition for supereject is
5789 % vital for proper filling; pages come out unaligned when you do a
5790 % pagealignmacro call if that space before the closing brace is
5791 % removed. (Generally, numeric constants should always be followed by a
5792 % space to prevent strange expansion errors.)
5793 \def\supereject{\par\penalty -20000\footnoteno =0 }
5795 % @footnotestyle is meaningful for info output only.
5796 \let\footnotestyle=\comment
5798 \let\ptexfootnote=\footnote
5802 % Auto-number footnotes. Otherwise like plain.
5804 \global\advance\footnoteno by \@ne
5805 \edef\thisfootno{$^{\the\footnoteno}$}%
5807 % In case the footnote comes at the end of a sentence, preserve the
5808 % extra spacing after we do the footnote number.
5810 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5812 % Remove inadvertent blank space before typesetting the footnote number.
5818 % Don't bother with the trickery in plain.tex to not require the
5819 % footnote text as a parameter. Our footnotes don't need to be so general.
5821 % Oh yes, they do; otherwise, @ifset and anything else that uses
5822 % \parseargline fail inside footnotes because the tokens are fixed when
5823 % the footnote is read. --karl, 16nov96.
5825 \long\gdef\footnotezzz{\insert\footins\bgroup
5826 % We want to typeset this text as a normal paragraph, even if the
5827 % footnote reference occurs in (for example) a display environment.
5828 % So reset some parameters.
5829 \interlinepenalty\interfootnotelinepenalty
5830 \splittopskip\ht\strutbox % top baseline for broken footnotes
5831 \splitmaxdepth\dp\strutbox
5832 \floatingpenalty\@MM
5837 \parindent\defaultparindent
5841 % Because we use hanging indentation in footnotes, a @noindent appears
5842 % to exdent this text, so make it be a no-op. makeinfo does not use
5843 % hanging indentation so @noindent can still be needed within footnote
5844 % text after an @example or the like (not that this is good style).
5845 \let\noindent = \relax
5847 % Hang the footnote text off the number. Use \everypar in case the
5848 % footnote extends for more than one paragraph.
5849 \everypar = {\hang}%
5850 \textindent{\thisfootno}%
5852 % Don't crash into the line above the footnote text. Since this
5853 % expands into a box, it must come within the paragraph, lest it
5854 % provide a place where TeX can split the footnote.
5856 \futurelet\next\fo@t
5858 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5859 \else\let\next\f@t\fi \next}
5860 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
5861 \def\f@t#1{#1\@foot}
5862 \def\@foot{\strut\par\egroup}
5864 }%end \catcode `\@=11
5866 % @| inserts a changebar to the left of the current line. It should
5867 % surround any changed text. This approach does *not* work if the
5868 % change spans more than two lines of output. To handle that, we would
5869 % have adopt a much more difficult approach (putting marks into the main
5870 % vertical list for the beginning and end of each change).
5873 % \vadjust can only be used in horizontal mode.
5876 % Append this vertical mode material after the current line in the output.
5878 % We want to insert a rule with the height and depth of the current
5879 % leading; that is exactly what \strutbox is supposed to record.
5880 \vskip-\baselineskip
5882 % \vadjust-items are inserted at the left edge of the type. So
5883 % the \llap here moves out into the left-hand margin.
5886 % For a thicker or thinner bar, change the `1pt'.
5887 \vrule height\baselineskip width1pt
5889 % This is the space between the bar and the text.
5895 % For a final copy, take out the rectangles
5896 % that mark overfull boxes (in case you have decided
5897 % that the text looks ok even though it passes the margin).
5899 \def\finalout{\overfullrule=0pt}
5901 % @image. We use the macros from epsf.tex to support this.
5902 % If epsf.tex is not installed and @image is used, we complain.
5904 % Check for and read epsf.tex up front. If we read it only at @image
5905 % time, we might be inside a group, and then its definitions would get
5906 % undone and the next image would fail.
5907 \openin 1 = epsf.tex
5910 % Do not bother showing banner with post-v2.7 epsf.tex (available in
5911 % doc/epsf.tex until it shows up on ctan).
5912 \def\epsfannounce{\toks0 = }%
5916 % We will only complain once about lack of epsf.tex.
5917 \newif\ifwarnednoepsf
5918 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5919 work. It is also included in the Texinfo distribution, or you can get
5920 it from ftp://tug.org/tex/epsf.tex.}
5923 \ifx\epsfbox\undefined
5924 \ifwarnednoepsf \else
5925 \errhelp = \noepsfhelp
5926 \errmessage{epsf.tex not found, images will be ignored}%
5927 \global\warnednoepsftrue
5930 \imagexxx #1,,,,,\finish
5934 % Arguments to @image:
5935 % #1 is (mandatory) image filename; we tack on .eps extension.
5936 % #2 is (optional) width, #3 is (optional) height.
5937 % #4 is (ignored optional) html alt text.
5938 % #5 is (ignored optional) extension.
5939 % #6 is just the usual extra ignored arg for parsing this stuff.
5941 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
5942 \catcode`\^^M = 5 % in case we're inside an example
5943 \normalturnoffactive % allow _ et al. in names
5944 % If the image is by itself, center it.
5948 % Usually we'll have text after the image which will insert
5949 % \parskip glue, so insert it here too to equalize the space
5951 \nobreak\vskip\parskip
5958 \dopdfimage{#1}{#2}{#3}%
5960 % \epsfbox itself resets \epsf?size at each figure.
5961 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5962 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5966 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
5970 \message{localization,}
5973 % @documentlanguage is usually given very early, just after
5974 % @setfilename. If done too late, it may not override everything
5975 % properly. Single argument is the language abbreviation.
5976 % It would be nice if we could set up a hyphenation file here.
5978 \def\documentlanguage{\parsearg\dodocumentlanguage}
5979 \def\dodocumentlanguage#1{%
5980 \tex % read txi-??.tex file in plain TeX.
5981 % Read the file if it exists.
5982 \openin 1 txi-#1.tex
5984 \errhelp = \nolanghelp
5985 \errmessage{Cannot read language file txi-#1.tex}%
5988 \def\temp{\input txi-#1.tex }%
5993 \newhelp\nolanghelp{The given language definition file cannot be found or
5994 is empty. Maybe you need to install it? In the current directory
5995 should work if nowhere else does.}
5998 % @documentencoding should change something in TeX eventually, most
5999 % likely, but for now just recognize it.
6000 \let\documentencoding = \comment
6003 % Page size parameters.
6005 \newdimen\defaultparindent \defaultparindent = 15pt
6007 \chapheadingskip = 15pt plus 4pt minus 2pt
6008 \secheadingskip = 12pt plus 3pt minus 2pt
6009 \subsecheadingskip = 9pt plus 2pt minus 2pt
6011 % Prevent underfull vbox error messages.
6014 % Don't be so finicky about underfull hboxes, either.
6017 % Following George Bush, just get rid of widows and orphans.
6021 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6022 % using an old version of TeX, don't do anything. We want the amount of
6023 % stretch added to depend on the line length, hence the dependence on
6024 % \hsize. We call this whenever the paper size is set.
6026 \def\setemergencystretch{%
6027 \ifx\emergencystretch\thisisundefined
6028 % Allow us to assign to \emergencystretch anyway.
6029 \def\emergencystretch{\dimen0}%
6031 \emergencystretch = .15\hsize
6035 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6036 % 4) hoffset; 5) binding offset; 6) topskip. We also call
6037 % \setleading{\textleading}, so the caller should define \textleading.
6038 % The caller should also set \parskip.
6040 \def\internalpagesizes#1#2#3#4#5#6{%
6043 \splittopskip = \topskip
6046 \advance\vsize by \topskip
6047 \outervsize = \vsize
6048 \advance\outervsize by 2\topandbottommargin
6049 \pageheight = \vsize
6052 \outerhsize = \hsize
6053 \advance\outerhsize by 0.5in
6056 \normaloffset = #4\relax
6057 \bindingoffset = #5\relax
6059 \setleading{\textleading}
6061 \parindent = \defaultparindent
6062 \setemergencystretch
6065 % Use `small' versions.
6067 \def\smallenvironments{%
6068 \let\smalldisplay = \smalldisplayx
6069 \let\smallexample = \smalllispx
6070 \let\smallformat = \smallformatx
6071 \let\smalllisp = \smalllispx
6074 % @letterpaper (the default).
6075 \def\letterpaper{{\globaldefs = 1
6076 \parskip = 3pt plus 2pt minus 1pt
6077 \textleading = 13.2pt
6079 % If page is nothing but text, make it come out even.
6080 \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}%
6083 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6084 \def\smallbook{{\globaldefs = 1
6085 \parskip = 2pt plus 1pt
6088 \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}%
6090 \lispnarrowing = 0.3in
6093 \contentsrightmargin = 0pt
6094 \deftypemargin = 0pt
6095 \defbodyindent = .5cm
6099 % Use @afourpaper to print on European A4 paper.
6100 \def\afourpaper{{\globaldefs = 1
6101 \parskip = 3pt plus 2pt minus 1pt
6102 \textleading = 13.2pt
6104 % Double-side printing via postscript on Laserjet 4050
6105 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6106 % To change the settings for a different printer or situation, adjust
6107 % \normaloffset until the front-side and back-side texts align. Then
6108 % do the same for \bindingoffset. You can set these for testing in
6109 % your texinfo source file like this:
6111 % \global\normaloffset = -6mm
6112 % \global\bindingoffset = 10mm
6114 \internalpagesizes{51\baselineskip}{160mm}{\voffset}{\hoffset}%
6115 {\bindingoffset}{44pt}%
6119 \contentsrightmargin = 0pt
6120 \deftypemargin = 0pt
6121 \defbodyindent = 5mm
6124 % Use @afivepaper to print on European A5 paper.
6125 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6126 % He also recommends making @example and @lisp be small.
6127 \def\afivepaper{{\globaldefs = 1
6128 \parskip = 2pt plus 1pt minus 0.1pt
6129 \textleading = 12.5pt
6131 \internalpagesizes{160mm}{120mm}{\voffset}{\hoffset}{\bindingoffset}{8pt}%
6133 \lispnarrowing = 0.2in
6136 \contentsrightmargin = 0pt
6137 \deftypemargin = 0pt
6138 \defbodyindent = 2mm
6144 % A specific text layout, 24x15cm overall, intended for A4 paper.
6145 \def\afourlatex{{\globaldefs = 1
6147 \internalpagesizes{237mm}{150mm}{\voffset}{4.6mm}{\bindingoffset}{7mm}%
6149 % Must explicitly reset to 0 because we call \afourpaper.
6153 % Use @afourwide to print on A4 paper in wide format.
6154 \def\afourwide{{\globaldefs = 1
6156 \internalpagesizes{241mm}{165mm}{\voffset}{-2.95mm}{\bindingoffset}{7mm}%
6160 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6161 % Perhaps we should allow setting the margins, \topskip, \parskip,
6162 % and/or leading, also. Or perhaps we should compute them somehow.
6164 \def\pagesizes{\parsearg\pagesizesxxx}
6165 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6166 \def\pagesizesyyy#1,#2,#3\finish{{%
6167 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6170 \parskip = 3pt plus 2pt minus 1pt
6171 \setleading{\textleading}%
6173 \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}%
6176 % Set default to letter.
6181 \message{and turning on texinfo input format.}
6183 % Define macros to output various characters with catcode for normal text.
6193 \def\normaldoublequote{"}
6196 \def\normalunderscore{_}
6197 \def\normalverticalbar{|}
6199 \def\normalgreater{>}
6201 \def\normaldollar{$}%$ font-lock fix
6203 % This macro is used to make a character print one way in ttfont
6204 % where it can probably just be output, and another way in other fonts,
6205 % where something hairier probably needs to be done.
6207 % #1 is what to print if we are indeed using \tt; #2 is what to print
6208 % otherwise. Since all the Computer Modern typewriter fonts have zero
6209 % interword stretch (and shrink), and it is reasonable to expect all
6210 % typewriter fonts to have this, we can check that font parameter.
6212 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6214 % Same as above, but check for italic font. Actually this also catches
6215 % non-italic slanted fonts since it is impossible to distinguish them from
6216 % italic fonts. But since this is only used by $ and it uses \sl anyway
6217 % this is not a problem.
6218 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6220 % Turn off all special characters except @
6221 % (and those which the user can use as if they were ordinary).
6222 % Most of these we simply print from the \tt font, but for some, we can
6223 % use math or other variants that look better in normal text.
6226 \def\activedoublequote{{\tt\char34}}
6227 \let"=\activedoublequote
6229 \def~{{\tt\char126}}
6235 \def_{\ifusingtt\normalunderscore\_}
6236 % Subroutine for the previous macro.
6237 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
6240 \def|{{\tt\char124}}
6248 \def+{{\tt \char 43}}
6250 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6251 %\catcode 27=\active
6252 %\def^^[{$\diamondsuit$}
6254 % Set up an active definition for =, but don't enable it most of the time.
6255 {\catcode`\==\active
6256 \global\def={{\tt \char 61}}}
6261 % If a .fmt file is being used, characters that might appear in a file
6262 % name cannot be active until we have parsed the command line.
6263 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6264 % \otherifyactive is called near the end of this file.
6265 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6269 % \rawbackslashxx output one backslash character in current font
6270 \global\chardef\rawbackslashxx=`\\
6271 %{\catcode`\\=\other
6272 %@gdef@rawbackslashxx{\}}
6274 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6275 {\catcode`\\=\active
6276 @gdef@rawbackslash{@let\=@rawbackslashxx }}
6278 % \normalbackslash outputs one backslash in fixed width font.
6279 \def\normalbackslash{{\tt\rawbackslashxx}}
6281 % \catcode 17=0 % Define control-q
6284 % Used sometimes to turn off (effectively) the active characters
6285 % even after parsing them.
6286 @def@turnoffactive{@let"=@normaldoublequote
6287 @let\=@realbackslash
6290 @let_=@normalunderscore
6291 @let|=@normalverticalbar
6293 @let>=@normalgreater
6295 @let$=@normaldollar}%$ font-lock fix
6297 % Same as @turnoffactive except for \.
6298 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6300 % Make _ and + \other characters, temporarily.
6301 % This is canceled by @fixbackslash.
6304 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6305 % That is what \eatinput is for; after that, the `\' should revert to printing
6308 @gdef@eatinput input texinfo{@fixbackslash}
6309 @global@let\ = @eatinput
6311 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6312 % the first `\{ in the file would cause an error. This macro tries to fix
6313 % that, assuming it is called before the first `\' could plausibly occur.
6314 % Also back turn on active characters that might appear in the input
6315 % file name, in case not using a pre-dumped format.
6317 @gdef@fixbackslash{%
6318 @ifx\@eatinput @let\ = @normalbackslash @fi
6323 % Say @foo, not \foo, in error messages.
6326 % These look ok in all fonts, so just make them not special.
6327 @catcode`@& = @other
6328 @catcode`@# = @other
6329 @catcode`@% = @other
6331 @c Set initial fonts.
6337 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6338 @c page-delimiter: "^\\\\message"
6339 @c time-stamp-start: "def\\\\texinfoversion{"
6340 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6341 @c time-stamp-end: "}"