* fixes of groffer 0.9.2
[s-roff.git] / doc / texinfo.tex
blobc83af30e0e082bda79f18546a16ff5d16e840440
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-03-26.08-wl}
8 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99,
9 % 2000, 01, 02 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 texinfo.tex in any given Texinfo distribution could well be out
40 % of date, so if that's what you're using, please check.
42 % Texinfo has a small home page at http://texinfo.org/ and also
43 % http://www.gnu.org/software/texinfo.
45 % Send bug reports to bug-texinfo@gnu.org. Please include including a
46 % complete document in each bug report with which we can reproduce the
47 % problem. Patches are, of course, greatly appreciated.
49 % To process a Texinfo manual with TeX, it's most reliable to use the
50 % texi2dvi shell script that comes with the distribution. For a simple
51 % manual foo.texi, however, you can get away with this:
52 % tex foo.texi
53 % texindex foo.??
54 % tex foo.texi
55 % tex foo.texi
56 % dvips foo.dvi -o # or whatever; this makes foo.ps.
57 % The extra TeX runs get the cross-reference information correct.
58 % Sometimes one run after texindex suffices, and sometimes you need more
59 % than two; texi2dvi does it as many times as necessary.
61 % It is possible to adapt texinfo.tex for other languages. You can get
62 % the existing language-specific files from the full Texinfo distribution.
64 \message{Loading texinfo [version \texinfoversion]:}
66 % If in a .fmt file, print the version number
67 % and turn on active characters that we couldn't do earlier because
68 % they might have appeared in the input file name.
69 \everyjob{\message{[Texinfo version \texinfoversion]}%
70 \catcode`+=\active \catcode`\_=\active}
72 % Save some parts of plain tex whose names we will redefine.
73 \let\ptexb=\b
74 \let\ptexbullet=\bullet
75 \let\ptexc=\c
76 \let\ptexcomma=\,
77 \let\ptexdot=\.
78 \let\ptexdots=\dots
79 \let\ptexend=\end
80 \let\ptexequiv=\equiv
81 \let\ptexexclam=\!
82 \let\ptexi=\i
83 \let\ptexlbrace=\{
84 \let\ptexrbrace=\}
85 \let\ptexstar=\*
86 \let\ptext=\t
88 % We never want plain's outer \+ definition in Texinfo.
89 % For @tex, we can use \tabalign.
90 \let\+ = \relax
92 \message{Basics,}
93 \chardef\other=12
95 % If this character appears in an error message or help string, it
96 % starts a new line in the output.
97 \newlinechar = `^^J
99 % Set up fixed words for English if not already set.
100 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
101 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
102 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
103 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
104 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
105 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
106 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
107 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
108 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
109 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
110 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
111 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
112 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
113 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
114 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
115 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
116 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
117 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
118 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
120 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
121 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
122 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
123 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
124 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
125 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
126 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
127 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
128 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
129 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
130 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
131 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
133 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
134 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
135 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
136 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
137 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
138 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
139 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
141 % Ignore a token.
143 \def\gobble#1{}
145 \hyphenation{ap-pen-dix}
146 \hyphenation{mini-buf-fer mini-buf-fers}
147 \hyphenation{eshell}
148 \hyphenation{white-space}
150 % Margin to add to right of even pages, to left of odd pages.
151 \newdimen \bindingoffset
152 \newdimen \normaloffset
153 \newdimen\pagewidth \newdimen\pageheight
155 % Sometimes it is convenient to have everything in the transcript file
156 % and nothing on the terminal. We don't just call \tracingall here,
157 % since that produces some useless output on the terminal.
159 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
160 \ifx\eTeXversion\undefined
161 \def\loggingall{\tracingcommands2 \tracingstats2
162 \tracingpages1 \tracingoutput1 \tracinglostchars1
163 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
164 \showboxbreadth\maxdimen\showboxdepth\maxdimen
166 \else
167 \def\loggingall{\tracingcommands3 \tracingstats2
168 \tracingpages1 \tracingoutput1 \tracinglostchars1
169 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
170 \tracingscantokens1 \tracingassigns1 \tracingifs1
171 \tracinggroups1 \tracingnesting2
172 \showboxbreadth\maxdimen\showboxdepth\maxdimen
176 % add check for \lastpenalty to plain's definitions. If the last thing
177 % we did was a \nobreak, we don't want to insert more space.
179 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
180 \removelastskip\penalty-50\smallskip\fi\fi}
181 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
182 \removelastskip\penalty-100\medskip\fi\fi}
183 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
184 \removelastskip\penalty-200\bigskip\fi\fi}
186 % For @cropmarks command.
187 % Do @cropmarks to get crop marks.
189 \newif\ifcropmarks
190 \let\cropmarks = \cropmarkstrue
192 % Dimensions to add cropmarks at corners.
193 % Added by P. A. MacKay, 12 Nov. 1986
195 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
196 \newdimen\cornerlong \cornerlong=1pc
197 \newdimen\cornerthick \cornerthick=.3pt
198 \newdimen\topandbottommargin \topandbottommargin=.75in
200 % Main output routine.
201 \chardef\PAGE = 255
202 \output = {\onepageout{\pagecontents\PAGE}}
204 \newbox\headlinebox
205 \newbox\footlinebox
207 % \onepageout takes a vbox as an argument. Note that \pagecontents
208 % does insertions, but you have to call it yourself.
209 \def\onepageout#1{%
210 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
212 \ifodd\pageno \advance\hoffset by \bindingoffset
213 \else \advance\hoffset by -\bindingoffset\fi
215 % Do this outside of the \shipout so @code etc. will be expanded in
216 % the headline as they should be, not taken literally (outputting ''code).
217 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
218 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
221 % Have to do this stuff outside the \shipout because we want it to
222 % take effect in \write's, yet the group defined by the \vbox ends
223 % before the \shipout runs.
225 \escapechar = `\\ % use backslash in output files.
226 \indexdummies % don't expand commands in the output.
227 \normalturnoffactive % \ in index entries must not stay \, e.g., if
228 % the page break happens to be in the middle of an example.
229 \shipout\vbox{%
230 % Do this early so pdf references go to the beginning of the page.
231 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
233 \ifcropmarks \vbox to \outervsize\bgroup
234 \hsize = \outerhsize
235 \vskip-\topandbottommargin
236 \vtop to0pt{%
237 \line{\ewtop\hfil\ewtop}%
238 \nointerlineskip
239 \line{%
240 \vbox{\moveleft\cornerthick\nstop}%
241 \hfill
242 \vbox{\moveright\cornerthick\nstop}%
244 \vss}%
245 \vskip\topandbottommargin
246 \line\bgroup
247 \hfil % center the page within the outer (page) hsize.
248 \ifodd\pageno\hskip\bindingoffset\fi
249 \vbox\bgroup
252 \unvbox\headlinebox
253 \pagebody{#1}%
254 \ifdim\ht\footlinebox > 0pt
255 % Only leave this space if the footline is nonempty.
256 % (We lessened \vsize for it in \oddfootingxxx.)
257 % The \baselineskip=24pt in plain's \makefootline has no effect.
258 \vskip 2\baselineskip
259 \unvbox\footlinebox
262 \ifcropmarks
263 \egroup % end of \vbox\bgroup
264 \hfil\egroup % end of (centering) \line\bgroup
265 \vskip\topandbottommargin plus1fill minus1fill
266 \boxmaxdepth = \cornerthick
267 \vbox to0pt{\vss
268 \line{%
269 \vbox{\moveleft\cornerthick\nsbot}%
270 \hfill
271 \vbox{\moveright\cornerthick\nsbot}%
273 \nointerlineskip
274 \line{\ewbot\hfil\ewbot}%
276 \egroup % \vbox from first cropmarks clause
278 }% end of \shipout\vbox
279 }% end of group with \turnoffactive
280 \advancepageno
281 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
284 \newinsert\margin \dimen\margin=\maxdimen
286 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
287 {\catcode`\@ =11
288 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
289 % marginal hacks, juha@viisa.uucp (Juha Takala)
290 \ifvoid\margin\else % marginal info is present
291 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
292 \dimen@=\dp#1 \unvbox#1
293 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
294 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
297 % Here are the rules for the cropmarks. Note that they are
298 % offset so that the space between them is truly \outerhsize or \outervsize
299 % (P. A. MacKay, 12 November, 1986)
301 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
302 \def\nstop{\vbox
303 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
304 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
305 \def\nsbot{\vbox
306 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
308 % Parse an argument, then pass it to #1. The argument is the rest of
309 % the input line (except we remove a trailing comment). #1 should be a
310 % macro which expects an ordinary undelimited TeX argument.
312 \def\parsearg#1{%
313 \let\next = #1%
314 \begingroup
315 \obeylines
316 \futurelet\temp\parseargx
319 % If the next token is an obeyed space (from an @example environment or
320 % the like), remove it and recurse. Otherwise, we're done.
321 \def\parseargx{%
322 % \obeyedspace is defined far below, after the definition of \sepspaces.
323 \ifx\obeyedspace\temp
324 \expandafter\parseargdiscardspace
325 \else
326 \expandafter\parseargline
330 % Remove a single space (as the delimiter token to the macro call).
331 {\obeyspaces %
332 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
334 {\obeylines %
335 \gdef\parseargline#1^^M{%
336 \endgroup % End of the group started in \parsearg.
338 % First remove any @c comment, then any @comment.
339 % Result of each macro is put in \toks0.
340 \argremovec #1\c\relax %
341 \expandafter\argremovecomment \the\toks0 \comment\relax %
343 % Call the caller's macro, saved as \next in \parsearg.
344 \expandafter\next\expandafter{\the\toks0}%
348 % Since all \c{,omment} does is throw away the argument, we can let TeX
349 % do that for us. The \relax here is matched by the \relax in the call
350 % in \parseargline; it could be more or less anything, its purpose is
351 % just to delimit the argument to the \c.
352 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
353 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
355 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
356 % @end itemize @c foo
357 % will have two active spaces as part of the argument with the
358 % `itemize'. Here we remove all active spaces from #1, and assign the
359 % result to \toks0.
361 % This loses if there are any *other* active characters besides spaces
362 % in the argument -- _ ^ +, for example -- since they get expanded.
363 % Fortunately, Texinfo does not define any such commands. (If it ever
364 % does, the catcode of the characters in questionwill have to be changed
365 % here.) But this means we cannot call \removeactivespaces as part of
366 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
367 % that \parsearg gets might well have any character at all in it.
369 \def\removeactivespaces#1{%
370 \begingroup
371 \ignoreactivespaces
372 \edef\temp{#1}%
373 \global\toks0 = \expandafter{\temp}%
374 \endgroup
377 % Change the active space to expand to nothing.
379 \begingroup
380 \obeyspaces
381 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
382 \endgroup
385 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
387 %% These are used to keep @begin/@end levels from running away
388 %% Call \inENV within environments (after a \begingroup)
389 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
390 \def\ENVcheck{%
391 \ifENV\errmessage{Still within an environment; press RETURN to continue}
392 \endgroup\fi} % This is not perfect, but it should reduce lossage
394 % @begin foo is the same as @foo, for now.
395 \newhelp\EMsimple{Press RETURN to continue.}
397 \outer\def\begin{\parsearg\beginxxx}
399 \def\beginxxx #1{%
400 \expandafter\ifx\csname #1\endcsname\relax
401 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
402 \csname #1\endcsname\fi}
404 % @end foo executes the definition of \Efoo.
406 \def\end{\parsearg\endxxx}
407 \def\endxxx #1{%
408 \removeactivespaces{#1}%
409 \edef\endthing{\the\toks0}%
411 \expandafter\ifx\csname E\endthing\endcsname\relax
412 \expandafter\ifx\csname \endthing\endcsname\relax
413 % There's no \foo, i.e., no ``environment'' foo.
414 \errhelp = \EMsimple
415 \errmessage{Undefined command `@end \endthing'}%
416 \else
417 \unmatchedenderror\endthing
419 \else
420 % Everything's ok; the right environment has been started.
421 \csname E\endthing\endcsname
425 % There is an environment #1, but it hasn't been started. Give an error.
427 \def\unmatchedenderror#1{%
428 \errhelp = \EMsimple
429 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
432 % Define the control sequence \E#1 to give an unmatched @end error.
434 \def\defineunmatchedend#1{%
435 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
439 % Single-spacing is done by various environments (specifically, in
440 % \nonfillstart and \quotations).
441 \newskip\singlespaceskip \singlespaceskip = 12.5pt
442 \def\singlespace{%
443 % Why was this kern here? It messes up equalizing space above and below
444 % environments. --karl, 6may93
445 %{\advance \baselineskip by -\singlespaceskip
446 %\kern \baselineskip}%
447 \setleading\singlespaceskip
450 %% Simple single-character @ commands
452 % @@ prints an @
453 % Kludge this until the fonts are right (grr).
454 \def\@{{\tt\char64}}
456 % This is turned off because it was never documented
457 % and you can use @w{...} around a quote to suppress ligatures.
458 %% Define @` and @' to be the same as ` and '
459 %% but suppressing ligatures.
460 %\def\`{{`}}
461 %\def\'{{'}}
463 % Used to generate quoted braces.
464 \def\mylbrace {{\tt\char123}}
465 \def\myrbrace {{\tt\char125}}
466 \let\{=\mylbrace
467 \let\}=\myrbrace
468 \begingroup
469 % Definitions to produce actual \{ & \} command in an index.
470 \catcode`\{ = 12 \catcode`\} = 12
471 \catcode`\[ = 1 \catcode`\] = 2
472 \catcode`\@ = 0 \catcode`\\ = 12
473 @gdef@lbracecmd[\{]%
474 @gdef@rbracecmd[\}]%
475 @endgroup
477 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
478 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
479 \let\, = \c
480 \let\dotaccent = \.
481 \def\ringaccent#1{{\accent23 #1}}
482 \let\tieaccent = \t
483 \let\ubaraccent = \b
484 \let\udotaccent = \d
486 % Other special characters: @questiondown @exclamdown
487 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
488 \def\questiondown{?`}
489 \def\exclamdown{!`}
491 % Dotless i and dotless j, used for accents.
492 \def\imacro{i}
493 \def\jmacro{j}
494 \def\dotless#1{%
495 \def\temp{#1}%
496 \ifx\temp\imacro \ptexi
497 \else\ifx\temp\jmacro \j
498 \else \errmessage{@dotless can be used only with i or j}%
499 \fi\fi
502 % Be sure we're in horizontal mode when doing a tie, since we make space
503 % equivalent to this in @example-like environments. Otherwise, a space
504 % at the beginning of a line will start with \penalty -- and
505 % since \penalty is valid in vertical mode, we'd end up putting the
506 % penalty on the vertical list instead of in the new paragraph.
507 {\catcode`@ = 11
508 % Avoid using \@M directly, because that causes trouble
509 % if the definition is written into an index file.
510 \global\let\tiepenalty = \@M
511 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
514 % @: forces normal size whitespace following.
515 \def\:{\spacefactor=1000 }
517 % @* forces a line break.
518 \def\*{\hfil\break\hbox{}\ignorespaces}
520 % @. is an end-of-sentence period.
521 \def\.{.\spacefactor=3000 }
523 % @! is an end-of-sentence bang.
524 \def\!{!\spacefactor=3000 }
526 % @? is an end-of-sentence query.
527 \def\?{?\spacefactor=3000 }
529 % @w prevents a word break. Without the \leavevmode, @w at the
530 % beginning of a paragraph, when TeX is still in vertical mode, would
531 % produce a whole line of output instead of starting the paragraph.
532 \def\w#1{\leavevmode\hbox{#1}}
534 % @group ... @end group forces ... to be all on one page, by enclosing
535 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
536 % to keep its height that of a normal line. According to the rules for
537 % \topskip (p.114 of the TeXbook), the glue inserted is
538 % max (\topskip - \ht (first item), 0). If that height is large,
539 % therefore, no glue is inserted, and the space between the headline and
540 % the text is small, which looks bad.
542 \def\group{\begingroup
543 \ifnum\catcode13=\active \else
544 \errhelp = \groupinvalidhelp
545 \errmessage{@group invalid in context where filling is enabled}%
548 % The \vtop we start below produces a box with normal height and large
549 % depth; thus, TeX puts \baselineskip glue before it, and (when the
550 % next line of text is done) \lineskip glue after it. (See p.82 of
551 % the TeXbook.) Thus, space below is not quite equal to space
552 % above. But it's pretty close.
553 \def\Egroup{%
554 \egroup % End the \vtop.
555 \endgroup % End the \group.
558 \vtop\bgroup
559 % We have to put a strut on the last line in case the @group is in
560 % the midst of an example, rather than completely enclosing it.
561 % Otherwise, the interline space between the last line of the group
562 % and the first line afterwards is too small. But we can't put the
563 % strut in \Egroup, since there it would be on a line by itself.
564 % Hence this just inserts a strut at the beginning of each line.
565 \everypar = {\strut}%
567 % Since we have a strut on every line, we don't need any of TeX's
568 % normal interline spacing.
569 \offinterlineskip
571 % OK, but now we have to do something about blank
572 % lines in the input in @example-like environments, which normally
573 % just turn into \lisppar, which will insert no space now that we've
574 % turned off the interline space. Simplest is to make them be an
575 % empty paragraph.
576 \ifx\par\lisppar
577 \edef\par{\leavevmode \par}%
579 % Reset ^^M's definition to new definition of \par.
580 \obeylines
583 % Do @comment since we are called inside an environment such as
584 % @example, where each end-of-line in the input causes an
585 % end-of-line in the output. We don't want the end-of-line after
586 % the `@group' to put extra space in the output. Since @group
587 % should appear on a line by itself (according to the Texinfo
588 % manual), we don't worry about eating any user text.
589 \comment
592 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
593 % message, so this ends up printing `@group can only ...'.
595 \newhelp\groupinvalidhelp{%
596 group can only be used in environments such as @example,^^J%
597 where each line of input produces a line of output.}
599 % @need space-in-mils
600 % forces a page break if there is not space-in-mils remaining.
602 \newdimen\mil \mil=0.001in
604 \def\need{\parsearg\needx}
606 % Old definition--didn't work.
607 %\def\needx #1{\par %
608 %% This method tries to make TeX break the page naturally
609 %% if the depth of the box does not fit.
610 %{\baselineskip=0pt%
611 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
612 %\prevdepth=-1000pt
615 \def\needx#1{%
616 % Ensure vertical mode, so we don't make a big box in the middle of a
617 % paragraph.
618 \par
620 % If the @need value is less than one line space, it's useless.
621 \dimen0 = #1\mil
622 \dimen2 = \ht\strutbox
623 \advance\dimen2 by \dp\strutbox
624 \ifdim\dimen0 > \dimen2
626 % Do a \strut just to make the height of this box be normal, so the
627 % normal leading is inserted relative to the preceding line.
628 % And a page break here is fine.
629 \vtop to #1\mil{\strut\vfil}%
631 % TeX does not even consider page breaks if a penalty added to the
632 % main vertical list is 10000 or more. But in order to see if the
633 % empty box we just added fits on the page, we must make it consider
634 % page breaks. On the other hand, we don't want to actually break the
635 % page after the empty box. So we use a penalty of 9999.
637 % There is an extremely small chance that TeX will actually break the
638 % page at this \penalty, if there are no other feasible breakpoints in
639 % sight. (If the user is using lots of big @group commands, which
640 % almost-but-not-quite fill up a page, TeX will have a hard time doing
641 % good page breaking, for example.) However, I could not construct an
642 % example where a page broke at this \penalty; if it happens in a real
643 % document, then we can reconsider our strategy.
644 \penalty9999
646 % Back up by the size of the box, whether we did a page break or not.
647 \kern -#1\mil
649 % Do not allow a page break right after this kern.
650 \nobreak
654 % @br forces paragraph break
656 \let\br = \par
658 % @dots{} output an ellipsis using the current font.
659 % We do .5em per period so that it has the same spacing in a typewriter
660 % font as three actual period characters.
662 \def\dots{%
663 \leavevmode
664 \hbox to 1.5em{%
665 \hskip 0pt plus 0.25fil minus 0.25fil
666 .\hss.\hss.%
667 \hskip 0pt plus 0.5fil minus 0.5fil
671 % @enddots{} is an end-of-sentence ellipsis.
673 \def\enddots{%
674 \leavevmode
675 \hbox to 2em{%
676 \hskip 0pt plus 0.25fil minus 0.25fil
677 .\hss.\hss.\hss.%
678 \hskip 0pt plus 0.5fil minus 0.5fil
680 \spacefactor=3000
684 % @page forces the start of a new page
686 \def\page{\par\vfill\supereject}
688 % @exdent text....
689 % outputs text on separate line in roman font, starting at standard page margin
691 % This records the amount of indent in the innermost environment.
692 % That's how much \exdent should take out.
693 \newskip\exdentamount
695 % This defn is used inside fill environments such as @defun.
696 \def\exdent{\parsearg\exdentyyy}
697 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
699 % This defn is used inside nofill environments such as @example.
700 \def\nofillexdent{\parsearg\nofillexdentyyy}
701 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
702 \leftline{\hskip\leftskip{\rm#1}}}}
704 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
705 % paragraph. For more general purposes, use the \margin insertion
706 % class. WHICH is `l' or `r'.
708 \newskip\inmarginspacing \inmarginspacing=1cm
709 \def\strutdepth{\dp\strutbox}
711 \def\doinmargin#1#2{\strut\vadjust{%
712 \nobreak
713 \kern-\strutdepth
714 \vtop to \strutdepth{%
715 \baselineskip=\strutdepth
716 \vss
717 % if you have multiple lines of stuff to put here, you'll need to
718 % make the vbox yourself of the appropriate size.
719 \ifx#1l%
720 \llap{\ignorespaces #2\hskip\inmarginspacing}%
721 \else
722 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
724 \null
727 \def\inleftmargin{\doinmargin l}
728 \def\inrightmargin{\doinmargin r}
730 % @inmargin{TEXT [, RIGHT-TEXT]}
731 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
732 % else use TEXT for both).
734 \def\inmargin#1{\parseinmargin #1,,\finish}
735 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
736 \setbox0 = \hbox{\ignorespaces #2}%
737 \ifdim\wd0 > 0pt
738 \def\lefttext{#1}% have both texts
739 \def\righttext{#2}%
740 \else
741 \def\lefttext{#1}% have only one text
742 \def\righttext{#1}%
745 \ifodd\pageno
746 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
747 \else
748 \def\temp{\inleftmargin\lefttext}%
750 \temp
753 % @include file insert text of that file as input.
754 % Allow normal characters that we make active in the argument (a file name).
755 \def\include{\begingroup
756 \catcode`\\=12
757 \catcode`~=12
758 \catcode`^=12
759 \catcode`_=12
760 \catcode`|=12
761 \catcode`<=12
762 \catcode`>=12
763 \catcode`+=12
764 \parsearg\includezzz}
765 % Restore active chars for included file.
766 \def\includezzz#1{\endgroup\begingroup
767 % Read the included file in a group so nested @include's work.
768 \def\thisfile{#1}%
769 \input\thisfile
770 \endgroup}
772 \def\thisfile{}
774 % @center line outputs that line, centered
776 \def\center{\parsearg\centerzzz}
777 \def\centerzzz #1{{\advance\hsize by -\leftskip
778 \advance\hsize by -\rightskip
779 \centerline{#1}}}
781 % @sp n outputs n lines of vertical space
783 \def\sp{\parsearg\spxxx}
784 \def\spxxx #1{\vskip #1\baselineskip}
786 % @comment ...line which is ignored...
787 % @c is the same as @comment
788 % @ignore ... @end ignore is another way to write a comment
790 \def\comment{\begingroup \catcode`\^^M=\other%
791 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
792 \commentxxx}
793 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
795 \let\c=\comment
797 % @paragraphindent NCHARS
798 % We'll use ems for NCHARS, close enough.
799 % We cannot implement @paragraphindent asis, though.
801 \def\asisword{asis} % no translation, these are keywords
802 \def\noneword{none}
804 \def\paragraphindent{\parsearg\doparagraphindent}
805 \def\doparagraphindent#1{%
806 \def\temp{#1}%
807 \ifx\temp\asisword
808 \else
809 \ifx\temp\noneword
810 \defaultparindent = 0pt
811 \else
812 \defaultparindent = #1em
815 \parindent = \defaultparindent
818 % @exampleindent NCHARS
819 % We'll use ems for NCHARS like @paragraphindent.
820 % It seems @exampleindent asis isn't necessary, but
821 % I preserve it to make it similar to @paragraphindent.
822 \def\exampleindent{\parsearg\doexampleindent}
823 \def\doexampleindent#1{%
824 \def\temp{#1}%
825 \ifx\temp\asisword
826 \else
827 \ifx\temp\noneword
828 \lispnarrowing = 0pt
829 \else
830 \lispnarrowing = #1em
835 % @asis just yields its argument. Used with @table, for example.
837 \def\asis#1{#1}
839 % @math outputs its argument in math mode.
840 % We don't use $'s directly in the definition of \math because we need
841 % to set catcodes according to plain TeX first, to allow for subscripts,
842 % superscripts, special math chars, etc.
844 % @math does not do math typesetting in section titles, index
845 % entries, and other such contexts where the catcodes are set before
846 % @math gets a chance to work. This could perhaps be fixed, but for now
847 % at least we can have real math in the main text, where it's needed most.
849 \let\implicitmath = $%$ font-lock fix
851 % One complication: _ usually means subscripts, but it could also mean
852 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
853 % _ within @math be active (mathcode "8000), and distinguish by seeing
854 % if the current family is \slfam, which is what @var uses.
856 {\catcode95 = \active % 95 = _
857 \gdef\mathunderscore{%
858 \catcode95=\active
859 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
862 % Another complication: we want \\ (and @\) to output a \ character.
863 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
864 % this is not advertised and we don't care. Texinfo does not
865 % otherwise define @\.
867 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
868 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
870 \def\math{%
871 \tex
872 \mathcode`\_="8000 \mathunderscore
873 \let\\ = \mathbackslash
874 \implicitmath\finishmath}
875 \def\finishmath#1{#1\implicitmath\Etex}
877 % @bullet and @minus need the same treatment as @math, just above.
878 \def\bullet{\implicitmath\ptexbullet\implicitmath}
879 \def\minus{\implicitmath-\implicitmath}
881 % @refill is a no-op.
882 \let\refill=\relax
884 % If working on a large document in chapters, it is convenient to
885 % be able to disable indexing, cross-referencing, and contents, for test runs.
886 % This is done with @novalidate (before @setfilename).
888 \newif\iflinks \linkstrue % by default we want the aux files.
889 \let\novalidate = \linksfalse
891 % @setfilename is done at the beginning of every texinfo file.
892 % So open here the files we need to have open while reading the input.
893 % This makes it possible to make a .fmt file for texinfo.
894 \def\setfilename{%
895 \iflinks
896 \readauxfile
897 \fi % \openindices needs to do some work in any case.
898 \openindices
899 \fixbackslash % Turn off hack to swallow `\input texinfo'.
900 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
902 % If texinfo.cnf is present on the system, read it.
903 % Useful for site-wide @afourpaper, etc.
904 % Just to be on the safe side, close the input stream before the \input.
905 \openin 1 texinfo.cnf
906 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
907 \closein1
908 \temp
910 \comment % Ignore the actual filename.
913 % Called from \setfilename.
915 \def\openindices{%
916 \newindex{cp}%
917 \newcodeindex{fn}%
918 \newcodeindex{vr}%
919 \newcodeindex{tp}%
920 \newcodeindex{ky}%
921 \newcodeindex{pg}%
924 % @bye.
925 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
928 \message{pdf,}
929 % adobe `portable' document format
930 \newcount\tempnum
931 \newcount\lnkcount
932 \newtoks\filename
933 \newcount\filenamelength
934 \newcount\pgn
935 \newtoks\toksA
936 \newtoks\toksB
937 \newtoks\toksC
938 \newtoks\toksD
939 \newbox\boxA
940 \newcount\countA
941 \newif\ifpdf
942 \newif\ifpdfmakepagedest
944 \ifx\pdfoutput\undefined
945 \pdffalse
946 \let\pdfmkdest = \gobble
947 \let\pdfurl = \gobble
948 \let\endlink = \relax
949 \let\linkcolor = \relax
950 \let\pdfmakeoutlines = \relax
951 \else
952 \pdftrue
953 \pdfoutput = 1
954 \input pdfcolor
955 \def\dopdfimage#1#2#3{%
956 \def\imagewidth{#2}%
957 \def\imageheight{#3}%
958 % without \immediate, pdftex seg faults when the same image is
959 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
960 \ifnum\pdftexversion < 14
961 \immediate\pdfimage
962 \else
963 \immediate\pdfximage
965 \ifx\empty\imagewidth\else width \imagewidth \fi
966 \ifx\empty\imageheight\else height \imageheight \fi
967 \ifnum\pdftexversion<13
968 #1.pdf%
969 \else
970 {#1.pdf}%
972 \ifnum\pdftexversion < 14 \else
973 \pdfrefximage \pdflastximage
974 \fi}
975 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
976 \def\pdfmkpgn#1{#1}
977 \let\linkcolor = \Blue % was Cyan, but that seems light?
978 \def\endlink{\Black\pdfendlink}
979 % Adding outlines to PDF; macros for calculating structure of outlines
980 % come from Petr Olsak
981 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
982 \else \csname#1\endcsname \fi}
983 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
984 \advance\tempnum by1
985 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
986 \def\pdfmakeoutlines{{%
987 \openin 1 \jobname.toc
988 \ifeof 1\else\begingroup
989 \closein 1
990 \indexnofonts
991 \def\tt{}
992 \let\_ = \normalunderscore
993 % Thanh's hack / proper braces in bookmarks
994 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
995 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
997 \def\chapentry ##1##2##3{}
998 \let\appendixentry = \chapentry
999 \def\unnumbchapentry ##1##2{}
1000 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
1001 \def\unnumbsecentry ##1##2##3{\advancenumber{chap##2}}
1002 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
1003 \def\unnumbsubsecentry ##1##2##3##4{\advancenumber{sec##2.##3}}
1004 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
1005 \def\unnumbsubsubsecentry ##1##2##3##4##5{\advancenumber{subsec##2.##3.##4}}
1006 \input \jobname.toc
1007 \def\chapentry ##1##2##3{%
1008 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1009 \let\appendixentry = \chapentry
1010 \def\unnumbchapentry ##1##2{%
1011 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
1012 \def\secentry ##1##2##3##4{%
1013 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1014 \def\unnumbsecentry ##1##2##3{%
1015 \pdfoutline goto name{\pdfmkpgn{##3}}{##1}}
1016 \def\subsecentry ##1##2##3##4##5{%
1017 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1018 \def\unnumbsubsecentry ##1##2##3##4{%
1019 \pdfoutline goto name{\pdfmkpgn{##4}}{##1}}
1020 \def\subsubsecentry ##1##2##3##4##5##6{%
1021 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1022 \def\unnumbsubsubsecentry ##1##2##3##4##5{%
1023 \pdfoutline goto name{\pdfmkpgn{##5}}{##1}}
1024 \input \jobname.toc
1025 \endgroup\fi
1027 \def\makelinks #1,{%
1028 \def\params{#1}\def\E{END}%
1029 \ifx\params\E
1030 \let\nextmakelinks=\relax
1031 \else
1032 \let\nextmakelinks=\makelinks
1033 \ifnum\lnkcount>0,\fi
1034 \picknum{#1}%
1035 \startlink attr{/Border [0 0 0]}
1036 goto name{\pdfmkpgn{\the\pgn}}%
1037 \linkcolor #1%
1038 \advance\lnkcount by 1%
1039 \endlink
1041 \nextmakelinks
1043 \def\picknum#1{\expandafter\pn#1}
1044 \def\pn#1{%
1045 \def\p{#1}%
1046 \ifx\p\lbrace
1047 \let\nextpn=\ppn
1048 \else
1049 \let\nextpn=\ppnn
1050 \def\first{#1}
1052 \nextpn
1054 \def\ppn#1{\pgn=#1\gobble}
1055 \def\ppnn{\pgn=\first}
1056 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1057 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1058 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1059 \ifx\PP\D\let\nextsp\relax
1060 \else\let\nextsp\skipspaces
1061 \ifx\p\space\else\addtokens{\filename}{\PP}%
1062 \advance\filenamelength by 1
1065 \nextsp}
1066 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1067 \ifnum\pdftexversion < 14
1068 \let \startlink \pdfannotlink
1069 \else
1070 \let \startlink \pdfstartlink
1072 \def\pdfurl#1{%
1073 \begingroup
1074 \normalturnoffactive\def\@{@}%
1075 \let\value=\expandablevalue
1076 \leavevmode\Red
1077 \startlink attr{/Border [0 0 0]}%
1078 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1079 % #1
1080 \endgroup}
1081 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1082 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1083 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1084 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1085 \def\maketoks{%
1086 \expandafter\poptoks\the\toksA|ENDTOKS|
1087 \ifx\first0\adn0
1088 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1089 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1090 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1091 \else
1092 \ifnum0=\countA\else\makelink\fi
1093 \ifx\first.\let\next=\done\else
1094 \let\next=\maketoks
1095 \addtokens{\toksB}{\the\toksD}
1096 \ifx\first,\addtokens{\toksB}{\space}\fi
1098 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1099 \next}
1100 \def\makelink{\addtokens{\toksB}%
1101 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1102 \def\pdflink#1{%
1103 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1104 \linkcolor #1\endlink}
1105 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1106 \fi % \ifx\pdfoutput
1109 \message{fonts,}
1110 % Font-change commands.
1112 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1113 % So we set up a \sf analogous to plain's \rm, etc.
1114 \newfam\sffam
1115 \def\sf{\fam=\sffam \tensf}
1116 \let\li = \sf % Sometimes we call it \li, not \sf.
1118 % We don't need math for this one.
1119 \def\ttsl{\tenttsl}
1121 % Default leading.
1122 \newdimen\textleading \textleading = 13.2pt
1124 % Set the baselineskip to #1, and the lineskip and strut size
1125 % correspondingly. There is no deep meaning behind these magic numbers
1126 % used as factors; they just match (closely enough) what Knuth defined.
1128 \def\lineskipfactor{.08333}
1129 \def\strutheightpercent{.70833}
1130 \def\strutdepthpercent {.29167}
1132 \def\setleading#1{%
1133 \normalbaselineskip = #1\relax
1134 \normallineskip = \lineskipfactor\normalbaselineskip
1135 \normalbaselines
1136 \setbox\strutbox =\hbox{%
1137 \vrule width0pt height\strutheightpercent\baselineskip
1138 depth \strutdepthpercent \baselineskip
1142 % Set the font macro #1 to the font named #2, adding on the
1143 % specified font prefix (normally `cm').
1144 % #3 is the font's design size, #4 is a scale factor
1145 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1147 % Use cm as the default font prefix.
1148 % To specify the font prefix, you must define \fontprefix
1149 % before you read in texinfo.tex.
1150 \ifx\fontprefix\undefined
1151 \def\fontprefix{cm}
1153 % Support font families that don't use the same naming scheme as CM.
1154 \def\rmshape{r}
1155 \def\rmbshape{bx} %where the normal face is bold
1156 \def\bfshape{b}
1157 \def\bxshape{bx}
1158 \def\ttshape{tt}
1159 \def\ttbshape{tt}
1160 \def\ttslshape{sltt}
1161 \def\itshape{ti}
1162 \def\itbshape{bxti}
1163 \def\slshape{sl}
1164 \def\slbshape{bxsl}
1165 \def\sfshape{ss}
1166 \def\sfbshape{ss}
1167 \def\scshape{csc}
1168 \def\scbshape{csc}
1170 \newcount\mainmagstep
1171 \ifx\bigger\relax
1172 % not really supported.
1173 \let\mainmagstep=\magstep1
1174 \setfont\textrm\rmshape{12}{1000}
1175 \setfont\texttt\ttshape{12}{1000}
1176 \else
1177 \mainmagstep=\magstephalf
1178 \setfont\textrm\rmshape{10}{\mainmagstep}
1179 \setfont\texttt\ttshape{10}{\mainmagstep}
1181 % Instead of cmb10, you many want to use cmbx10.
1182 % cmbx10 is a prettier font on its own, but cmb10
1183 % looks better when embedded in a line with cmr10.
1184 \setfont\textbf\bfshape{10}{\mainmagstep}
1185 \setfont\textit\itshape{10}{\mainmagstep}
1186 \setfont\textsl\slshape{10}{\mainmagstep}
1187 \setfont\textsf\sfshape{10}{\mainmagstep}
1188 \setfont\textsc\scshape{10}{\mainmagstep}
1189 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1190 \font\texti=cmmi10 scaled \mainmagstep
1191 \font\textsy=cmsy10 scaled \mainmagstep
1193 % A few fonts for @defun, etc.
1194 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1195 \setfont\deftt\ttshape{10}{\magstep1}
1196 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1198 % Fonts for indices, footnotes, small examples (9pt).
1199 \setfont\smallrm\rmshape{9}{1000}
1200 \setfont\smalltt\ttshape{9}{1000}
1201 \setfont\smallbf\bfshape{10}{900}
1202 \setfont\smallit\itshape{9}{1000}
1203 \setfont\smallsl\slshape{9}{1000}
1204 \setfont\smallsf\sfshape{9}{1000}
1205 \setfont\smallsc\scshape{10}{900}
1206 \setfont\smallttsl\ttslshape{10}{900}
1207 \font\smalli=cmmi9
1208 \font\smallsy=cmsy9
1210 % Fonts for small examples (8pt).
1211 \setfont\smallerrm\rmshape{8}{1000}
1212 \setfont\smallertt\ttshape{8}{1000}
1213 \setfont\smallerbf\bfshape{10}{800}
1214 \setfont\smallerit\itshape{8}{1000}
1215 \setfont\smallersl\slshape{8}{1000}
1216 \setfont\smallersf\sfshape{8}{1000}
1217 \setfont\smallersc\scshape{10}{800}
1218 \setfont\smallerttsl\ttslshape{10}{800}
1219 \font\smalleri=cmmi8
1220 \font\smallersy=cmsy8
1222 % Fonts for title page:
1223 \setfont\titlerm\rmbshape{12}{\magstep3}
1224 \setfont\titleit\itbshape{10}{\magstep4}
1225 \setfont\titlesl\slbshape{10}{\magstep4}
1226 \setfont\titlett\ttbshape{12}{\magstep3}
1227 \setfont\titlettsl\ttslshape{10}{\magstep4}
1228 \setfont\titlesf\sfbshape{17}{\magstep1}
1229 \let\titlebf=\titlerm
1230 \setfont\titlesc\scbshape{10}{\magstep4}
1231 \font\titlei=cmmi12 scaled \magstep3
1232 \font\titlesy=cmsy10 scaled \magstep4
1233 \def\authorrm{\secrm}
1234 \def\authortt{\sectt}
1236 % Chapter (and unnumbered) fonts (17.28pt).
1237 \setfont\chaprm\rmbshape{12}{\magstep2}
1238 \setfont\chapit\itbshape{10}{\magstep3}
1239 \setfont\chapsl\slbshape{10}{\magstep3}
1240 \setfont\chaptt\ttbshape{12}{\magstep2}
1241 \setfont\chapttsl\ttslshape{10}{\magstep3}
1242 \setfont\chapsf\sfbshape{17}{1000}
1243 \let\chapbf=\chaprm
1244 \setfont\chapsc\scbshape{10}{\magstep3}
1245 \font\chapi=cmmi12 scaled \magstep2
1246 \font\chapsy=cmsy10 scaled \magstep3
1248 % Section fonts (14.4pt).
1249 \setfont\secrm\rmbshape{12}{\magstep1}
1250 \setfont\secit\itbshape{10}{\magstep2}
1251 \setfont\secsl\slbshape{10}{\magstep2}
1252 \setfont\sectt\ttbshape{12}{\magstep1}
1253 \setfont\secttsl\ttslshape{10}{\magstep2}
1254 \setfont\secsf\sfbshape{12}{\magstep1}
1255 \let\secbf\secrm
1256 \setfont\secsc\scbshape{10}{\magstep2}
1257 \font\seci=cmmi12 scaled \magstep1
1258 \font\secsy=cmsy10 scaled \magstep2
1260 % Subsection fonts (13.15pt).
1261 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1262 \setfont\ssecit\itbshape{10}{1315}
1263 \setfont\ssecsl\slbshape{10}{1315}
1264 \setfont\ssectt\ttbshape{12}{\magstephalf}
1265 \setfont\ssecttsl\ttslshape{10}{1315}
1266 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1267 \let\ssecbf\ssecrm
1268 \setfont\ssecsc\scbshape{10}{\magstep1}
1269 \font\sseci=cmmi12 scaled \magstephalf
1270 \font\ssecsy=cmsy10 scaled 1315
1271 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1272 % but that is not a standard magnification.
1274 % In order for the font changes to affect most math symbols and letters,
1275 % we have to define the \textfont of the standard families. Since
1276 % texinfo doesn't allow for producing subscripts and superscripts except
1277 % in the main text, we don't bother to reset \scriptfont and
1278 % \scriptscriptfont (which would also require loading a lot more fonts).
1280 \def\resetmathfonts{%
1281 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1282 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1283 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1286 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1287 % of just \STYLE. We do this so that font changes will continue to work
1288 % in math mode, where it is the current \fam that is relevant in most
1289 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1290 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1291 % redefine \bf itself.
1292 \def\textfonts{%
1293 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1294 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1295 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1296 \resetmathfonts \setleading{\textleading}}
1297 \def\titlefonts{%
1298 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1299 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1300 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1301 \let\tenttsl=\titlettsl
1302 \resetmathfonts \setleading{25pt}}
1303 \def\titlefont#1{{\titlefonts\rm #1}}
1304 \def\chapfonts{%
1305 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1306 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1307 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1308 \resetmathfonts \setleading{19pt}}
1309 \def\secfonts{%
1310 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1311 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1312 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1313 \resetmathfonts \setleading{16pt}}
1314 \def\subsecfonts{%
1315 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1316 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1317 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1318 \resetmathfonts \setleading{15pt}}
1319 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1320 \def\smallfonts{%
1321 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1322 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1323 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1324 \let\tenttsl=\smallttsl
1325 \resetmathfonts \setleading{10.5pt}}
1326 \def\smallerfonts{%
1327 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1328 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1329 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1330 \let\tenttsl=\smallerttsl
1331 \resetmathfonts \setleading{9.5pt}}
1332 \let\smallexamplefonts = \smallerfonts
1334 % Set up the default fonts, so we can use them for creating boxes.
1336 \textfonts
1338 % Define these so they can be easily changed for other fonts.
1339 \def\angleleft{$\langle$}
1340 \def\angleright{$\rangle$}
1342 % Count depth in font-changes, for error checks
1343 \newcount\fontdepth \fontdepth=0
1345 % Fonts for short table of contents.
1346 \setfont\shortcontrm\rmshape{12}{1000}
1347 \setfont\shortcontbf\bxshape{12}{1000}
1348 \setfont\shortcontsl\slshape{12}{1000}
1349 \setfont\shortconttt\ttshape{12}{1000}
1351 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1352 %% serif) and @ii for TeX italic
1354 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1355 % unless the following character is such as not to need one.
1356 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1357 \def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx}
1358 \def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx}
1360 \let\i=\smartitalic
1361 \let\var=\smartslanted
1362 \let\dfn=\smartslanted
1363 \let\emph=\smartitalic
1364 \let\cite=\smartslanted
1366 \def\b#1{{\bf #1}}
1367 \let\strong=\b
1369 % We can't just use \exhyphenpenalty, because that only has effect at
1370 % the end of a paragraph. Restore normal hyphenation at the end of the
1371 % group within which \nohyphenation is presumably called.
1373 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1374 \def\restorehyphenation{\hyphenchar\font = `- }
1376 \def\t#1{%
1377 {\tt \rawbackslash \frenchspacing #1}%
1378 \null
1380 \let\ttfont=\t
1381 \def\samp#1{`\tclose{#1}'\null}
1382 \setfont\keyrm\rmshape{8}{1000}
1383 \font\keysy=cmsy9
1384 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1385 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1386 \vbox{\hrule\kern-0.4pt
1387 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1388 \kern-0.4pt\hrule}%
1389 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1390 % The old definition, with no lozenge:
1391 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1392 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1394 % @file, @option are the same as @samp.
1395 \let\file=\samp
1396 \let\option=\samp
1398 % @code is a modification of @t,
1399 % which makes spaces the same size as normal in the surrounding text.
1400 \def\tclose#1{%
1402 % Change normal interword space to be same as for the current font.
1403 \spaceskip = \fontdimen2\font
1405 % Switch to typewriter.
1408 % But `\ ' produces the large typewriter interword space.
1409 \def\ {{\spaceskip = 0pt{} }}%
1411 % Turn off hyphenation.
1412 \nohyphenation
1414 \rawbackslash
1415 \frenchspacing
1418 \null
1421 % We *must* turn on hyphenation at `-' and `_' in \code.
1422 % Otherwise, it is too hard to avoid overfull hboxes
1423 % in the Emacs manual, the Library manual, etc.
1425 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1426 % both hyphenation at - and hyphenation within words.
1427 % We must therefore turn them both off (\tclose does that)
1428 % and arrange explicitly to hyphenate at a dash.
1429 % -- rms.
1431 \catcode`\-=\active
1432 \catcode`\_=\active
1434 \global\def\code{\begingroup
1435 \catcode`\-=\active \let-\codedash
1436 \catcode`\_=\active \let_\codeunder
1437 \codex
1440 % If we end up with any active - characters when handling the index,
1441 % just treat them as a normal -.
1442 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1445 \def\realdash{-}
1446 \def\codedash{-\discretionary{}{}{}}
1447 \def\codeunder{%
1448 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1449 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1450 % will therefore expand the active definition of _, which is us
1451 % (inside @code that is), therefore an endless loop.
1452 \ifusingtt{\ifmmode
1453 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1454 \else\normalunderscore \fi
1455 \discretionary{}{}{}}%
1456 {\_}%
1458 \def\codex #1{\tclose{#1}\endgroup}
1460 % @kbd is like @code, except that if the argument is just one @key command,
1461 % then @kbd has no effect.
1463 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1464 % `example' (@kbd uses ttsl only inside of @example and friends),
1465 % or `code' (@kbd uses normal tty font always).
1466 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1467 \def\kbdinputstylexxx#1{%
1468 \def\arg{#1}%
1469 \ifx\arg\worddistinct
1470 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1471 \else\ifx\arg\wordexample
1472 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1473 \else\ifx\arg\wordcode
1474 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1475 \fi\fi\fi
1477 \def\worddistinct{distinct}
1478 \def\wordexample{example}
1479 \def\wordcode{code}
1481 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1482 % the catcodes are wrong for parsearg to work.)
1483 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1485 \def\xkey{\key}
1486 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1487 \ifx\one\xkey\ifx\threex\three \key{#2}%
1488 \else{\tclose{\kbdfont\look}}\fi
1489 \else{\tclose{\kbdfont\look}}\fi}
1491 % For @url, @env, @command quotes seem unnecessary, so use \code.
1492 \let\url=\code
1493 \let\env=\code
1494 \let\command=\code
1496 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1497 % second argument specifying the text to display and an optional third
1498 % arg as text to display instead of (rather than in addition to) the url
1499 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1500 % a hypertex \special here.
1502 \def\uref#1{\douref #1,,,\finish}
1503 \def\douref#1,#2,#3,#4\finish{\begingroup
1504 \unsepspaces
1505 \pdfurl{#1}%
1506 \setbox0 = \hbox{\ignorespaces #3}%
1507 \ifdim\wd0 > 0pt
1508 \unhbox0 % third arg given, show only that
1509 \else
1510 \setbox0 = \hbox{\ignorespaces #2}%
1511 \ifdim\wd0 > 0pt
1512 \ifpdf
1513 \unhbox0 % PDF: 2nd arg given, show only it
1514 \else
1515 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1517 \else
1518 \code{#1}% only url given, so show it
1521 \endlink
1522 \endgroup}
1524 % rms does not like angle brackets --karl, 17may97.
1525 % So now @email is just like @uref, unless we are pdf.
1527 %\def\email#1{\angleleft{\tt #1}\angleright}
1528 \ifpdf
1529 \def\email#1{\doemail#1,,\finish}
1530 \def\doemail#1,#2,#3\finish{\begingroup
1531 \unsepspaces
1532 \pdfurl{mailto:#1}%
1533 \setbox0 = \hbox{\ignorespaces #2}%
1534 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1535 \endlink
1536 \endgroup}
1537 \else
1538 \let\email=\uref
1541 % Check if we are currently using a typewriter font. Since all the
1542 % Computer Modern typewriter fonts have zero interword stretch (and
1543 % shrink), and it is reasonable to expect all typewriter fonts to have
1544 % this property, we can check that font parameter.
1546 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1548 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1549 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1551 \def\dmn#1{\thinspace #1}
1553 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1555 % @l was never documented to mean ``switch to the Lisp font'',
1556 % and it is not used as such in any manual I can find. We need it for
1557 % Polish suppressed-l. --karl, 22sep96.
1558 %\def\l#1{{\li #1}\null}
1560 % Explicit font changes: @r, @sc, undocumented @ii.
1561 \def\r#1{{\rm #1}} % roman font
1562 \def\sc#1{{\smallcaps#1}} % smallcaps font
1563 \def\ii#1{{\it #1}} % italic font
1565 % @acronym downcases the argument and prints in smallcaps.
1566 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1568 % @pounds{} is a sterling sign.
1569 \def\pounds{{\it\$}}
1572 \message{page headings,}
1574 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1575 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1577 % First the title page. Must do @settitle before @titlepage.
1578 \newif\ifseenauthor
1579 \newif\iffinishedtitlepage
1581 % Do an implicit @contents or @shortcontents after @end titlepage if the
1582 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1584 \newif\ifsetcontentsaftertitlepage
1585 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1586 \newif\ifsetshortcontentsaftertitlepage
1587 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1589 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1590 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1591 \endgroup\page\hbox{}\page}
1593 \def\titlepage{\begingroup \parindent=0pt \textfonts
1594 \let\subtitlerm=\tenrm
1595 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1597 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
1598 \let\tt=\authortt}%
1600 % Leave some space at the very top of the page.
1601 \vglue\titlepagetopglue
1603 % Now you can print the title using @title.
1604 \def\title{\parsearg\titlezzz}%
1605 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1606 % print a rule at the page bottom also.
1607 \finishedtitlepagefalse
1608 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1609 % No rule at page bottom unless we print one at the top with @title.
1610 \finishedtitlepagetrue
1612 % Now you can put text using @subtitle.
1613 \def\subtitle{\parsearg\subtitlezzz}%
1614 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1616 % @author should come last, but may come many times.
1617 \def\author{\parsearg\authorzzz}%
1618 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1619 {\authorfont \leftline{##1}}}%
1621 % Most title ``pages'' are actually two pages long, with space
1622 % at the top of the second. We don't want the ragged left on the second.
1623 \let\oldpage = \page
1624 \def\page{%
1625 \iffinishedtitlepage\else
1626 \finishtitlepage
1628 \oldpage
1629 \let\page = \oldpage
1630 \hbox{}}%
1631 % \def\page{\oldpage \hbox{}}
1634 \def\Etitlepage{%
1635 \iffinishedtitlepage\else
1636 \finishtitlepage
1638 % It is important to do the page break before ending the group,
1639 % because the headline and footline are only empty inside the group.
1640 % If we use the new definition of \page, we always get a blank page
1641 % after the title page, which we certainly don't want.
1642 \oldpage
1643 \endgroup
1645 % Need this before the \...aftertitlepage checks so that if they are
1646 % in effect the toc pages will come out with page numbers.
1647 \HEADINGSon
1649 % If they want short, they certainly want long too.
1650 \ifsetshortcontentsaftertitlepage
1651 \shortcontents
1652 \contents
1653 \global\let\shortcontents = \relax
1654 \global\let\contents = \relax
1657 \ifsetcontentsaftertitlepage
1658 \contents
1659 \global\let\contents = \relax
1660 \global\let\shortcontents = \relax
1664 \def\finishtitlepage{%
1665 \vskip4pt \hrule height 2pt width \hsize
1666 \vskip\titlepagebottomglue
1667 \finishedtitlepagetrue
1670 %%% Set up page headings and footings.
1672 \let\thispage=\folio
1674 \newtoks\evenheadline % headline on even pages
1675 \newtoks\oddheadline % headline on odd pages
1676 \newtoks\evenfootline % footline on even pages
1677 \newtoks\oddfootline % footline on odd pages
1679 % Now make Tex use those variables
1680 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1681 \else \the\evenheadline \fi}}
1682 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1683 \else \the\evenfootline \fi}\HEADINGShook}
1684 \let\HEADINGShook=\relax
1686 % Commands to set those variables.
1687 % For example, this is what @headings on does
1688 % @evenheading @thistitle|@thispage|@thischapter
1689 % @oddheading @thischapter|@thispage|@thistitle
1690 % @evenfooting @thisfile||
1691 % @oddfooting ||@thisfile
1693 \def\evenheading{\parsearg\evenheadingxxx}
1694 \def\oddheading{\parsearg\oddheadingxxx}
1695 \def\everyheading{\parsearg\everyheadingxxx}
1697 \def\evenfooting{\parsearg\evenfootingxxx}
1698 \def\oddfooting{\parsearg\oddfootingxxx}
1699 \def\everyfooting{\parsearg\everyfootingxxx}
1701 {\catcode`\@=0 %
1703 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1704 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1705 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1707 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1708 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1709 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1711 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1713 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1714 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1715 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1717 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1718 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1719 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1721 % Leave some space for the footline. Hopefully ok to assume
1722 % @evenfooting will not be used by itself.
1723 \global\advance\pageheight by -\baselineskip
1724 \global\advance\vsize by -\baselineskip
1727 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1729 }% unbind the catcode of @.
1731 % @headings double turns headings on for double-sided printing.
1732 % @headings single turns headings on for single-sided printing.
1733 % @headings off turns them off.
1734 % @headings on same as @headings double, retained for compatibility.
1735 % @headings after turns on double-sided headings after this page.
1736 % @headings doubleafter turns on double-sided headings after this page.
1737 % @headings singleafter turns on single-sided headings after this page.
1738 % By default, they are off at the start of a document,
1739 % and turned `on' after @end titlepage.
1741 \def\headings #1 {\csname HEADINGS#1\endcsname}
1743 \def\HEADINGSoff{
1744 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1745 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1746 \HEADINGSoff
1747 % When we turn headings on, set the page number to 1.
1748 % For double-sided printing, put current file name in lower left corner,
1749 % chapter name on inside top of right hand pages, document
1750 % title on inside top of left hand pages, and page numbers on outside top
1751 % edge of all pages.
1752 \def\HEADINGSdouble{
1753 \global\pageno=1
1754 \global\evenfootline={\hfil}
1755 \global\oddfootline={\hfil}
1756 \global\evenheadline={\line{\folio\hfil\thistitle}}
1757 \global\oddheadline={\line{\thischapter\hfil\folio}}
1758 \global\let\contentsalignmacro = \chapoddpage
1760 \let\contentsalignmacro = \chappager
1762 % For single-sided printing, chapter title goes across top left of page,
1763 % page number on top right.
1764 \def\HEADINGSsingle{
1765 \global\pageno=1
1766 \global\evenfootline={\hfil}
1767 \global\oddfootline={\hfil}
1768 \global\evenheadline={\line{\thischapter\hfil\folio}}
1769 \global\oddheadline={\line{\thischapter\hfil\folio}}
1770 \global\let\contentsalignmacro = \chappager
1772 \def\HEADINGSon{\HEADINGSdouble}
1774 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1775 \let\HEADINGSdoubleafter=\HEADINGSafter
1776 \def\HEADINGSdoublex{%
1777 \global\evenfootline={\hfil}
1778 \global\oddfootline={\hfil}
1779 \global\evenheadline={\line{\folio\hfil\thistitle}}
1780 \global\oddheadline={\line{\thischapter\hfil\folio}}
1781 \global\let\contentsalignmacro = \chapoddpage
1784 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1785 \def\HEADINGSsinglex{%
1786 \global\evenfootline={\hfil}
1787 \global\oddfootline={\hfil}
1788 \global\evenheadline={\line{\thischapter\hfil\folio}}
1789 \global\oddheadline={\line{\thischapter\hfil\folio}}
1790 \global\let\contentsalignmacro = \chappager
1793 % Subroutines used in generating headings
1794 % This produces Day Month Year style of output.
1795 % Only define if not already defined, in case a txi-??.tex file has set
1796 % up a different format (e.g., txi-cs.tex does this).
1797 \ifx\today\undefined
1798 \def\today{%
1799 \number\day\space
1800 \ifcase\month
1801 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1802 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1803 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1805 \space\number\year}
1808 % @settitle line... specifies the title of the document, for headings.
1809 % It generates no output of its own.
1810 \def\thistitle{\putwordNoTitle}
1811 \def\settitle{\parsearg\settitlezzz}
1812 \def\settitlezzz #1{\gdef\thistitle{#1}}
1815 \message{tables,}
1816 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1818 % default indentation of table text
1819 \newdimen\tableindent \tableindent=.8in
1820 % default indentation of @itemize and @enumerate text
1821 \newdimen\itemindent \itemindent=.3in
1822 % margin between end of table item and start of table text.
1823 \newdimen\itemmargin \itemmargin=.1in
1825 % used internally for \itemindent minus \itemmargin
1826 \newdimen\itemmax
1828 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1829 % these defs.
1830 % They also define \itemindex
1831 % to index the item name in whatever manner is desired (perhaps none).
1833 \newif\ifitemxneedsnegativevskip
1835 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1837 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1838 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1840 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1841 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1843 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1844 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1846 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1847 \itemzzz {#1}}
1849 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1850 \itemzzz {#1}}
1852 \def\itemzzz #1{\begingroup %
1853 \advance\hsize by -\rightskip
1854 \advance\hsize by -\tableindent
1855 \setbox0=\hbox{\itemfont{#1}}%
1856 \itemindex{#1}%
1857 \nobreak % This prevents a break before @itemx.
1859 % If the item text does not fit in the space we have, put it on a line
1860 % by itself, and do not allow a page break either before or after that
1861 % line. We do not start a paragraph here because then if the next
1862 % command is, e.g., @kindex, the whatsit would get put into the
1863 % horizontal list on a line by itself, resulting in extra blank space.
1864 \ifdim \wd0>\itemmax
1866 % Make this a paragraph so we get the \parskip glue and wrapping,
1867 % but leave it ragged-right.
1868 \begingroup
1869 \advance\leftskip by-\tableindent
1870 \advance\hsize by\tableindent
1871 \advance\rightskip by0pt plus1fil
1872 \leavevmode\unhbox0\par
1873 \endgroup
1875 % We're going to be starting a paragraph, but we don't want the
1876 % \parskip glue -- logically it's part of the @item we just started.
1877 \nobreak \vskip-\parskip
1879 % Stop a page break at the \parskip glue coming up. Unfortunately
1880 % we can't prevent a possible page break at the following
1881 % \baselineskip glue.
1882 \nobreak
1883 \endgroup
1884 \itemxneedsnegativevskipfalse
1885 \else
1886 % The item text fits into the space. Start a paragraph, so that the
1887 % following text (if any) will end up on the same line.
1888 \noindent
1889 % Do this with kerns and \unhbox so that if there is a footnote in
1890 % the item text, it can migrate to the main vertical list and
1891 % eventually be printed.
1892 \nobreak\kern-\tableindent
1893 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1894 \unhbox0
1895 \nobreak\kern\dimen0
1896 \endgroup
1897 \itemxneedsnegativevskiptrue
1901 \def\item{\errmessage{@item while not in a table}}
1902 \def\itemx{\errmessage{@itemx while not in a table}}
1903 \def\kitem{\errmessage{@kitem while not in a table}}
1904 \def\kitemx{\errmessage{@kitemx while not in a table}}
1905 \def\xitem{\errmessage{@xitem while not in a table}}
1906 \def\xitemx{\errmessage{@xitemx while not in a table}}
1908 % Contains a kludge to get @end[description] to work.
1909 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1911 % @table, @ftable, @vtable.
1912 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1913 {\obeylines\obeyspaces%
1914 \gdef\tablex #1^^M{%
1915 \tabley\dontindex#1 \endtabley}}
1917 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1918 {\obeylines\obeyspaces%
1919 \gdef\ftablex #1^^M{%
1920 \tabley\fnitemindex#1 \endtabley
1921 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1922 \let\Etable=\relax}}
1924 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1925 {\obeylines\obeyspaces%
1926 \gdef\vtablex #1^^M{%
1927 \tabley\vritemindex#1 \endtabley
1928 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1929 \let\Etable=\relax}}
1931 \def\dontindex #1{}
1932 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1933 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1935 {\obeyspaces %
1936 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1937 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1939 \def\tablez #1#2#3#4#5#6{%
1940 \aboveenvbreak %
1941 \begingroup %
1942 \def\Edescription{\Etable}% Necessary kludge.
1943 \let\itemindex=#1%
1944 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1945 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1946 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1947 \def\itemfont{#2}%
1948 \itemmax=\tableindent %
1949 \advance \itemmax by -\itemmargin %
1950 \advance \leftskip by \tableindent %
1951 \exdentamount=\tableindent
1952 \parindent = 0pt
1953 \parskip = \smallskipamount
1954 \ifdim \parskip=0pt \parskip=2pt \fi%
1955 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1956 \let\item = \internalBitem %
1957 \let\itemx = \internalBitemx %
1958 \let\kitem = \internalBkitem %
1959 \let\kitemx = \internalBkitemx %
1960 \let\xitem = \internalBxitem %
1961 \let\xitemx = \internalBxitemx %
1964 % This is the counter used by @enumerate, which is really @itemize
1966 \newcount \itemno
1968 \def\itemize{\parsearg\itemizezzz}
1970 \def\itemizezzz #1{%
1971 \begingroup % ended by the @end itemize
1972 \itemizey {#1}{\Eitemize}
1975 \def\itemizey #1#2{%
1976 \aboveenvbreak %
1977 \itemmax=\itemindent %
1978 \advance \itemmax by -\itemmargin %
1979 \advance \leftskip by \itemindent %
1980 \exdentamount=\itemindent
1981 \parindent = 0pt %
1982 \parskip = \smallskipamount %
1983 \ifdim \parskip=0pt \parskip=2pt \fi%
1984 \def#2{\endgraf\afterenvbreak\endgroup}%
1985 \def\itemcontents{#1}%
1986 \let\item=\itemizeitem}
1988 % Set sfcode to normal for the chars that usually have another value.
1989 % These are `.?!:;,'
1990 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1991 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1993 % \splitoff TOKENS\endmark defines \first to be the first token in
1994 % TOKENS, and \rest to be the remainder.
1996 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1998 % Allow an optional argument of an uppercase letter, lowercase letter,
1999 % or number, to specify the first label in the enumerated list. No
2000 % argument is the same as `1'.
2002 \def\enumerate{\parsearg\enumeratezzz}
2003 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2004 \def\enumeratey #1 #2\endenumeratey{%
2005 \begingroup % ended by the @end enumerate
2007 % If we were given no argument, pretend we were given `1'.
2008 \def\thearg{#1}%
2009 \ifx\thearg\empty \def\thearg{1}\fi
2011 % Detect if the argument is a single token. If so, it might be a
2012 % letter. Otherwise, the only valid thing it can be is a number.
2013 % (We will always have one token, because of the test we just made.
2014 % This is a good thing, since \splitoff doesn't work given nothing at
2015 % all -- the first parameter is undelimited.)
2016 \expandafter\splitoff\thearg\endmark
2017 \ifx\rest\empty
2018 % Only one token in the argument. It could still be anything.
2019 % A ``lowercase letter'' is one whose \lccode is nonzero.
2020 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2021 % not equal to itself.
2022 % Otherwise, we assume it's a number.
2024 % We need the \relax at the end of the \ifnum lines to stop TeX from
2025 % continuing to look for a <number>.
2027 \ifnum\lccode\expandafter`\thearg=0\relax
2028 \numericenumerate % a number (we hope)
2029 \else
2030 % It's a letter.
2031 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2032 \lowercaseenumerate % lowercase letter
2033 \else
2034 \uppercaseenumerate % uppercase letter
2037 \else
2038 % Multiple tokens in the argument. We hope it's a number.
2039 \numericenumerate
2043 % An @enumerate whose labels are integers. The starting integer is
2044 % given in \thearg.
2046 \def\numericenumerate{%
2047 \itemno = \thearg
2048 \startenumeration{\the\itemno}%
2051 % The starting (lowercase) letter is in \thearg.
2052 \def\lowercaseenumerate{%
2053 \itemno = \expandafter`\thearg
2054 \startenumeration{%
2055 % Be sure we're not beyond the end of the alphabet.
2056 \ifnum\itemno=0
2057 \errmessage{No more lowercase letters in @enumerate; get a bigger
2058 alphabet}%
2060 \char\lccode\itemno
2064 % The starting (uppercase) letter is in \thearg.
2065 \def\uppercaseenumerate{%
2066 \itemno = \expandafter`\thearg
2067 \startenumeration{%
2068 % Be sure we're not beyond the end of the alphabet.
2069 \ifnum\itemno=0
2070 \errmessage{No more uppercase letters in @enumerate; get a bigger
2071 alphabet}
2073 \char\uccode\itemno
2077 % Call itemizey, adding a period to the first argument and supplying the
2078 % common last two arguments. Also subtract one from the initial value in
2079 % \itemno, since @item increments \itemno.
2081 \def\startenumeration#1{%
2082 \advance\itemno by -1
2083 \itemizey{#1.}\Eenumerate\flushcr
2086 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2087 % to @enumerate.
2089 \def\alphaenumerate{\enumerate{a}}
2090 \def\capsenumerate{\enumerate{A}}
2091 \def\Ealphaenumerate{\Eenumerate}
2092 \def\Ecapsenumerate{\Eenumerate}
2094 % Definition of @item while inside @itemize.
2096 \def\itemizeitem{%
2097 \advance\itemno by 1
2098 {\let\par=\endgraf \smallbreak}%
2099 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2100 {\parskip=0in \hskip 0pt
2101 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2102 \vadjust{\penalty 1200}}%
2103 \flushcr}
2105 % @multitable macros
2106 % Amy Hendrickson, 8/18/94, 3/6/96
2108 % @multitable ... @end multitable will make as many columns as desired.
2109 % Contents of each column will wrap at width given in preamble. Width
2110 % can be specified either with sample text given in a template line,
2111 % or in percent of \hsize, the current width of text on page.
2113 % Table can continue over pages but will only break between lines.
2115 % To make preamble:
2117 % Either define widths of columns in terms of percent of \hsize:
2118 % @multitable @columnfractions .25 .3 .45
2119 % @item ...
2121 % Numbers following @columnfractions are the percent of the total
2122 % current hsize to be used for each column. You may use as many
2123 % columns as desired.
2126 % Or use a template:
2127 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2128 % @item ...
2129 % using the widest term desired in each column.
2131 % For those who want to use more than one line's worth of words in
2132 % the preamble, break the line within one argument and it
2133 % will parse correctly, i.e.,
2135 % @multitable {Column 1 template} {Column 2 template} {Column 3
2136 % template}
2137 % Not:
2138 % @multitable {Column 1 template} {Column 2 template}
2139 % {Column 3 template}
2141 % Each new table line starts with @item, each subsequent new column
2142 % starts with @tab. Empty columns may be produced by supplying @tab's
2143 % with nothing between them for as many times as empty columns are needed,
2144 % ie, @tab@tab@tab will produce two empty columns.
2146 % @item, @tab, @multitable or @end multitable do not need to be on their
2147 % own lines, but it will not hurt if they are.
2149 % Sample multitable:
2151 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2152 % @item first col stuff @tab second col stuff @tab third col
2153 % @item
2154 % first col stuff
2155 % @tab
2156 % second col stuff
2157 % @tab
2158 % third col
2159 % @item first col stuff @tab second col stuff
2160 % @tab Many paragraphs of text may be used in any column.
2162 % They will wrap at the width determined by the template.
2163 % @item@tab@tab This will be in third column.
2164 % @end multitable
2166 % Default dimensions may be reset by user.
2167 % @multitableparskip is vertical space between paragraphs in table.
2168 % @multitableparindent is paragraph indent in table.
2169 % @multitablecolmargin is horizontal space to be left between columns.
2170 % @multitablelinespace is space to leave between table items, baseline
2171 % to baseline.
2172 % 0pt means it depends on current normal line spacing.
2174 \newskip\multitableparskip
2175 \newskip\multitableparindent
2176 \newdimen\multitablecolspace
2177 \newskip\multitablelinespace
2178 \multitableparskip=0pt
2179 \multitableparindent=6pt
2180 \multitablecolspace=12pt
2181 \multitablelinespace=0pt
2183 % Macros used to set up halign preamble:
2185 \let\endsetuptable\relax
2186 \def\xendsetuptable{\endsetuptable}
2187 \let\columnfractions\relax
2188 \def\xcolumnfractions{\columnfractions}
2189 \newif\ifsetpercent
2191 % #1 is the part of the @columnfraction before the decimal point, which
2192 % is presumably either 0 or the empty string (but we don't check, we
2193 % just throw it away). #2 is the decimal part, which we use as the
2194 % percent of \hsize for this column.
2195 \def\pickupwholefraction#1.#2 {%
2196 \global\advance\colcount by 1
2197 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2198 \setuptable
2201 \newcount\colcount
2202 \def\setuptable#1{%
2203 \def\firstarg{#1}%
2204 \ifx\firstarg\xendsetuptable
2205 \let\go = \relax
2206 \else
2207 \ifx\firstarg\xcolumnfractions
2208 \global\setpercenttrue
2209 \else
2210 \ifsetpercent
2211 \let\go\pickupwholefraction
2212 \else
2213 \global\advance\colcount by 1
2214 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2215 % typically that is always in the input, anyway.
2216 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2219 \ifx\go\pickupwholefraction
2220 % Put the argument back for the \pickupwholefraction call, so
2221 % we'll always have a period there to be parsed.
2222 \def\go{\pickupwholefraction#1}%
2223 \else
2224 \let\go = \setuptable
2225 \fi%
2230 % This used to have \hskip1sp. But then the space in a template line is
2231 % not enough. That is bad. So let's go back to just & until we
2232 % encounter the problem it was intended to solve again.
2233 % --karl, nathan@acm.org, 20apr99.
2234 \def\tab{&}
2236 % @multitable ... @end multitable definitions:
2238 \def\multitable{\parsearg\dotable}
2239 \def\dotable#1{\bgroup
2240 \vskip\parskip
2241 \let\item\crcr
2242 \tolerance=9500
2243 \hbadness=9500
2244 \setmultitablespacing
2245 \parskip=\multitableparskip
2246 \parindent=\multitableparindent
2247 \overfullrule=0pt
2248 \global\colcount=0
2249 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2251 % To parse everything between @multitable and @item:
2252 \setuptable#1 \endsetuptable
2254 % \everycr will reset column counter, \colcount, at the end of
2255 % each line. Every column entry will cause \colcount to advance by one.
2256 % The table preamble
2257 % looks at the current \colcount to find the correct column width.
2258 \everycr{\noalign{%
2260 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2261 % Maybe so, but it also creates really weird page breaks when the table
2262 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2263 % manifests itself, so it can be fixed for real --karl.
2264 \global\colcount=0\relax}}%
2266 % This preamble sets up a generic column definition, which will
2267 % be used as many times as user calls for columns.
2268 % \vtop will set a single line and will also let text wrap and
2269 % continue for many paragraphs if desired.
2270 \halign\bgroup&\global\advance\colcount by 1\relax
2271 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2273 % In order to keep entries from bumping into each other
2274 % we will add a \leftskip of \multitablecolspace to all columns after
2275 % the first one.
2277 % If a template has been used, we will add \multitablecolspace
2278 % to the width of each template entry.
2280 % If the user has set preamble in terms of percent of \hsize we will
2281 % use that dimension as the width of the column, and the \leftskip
2282 % will keep entries from bumping into each other. Table will start at
2283 % left margin and final column will justify at right margin.
2285 % Make sure we don't inherit \rightskip from the outer environment.
2286 \rightskip=0pt
2287 \ifnum\colcount=1
2288 % The first column will be indented with the surrounding text.
2289 \advance\hsize by\leftskip
2290 \else
2291 \ifsetpercent \else
2292 % If user has not set preamble in terms of percent of \hsize
2293 % we will advance \hsize by \multitablecolspace.
2294 \advance\hsize by \multitablecolspace
2296 % In either case we will make \leftskip=\multitablecolspace:
2297 \leftskip=\multitablecolspace
2299 % Ignoring space at the beginning and end avoids an occasional spurious
2300 % blank line, when TeX decides to break the line at the space before the
2301 % box from the multistrut, so the strut ends up on a line by itself.
2302 % For example:
2303 % @multitable @columnfractions .11 .89
2304 % @item @code{#}
2305 % @tab Legal holiday which is valid in major parts of the whole country.
2306 % Is automatically provided with highlighting sequences respectively marking
2307 % characters.
2308 \noindent\ignorespaces##\unskip\multistrut}\cr
2311 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2312 % If so, do nothing. If not, give it an appropriate dimension based on
2313 % current baselineskip.
2314 \ifdim\multitablelinespace=0pt
2315 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2316 \global\advance\multitablelinespace by-\ht0
2317 %% strut to put in table in case some entry doesn't have descenders,
2318 %% to keep lines equally spaced
2319 \let\multistrut = \strut
2320 \else
2321 %% FIXME: what is \box0 supposed to be?
2322 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2323 width0pt\relax} \fi
2324 %% Test to see if parskip is larger than space between lines of
2325 %% table. If not, do nothing.
2326 %% If so, set to same dimension as multitablelinespace.
2327 \ifdim\multitableparskip>\multitablelinespace
2328 \global\multitableparskip=\multitablelinespace
2329 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2330 %% than skip between lines in the table.
2331 \fi%
2332 \ifdim\multitableparskip=0pt
2333 \global\multitableparskip=\multitablelinespace
2334 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2335 %% than skip between lines in the table.
2336 \fi}
2339 \message{conditionals,}
2340 % Prevent errors for section commands.
2341 % Used in @ignore and in failing conditionals.
2342 \def\ignoresections{%
2343 \let\chapter=\relax
2344 \let\unnumbered=\relax
2345 \let\top=\relax
2346 \let\unnumberedsec=\relax
2347 \let\unnumberedsection=\relax
2348 \let\unnumberedsubsec=\relax
2349 \let\unnumberedsubsection=\relax
2350 \let\unnumberedsubsubsec=\relax
2351 \let\unnumberedsubsubsection=\relax
2352 \let\section=\relax
2353 \let\subsec=\relax
2354 \let\subsubsec=\relax
2355 \let\subsection=\relax
2356 \let\subsubsection=\relax
2357 \let\appendix=\relax
2358 \let\appendixsec=\relax
2359 \let\appendixsection=\relax
2360 \let\appendixsubsec=\relax
2361 \let\appendixsubsection=\relax
2362 \let\appendixsubsubsec=\relax
2363 \let\appendixsubsubsection=\relax
2364 \let\contents=\relax
2365 \let\smallbook=\relax
2366 \let\titlepage=\relax
2369 % Used in nested conditionals, where we have to parse the Texinfo source
2370 % and so want to turn off most commands, in case they are used
2371 % incorrectly.
2373 \def\ignoremorecommands{%
2374 \let\defcodeindex = \relax
2375 \let\defcv = \relax
2376 \let\deffn = \relax
2377 \let\deffnx = \relax
2378 \let\defindex = \relax
2379 \let\defivar = \relax
2380 \let\defmac = \relax
2381 \let\defmethod = \relax
2382 \let\defop = \relax
2383 \let\defopt = \relax
2384 \let\defspec = \relax
2385 \let\deftp = \relax
2386 \let\deftypefn = \relax
2387 \let\deftypefun = \relax
2388 \let\deftypeivar = \relax
2389 \let\deftypeop = \relax
2390 \let\deftypevar = \relax
2391 \let\deftypevr = \relax
2392 \let\defun = \relax
2393 \let\defvar = \relax
2394 \let\defvr = \relax
2395 \let\ref = \relax
2396 \let\xref = \relax
2397 \let\printindex = \relax
2398 \let\pxref = \relax
2399 \let\settitle = \relax
2400 \let\setchapternewpage = \relax
2401 \let\setchapterstyle = \relax
2402 \let\everyheading = \relax
2403 \let\evenheading = \relax
2404 \let\oddheading = \relax
2405 \let\everyfooting = \relax
2406 \let\evenfooting = \relax
2407 \let\oddfooting = \relax
2408 \let\headings = \relax
2409 \let\include = \relax
2410 \let\lowersections = \relax
2411 \let\down = \relax
2412 \let\raisesections = \relax
2413 \let\up = \relax
2414 \let\set = \relax
2415 \let\clear = \relax
2416 \let\item = \relax
2419 % Ignore @ignore, @ifhtml, @ifinfo, @ifplaintext, @ifnottex, @html, @menu,
2420 % @direntry, and @documentdescription.
2422 \def\ignore{\doignore{ignore}}
2423 \def\ifhtml{\doignore{ifhtml}}
2424 \def\ifinfo{\doignore{ifinfo}}
2425 \def\ifplaintext{\doignore{ifplaintext}}
2426 \def\ifnottex{\doignore{ifnottex}}
2427 \def\html{\doignore{html}}
2428 \def\menu{\doignore{menu}}
2429 \def\direntry{\doignore{direntry}}
2430 \def\documentdescription{\doignore{documentdescription}}
2431 \def\documentdescriptionword{documentdescription}
2433 % @dircategory CATEGORY -- specify a category of the dir file
2434 % which this file should belong to. Ignore this in TeX.
2435 \let\dircategory = \comment
2437 % Ignore text until a line `@end #1'.
2439 \def\doignore#1{\begingroup
2440 % Don't complain about control sequences we have declared \outer.
2441 \ignoresections
2443 % Define a command to swallow text until we reach `@end #1'.
2444 % This @ is a catcode 12 token (that is the normal catcode of @ in
2445 % this texinfo.tex file). We change the catcode of @ below to match.
2446 \long\def\doignoretext##1@end #1{\enddoignore}%
2448 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2449 \catcode32 = 10
2451 % Ignore braces, too, so mismatched braces don't cause trouble.
2452 \catcode`\{ = 9
2453 \catcode`\} = 9
2455 % We must not have @c interpreted as a control sequence.
2456 \catcode`\@ = 12
2458 \def\ignoreword{#1}%
2459 \ifx\ignoreword\documentdescriptionword
2460 % The c kludge breaks documentdescription, since
2461 % `documentdescription' contains a `c'. Means not everything will
2462 % be ignored inside @documentdescription, but oh well...
2463 \else
2464 % Make the letter c a comment character so that the rest of the line
2465 % will be ignored. This way, the document can have (for example)
2466 % @c @end ifinfo
2467 % and the @end ifinfo will be properly ignored.
2468 % (We've just changed @ to catcode 12.)
2469 \catcode`\c = 14
2472 % And now expand the command defined above.
2473 \doignoretext
2476 % What we do to finish off ignored text.
2478 \def\enddoignore{\endgroup\ignorespaces}%
2480 \newif\ifwarnedobs\warnedobsfalse
2481 \def\obstexwarn{%
2482 \ifwarnedobs\relax\else
2483 % We need to warn folks that they may have trouble with TeX 3.0.
2484 % This uses \immediate\write16 rather than \message to get newlines.
2485 \immediate\write16{}
2486 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2487 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2488 \immediate\write16{If you are running another version of TeX, relax.}
2489 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2490 \immediate\write16{ Then upgrade your TeX installation if you can.}
2491 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2492 \immediate\write16{If you are stuck with version 3.0, run the}
2493 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2494 \immediate\write16{ to use a workaround.}
2495 \immediate\write16{}
2496 \global\warnedobstrue
2500 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2501 % workaround (which requires the file ``dummy.tfm'' to be installed),
2502 % uncomment the following line:
2503 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2505 % Ignore text, except that we keep track of conditional commands for
2506 % purposes of nesting, up to an `@end #1' command.
2508 \def\nestedignore#1{%
2509 \obstexwarn
2510 % We must actually expand the ignored text to look for the @end
2511 % command, so that nested ignore constructs work. Thus, we put the
2512 % text into a \vbox and then do nothing with the result. To minimize
2513 % the change of memory overflow, we follow the approach outlined on
2514 % page 401 of the TeXbook: make the current font be a dummy font.
2516 \setbox0 = \vbox\bgroup
2517 % Don't complain about control sequences we have declared \outer.
2518 \ignoresections
2520 % Define `@end #1' to end the box, which will in turn undefine the
2521 % @end command again.
2522 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2524 % We are going to be parsing Texinfo commands. Most cause no
2525 % trouble when they are used incorrectly, but some commands do
2526 % complicated argument parsing or otherwise get confused, so we
2527 % undefine them.
2529 % We can't do anything about stray @-signs, unfortunately;
2530 % they'll produce `undefined control sequence' errors.
2531 \ignoremorecommands
2533 % Set the current font to be \nullfont, a TeX primitive, and define
2534 % all the font commands to also use \nullfont. We don't use
2535 % dummy.tfm, as suggested in the TeXbook, because not all sites
2536 % might have that installed. Therefore, math mode will still
2537 % produce output, but that should be an extremely small amount of
2538 % stuff compared to the main input.
2540 \nullfont
2541 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2542 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2543 \let\tensf=\nullfont
2544 % Similarly for index fonts.
2545 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2546 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2547 \let\smallsf=\nullfont
2548 % Similarly for smallexample fonts.
2549 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2550 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2551 \let\smallersf=\nullfont
2553 % Don't complain when characters are missing from the fonts.
2554 \tracinglostchars = 0
2556 % Don't bother to do space factor calculations.
2557 \frenchspacing
2559 % Don't report underfull hboxes.
2560 \hbadness = 10000
2562 % Do minimal line-breaking.
2563 \pretolerance = 10000
2565 % Do not execute instructions in @tex
2566 \def\tex{\doignore{tex}}%
2567 % Do not execute macro definitions.
2568 % `c' is a comment character, so the word `macro' will get cut off.
2569 \def\macro{\doignore{ma}}%
2572 % @set VAR sets the variable VAR to an empty value.
2573 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2575 % Since we want to separate VAR from REST-OF-LINE (which might be
2576 % empty), we can't just use \parsearg; we have to insert a space of our
2577 % own to delimit the rest of the line, and then take it out again if we
2578 % didn't need it. Make sure the catcode of space is correct to avoid
2579 % losing inside @example, for instance.
2581 \def\set{\begingroup\catcode` =10
2582 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2583 \parsearg\setxxx}
2584 \def\setxxx#1{\setyyy#1 \endsetyyy}
2585 \def\setyyy#1 #2\endsetyyy{%
2586 \def\temp{#2}%
2587 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2588 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2590 \endgroup
2592 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2593 % \next or other control sequences that we've defined might get us into
2594 % an infinite loop. Consider `@set foo @cite{bar}'.
2595 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2597 % @clear VAR clears (i.e., unsets) the variable VAR.
2599 \def\clear{\parsearg\clearxxx}
2600 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2602 % @value{foo} gets the text saved in variable foo.
2604 \catcode`\_ = \active
2606 % We might end up with active _ or - characters in the argument if
2607 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2608 % such active characters to their normal equivalents.
2609 \gdef\value{\begingroup
2610 \catcode`\-=12 \catcode`\_=12
2611 \indexbreaks \let_\normalunderscore
2612 \valuexxx}
2614 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2616 % We have this subroutine so that we can handle at least some @value's
2617 % properly in indexes (we \let\value to this in \indexdummies). Ones
2618 % whose names contain - or _ still won't work, but we can't do anything
2619 % about that. The command has to be fully expandable, since the result
2620 % winds up in the index file. This means that if the variable's value
2621 % contains other Texinfo commands, it's almost certain it will fail
2622 % (although perhaps we could fix that with sufficient work to do a
2623 % one-level expansion on the result, instead of complete).
2625 \def\expandablevalue#1{%
2626 \expandafter\ifx\csname SET#1\endcsname\relax
2627 {[No value for ``#1'']}%
2628 \else
2629 \csname SET#1\endcsname
2633 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2634 % with @set.
2636 \def\ifset{\parsearg\ifsetxxx}
2637 \def\ifsetxxx #1{%
2638 \expandafter\ifx\csname SET#1\endcsname\relax
2639 \expandafter\ifsetfail
2640 \else
2641 \expandafter\ifsetsucceed
2644 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2645 \def\ifsetfail{\nestedignore{ifset}}
2646 \defineunmatchedend{ifset}
2648 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2649 % defined with @set, or has been undefined with @clear.
2651 \def\ifclear{\parsearg\ifclearxxx}
2652 \def\ifclearxxx #1{%
2653 \expandafter\ifx\csname SET#1\endcsname\relax
2654 \expandafter\ifclearsucceed
2655 \else
2656 \expandafter\ifclearfail
2659 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2660 \def\ifclearfail{\nestedignore{ifclear}}
2661 \defineunmatchedend{ifclear}
2663 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2664 % read the text following, through the first @end iftex (etc.). Make
2665 % `@end iftex' (etc.) valid only after an @iftex.
2667 \def\iftex{\conditionalsucceed{iftex}}
2668 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2669 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2670 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2671 \defineunmatchedend{iftex}
2672 \defineunmatchedend{ifnothtml}
2673 \defineunmatchedend{ifnotinfo}
2674 \defineunmatchedend{ifnotplaintext}
2676 % We can't just want to start a group at @iftex (etc.) and end it at
2677 % @end iftex, since then @set commands inside the conditional have no
2678 % effect (they'd get reverted at the end of the group). So we must
2679 % define \Eiftex to redefine itself to be its previous value. (We can't
2680 % just define it to fail again with an ``unmatched end'' error, since
2681 % the @ifset might be nested.)
2683 \def\conditionalsucceed#1{%
2684 \edef\temp{%
2685 % Remember the current value of \E#1.
2686 \let\nece{prevE#1} = \nece{E#1}%
2688 % At the `@end #1', redefine \E#1 to be its previous value.
2689 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2691 \temp
2694 % We need to expand lots of \csname's, but we don't want to expand the
2695 % control sequences after we've constructed them.
2697 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2699 % @defininfoenclose.
2700 \let\definfoenclose=\comment
2703 \message{indexing,}
2704 % Index generation facilities
2706 % Define \newwrite to be identical to plain tex's \newwrite
2707 % except not \outer, so it can be used within \newindex.
2708 {\catcode`\@=11
2709 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2711 % \newindex {foo} defines an index named foo.
2712 % It automatically defines \fooindex such that
2713 % \fooindex ...rest of line... puts an entry in the index foo.
2714 % It also defines \fooindfile to be the number of the output channel for
2715 % the file that accumulates this index. The file's extension is foo.
2716 % The name of an index should be no more than 2 characters long
2717 % for the sake of vms.
2719 \def\newindex#1{%
2720 \iflinks
2721 \expandafter\newwrite \csname#1indfile\endcsname
2722 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2724 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2725 \noexpand\doindex{#1}}
2728 % @defindex foo == \newindex{foo}
2730 \def\defindex{\parsearg\newindex}
2732 % Define @defcodeindex, like @defindex except put all entries in @code.
2734 \def\defcodeindex{\parsearg\newcodeindex}
2736 \def\newcodeindex#1{%
2737 \iflinks
2738 \expandafter\newwrite \csname#1indfile\endcsname
2739 \openout \csname#1indfile\endcsname \jobname.#1
2741 \expandafter\xdef\csname#1index\endcsname{%
2742 \noexpand\docodeindex{#1}}%
2746 % @synindex foo bar makes index foo feed into index bar.
2747 % Do this instead of @defindex foo if you don't want it as a separate index.
2749 % @syncodeindex foo bar similar, but put all entries made for index foo
2750 % inside @code.
2752 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2753 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2755 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2756 % #3 the target index (bar).
2757 \def\dosynindex#1#2#3{%
2758 % Only do \closeout if we haven't already done it, else we'll end up
2759 % closing the target index.
2760 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2761 % The \closeout helps reduce unnecessary open files; the limit on the
2762 % Acorn RISC OS is a mere 16 files.
2763 \expandafter\closeout\csname#2indfile\endcsname
2764 \expandafter\let\csname\donesynindex#2\endcsname = 1
2766 % redefine \fooindfile:
2767 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2768 \expandafter\let\csname#2indfile\endcsname=\temp
2769 % redefine \fooindex:
2770 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2773 % Define \doindex, the driver for all \fooindex macros.
2774 % Argument #1 is generated by the calling \fooindex macro,
2775 % and it is "foo", the name of the index.
2777 % \doindex just uses \parsearg; it calls \doind for the actual work.
2778 % This is because \doind is more useful to call from other macros.
2780 % There is also \dosubind {index}{topic}{subtopic}
2781 % which makes an entry in a two-level index such as the operation index.
2783 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2784 \def\singleindexer #1{\doind{\indexname}{#1}}
2786 % like the previous two, but they put @code around the argument.
2787 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2788 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2790 % Take care of texinfo commands likely to appear in an index entry.
2791 % (Must be a way to avoid doing expansion at all, and thus not have to
2792 % laboriously list every single command here.)
2794 \def\indexdummies{%
2795 \def\ { }%
2796 \def\@{@}% change to @@ when we switch to @ as escape char in aux files.
2797 % Need these in case \tex is in effect and \{ is a \delimiter again.
2798 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2799 % braces and backslashes are used only as delimiters.
2800 \let\{ = \mylbrace
2801 \let\} = \myrbrace
2802 \def\_{{\realbackslash _}}%
2803 \normalturnoffactive
2805 % Take care of the plain tex accent commands.
2806 \def\,##1{\realbackslash ,{##1}}%
2807 \def\"{\realbackslash "}%
2808 \def\`{\realbackslash `}%
2809 \def\'{\realbackslash '}%
2810 \def\^{\realbackslash ^}%
2811 \def\~{\realbackslash ~}%
2812 \def\={\realbackslash =}%
2813 \def\b{\realbackslash b}%
2814 \def\c{\realbackslash c}%
2815 \def\d{\realbackslash d}%
2816 \def\u{\realbackslash u}%
2817 \def\v{\realbackslash v}%
2818 \def\H{\realbackslash H}%
2819 \def\dotless##1{\realbackslash dotless {##1}}%
2820 % Take care of the plain tex special European modified letters.
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\aa{\realbackslash aa}%
2827 \def\ae{\realbackslash ae}%
2828 \def\l{\realbackslash l}%
2829 \def\oe{\realbackslash oe}%
2830 \def\o{\realbackslash o}%
2831 \def\ss{\realbackslash ss}%
2833 % Although these internals commands shouldn't show up, sometimes they do.
2834 \def\bf{\realbackslash bf }%
2835 \def\gtr{\realbackslash gtr}%
2836 \def\hat{\realbackslash hat}%
2837 \def\less{\realbackslash less}%
2838 %\def\rm{\realbackslash rm }%
2839 \def\sf{\realbackslash sf}%
2840 \def\sl{\realbackslash sl }%
2841 \def\tclose##1{\realbackslash tclose {##1}}%
2842 \def\tt{\realbackslash tt}%
2844 \def\b##1{\realbackslash b {##1}}%
2845 \def\i##1{\realbackslash i {##1}}%
2846 \def\sc##1{\realbackslash sc {##1}}%
2847 \def\t##1{\realbackslash t {##1}}%
2848 \def\r##1{\realbackslash r {##1}}%
2850 \def\TeX{\realbackslash TeX}%
2851 \def\acronym##1{\realbackslash acronym {##1}}%
2852 \def\cite##1{\realbackslash cite {##1}}%
2853 \def\code##1{\realbackslash code {##1}}%
2854 \def\command##1{\realbackslash command {##1}}%
2855 \def\dfn##1{\realbackslash dfn {##1}}%
2856 \def\dots{\realbackslash dots }%
2857 \def\emph##1{\realbackslash emph {##1}}%
2858 \def\env##1{\realbackslash env {##1}}%
2859 \def\file##1{\realbackslash file {##1}}%
2860 \def\kbd##1{\realbackslash kbd {##1}}%
2861 \def\key##1{\realbackslash key {##1}}%
2862 \def\math##1{\realbackslash math {##1}}%
2863 \def\option##1{\realbackslash option {##1}}%
2864 \def\samp##1{\realbackslash samp {##1}}%
2865 \def\strong##1{\realbackslash strong {##1}}%
2866 \def\uref##1{\realbackslash uref {##1}}%
2867 \def\url##1{\realbackslash url {##1}}%
2868 \def\var##1{\realbackslash var {##1}}%
2869 \def\w{\realbackslash w }%
2871 % These math commands don't seem likely to be used in index entries.
2872 \def\copyright{\realbackslash copyright}%
2873 \def\equiv{\realbackslash equiv}%
2874 \def\error{\realbackslash error}%
2875 \def\expansion{\realbackslash expansion}%
2876 \def\point{\realbackslash point}%
2877 \def\print{\realbackslash print}%
2878 \def\result{\realbackslash result}%
2880 % Handle some cases of @value -- where the variable name does not
2881 % contain - or _, and the value does not contain any
2882 % (non-fully-expandable) commands.
2883 \let\value = \expandablevalue
2885 \unsepspaces
2886 % Turn off macro expansion
2887 \turnoffmacros
2890 % If an index command is used in an @example environment, any spaces
2891 % therein should become regular spaces in the raw index file, not the
2892 % expansion of \tie (\leavevmode \penalty \@M \ ).
2893 {\obeyspaces
2894 \gdef\unsepspaces{\obeyspaces\let =\space}}
2896 % \indexnofonts no-ops all font-change commands.
2897 % This is used when outputting the strings to sort the index by.
2898 \def\indexdummyfont#1{#1}
2899 \def\indexdummytex{TeX}
2900 \def\indexdummydots{...}
2902 \def\indexnofonts{%
2903 \def\@{@}%
2904 % how to handle braces?
2905 \def\_{\normalunderscore}%
2907 \let\,=\indexdummyfont
2908 \let\"=\indexdummyfont
2909 \let\`=\indexdummyfont
2910 \let\'=\indexdummyfont
2911 \let\^=\indexdummyfont
2912 \let\~=\indexdummyfont
2913 \let\==\indexdummyfont
2914 \let\b=\indexdummyfont
2915 \let\c=\indexdummyfont
2916 \let\d=\indexdummyfont
2917 \let\u=\indexdummyfont
2918 \let\v=\indexdummyfont
2919 \let\H=\indexdummyfont
2920 \let\dotless=\indexdummyfont
2921 % Take care of the plain tex special European modified letters.
2922 \def\AA{AA}%
2923 \def\AE{AE}%
2924 \def\L{L}%
2925 \def\OE{OE}%
2926 \def\O{O}%
2927 \def\aa{aa}%
2928 \def\ae{ae}%
2929 \def\l{l}%
2930 \def\oe{oe}%
2931 \def\o{o}%
2932 \def\ss{ss}%
2934 % Don't no-op \tt, since it isn't a user-level command
2935 % and is used in the definitions of the active chars like <, >, |, etc.
2936 % Likewise with the other plain tex font commands.
2937 %\let\tt=\indexdummyfont
2939 \let\b=\indexdummyfont
2940 \let\i=\indexdummyfont
2941 \let\r=\indexdummyfont
2942 \let\sc=\indexdummyfont
2943 \let\t=\indexdummyfont
2945 \let\TeX=\indexdummytex
2946 \let\acronym=\indexdummyfont
2947 \let\cite=\indexdummyfont
2948 \let\code=\indexdummyfont
2949 \let\command=\indexdummyfont
2950 \let\dfn=\indexdummyfont
2951 \let\dots=\indexdummydots
2952 \let\emph=\indexdummyfont
2953 \let\env=\indexdummyfont
2954 \let\file=\indexdummyfont
2955 \let\kbd=\indexdummyfont
2956 \let\key=\indexdummyfont
2957 \let\math=\indexdummyfont
2958 \let\option=\indexdummyfont
2959 \let\samp=\indexdummyfont
2960 \let\strong=\indexdummyfont
2961 \let\uref=\indexdummyfont
2962 \let\url=\indexdummyfont
2963 \let\var=\indexdummyfont
2964 \let\w=\indexdummyfont
2967 % To define \realbackslash, we must make \ not be an escape.
2968 % We must first make another character (@) an escape
2969 % so we do not become unable to do a definition.
2971 {\catcode`\@=0 \catcode`\\=\other
2972 @gdef@realbackslash{\}}
2974 \let\indexbackslash=0 %overridden during \printindex.
2975 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2977 % For \ifx comparisons.
2978 \def\emptymacro{\empty}
2980 % Most index entries go through here, but \dosubind is the general case.
2982 \def\doind#1#2{\dosubind{#1}{#2}\empty}
2984 % Workhorse for all \fooindexes.
2985 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2986 % \empty if called from \doind, as we usually are. The main exception
2987 % is with defuns, which call us directly.
2989 \def\dosubind#1#2#3{%
2990 % Put the index entry in the margin if desired.
2991 \ifx\SETmarginindex\relax\else
2992 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2995 \count255=\lastpenalty
2997 \indexdummies % Must do this here, since \bf, etc expand at this stage
2998 \escapechar=`\\
3000 \let\folio = 0% We will expand all macros now EXCEPT \folio.
3001 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3002 % so it will be output as is; and it will print as backslash.
3004 \def\thirdarg{#3}%
3006 % If third arg is present, precede it with space in sort key.
3007 \ifx\thirdarg\emptymacro
3008 \let\subentry = \empty
3009 \else
3010 \def\subentry{ #3}%
3013 % First process the index entry with all font commands turned
3014 % off to get the string to sort by.
3015 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
3017 % Now the real index entry with the fonts.
3018 \toks0 = {#2}%
3020 % If the third (subentry) arg is present, add it to the index
3021 % line to write.
3022 \ifx\thirdarg\emptymacro \else
3023 \toks0 = \expandafter{\the\toks0{#3}}%
3026 % Set up the complete index entry, with both the sort key and
3027 % the original text, including any font commands. We write
3028 % three arguments to \entry to the .?? file (four in the
3029 % subentry case), texindex reduces to two when writing the .??s
3030 % sorted result.
3031 \edef\temp{%
3032 \write\csname#1indfile\endcsname{%
3033 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3036 % If a skip is the last thing on the list now, preserve it
3037 % by backing up by \lastskip, doing the \write, then inserting
3038 % the skip again. Otherwise, the whatsit generated by the
3039 % \write will make \lastskip zero. The result is that sequences
3040 % like this:
3041 % @end defun
3042 % @tindex whatever
3043 % @defun ...
3044 % will have extra space inserted, because the \medbreak in the
3045 % start of the @defun won't see the skip inserted by the @end of
3046 % the previous defun.
3048 % But don't do any of this if we're not in vertical mode. We
3049 % don't want to do a \vskip and prematurely end a paragraph.
3051 % Avoid page breaks due to these extra skips, too.
3053 \iflinks
3054 \ifvmode
3055 \skip0 = \lastskip
3056 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
3059 \temp % do the write
3062 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3066 \penalty\count255
3070 % The index entry written in the file actually looks like
3071 % \entry {sortstring}{page}{topic}
3072 % or
3073 % \entry {sortstring}{page}{topic}{subtopic}
3074 % The texindex program reads in these files and writes files
3075 % containing these kinds of lines:
3076 % \initial {c}
3077 % before the first topic whose initial is c
3078 % \entry {topic}{pagelist}
3079 % for a topic that is used without subtopics
3080 % \primary {topic}
3081 % for the beginning of a topic that is used with subtopics
3082 % \secondary {subtopic}{pagelist}
3083 % for each subtopic.
3085 % Define the user-accessible indexing commands
3086 % @findex, @vindex, @kindex, @cindex.
3088 \def\findex {\fnindex}
3089 \def\kindex {\kyindex}
3090 \def\cindex {\cpindex}
3091 \def\vindex {\vrindex}
3092 \def\tindex {\tpindex}
3093 \def\pindex {\pgindex}
3095 \def\cindexsub {\begingroup\obeylines\cindexsub}
3096 {\obeylines %
3097 \gdef\cindexsub "#1" #2^^M{\endgroup %
3098 \dosubind{cp}{#2}{#1}}}
3100 % Define the macros used in formatting output of the sorted index material.
3102 % @printindex causes a particular index (the ??s file) to get printed.
3103 % It does not print any chapter heading (usually an @unnumbered).
3105 \def\printindex{\parsearg\doprintindex}
3106 \def\doprintindex#1{\begingroup
3107 \dobreak \chapheadingskip{10000}%
3109 \smallfonts \rm
3110 \tolerance = 9500
3111 \indexbreaks
3113 % See if the index file exists and is nonempty.
3114 % Change catcode of @ here so that if the index file contains
3115 % \initial {@}
3116 % as its first line, TeX doesn't complain about mismatched braces
3117 % (because it thinks @} is a control sequence).
3118 \catcode`\@ = 11
3119 \openin 1 \jobname.#1s
3120 \ifeof 1
3121 % \enddoublecolumns gets confused if there is no text in the index,
3122 % and it loses the chapter title and the aux file entries for the
3123 % index. The easiest way to prevent this problem is to make sure
3124 % there is some text.
3125 \putwordIndexNonexistent
3126 \else
3128 % If the index file exists but is empty, then \openin leaves \ifeof
3129 % false. We have to make TeX try to read something from the file, so
3130 % it can discover if there is anything in it.
3131 \read 1 to \temp
3132 \ifeof 1
3133 \putwordIndexIsEmpty
3134 \else
3135 % Index files are almost Texinfo source, but we use \ as the escape
3136 % character. It would be better to use @, but that's too big a change
3137 % to make right now.
3138 \def\indexbackslash{\rawbackslashxx}%
3139 \catcode`\\ = 0
3140 \escapechar = `\\
3141 \begindoublecolumns
3142 \input \jobname.#1s
3143 \enddoublecolumns
3146 \closein 1
3147 \endgroup}
3149 % These macros are used by the sorted index file itself.
3150 % Change them to control the appearance of the index.
3152 \def\initial#1{{%
3153 % Some minor font changes for the special characters.
3154 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3156 % Remove any glue we may have, we'll be inserting our own.
3157 \removelastskip
3159 % We like breaks before the index initials, so insert a bonus.
3160 \penalty -300
3162 % Typeset the initial. Making this add up to a whole number of
3163 % baselineskips increases the chance of the dots lining up from column
3164 % to column. It still won't often be perfect, because of the stretch
3165 % we need before each entry, but it's better.
3167 % No shrink because it confuses \balancecolumns.
3168 \vskip 1.67\baselineskip plus .5\baselineskip
3169 \leftline{\secbf #1}%
3170 \vskip .33\baselineskip plus .1\baselineskip
3172 % Do our best not to break after the initial.
3173 \nobreak
3176 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3177 % flush to the right margin. It is used for index and table of contents
3178 % entries. The paragraph is indented by \leftskip.
3180 \def\entry#1#2{\begingroup
3182 % Start a new paragraph if necessary, so our assignments below can't
3183 % affect previous text.
3184 \par
3186 % Do not fill out the last line with white space.
3187 \parfillskip = 0in
3189 % No extra space above this paragraph.
3190 \parskip = 0in
3192 % Do not prefer a separate line ending with a hyphen to fewer lines.
3193 \finalhyphendemerits = 0
3195 % \hangindent is only relevant when the entry text and page number
3196 % don't both fit on one line. In that case, bob suggests starting the
3197 % dots pretty far over on the line. Unfortunately, a large
3198 % indentation looks wrong when the entry text itself is broken across
3199 % lines. So we use a small indentation and put up with long leaders.
3201 % \hangafter is reset to 1 (which is the value we want) at the start
3202 % of each paragraph, so we need not do anything with that.
3203 \hangindent = 2em
3205 % When the entry text needs to be broken, just fill out the first line
3206 % with blank space.
3207 \rightskip = 0pt plus1fil
3209 % A bit of stretch before each entry for the benefit of balancing columns.
3210 \vskip 0pt plus1pt
3212 % Start a ``paragraph'' for the index entry so the line breaking
3213 % parameters we've set above will have an effect.
3214 \noindent
3216 % Insert the text of the index entry. TeX will do line-breaking on it.
3218 % The following is kludged to not output a line of dots in the index if
3219 % there are no page numbers. The next person who breaks this will be
3220 % cursed by a Unix daemon.
3221 \def\tempa{{\rm }}%
3222 \def\tempb{#2}%
3223 \edef\tempc{\tempa}%
3224 \edef\tempd{\tempb}%
3225 \ifx\tempc\tempd\ \else%
3227 % If we must, put the page number on a line of its own, and fill out
3228 % this line with blank space. (The \hfil is overwhelmed with the
3229 % fill leaders glue in \indexdotfill if the page number does fit.)
3230 \hfil\penalty50
3231 \null\nobreak\indexdotfill % Have leaders before the page number.
3233 % The `\ ' here is removed by the implicit \unskip that TeX does as
3234 % part of (the primitive) \par. Without it, a spurious underfull
3235 % \hbox ensues.
3236 \ifpdf
3237 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3238 \else
3239 \ #2% The page number ends the paragraph.
3241 \fi%
3242 \par
3243 \endgroup}
3245 % Like \dotfill except takes at least 1 em.
3246 \def\indexdotfill{\cleaders
3247 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3249 \def\primary #1{\line{#1\hfil}}
3251 \newskip\secondaryindent \secondaryindent=0.5cm
3252 \def\secondary#1#2{{%
3253 \parfillskip=0in
3254 \parskip=0in
3255 \hangindent=1in
3256 \hangafter=1
3257 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3258 \ifpdf
3259 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3260 \else
3263 \par
3266 % Define two-column mode, which we use to typeset indexes.
3267 % Adapted from the TeXbook, page 416, which is to say,
3268 % the manmac.tex format used to print the TeXbook itself.
3269 \catcode`\@=11
3271 \newbox\partialpage
3272 \newdimen\doublecolumnhsize
3274 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3275 % Grab any single-column material above us.
3276 \output = {%
3278 % Here is a possibility not foreseen in manmac: if we accumulate a
3279 % whole lot of material, we might end up calling this \output
3280 % routine twice in a row (see the doublecol-lose test, which is
3281 % essentially a couple of indexes with @setchapternewpage off). In
3282 % that case we just ship out what is in \partialpage with the normal
3283 % output routine. Generally, \partialpage will be empty when this
3284 % runs and this will be a no-op. See the indexspread.tex test case.
3285 \ifvoid\partialpage \else
3286 \onepageout{\pagecontents\partialpage}%
3289 \global\setbox\partialpage = \vbox{%
3290 % Unvbox the main output page.
3291 \unvbox\PAGE
3292 \kern-\topskip \kern\baselineskip
3295 \eject % run that output routine to set \partialpage
3297 % Use the double-column output routine for subsequent pages.
3298 \output = {\doublecolumnout}%
3300 % Change the page size parameters. We could do this once outside this
3301 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3302 % format, but then we repeat the same computation. Repeating a couple
3303 % of assignments once per index is clearly meaningless for the
3304 % execution time, so we may as well do it in one place.
3306 % First we halve the line length, less a little for the gutter between
3307 % the columns. We compute the gutter based on the line length, so it
3308 % changes automatically with the paper format. The magic constant
3309 % below is chosen so that the gutter has the same value (well, +-<1pt)
3310 % as it did when we hard-coded it.
3312 % We put the result in a separate register, \doublecolumhsize, so we
3313 % can restore it in \pagesofar, after \hsize itself has (potentially)
3314 % been clobbered.
3316 \doublecolumnhsize = \hsize
3317 \advance\doublecolumnhsize by -.04154\hsize
3318 \divide\doublecolumnhsize by 2
3319 \hsize = \doublecolumnhsize
3321 % Double the \vsize as well. (We don't need a separate register here,
3322 % since nobody clobbers \vsize.)
3323 \vsize = 2\vsize
3326 % The double-column output routine for all double-column pages except
3327 % the last.
3329 \def\doublecolumnout{%
3330 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3331 % Get the available space for the double columns -- the normal
3332 % (undoubled) page height minus any material left over from the
3333 % previous page.
3334 \dimen@ = \vsize
3335 \divide\dimen@ by 2
3336 \advance\dimen@ by -\ht\partialpage
3338 % box0 will be the left-hand column, box2 the right.
3339 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3340 \onepageout\pagesofar
3341 \unvbox255
3342 \penalty\outputpenalty
3345 % Re-output the contents of the output page -- any previous material,
3346 % followed by the two boxes we just split, in box0 and box2.
3347 \def\pagesofar{%
3348 \unvbox\partialpage
3350 \hsize = \doublecolumnhsize
3351 \wd0=\hsize \wd2=\hsize
3352 \hbox to\pagewidth{\box0\hfil\box2}%
3355 % All done with double columns.
3356 \def\enddoublecolumns{%
3357 \output = {%
3358 % Split the last of the double-column material. Leave it on the
3359 % current page, no automatic page break.
3360 \balancecolumns
3362 % If we end up splitting too much material for the current page,
3363 % though, there will be another page break right after this \output
3364 % invocation ends. Having called \balancecolumns once, we do not
3365 % want to call it again. Therefore, reset \output to its normal
3366 % definition right away. (We hope \balancecolumns will never be
3367 % called on to balance too much material, but if it is, this makes
3368 % the output somewhat more palatable.)
3369 \global\output = {\onepageout{\pagecontents\PAGE}}%
3371 \eject
3372 \endgroup % started in \begindoublecolumns
3374 % \pagegoal was set to the doubled \vsize above, since we restarted
3375 % the current page. We're now back to normal single-column
3376 % typesetting, so reset \pagegoal to the normal \vsize (after the
3377 % \endgroup where \vsize got restored).
3378 \pagegoal = \vsize
3381 % Called at the end of the double column material.
3382 \def\balancecolumns{%
3383 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3384 \dimen@ = \ht0
3385 \advance\dimen@ by \topskip
3386 \advance\dimen@ by-\baselineskip
3387 \divide\dimen@ by 2 % target to split to
3388 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3389 \splittopskip = \topskip
3390 % Loop until we get a decent breakpoint.
3392 \vbadness = 10000
3393 \loop
3394 \global\setbox3 = \copy0
3395 \global\setbox1 = \vsplit3 to \dimen@
3396 \ifdim\ht3>\dimen@
3397 \global\advance\dimen@ by 1pt
3398 \repeat
3400 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3401 \setbox0=\vbox to\dimen@{\unvbox1}%
3402 \setbox2=\vbox to\dimen@{\unvbox3}%
3404 \pagesofar
3406 \catcode`\@ = \other
3409 \message{sectioning,}
3410 % Chapters, sections, etc.
3412 \newcount\chapno
3413 \newcount\secno \secno=0
3414 \newcount\subsecno \subsecno=0
3415 \newcount\subsubsecno \subsubsecno=0
3417 % This counter is funny since it counts through charcodes of letters A, B, ...
3418 \newcount\appendixno \appendixno = `\@
3419 % \def\appendixletter{\char\the\appendixno}
3420 % We do the following for the sake of pdftex, which needs the actual
3421 % letter in the expansion, not just typeset.
3422 \def\appendixletter{%
3423 \ifnum\appendixno=`A A%
3424 \else\ifnum\appendixno=`B B%
3425 \else\ifnum\appendixno=`C C%
3426 \else\ifnum\appendixno=`D D%
3427 \else\ifnum\appendixno=`E E%
3428 \else\ifnum\appendixno=`F F%
3429 \else\ifnum\appendixno=`G G%
3430 \else\ifnum\appendixno=`H H%
3431 \else\ifnum\appendixno=`I I%
3432 \else\ifnum\appendixno=`J J%
3433 \else\ifnum\appendixno=`K K%
3434 \else\ifnum\appendixno=`L L%
3435 \else\ifnum\appendixno=`M M%
3436 \else\ifnum\appendixno=`N N%
3437 \else\ifnum\appendixno=`O O%
3438 \else\ifnum\appendixno=`P P%
3439 \else\ifnum\appendixno=`Q Q%
3440 \else\ifnum\appendixno=`R R%
3441 \else\ifnum\appendixno=`S S%
3442 \else\ifnum\appendixno=`T T%
3443 \else\ifnum\appendixno=`U U%
3444 \else\ifnum\appendixno=`V V%
3445 \else\ifnum\appendixno=`W W%
3446 \else\ifnum\appendixno=`X X%
3447 \else\ifnum\appendixno=`Y Y%
3448 \else\ifnum\appendixno=`Z Z%
3449 % The \the is necessary, despite appearances, because \appendixletter is
3450 % expanded while writing the .toc file. \char\appendixno is not
3451 % expandable, thus it is written literally, thus all appendixes come out
3452 % with the same letter (or @) in the toc without it.
3453 \else\char\the\appendixno
3454 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3455 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3457 % Each @chapter defines this as the name of the chapter.
3458 % page headings and footings can use it. @section does likewise.
3459 \def\thischapter{}
3460 \def\thissection{}
3462 \newcount\absseclevel % used to calculate proper heading level
3463 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3465 % @raisesections: treat @section as chapter, @subsection as section, etc.
3466 \def\raisesections{\global\advance\secbase by -1}
3467 \let\up=\raisesections % original BFox name
3469 % @lowersections: treat @chapter as section, @section as subsection, etc.
3470 \def\lowersections{\global\advance\secbase by 1}
3471 \let\down=\lowersections % original BFox name
3473 % Choose a numbered-heading macro
3474 % #1 is heading level if unmodified by @raisesections or @lowersections
3475 % #2 is text for heading
3476 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3477 \ifcase\absseclevel
3478 \chapterzzz{#2}
3480 \seczzz{#2}
3482 \numberedsubseczzz{#2}
3484 \numberedsubsubseczzz{#2}
3485 \else
3486 \ifnum \absseclevel<0
3487 \chapterzzz{#2}
3488 \else
3489 \numberedsubsubseczzz{#2}
3494 % like \numhead, but chooses appendix heading levels
3495 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3496 \ifcase\absseclevel
3497 \appendixzzz{#2}
3499 \appendixsectionzzz{#2}
3501 \appendixsubseczzz{#2}
3503 \appendixsubsubseczzz{#2}
3504 \else
3505 \ifnum \absseclevel<0
3506 \appendixzzz{#2}
3507 \else
3508 \appendixsubsubseczzz{#2}
3513 % like \numhead, but chooses numberless heading levels
3514 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3515 \ifcase\absseclevel
3516 \unnumberedzzz{#2}
3518 \unnumberedseczzz{#2}
3520 \unnumberedsubseczzz{#2}
3522 \unnumberedsubsubseczzz{#2}
3523 \else
3524 \ifnum \absseclevel<0
3525 \unnumberedzzz{#2}
3526 \else
3527 \unnumberedsubsubseczzz{#2}
3532 % @chapter, @appendix, @unnumbered.
3533 \def\thischaptername{No Chapter Title}
3534 \outer\def\chapter{\parsearg\chapteryyy}
3535 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3536 \def\chapterzzz #1{%
3537 \secno=0 \subsecno=0 \subsubsecno=0
3538 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3539 \chapmacro {#1}{\the\chapno}%
3540 \gdef\thissection{#1}%
3541 \gdef\thischaptername{#1}%
3542 % We don't substitute the actual chapter name into \thischapter
3543 % because we don't want its macros evaluated now.
3544 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3545 \toks0 = {#1}%
3546 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3547 {\the\chapno}}}%
3548 \temp
3549 \donoderef
3550 \global\let\section = \numberedsec
3551 \global\let\subsection = \numberedsubsec
3552 \global\let\subsubsection = \numberedsubsubsec
3555 % we use \chapno to avoid indenting back
3556 \def\appendixbox#1{%
3557 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}%
3558 \hbox to \wd0{#1\hss}}
3560 \outer\def\appendix{\parsearg\appendixyyy}
3561 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3562 \def\appendixzzz #1{%
3563 \secno=0 \subsecno=0 \subsubsecno=0
3564 \global\advance \appendixno by 1
3565 \message{\putwordAppendix\space \appendixletter}%
3566 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}%
3567 \gdef\thissection{#1}%
3568 \gdef\thischaptername{#1}%
3569 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3570 \toks0 = {#1}%
3571 \edef\temp{\noexpand\writetocentry{\realbackslash appendixentry{\the\toks0}%
3572 {\appendixletter}}}%
3573 \temp
3574 \appendixnoderef
3575 \global\let\section = \appendixsec
3576 \global\let\subsection = \appendixsubsec
3577 \global\let\subsubsection = \appendixsubsubsec
3580 % @centerchap is like @unnumbered, but the heading is centered.
3581 \outer\def\centerchap{\parsearg\centerchapyyy}
3582 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3584 % @top is like @unnumbered.
3585 \outer\def\top{\parsearg\unnumberedyyy}
3587 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3588 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3589 \def\unnumberedzzz #1{%
3590 \secno=0 \subsecno=0 \subsubsecno=0
3592 % This used to be simply \message{#1}, but TeX fully expands the
3593 % argument to \message. Therefore, if #1 contained @-commands, TeX
3594 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3595 % expanded @cite (which turns out to cause errors because \cite is meant
3596 % to be executed, not expanded).
3598 % Anyway, we don't want the fully-expanded definition of @cite to appear
3599 % as a result of the \message, we just want `@cite' itself. We use
3600 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3601 % simply yielding the contents of <toks register>. (We also do this for
3602 % the toc entries.)
3603 \toks0 = {#1}\message{(\the\toks0)}%
3605 \unnumbchapmacro {#1}%
3606 \gdef\thischapter{#1}\gdef\thissection{#1}%
3607 \toks0 = {#1}%
3608 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3609 \temp
3610 \unnumbnoderef
3611 \global\let\section = \unnumberedsec
3612 \global\let\subsection = \unnumberedsubsec
3613 \global\let\subsubsection = \unnumberedsubsubsec
3616 % Sections.
3617 \outer\def\numberedsec{\parsearg\secyyy}
3618 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3619 \def\seczzz #1{%
3620 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3621 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3622 \toks0 = {#1}%
3623 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3624 {\the\chapno}{\the\secno}}}%
3625 \temp
3626 \donoderef
3627 \nobreak
3630 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3631 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3632 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3633 \def\appendixsectionzzz #1{%
3634 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3635 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3636 \toks0 = {#1}%
3637 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3638 {\appendixletter}{\the\secno}}}%
3639 \temp
3640 \appendixnoderef
3641 \nobreak
3644 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3645 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3646 \def\unnumberedseczzz #1{%
3647 \plainsecheading {#1}\gdef\thissection{#1}%
3648 \toks0 = {#1}%
3649 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry%
3650 {\the\toks0}{\the\chapno}}}%
3651 \temp
3652 \unnumbnoderef
3653 \nobreak
3656 % Subsections.
3657 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3658 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3659 \def\numberedsubseczzz #1{%
3660 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3661 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3662 \toks0 = {#1}%
3663 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3664 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3665 \temp
3666 \donoderef
3667 \nobreak
3670 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3671 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3672 \def\appendixsubseczzz #1{%
3673 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3674 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3675 \toks0 = {#1}%
3676 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3677 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3678 \temp
3679 \appendixnoderef
3680 \nobreak
3683 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3684 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3685 \def\unnumberedsubseczzz #1{%
3686 \plainsubsecheading {#1}\gdef\thissection{#1}%
3687 \toks0 = {#1}%
3688 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3689 {\the\toks0}{\the\chapno}{\the\secno}}}%
3690 \temp
3691 \unnumbnoderef
3692 \nobreak
3695 % Subsubsections.
3696 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3697 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3698 \def\numberedsubsubseczzz #1{%
3699 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3700 \subsubsecheading {#1}
3701 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3702 \toks0 = {#1}%
3703 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3704 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3705 \temp
3706 \donoderef
3707 \nobreak
3710 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3711 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3712 \def\appendixsubsubseczzz #1{%
3713 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3714 \subsubsecheading {#1}
3715 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3716 \toks0 = {#1}%
3717 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3718 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3719 \temp
3720 \appendixnoderef
3721 \nobreak
3724 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3725 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3726 \def\unnumberedsubsubseczzz #1{%
3727 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3728 \toks0 = {#1}%
3729 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3730 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}}}%
3731 \temp
3732 \unnumbnoderef
3733 \nobreak
3736 % These are variants which are not "outer", so they can appear in @ifinfo.
3737 % Actually, they should now be obsolete; ordinary section commands should work.
3738 \def\infotop{\parsearg\unnumberedzzz}
3739 \def\infounnumbered{\parsearg\unnumberedzzz}
3740 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3741 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3742 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3744 \def\infoappendix{\parsearg\appendixzzz}
3745 \def\infoappendixsec{\parsearg\appendixseczzz}
3746 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3747 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3749 \def\infochapter{\parsearg\chapterzzz}
3750 \def\infosection{\parsearg\sectionzzz}
3751 \def\infosubsection{\parsearg\subsectionzzz}
3752 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3754 % These macros control what the section commands do, according
3755 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3756 % Define them by default for a numbered chapter.
3757 \global\let\section = \numberedsec
3758 \global\let\subsection = \numberedsubsec
3759 \global\let\subsubsection = \numberedsubsubsec
3761 % Define @majorheading, @heading and @subheading
3763 % NOTE on use of \vbox for chapter headings, section headings, and such:
3764 % 1) We use \vbox rather than the earlier \line to permit
3765 % overlong headings to fold.
3766 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3767 % heading is obnoxious; this forbids it.
3768 % 3) Likewise, headings look best if no \parindent is used, and
3769 % if justification is not attempted. Hence \raggedright.
3772 \def\majorheading{\parsearg\majorheadingzzz}
3773 \def\majorheadingzzz #1{%
3774 {\advance\chapheadingskip by 10pt \chapbreak }%
3775 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3776 \parindent=0pt\raggedright
3777 \rm #1\hfill}}\bigskip \par\penalty 200}
3779 \def\chapheading{\parsearg\chapheadingzzz}
3780 \def\chapheadingzzz #1{\chapbreak %
3781 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3782 \parindent=0pt\raggedright
3783 \rm #1\hfill}}\bigskip \par\penalty 200}
3785 % @heading, @subheading, @subsubheading.
3786 \def\heading{\parsearg\plainsecheading}
3787 \def\subheading{\parsearg\plainsubsecheading}
3788 \def\subsubheading{\parsearg\plainsubsubsecheading}
3790 % These macros generate a chapter, section, etc. heading only
3791 % (including whitespace, linebreaking, etc. around it),
3792 % given all the information in convenient, parsed form.
3794 %%% Args are the skip and penalty (usually negative)
3795 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3797 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3799 %%% Define plain chapter starts, and page on/off switching for it
3800 % Parameter controlling skip before chapter headings (if needed)
3802 \newskip\chapheadingskip
3804 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3805 \def\chappager{\par\vfill\supereject}
3806 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3808 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3810 \def\CHAPPAGoff{%
3811 \global\let\contentsalignmacro = \chappager
3812 \global\let\pchapsepmacro=\chapbreak
3813 \global\let\pagealignmacro=\chappager}
3815 \def\CHAPPAGon{%
3816 \global\let\contentsalignmacro = \chappager
3817 \global\let\pchapsepmacro=\chappager
3818 \global\let\pagealignmacro=\chappager
3819 \global\def\HEADINGSon{\HEADINGSsingle}}
3821 \def\CHAPPAGodd{
3822 \global\let\contentsalignmacro = \chapoddpage
3823 \global\let\pchapsepmacro=\chapoddpage
3824 \global\let\pagealignmacro=\chapoddpage
3825 \global\def\HEADINGSon{\HEADINGSdouble}}
3827 \CHAPPAGon
3829 \def\CHAPFplain{
3830 \global\let\chapmacro=\chfplain
3831 \global\let\unnumbchapmacro=\unnchfplain
3832 \global\let\centerchapmacro=\centerchfplain}
3834 % Plain chapter opening.
3835 % #1 is the text, #2 the chapter number or empty if unnumbered.
3836 \def\chfplain#1#2{%
3837 \pchapsepmacro
3839 \chapfonts \rm
3840 \def\chapnum{#2}%
3841 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3842 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3843 \hangindent = \wd0 \centerparametersmaybe
3844 \unhbox0 #1\par}%
3846 \nobreak\bigskip % no page break after a chapter title
3847 \nobreak
3850 % Plain opening for unnumbered.
3851 \def\unnchfplain#1{\chfplain{#1}{}}
3853 % @centerchap -- centered and unnumbered.
3854 \let\centerparametersmaybe = \relax
3855 \def\centerchfplain#1{{%
3856 \def\centerparametersmaybe{%
3857 \advance\rightskip by 3\rightskip
3858 \leftskip = \rightskip
3859 \parfillskip = 0pt
3861 \chfplain{#1}{}%
3864 \CHAPFplain % The default
3866 \def\unnchfopen #1{%
3867 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3868 \parindent=0pt\raggedright
3869 \rm #1\hfill}}\bigskip \par\nobreak
3872 \def\chfopen #1#2{\chapoddpage {\chapfonts
3873 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3874 \par\penalty 5000 %
3877 \def\centerchfopen #1{%
3878 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3879 \parindent=0pt
3880 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3883 \def\CHAPFopen{
3884 \global\let\chapmacro=\chfopen
3885 \global\let\unnumbchapmacro=\unnchfopen
3886 \global\let\centerchapmacro=\centerchfopen}
3889 % Section titles.
3890 \newskip\secheadingskip
3891 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3892 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3893 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3895 % Subsection titles.
3896 \newskip \subsecheadingskip
3897 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3898 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3899 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3901 % Subsubsection titles.
3902 \let\subsubsecheadingskip = \subsecheadingskip
3903 \let\subsubsecheadingbreak = \subsecheadingbreak
3904 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3905 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3908 % Print any size section title.
3910 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3911 % number (maybe empty), #3 the text.
3912 \def\sectionheading#1#2#3{%
3914 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3915 \csname #1headingbreak\endcsname
3918 % Switch to the right set of fonts.
3919 \csname #1fonts\endcsname \rm
3921 % Only insert the separating space if we have a section number.
3922 \def\secnum{#2}%
3923 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3925 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3926 \hangindent = \wd0 % zero if no section number
3927 \unhbox0 #3}%
3929 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3933 \message{toc,}
3934 % Table of contents.
3935 \newwrite\tocfile
3937 % Write an entry to the toc file, opening it if necessary.
3938 % Called from @chapter, etc. We supply {\folio} at the end of the
3939 % argument, which will end up as the last argument to the \...entry macro.
3941 % We open the .toc file here instead of at @setfilename or any other
3942 % fixed time so that @contents can be put in the document anywhere.
3944 \newif\iftocfileopened
3945 \def\writetocentry#1{%
3946 \iftocfileopened\else
3947 \immediate\openout\tocfile = \jobname.toc
3948 \global\tocfileopenedtrue
3950 \iflinks \write\tocfile{#1{\folio}}\fi
3952 % Tell \shipout to create a page destination if we're doing pdf, which
3953 % will be the target of the links in the table of contents. We can't
3954 % just do it on every page because the title pages are numbered 1 and
3955 % 2 (the page numbers aren't printed), and so are the first two pages
3956 % of the document. Thus, we'd have two destinations named `1', and
3957 % two named `2'.
3958 \ifpdf \pdfmakepagedesttrue \fi
3961 \newskip\contentsrightmargin \contentsrightmargin=1in
3962 \newcount\savepageno
3963 \newcount\lastnegativepageno \lastnegativepageno = -1
3965 % Finish up the main text and prepare to read what we've written
3966 % to \tocfile.
3968 \def\startcontents#1{%
3969 % If @setchapternewpage on, and @headings double, the contents should
3970 % start on an odd page, unlike chapters. Thus, we maintain
3971 % \contentsalignmacro in parallel with \pagealignmacro.
3972 % From: Torbjorn Granlund <tege@matematik.su.se>
3973 \contentsalignmacro
3974 \immediate\closeout\tocfile
3976 % Don't need to put `Contents' or `Short Contents' in the headline.
3977 % It is abundantly clear what they are.
3978 \unnumbchapmacro{#1}\def\thischapter{}%
3979 \savepageno = \pageno
3980 \begingroup % Set up to handle contents files properly.
3981 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3982 % We can't do this, because then an actual ^ in a section
3983 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3984 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3985 \raggedbottom % Worry more about breakpoints than the bottom.
3986 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3988 % Roman numerals for page numbers.
3989 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3993 % Normal (long) toc.
3994 \def\contents{%
3995 \startcontents{\putwordTOC}%
3996 \openin 1 \jobname.toc
3997 \ifeof 1 \else
3998 \closein 1
3999 \input \jobname.toc
4001 \vfill \eject
4002 \contentsalignmacro % in case @setchapternewpage odd is in effect
4003 \pdfmakeoutlines
4004 \endgroup
4005 \lastnegativepageno = \pageno
4006 \pageno = \savepageno
4009 % And just the chapters.
4010 \def\summarycontents{%
4011 \startcontents{\putwordShortTOC}%
4013 \let\chapentry = \shortchapentry
4014 \let\appendixentry = \shortappendixentry
4015 \let\unnumbchapentry = \shortunnumberedentry
4016 % We want a true roman here for the page numbers.
4017 \secfonts
4018 \let\rm=\shortcontrm \let\bf=\shortcontbf
4019 \let\sl=\shortcontsl \let\tt=\shortconttt
4021 \hyphenpenalty = 10000
4022 \advance\baselineskip by 1pt % Open it up a little.
4023 \def\secentry ##1##2##3##4{}
4024 \def\unnumbsecentry ##1##2##3{}
4025 \def\subsecentry ##1##2##3##4##5{}
4026 \def\unnumbsubsecentry ##1##2##3##4{}
4027 \def\subsubsecentry ##1##2##3##4##5##6{}
4028 \def\unnumbsubsubsecentry ##1##2##3##4##5{}
4029 \openin 1 \jobname.toc
4030 \ifeof 1 \else
4031 \closein 1
4032 \input \jobname.toc
4034 \vfill \eject
4035 \contentsalignmacro % in case @setchapternewpage odd is in effect
4036 \endgroup
4037 \lastnegativepageno = \pageno
4038 \pageno = \savepageno
4040 \let\shortcontents = \summarycontents
4042 \ifpdf
4043 \pdfcatalog{/PageMode /UseOutlines}%
4046 % These macros generate individual entries in the table of contents.
4047 % The first argument is the chapter or section name.
4048 % The last argument is the page number.
4049 % The arguments in between are the chapter number, section number, ...
4051 % Chapters, in the main contents.
4052 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4054 % Chapters, in the short toc.
4055 % See comments in \dochapentry re vbox and related settings.
4056 \def\shortchapentry#1#2#3{%
4057 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4060 % Appendices, in the main contents.
4061 \def\appendixentry#1#2#3{%
4062 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}}
4064 % Appendices, in the short toc.
4065 \let\shortappendixentry = \shortchapentry
4067 % Typeset the label for a chapter or appendix for the short contents.
4068 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4069 % We could simplify the code here by writing out an \appendixentry
4070 % command in the toc file for appendices, instead of using \chapentry
4071 % for both, but it doesn't seem worth it.
4073 \newdimen\shortappendixwidth
4075 \def\shortchaplabel#1{%
4076 % This space should be enough, since a single number is .5em, and the
4077 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4078 % But use \hss just in case.
4079 % (This space doesn't include the extra space that gets added after
4080 % the label; that gets put in by \shortchapentry above.)
4081 \dimen0 = 1em
4082 \hbox to \dimen0{#1\hss}%
4085 % Unnumbered chapters.
4086 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
4087 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
4089 % Sections.
4090 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4091 \def\unnumbsecentry#1#2#3{\dosecentry{#1}{#3}}
4093 % Subsections.
4094 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4095 \def\unnumbsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4097 % And subsubsections.
4098 \def\subsubsecentry#1#2#3#4#5#6{%
4099 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4100 \def\unnumbsubsubsecentry#1#2#3#4#5{\dosubsubsecentry{#1}{#5}}
4102 % This parameter controls the indentation of the various levels.
4103 \newdimen\tocindent \tocindent = 3pc
4105 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4106 % page number.
4108 % If the toc has to be broken over pages, we want it to be at chapters
4109 % if at all possible; hence the \penalty.
4110 \def\dochapentry#1#2{%
4111 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4112 \begingroup
4113 \chapentryfonts
4114 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4115 \endgroup
4116 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4119 \def\dosecentry#1#2{\begingroup
4120 \secentryfonts \leftskip=\tocindent
4121 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4122 \endgroup}
4124 \def\dosubsecentry#1#2{\begingroup
4125 \subsecentryfonts \leftskip=2\tocindent
4126 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4127 \endgroup}
4129 \def\dosubsubsecentry#1#2{\begingroup
4130 \subsubsecentryfonts \leftskip=3\tocindent
4131 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4132 \endgroup}
4134 % Final typesetting of a toc entry; we use the same \entry macro as for
4135 % the index entries, but we want to suppress hyphenation here. (We
4136 % can't do that in the \entry macro, since index entries might consist
4137 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4138 \def\tocentry#1#2{\begingroup
4139 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4140 % Do not use \turnoffactive in these arguments. Since the toc is
4141 % typeset in cmr, characters such as _ would come out wrong; we
4142 % have to do the usual translation tricks.
4143 \entry{#1}{#2}%
4144 \endgroup}
4146 % Space between chapter (or whatever) number and the title.
4147 \def\labelspace{\hskip1em \relax}
4149 \def\dopageno#1{{\rm #1}}
4150 \def\doshortpageno#1{{\rm #1}}
4152 \def\chapentryfonts{\secfonts \rm}
4153 \def\secentryfonts{\textfonts}
4154 \let\subsecentryfonts = \textfonts
4155 \let\subsubsecentryfonts = \textfonts
4158 \message{environments,}
4159 % @foo ... @end foo.
4161 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4163 % Since these characters are used in examples, it should be an even number of
4164 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4166 \def\point{$\star$}
4167 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4168 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4169 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4170 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4172 % The @error{} command.
4173 % Adapted from the TeXbook's \boxit.
4175 \newbox\errorbox
4177 {\tentt \global\dimen0 = 3em}% Width of the box.
4178 \dimen2 = .55pt % Thickness of rules
4179 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4180 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4182 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4183 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4184 \advance\hsize by -2\dimen2 % Rules.
4185 \vbox{
4186 \hrule height\dimen2
4187 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4188 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4189 \kern3pt\vrule width\dimen2}% Space to right.
4190 \hrule height\dimen2}
4191 \hfil}
4193 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4195 % @tex ... @end tex escapes into raw Tex temporarily.
4196 % One exception: @ is still an escape character, so that @end tex works.
4197 % But \@ or @@ will get a plain tex @ character.
4199 \def\tex{\begingroup
4200 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4201 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4202 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4203 \catcode `\%=14
4204 \catcode 43=12 % plus
4205 \catcode`\"=12
4206 \catcode`\==12
4207 \catcode`\|=12
4208 \catcode`\<=12
4209 \catcode`\>=12
4210 \escapechar=`\\
4212 \let\b=\ptexb
4213 \let\bullet=\ptexbullet
4214 \let\c=\ptexc
4215 \let\,=\ptexcomma
4216 \let\.=\ptexdot
4217 \let\dots=\ptexdots
4218 \let\equiv=\ptexequiv
4219 \let\!=\ptexexclam
4220 \let\i=\ptexi
4221 \let\{=\ptexlbrace
4222 \let\+=\tabalign
4223 \let\}=\ptexrbrace
4224 \let\*=\ptexstar
4225 \let\t=\ptext
4227 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4228 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4229 \def\@{@}%
4230 \let\Etex=\endgroup}
4232 % Define @lisp ... @end lisp.
4233 % @lisp does a \begingroup so it can rebind things,
4234 % including the definition of @end lisp (which normally is erroneous).
4236 % Amount to narrow the margins by for @lisp.
4237 \newskip\lispnarrowing \lispnarrowing=0.4in
4239 % This is the definition that ^^M gets inside @lisp, @example, and other
4240 % such environments. \null is better than a space, since it doesn't
4241 % have any width.
4242 \def\lisppar{\null\endgraf}
4244 % Make each space character in the input produce a normal interword
4245 % space in the output. Don't allow a line break at this space, as this
4246 % is used only in environments like @example, where each line of input
4247 % should produce a line of output anyway.
4249 {\obeyspaces %
4250 \gdef\sepspaces{\obeyspaces\let =\tie}}
4252 % Define \obeyedspace to be our active space, whatever it is. This is
4253 % for use in \parsearg.
4254 {\sepspaces%
4255 \global\let\obeyedspace= }
4257 % This space is always present above and below environments.
4258 \newskip\envskipamount \envskipamount = 0pt
4260 % Make spacing and below environment symmetrical. We use \parskip here
4261 % to help in doing that, since in @example-like environments \parskip
4262 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4263 % start of the next paragraph will insert \parskip
4265 \def\aboveenvbreak{{%
4266 \ifnum\lastpenalty < 10000
4267 \advance\envskipamount by \parskip
4268 \endgraf
4269 \ifdim\lastskip<\envskipamount
4270 \removelastskip
4271 \penalty-50
4272 \vskip\envskipamount
4277 \let\afterenvbreak = \aboveenvbreak
4279 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4280 \let\nonarrowing=\relax
4282 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4283 % environment contents.
4284 \font\circle=lcircle10
4285 \newdimen\circthick
4286 \newdimen\cartouter\newdimen\cartinner
4287 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4288 \circthick=\fontdimen8\circle
4290 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4291 \def\ctr{{\hskip 6pt\circle\char'010}}
4292 \def\cbl{{\circle\char'012\hskip -6pt}}
4293 \def\cbr{{\hskip 6pt\circle\char'011}}
4294 \def\carttop{\hbox to \cartouter{\hskip\lskip
4295 \ctl\leaders\hrule height\circthick\hfil\ctr
4296 \hskip\rskip}}
4297 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4298 \cbl\leaders\hrule height\circthick\hfil\cbr
4299 \hskip\rskip}}
4301 \newskip\lskip\newskip\rskip
4303 \long\def\cartouche{%
4304 \begingroup
4305 \lskip=\leftskip \rskip=\rightskip
4306 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4307 \cartinner=\hsize \advance\cartinner by-\lskip
4308 \advance\cartinner by-\rskip
4309 \cartouter=\hsize
4310 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4311 % side, and for 6pt waste from
4312 % each corner char, and rule thickness
4313 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4314 % Flag to tell @lisp, etc., not to narrow margin.
4315 \let\nonarrowing=\comment
4316 \vbox\bgroup
4317 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4318 \carttop
4319 \hbox\bgroup
4320 \hskip\lskip
4321 \vrule\kern3pt
4322 \vbox\bgroup
4323 \hsize=\cartinner
4324 \kern3pt
4325 \begingroup
4326 \baselineskip=\normbskip
4327 \lineskip=\normlskip
4328 \parskip=\normpskip
4329 \vskip -\parskip
4330 \def\Ecartouche{%
4331 \endgroup
4332 \kern3pt
4333 \egroup
4334 \kern3pt\vrule
4335 \hskip\rskip
4336 \egroup
4337 \cartbot
4338 \egroup
4339 \endgroup
4343 % This macro is called at the beginning of all the @example variants,
4344 % inside a group.
4345 \def\nonfillstart{%
4346 \aboveenvbreak
4347 \inENV % This group ends at the end of the body
4348 \hfuzz = 12pt % Don't be fussy
4349 \sepspaces % Make spaces be word-separators rather than space tokens.
4350 \singlespace
4351 \let\par = \lisppar % don't ignore blank lines
4352 \obeylines % each line of input is a line of output
4353 \parskip = 0pt
4354 \parindent = 0pt
4355 \emergencystretch = 0pt % don't try to avoid overfull boxes
4356 % @cartouche defines \nonarrowing to inhibit narrowing
4357 % at next level down.
4358 \ifx\nonarrowing\relax
4359 \advance \leftskip by \lispnarrowing
4360 \exdentamount=\lispnarrowing
4361 \let\exdent=\nofillexdent
4362 \let\nonarrowing=\relax
4366 % Define the \E... control sequence only if we are inside the particular
4367 % environment, so the error checking in \end will work.
4369 % To end an @example-like environment, we first end the paragraph (via
4370 % \afterenvbreak's vertical glue), and then the group. That way we keep
4371 % the zero \parskip that the environments set -- \parskip glue will be
4372 % inserted at the beginning of the next paragraph in the document, after
4373 % the environment.
4375 \def\nonfillfinish{\afterenvbreak\endgroup}
4377 % @lisp: indented, narrowed, typewriter font.
4378 \def\lisp{\begingroup
4379 \nonfillstart
4380 \let\Elisp = \nonfillfinish
4382 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4383 \gobble % eat return
4386 % @example: Same as @lisp.
4387 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4389 % @small... is usually equivalent to the non-small (@smallbook
4390 % redefines). We must call \example (or whatever) last in the
4391 % definition, since it reads the return following the @example (or
4392 % whatever) command.
4394 % This actually allows (for example) @end display inside an
4395 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4397 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4398 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4399 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4400 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4402 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4403 % Originally contributed by Pavel@xerox.
4404 \def\smalllispx{\begingroup
4405 \def\Esmalllisp{\nonfillfinish\endgroup}%
4406 \def\Esmallexample{\nonfillfinish\endgroup}%
4407 \smallexamplefonts
4408 \lisp
4411 % @display: same as @lisp except keep current font.
4413 \def\display{\begingroup
4414 \nonfillstart
4415 \let\Edisplay = \nonfillfinish
4416 \gobble
4419 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4421 \def\smalldisplayx{\begingroup
4422 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4423 \smallexamplefonts \rm
4424 \display
4427 % @format: same as @display except don't narrow margins.
4429 \def\format{\begingroup
4430 \let\nonarrowing = t
4431 \nonfillstart
4432 \let\Eformat = \nonfillfinish
4433 \gobble
4436 % @smallformat (when @smallbook): @format plus smaller fonts.
4438 \def\smallformatx{\begingroup
4439 \def\Esmallformat{\nonfillfinish\endgroup}%
4440 \smallexamplefonts \rm
4441 \format
4444 % @flushleft (same as @format).
4446 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4448 % @flushright.
4450 \def\flushright{\begingroup
4451 \let\nonarrowing = t
4452 \nonfillstart
4453 \let\Eflushright = \nonfillfinish
4454 \advance\leftskip by 0pt plus 1fill
4455 \gobble
4459 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4460 % and narrows the margins.
4462 \def\quotation{%
4463 \begingroup\inENV %This group ends at the end of the @quotation body
4464 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4465 \singlespace
4466 \parindent=0pt
4467 % We have retained a nonzero parskip for the environment, since we're
4468 % doing normal filling. So to avoid extra space below the environment...
4469 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4471 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4472 \ifx\nonarrowing\relax
4473 \advance\leftskip by \lispnarrowing
4474 \advance\rightskip by \lispnarrowing
4475 \exdentamount = \lispnarrowing
4476 \let\nonarrowing = \relax
4481 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4482 % If we want to allow any <char> as delimiter,
4483 % we need the curly braces so that makeinfo sees the @verb command, eg:
4484 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4486 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4488 % [Knuth] p. 344; only we need to do '@' too
4489 \def\dospecials{%
4490 \do\ \do\\\do\@\do\{\do\}\do\$\do\&%
4491 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~}
4493 % [Knuth] p. 380
4494 \def\uncatcodespecials{%
4495 \def\do##1{\catcode`##1=12}\dospecials}
4497 % [Knuth] pp. 380,381,391
4498 % Disable Spanish ligatures ?` and !` of \tt font
4499 \begingroup
4500 \catcode`\`=\active\gdef`{\relax\lq}
4501 \endgroup
4503 % Setup for the @verb command.
4505 % Eight spaces for a tab
4506 \begingroup
4507 \catcode`\^^I=\active
4508 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4509 \endgroup
4511 \def\setupverb{%
4512 \tt % easiest (and conventionally used) font for verbatim
4513 \def\par{\leavevmode\endgraf}%
4514 \catcode`\`=\active
4515 \tabeightspaces
4516 % Respect line breaks,
4517 % print special symbols as themselves, and
4518 % make each space count
4519 % must do in this order:
4520 \obeylines \uncatcodespecials \sepspaces
4523 % Setup for the @verbatim environment
4525 % Real tab expansion
4526 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4528 \def\starttabbox{\setbox0=\hbox\bgroup}
4529 \begingroup
4530 \catcode`\^^I=\active
4531 \gdef\tabexpand{%
4532 \catcode`\^^I=\active
4533 \def^^I{\leavevmode\egroup
4534 \dimen0=\wd0 % the width so far, or since the previous tab
4535 \divide\dimen0 by\tabw
4536 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4537 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4538 \wd0=\dimen0 \box0 \starttabbox
4541 \endgroup
4542 \def\setupverbatim{%
4543 % Easiest (and conventionally used) font for verbatim
4545 \def\par{\leavevmode\egroup\box0\endgraf}%
4546 \catcode`\`=\active
4547 \tabexpand
4548 % Respect line breaks,
4549 % print special symbols as themselves, and
4550 % make each space count
4551 % must do in this order:
4552 \obeylines \uncatcodespecials \sepspaces
4553 \everypar{\starttabbox}%
4556 % Do the @verb magic: verbatim text is quoted by unique
4557 % delimiter characters. Before first delimiter expect a
4558 % right brace, after last delimiter expect closing brace:
4560 % \def\doverb'{'<char>#1<char>'}'{#1}
4562 % [Knuth] p. 382; only eat outer {}
4563 \begingroup
4564 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4565 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4566 \endgroup
4568 \def\verb{\begingroup\setupverb\doverb}
4571 % Do the @verbatim magic: define the macro \doverbatim so that
4572 % the (first) argument ends when '@end verbatim' is reached, ie:
4574 % \def\doverbatim#1@end verbatim{#1}
4576 % For Texinfo it's a lot easier than for LaTeX,
4577 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4578 % we need not redefine '\', '{' and '}'
4580 % Inspired by LaTeX's verbatim command set [latex.ltx]
4581 %% Include LaTeX hack for completeness -- never know
4582 %% \begingroup
4583 %% \catcode`|=0 \catcode`[=1
4584 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4585 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4586 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4587 %% |endgroup
4588 \begingroup
4589 \catcode`\ =\active
4590 \gdef\doverbatim#1@end verbatim{#1\end{verbatim}}
4591 \endgroup
4593 \def\verbatim{%
4594 \def\Everbatim{\nonfillfinish\endgroup}%
4595 \begingroup
4596 \nonfillstart
4597 \advance\leftskip by -\defbodyindent
4598 \begingroup\setupverbatim\doverbatim
4601 % @verbatiminclude FILE - insert text of file in verbatim environment.
4603 % Allow normal characters that we make active in the argument (a file name).
4604 \def\verbatiminclude{%
4605 \begingroup
4606 \catcode`\\=12
4607 \catcode`~=12
4608 \catcode`^=12
4609 \catcode`_=12
4610 \catcode`|=12
4611 \catcode`<=12
4612 \catcode`>=12
4613 \catcode`+=12
4614 \parsearg\doverbatiminclude
4616 \def\setupverbatiminclude{%
4617 \begingroup
4618 \nonfillstart
4619 \advance\leftskip by -\defbodyindent
4620 \begingroup\setupverbatim
4623 \def\doverbatiminclude#1{%
4624 % Restore active chars for included file.
4625 \endgroup
4626 \begingroup
4627 \def\thisfile{#1}%
4628 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4629 \endgroup\nonfillfinish\endgroup
4632 % @copying ... @end copying.
4633 % Save the text away for @insertcopying later.
4635 \newbox\copyingbox
4637 \def\copying{\begingroup
4638 \parindent = 0pt % looks wrong on title page
4639 \def\Ecopying{\egroup\endgroup}%
4640 \global\setbox\copyingbox = \vbox\bgroup
4643 % @insertcopying.
4645 \def\insertcopying{\unvcopy\copyingbox}
4648 \message{defuns,}
4649 % @defun etc.
4651 % Allow user to change definition object font (\df) internally
4652 \def\setdeffont #1 {\csname DEF#1\endcsname}
4654 \newskip\defbodyindent \defbodyindent=.4in
4655 \newskip\defargsindent \defargsindent=50pt
4656 \newskip\deftypemargin \deftypemargin=12pt
4657 \newskip\deflastargmargin \deflastargmargin=18pt
4659 \newcount\parencount
4660 % define \functionparens, which makes ( and ) and & do special things.
4661 % \functionparens affects the group it is contained in.
4662 \def\activeparens{%
4663 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4664 \catcode`\[=\active \catcode`\]=\active}
4666 % Make control sequences which act like normal parenthesis chars.
4667 \let\lparen = ( \let\rparen = )
4669 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4671 % Be sure that we always have a definition for `(', etc. For example,
4672 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4673 % so TeX would otherwise complain about undefined control sequence.
4674 \global\let(=\lparen \global\let)=\rparen
4675 \global\let[=\lbrack \global\let]=\rbrack
4677 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4678 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4679 % This is used to turn on special parens
4680 % but make & act ordinary (given that it's active).
4681 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4683 % Definitions of (, ) and & used in args for functions.
4684 % This is the definition of ( outside of all parentheses.
4685 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4686 \global\advance\parencount by 1
4689 % This is the definition of ( when already inside a level of parens.
4690 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4692 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4693 % also in that case restore the outer-level definition of (.
4694 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4695 \global\advance \parencount by -1 }
4696 % If we encounter &foo, then turn on ()-hacking afterwards
4697 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
4699 \gdef\normalparens{\boldbrax\let&=\ampnr}
4700 } % End of definition inside \activeparens
4701 %% These parens (in \boldbrax) actually are a little bolder than the
4702 %% contained text. This is especially needed for [ and ]
4703 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4704 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4705 \let\ampnr = \&
4706 \def\lbrb{{\bf\char`\[}}
4707 \def\rbrb{{\bf\char`\]}}
4709 % Active &'s sneak into the index arguments, so make sure it's defined.
4711 \catcode`& = 13
4712 \global\let& = \ampnr
4715 % First, defname, which formats the header line itself.
4716 % #1 should be the function name.
4717 % #2 should be the type of definition, such as "Function".
4719 \def\defname #1#2{%
4720 % Get the values of \leftskip and \rightskip as they were
4721 % outside the @def...
4722 \dimen2=\leftskip
4723 \advance\dimen2 by -\defbodyindent
4724 \noindent
4725 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4726 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4727 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4728 \parshape 2 0in \dimen0 \defargsindent \dimen1
4729 % Now output arg 2 ("Function" or some such)
4730 % ending at \deftypemargin from the right margin,
4731 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4732 {% Adjust \hsize to exclude the ambient margins,
4733 % so that \rightline will obey them.
4734 \advance \hsize by -\dimen2
4735 \rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4736 % Make all lines underfull and no complaints:
4737 \tolerance=10000 \hbadness=10000
4738 \advance\leftskip by -\defbodyindent
4739 \exdentamount=\defbodyindent
4740 {\df #1}\enskip % Generate function name
4743 % Actually process the body of a definition
4744 % #1 should be the terminating control sequence, such as \Edefun.
4745 % #2 should be the "another name" control sequence, such as \defunx.
4746 % #3 should be the control sequence that actually processes the header,
4747 % such as \defunheader.
4749 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4750 \medbreak %
4751 % Define the end token that this defining construct specifies
4752 % so that it will exit this group.
4753 \def#1{\endgraf\endgroup\medbreak}%
4754 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4755 \parindent=0in
4756 \advance\leftskip by \defbodyindent
4757 \exdentamount=\defbodyindent
4758 \begingroup %
4759 \catcode 61=\active % 61 is `='
4760 \obeylines\activeparens\spacesplit#3}
4762 % #1 is the \E... control sequence to end the definition (which we define).
4763 % #2 is the \...x control sequence for consecutive fns (which we define).
4764 % #3 is the control sequence to call to resume processing.
4765 % #4, delimited by the space, is the class name.
4767 \def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4768 \medbreak %
4769 % Define the end token that this defining construct specifies
4770 % so that it will exit this group.
4771 \def#1{\endgraf\endgroup\medbreak}%
4772 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4773 \parindent=0in
4774 \advance\leftskip by \defbodyindent
4775 \exdentamount=\defbodyindent
4776 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4778 % Used for @deftypemethod and @deftypeivar.
4779 % #1 is the \E... control sequence to end the definition (which we define).
4780 % #2 is the \...x control sequence for consecutive fns (which we define).
4781 % #3 is the control sequence to call to resume processing.
4782 % #4, delimited by a space, is the class name.
4783 % #5 is the method's return type.
4785 \def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4786 \medbreak
4787 \def#1{\endgraf\endgroup\medbreak}%
4788 \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4789 \parindent=0in
4790 \advance\leftskip by \defbodyindent
4791 \exdentamount=\defbodyindent
4792 \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4794 % Used for @deftypeop. The change from \deftypemethparsebody is an
4795 % extra argument at the beginning which is the `category', instead of it
4796 % being the hardwired string `Method' or `Instance Variable'. We have
4797 % to account for this both in the \...x definition and in parsing the
4798 % input at hand. Thus also need a control sequence (passed as #5) for
4799 % the \E... definition to assign the category name to.
4801 \def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4802 \medbreak
4803 \def#1{\endgraf\endgroup\medbreak}%
4804 \def#2##1 ##2 ##3 {%
4805 \def#4{##1}%
4806 \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4807 \parindent=0in
4808 \advance\leftskip by \defbodyindent
4809 \exdentamount=\defbodyindent
4810 \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4812 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4813 \medbreak %
4814 % Define the end token that this defining construct specifies
4815 % so that it will exit this group.
4816 \def#1{\endgraf\endgroup\medbreak}%
4817 \def#2##1 ##2 {\def#4{##1}%
4818 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4819 \parindent=0in
4820 \advance\leftskip by \defbodyindent
4821 \exdentamount=\defbodyindent
4822 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4824 % These parsing functions are similar to the preceding ones
4825 % except that they do not make parens into active characters.
4826 % These are used for "variables" since they have no arguments.
4828 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4829 \medbreak %
4830 % Define the end token that this defining construct specifies
4831 % so that it will exit this group.
4832 \def#1{\endgraf\endgroup\medbreak}%
4833 \def#2{\begingroup\obeylines\spacesplit#3}%
4834 \parindent=0in
4835 \advance\leftskip by \defbodyindent
4836 \exdentamount=\defbodyindent
4837 \begingroup %
4838 \catcode 61=\active %
4839 \obeylines\spacesplit#3}
4841 % This is used for \def{tp,vr}parsebody. It could probably be used for
4842 % some of the others, too, with some judicious conditionals.
4844 \def\parsebodycommon#1#2#3{%
4845 \begingroup\inENV %
4846 \medbreak %
4847 % Define the end token that this defining construct specifies
4848 % so that it will exit this group.
4849 \def#1{\endgraf\endgroup\medbreak}%
4850 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4851 \parindent=0in
4852 \advance\leftskip by \defbodyindent
4853 \exdentamount=\defbodyindent
4854 \begingroup\obeylines
4857 \def\defvrparsebody#1#2#3#4 {%
4858 \parsebodycommon{#1}{#2}{#3}%
4859 \spacesplit{#3{#4}}%
4862 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4863 % type is just `struct', because we lose the braces in `{struct
4864 % termios}' when \spacesplit reads its undelimited argument. Sigh.
4865 % \let\deftpparsebody=\defvrparsebody
4867 % So, to get around this, we put \empty in with the type name. That
4868 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4869 % won't strip off the braces.
4871 \def\deftpparsebody #1#2#3#4 {%
4872 \parsebodycommon{#1}{#2}{#3}%
4873 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4876 % Fine, but then we have to eventually remove the \empty *and* the
4877 % braces (if any). That's what this does.
4879 \def\removeemptybraces\empty#1\relax{#1}
4881 % After \spacesplit has done its work, this is called -- #1 is the final
4882 % thing to call, #2 the type name (which starts with \empty), and #3
4883 % (which might be empty) the arguments.
4885 \def\parsetpheaderline#1#2#3{%
4886 #1{\removeemptybraces#2\relax}{#3}%
4889 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4890 \medbreak %
4891 % Define the end token that this defining construct specifies
4892 % so that it will exit this group.
4893 \def#1{\endgraf\endgroup\medbreak}%
4894 \def#2##1 ##2 {\def#4{##1}%
4895 \begingroup\obeylines\spacesplit{#3{##2}}}%
4896 \parindent=0in
4897 \advance\leftskip by \defbodyindent
4898 \exdentamount=\defbodyindent
4899 \begingroup\obeylines\spacesplit{#3{#5}}}
4901 % Split up #2 at the first space token.
4902 % call #1 with two arguments:
4903 % the first is all of #2 before the space token,
4904 % the second is all of #2 after that space token.
4905 % If #2 contains no space token, all of it is passed as the first arg
4906 % and the second is passed as empty.
4908 {\obeylines
4909 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4910 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4911 \ifx\relax #3%
4912 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4914 % So much for the things common to all kinds of definitions.
4916 % Define @defun.
4918 % First, define the processing that is wanted for arguments of \defun
4919 % Use this to expand the args and terminate the paragraph they make up
4921 \def\defunargs#1{\functionparens \sl
4922 % Expand, preventing hyphenation at `-' chars.
4923 % Note that groups don't affect changes in \hyphenchar.
4924 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4925 {\tensl\hyphenchar\font=0}%
4927 {\tensl\hyphenchar\font=45}%
4928 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4929 \interlinepenalty=10000
4930 \advance\rightskip by 0pt plus 1fil
4931 \endgraf\nobreak\vskip -\parskip\nobreak
4934 \def\deftypefunargs #1{%
4935 % Expand, preventing hyphenation at `-' chars.
4936 % Note that groups don't affect changes in \hyphenchar.
4937 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4938 \boldbraxnoamp
4939 \tclose{#1}% avoid \code because of side effects on active chars
4940 \interlinepenalty=10000
4941 \advance\rightskip by 0pt plus 1fil
4942 \endgraf\nobreak\vskip -\parskip\nobreak
4945 % Do complete processing of one @defun or @defunx line already parsed.
4947 % @deffn Command forward-char nchars
4949 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4951 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4952 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4953 \catcode 61=\other % Turn off change made in \defparsebody
4956 % @defun == @deffn Function
4958 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4960 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4961 \begingroup\defname {#1}{\putwordDeffunc}%
4962 \defunargs {#2}\endgroup %
4963 \catcode 61=\other % Turn off change made in \defparsebody
4966 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4968 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4970 % #1 is the data type. #2 is the name and args.
4971 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4972 % #1 is the data type, #2 the name, #3 the args.
4973 \def\deftypefunheaderx #1#2 #3\relax{%
4974 \doind {fn}{\code{#2}}% Make entry in function index
4975 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
4976 \deftypefunargs {#3}\endgroup %
4977 \catcode 61=\other % Turn off change made in \defparsebody
4980 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4982 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4984 % \defheaderxcond#1\relax$.$
4985 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4986 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
4988 % #1 is the classification. #2 is the data type. #3 is the name and args.
4989 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4990 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4991 \def\deftypefnheaderx #1#2#3 #4\relax{%
4992 \doind {fn}{\code{#3}}% Make entry in function index
4993 \begingroup
4994 \normalparens % notably, turn off `&' magic, which prevents
4995 % at least some C++ text from working
4996 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
4997 \deftypefunargs {#4}\endgroup %
4998 \catcode 61=\other % Turn off change made in \defparsebody
5001 % @defmac == @deffn Macro
5003 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5005 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5006 \begingroup\defname {#1}{\putwordDefmac}%
5007 \defunargs {#2}\endgroup %
5008 \catcode 61=\other % Turn off change made in \defparsebody
5011 % @defspec == @deffn Special Form
5013 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5015 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5016 \begingroup\defname {#1}{\putwordDefspec}%
5017 \defunargs {#2}\endgroup %
5018 \catcode 61=\other % Turn off change made in \defparsebody
5021 % @defop CATEGORY CLASS OPERATION ARG...
5023 \def\defop #1 {\def\defoptype{#1}%
5024 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5026 \def\defopheader#1#2#3{%
5027 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
5028 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
5029 \defunargs {#3}\endgroup %
5032 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5034 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5035 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5036 \deftypeopcategory}
5038 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5039 \def\deftypeopheader#1#2#3#4{%
5040 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5041 \begingroup
5042 \defname{\defheaderxcond#2\relax$.$#3}
5043 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5044 \deftypefunargs{#4}%
5045 \endgroup
5048 % @deftypemethod CLASS TYPE METHOD ARG...
5050 \def\deftypemethod{%
5051 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5053 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5054 \def\deftypemethodheader#1#2#3#4{%
5055 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5056 \begingroup
5057 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5058 \deftypefunargs{#4}%
5059 \endgroup
5062 % @deftypeivar CLASS TYPE VARNAME
5064 \def\deftypeivar{%
5065 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5067 % #1 is the class name, #2 the data type, #3 the variable name.
5068 \def\deftypeivarheader#1#2#3{%
5069 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5070 \begingroup
5071 \defname{\defheaderxcond#2\relax$.$#3}
5072 {\putwordInstanceVariableof\ \code{#1}}%
5073 \defvarargs{#3}%
5074 \endgroup
5077 % @defmethod == @defop Method
5079 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5081 % #1 is the class name, #2 the method name, #3 the args.
5082 \def\defmethodheader#1#2#3{%
5083 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5084 \begingroup
5085 \defname{#2}{\putwordMethodon\ \code{#1}}%
5086 \defunargs{#3}%
5087 \endgroup
5090 % @defcv {Class Option} foo-class foo-flag
5092 \def\defcv #1 {\def\defcvtype{#1}%
5093 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5095 \def\defcvarheader #1#2#3{%
5096 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5097 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5098 \defvarargs {#3}\endgroup %
5101 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5103 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5105 \def\defivarheader#1#2#3{%
5106 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5107 \begingroup
5108 \defname{#2}{\putwordInstanceVariableof\ #1}%
5109 \defvarargs{#3}%
5110 \endgroup
5113 % @defvar
5114 % First, define the processing that is wanted for arguments of @defvar.
5115 % This is actually simple: just print them in roman.
5116 % This must expand the args and terminate the paragraph they make up
5117 \def\defvarargs #1{\normalparens #1%
5118 \interlinepenalty=10000
5119 \endgraf\nobreak\vskip -\parskip\nobreak}
5121 % @defvr Counter foo-count
5123 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5125 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5126 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5128 % @defvar == @defvr Variable
5130 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5132 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5133 \begingroup\defname {#1}{\putwordDefvar}%
5134 \defvarargs {#2}\endgroup %
5137 % @defopt == @defvr {User Option}
5139 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5141 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5142 \begingroup\defname {#1}{\putwordDefopt}%
5143 \defvarargs {#2}\endgroup %
5146 % @deftypevar int foobar
5148 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5150 % #1 is the data type. #2 is the name, perhaps followed by text that
5151 % is actually part of the data type, which should not be put into the index.
5152 \def\deftypevarheader #1#2{%
5153 \dovarind#2 \relax% Make entry in variables index
5154 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5155 \interlinepenalty=10000
5156 \endgraf\nobreak\vskip -\parskip\nobreak
5157 \endgroup}
5158 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5160 % @deftypevr {Global Flag} int enable
5162 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5164 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5165 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5166 \interlinepenalty=10000
5167 \endgraf\nobreak\vskip -\parskip\nobreak
5168 \endgroup}
5170 % Now define @deftp
5171 % Args are printed in bold, a slight difference from @defvar.
5173 \def\deftpargs #1{\bf \defvarargs{#1}}
5175 % @deftp Class window height width ...
5177 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5179 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5180 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5182 % These definitions are used if you use @defunx (etc.)
5183 % anywhere other than immediately after a @defun or @defunx.
5185 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5186 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5187 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5188 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5189 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5190 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5191 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5192 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5193 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5194 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5195 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5196 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5197 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5198 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5199 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5200 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5201 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5202 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5203 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5206 \message{macros,}
5207 % @macro.
5209 % To do this right we need a feature of e-TeX, \scantokens,
5210 % which we arrange to emulate with a temporary file in ordinary TeX.
5211 \ifx\eTeXversion\undefined
5212 \newwrite\macscribble
5213 \def\scanmacro#1{%
5214 \begingroup \newlinechar`\^^M
5215 % Undo catcode changes of \startcontents and \doprintindex
5216 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5217 % Append \endinput to make sure that TeX does not see the ending newline.
5218 \toks0={#1\endinput}%
5219 \immediate\openout\macscribble=\jobname.tmp
5220 \immediate\write\macscribble{\the\toks0}%
5221 \immediate\closeout\macscribble
5222 \let\xeatspaces\eatspaces
5223 \input \jobname.tmp
5224 \endgroup
5226 \else
5227 \def\scanmacro#1{%
5228 \begingroup \newlinechar`\^^M
5229 % Undo catcode changes of \startcontents and \doprintindex
5230 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5231 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5234 \newcount\paramno % Count of parameters
5235 \newtoks\macname % Macro name
5236 \newif\ifrecursive % Is it recursive?
5237 \def\macrolist{} % List of all defined macros in the form
5238 % \do\macro1\do\macro2...
5240 % Utility routines.
5241 % Thisdoes \let #1 = #2, except with \csnames.
5242 \def\cslet#1#2{%
5243 \expandafter\expandafter
5244 \expandafter\let
5245 \expandafter\expandafter
5246 \csname#1\endcsname
5247 \csname#2\endcsname}
5249 % Trim leading and trailing spaces off a string.
5250 % Concepts from aro-bend problem 15 (see CTAN).
5251 {\catcode`\@=11
5252 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5253 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5254 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5255 \def\unbrace#1{#1}
5256 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5259 % Trim a single trailing ^^M off a string.
5260 {\catcode`\^^M=12\catcode`\Q=3%
5261 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5262 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5263 \gdef\eatcrb#1Q#2Q{#1}%
5266 % Macro bodies are absorbed as an argument in a context where
5267 % all characters are catcode 10, 11 or 12, except \ which is active
5268 % (as in normal texinfo). It is necessary to change the definition of \.
5270 % It's necessary to have hard CRs when the macro is executed. This is
5271 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5272 % body, and then making it the \newlinechar in \scanmacro.
5274 \def\macrobodyctxt{%
5275 \catcode`\~=12
5276 \catcode`\^=12
5277 \catcode`\_=12
5278 \catcode`\|=12
5279 \catcode`\<=12
5280 \catcode`\>=12
5281 \catcode`\+=12
5282 \catcode`\{=12
5283 \catcode`\}=12
5284 \catcode`\@=12
5285 \catcode`\^^M=12
5286 \usembodybackslash}
5288 \def\macroargctxt{%
5289 \catcode`\~=12
5290 \catcode`\^=12
5291 \catcode`\_=12
5292 \catcode`\|=12
5293 \catcode`\<=12
5294 \catcode`\>=12
5295 \catcode`\+=12
5296 \catcode`\@=12
5297 \catcode`\\=12}
5299 % \mbodybackslash is the definition of \ in @macro bodies.
5300 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5301 % where N is the macro parameter number.
5302 % We define \csname macarg.\endcsname to be \realbackslash, so
5303 % \\ in macro replacement text gets you a backslash.
5305 {\catcode`@=0 @catcode`@\=@active
5306 @gdef@usembodybackslash{@let\=@mbodybackslash}
5307 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5309 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5311 \def\macro{\recursivefalse\parsearg\macroxxx}
5312 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5314 \def\macroxxx#1{%
5315 \getargs{#1}% now \macname is the macname and \argl the arglist
5316 \ifx\argl\empty % no arguments
5317 \paramno=0%
5318 \else
5319 \expandafter\parsemargdef \argl;%
5321 \if1\csname ismacro.\the\macname\endcsname
5322 \message{Warning: redefining \the\macname}%
5323 \else
5324 \expandafter\ifx\csname \the\macname\endcsname \relax
5325 \else \errmessage{Macro name \the\macname\space already defined}\fi
5326 \global\cslet{macsave.\the\macname}{\the\macname}%
5327 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5328 % Add the macroname to \macrolist
5329 \toks0 = \expandafter{\macrolist\do}%
5330 \xdef\macrolist{\the\toks0
5331 \expandafter\noexpand\csname\the\macname\endcsname}%
5333 \begingroup \macrobodyctxt
5334 \ifrecursive \expandafter\parsermacbody
5335 \else \expandafter\parsemacbody
5336 \fi}
5338 \def\unmacro{\parsearg\unmacroxxx}
5339 \def\unmacroxxx#1{%
5340 \if1\csname ismacro.#1\endcsname
5341 \global\cslet{#1}{macsave.#1}%
5342 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5343 % Remove the macro name from \macrolist
5344 \begingroup
5345 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5346 \def\do##1{%
5347 \def\tempb{##1}%
5348 \ifx\tempa\tempb
5349 % remove this
5350 \else
5351 \toks0 = \expandafter{\newmacrolist\do}%
5352 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5353 \fi}%
5354 \def\newmacrolist{}%
5355 % Execute macro list to define \newmacrolist
5356 \macrolist
5357 \global\let\macrolist\newmacrolist
5358 \endgroup
5359 \else
5360 \errmessage{Macro #1 not defined}%
5364 % This makes use of the obscure feature that if the last token of a
5365 % <parameter list> is #, then the preceding argument is delimited by
5366 % an opening brace, and that opening brace is not consumed.
5367 \def\getargs#1{\getargsxxx#1{}}
5368 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5369 \def\getmacname #1 #2\relax{\macname={#1}}
5370 \def\getmacargs#1{\def\argl{#1}}
5372 % Parse the optional {params} list. Set up \paramno and \paramlist
5373 % so \defmacro knows what to do. Define \macarg.blah for each blah
5374 % in the params list, to be ##N where N is the position in that list.
5375 % That gets used by \mbodybackslash (above).
5377 % We need to get `macro parameter char #' into several definitions.
5378 % The technique used is stolen from LaTeX: let \hash be something
5379 % unexpandable, insert that wherever you need a #, and then redefine
5380 % it to # just before using the token list produced.
5382 % The same technique is used to protect \eatspaces till just before
5383 % the macro is used.
5385 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5386 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5387 \def\parsemargdefxxx#1,{%
5388 \if#1;\let\next=\relax
5389 \else \let\next=\parsemargdefxxx
5390 \advance\paramno by 1%
5391 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5392 {\xeatspaces{\hash\the\paramno}}%
5393 \edef\paramlist{\paramlist\hash\the\paramno,}%
5394 \fi\next}
5396 % These two commands read recursive and nonrecursive macro bodies.
5397 % (They're different since rec and nonrec macros end differently.)
5399 \long\def\parsemacbody#1@end macro%
5400 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5401 \long\def\parsermacbody#1@end rmacro%
5402 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5404 % This defines the macro itself. There are six cases: recursive and
5405 % nonrecursive macros of zero, one, and many arguments.
5406 % Much magic with \expandafter here.
5407 % \xdef is used so that macro definitions will survive the file
5408 % they're defined in; @include reads the file inside a group.
5409 \def\defmacro{%
5410 \let\hash=##% convert placeholders to macro parameter chars
5411 \ifrecursive
5412 \ifcase\paramno
5414 \expandafter\xdef\csname\the\macname\endcsname{%
5415 \noexpand\scanmacro{\temp}}%
5416 \or % 1
5417 \expandafter\xdef\csname\the\macname\endcsname{%
5418 \bgroup\noexpand\macroargctxt
5419 \noexpand\braceorline
5420 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5421 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5422 \egroup\noexpand\scanmacro{\temp}}%
5423 \else % many
5424 \expandafter\xdef\csname\the\macname\endcsname{%
5425 \bgroup\noexpand\macroargctxt
5426 \noexpand\csname\the\macname xx\endcsname}%
5427 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5428 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5429 \expandafter\expandafter
5430 \expandafter\xdef
5431 \expandafter\expandafter
5432 \csname\the\macname xxx\endcsname
5433 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5435 \else
5436 \ifcase\paramno
5438 \expandafter\xdef\csname\the\macname\endcsname{%
5439 \noexpand\norecurse{\the\macname}%
5440 \noexpand\scanmacro{\temp}\egroup}%
5441 \or % 1
5442 \expandafter\xdef\csname\the\macname\endcsname{%
5443 \bgroup\noexpand\macroargctxt
5444 \noexpand\braceorline
5445 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5446 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5447 \egroup
5448 \noexpand\norecurse{\the\macname}%
5449 \noexpand\scanmacro{\temp}\egroup}%
5450 \else % many
5451 \expandafter\xdef\csname\the\macname\endcsname{%
5452 \bgroup\noexpand\macroargctxt
5453 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5454 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5455 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5456 \expandafter\expandafter
5457 \expandafter\xdef
5458 \expandafter\expandafter
5459 \csname\the\macname xxx\endcsname
5460 \paramlist{%
5461 \egroup
5462 \noexpand\norecurse{\the\macname}%
5463 \noexpand\scanmacro{\temp}\egroup}%
5465 \fi}
5467 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5469 % \braceorline decides whether the next nonwhitespace character is a
5470 % {. If so it reads up to the closing }, if not, it reads the whole
5471 % line. Whatever was read is then fed to the next control sequence
5472 % as an argument (by \parsebrace or \parsearg)
5473 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5474 \def\braceorlinexxx{%
5475 \ifx\nchar\bgroup\else
5476 \expandafter\parsearg
5477 \fi \next}
5479 % We mant to disable all macros during \shipout so that they are not
5480 % expanded by \write.
5481 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5482 \edef\next{\macrolist}\expandafter\endgroup\next}
5485 % @alias.
5486 % We need some trickery to remove the optional spaces around the equal
5487 % sign. Just make them active and then expand them all to nothing.
5488 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5489 \def\aliasxxx #1{\aliasyyy#1\relax}
5490 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5491 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5492 \expandafter\noexpand\csname#2\endcsname}%
5493 \expandafter\endgroup\next}
5496 \message{cross references,}
5497 % @xref etc.
5499 \newwrite\auxfile
5501 \newif\ifhavexrefs % True if xref values are known.
5502 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5504 % @inforef is relatively simple.
5505 \def\inforef #1{\inforefzzz #1,,,,**}
5506 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5507 node \samp{\ignorespaces#1{}}}
5509 % @node's job is to define \lastnode.
5510 \def\node{\ENVcheck\parsearg\nodezzz}
5511 \def\nodezzz#1{\nodexxx [#1,]}
5512 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5513 \let\nwnode=\node
5514 \let\lastnode=\relax
5516 % The sectioning commands (@chapter, etc.) call these.
5517 \def\donoderef{%
5518 \ifx\lastnode\relax\else
5519 \expandafter\expandafter\expandafter\setref{\lastnode}%
5520 {Ysectionnumberandtype}%
5521 \global\let\lastnode=\relax
5524 \def\unnumbnoderef{%
5525 \ifx\lastnode\relax\else
5526 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5527 \global\let\lastnode=\relax
5530 \def\appendixnoderef{%
5531 \ifx\lastnode\relax\else
5532 \expandafter\expandafter\expandafter\setref{\lastnode}%
5533 {Yappendixletterandtype}%
5534 \global\let\lastnode=\relax
5539 % @anchor{NAME} -- define xref target at arbitrary point.
5541 \newcount\savesfregister
5542 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5543 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5544 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5546 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5547 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5548 % to set \indexdummies so commands such as @code in a section title
5549 % aren't expanded. It would be nicer not to expand the titles in the
5550 % first place, but there's so many layers that that is hard to do.
5552 \def\setref#1#2{{%
5553 \indexdummies
5554 \pdfmkdest{#1}%
5555 \dosetq{#1-title}{Ytitle}%
5556 \dosetq{#1-pg}{Ypagenumber}%
5557 \dosetq{#1-snt}{#2}%
5560 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5561 % the node name, #2 the name of the Info cross-reference, #3 the printed
5562 % node name, #4 the name of the Info file, #5 the name of the printed
5563 % manual. All but the node name can be omitted.
5565 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5566 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5567 \def\ref#1{\xrefX[#1,,,,,,,]}
5568 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5569 \unsepspaces
5570 \def\printedmanual{\ignorespaces #5}%
5571 \def\printednodename{\ignorespaces #3}%
5572 \setbox1=\hbox{\printedmanual}%
5573 \setbox0=\hbox{\printednodename}%
5574 \ifdim \wd0 = 0pt
5575 % No printed node name was explicitly given.
5576 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5577 % Use the node name inside the square brackets.
5578 \def\printednodename{\ignorespaces #1}%
5579 \else
5580 % Use the actual chapter/section title appear inside
5581 % the square brackets. Use the real section title if we have it.
5582 \ifdim \wd1 > 0pt
5583 % It is in another manual, so we don't have it.
5584 \def\printednodename{\ignorespaces #1}%
5585 \else
5586 \ifhavexrefs
5587 % We know the real title if we have the xref values.
5588 \def\printednodename{\refx{#1-title}{}}%
5589 \else
5590 % Otherwise just copy the Info node name.
5591 \def\printednodename{\ignorespaces #1}%
5592 \fi%
5597 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5598 % insert empty discretionaries after hyphens, which means that it will
5599 % not find a line break at a hyphen in a node names. Since some manuals
5600 % are best written with fairly long node names, containing hyphens, this
5601 % is a loss. Therefore, we give the text of the node name again, so it
5602 % is as if TeX is seeing it for the first time.
5603 \ifpdf
5604 \leavevmode
5605 \getfilename{#4}%
5606 {\normalturnoffactive
5607 \ifnum\filenamelength>0
5608 \startlink attr{/Border [0 0 0]}%
5609 goto file{\the\filename.pdf} name{#1}%
5610 \else
5611 \startlink attr{/Border [0 0 0]}%
5612 goto name{#1}%
5615 \linkcolor
5618 \ifdim \wd1 > 0pt
5619 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5620 \else
5621 % _ (for example) has to be the character _ for the purposes of the
5622 % control sequence corresponding to the node, but it has to expand
5623 % into the usual \leavevmode...\vrule stuff for purposes of
5624 % printing. So we \turnoffactive for the \refx-snt, back on for the
5625 % printing, back off for the \refx-pg.
5626 {\normalturnoffactive
5627 % Only output a following space if the -snt ref is nonempty; for
5628 % @unnumbered and @anchor, it won't be.
5629 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5630 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5632 % [mynode],
5633 [\printednodename],\space
5634 % page 3
5635 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5637 \endlink
5638 \endgroup}
5640 % \dosetq is the interface for calls from other macros
5642 % Use \normalturnoffactive so that punctuation chars such as underscore
5643 % and backslash work in node names. (\turnoffactive doesn't do \.)
5644 \def\dosetq#1#2{%
5645 {\let\folio=0%
5646 \normalturnoffactive
5647 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5648 \iflinks
5649 \next
5654 % \internalsetq {foo}{page} expands into
5655 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5656 % When the aux file is read, ' is the escape character
5658 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5660 % Things to be expanded by \internalsetq
5662 \def\Ypagenumber{\folio}
5664 \def\Ytitle{\thissection}
5666 \def\Ynothing{}
5668 \def\Ysectionnumberandtype{%
5669 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5670 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5671 \else \ifnum \subsubsecno=0 %
5672 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5673 \else %
5674 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5675 \fi \fi \fi }
5677 \def\Yappendixletterandtype{%
5678 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5679 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5680 \else \ifnum \subsubsecno=0 %
5681 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5682 \else %
5683 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5684 \fi \fi \fi }
5686 \gdef\xreftie{'tie}
5688 % Use TeX 3.0's \inputlineno to get the line number, for better error
5689 % messages, but if we're using an old version of TeX, don't do anything.
5691 \ifx\inputlineno\thisisundefined
5692 \let\linenumber = \empty % Non-3.0.
5693 \else
5694 \def\linenumber{\the\inputlineno:\space}
5697 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5698 % If its value is nonempty, SUFFIX is output afterward.
5700 \def\refx#1#2{%
5701 \expandafter\ifx\csname X#1\endcsname\relax
5702 % If not defined, say something at least.
5703 \angleleft un\-de\-fined\angleright
5704 \iflinks
5705 \ifhavexrefs
5706 \message{\linenumber Undefined cross reference `#1'.}%
5707 \else
5708 \ifwarnedxrefs\else
5709 \global\warnedxrefstrue
5710 \message{Cross reference values unknown; you must run TeX again.}%
5714 \else
5715 % It's defined, so just use it.
5716 \csname X#1\endcsname
5718 #2% Output the suffix in any case.
5721 % This is the macro invoked by entries in the aux file.
5723 \def\xrdef#1{\begingroup
5724 % Reenable \ as an escape while reading the second argument.
5725 \catcode`\\ = 0
5726 \afterassignment\endgroup
5727 \expandafter\gdef\csname X#1\endcsname
5730 % Read the last existing aux file, if any. No error if none exists.
5731 \def\readauxfile{\begingroup
5732 \catcode`\^^@=\other
5733 \catcode`\^^A=\other
5734 \catcode`\^^B=\other
5735 \catcode`\^^C=\other
5736 \catcode`\^^D=\other
5737 \catcode`\^^E=\other
5738 \catcode`\^^F=\other
5739 \catcode`\^^G=\other
5740 \catcode`\^^H=\other
5741 \catcode`\^^K=\other
5742 \catcode`\^^L=\other
5743 \catcode`\^^N=\other
5744 \catcode`\^^P=\other
5745 \catcode`\^^Q=\other
5746 \catcode`\^^R=\other
5747 \catcode`\^^S=\other
5748 \catcode`\^^T=\other
5749 \catcode`\^^U=\other
5750 \catcode`\^^V=\other
5751 \catcode`\^^W=\other
5752 \catcode`\^^X=\other
5753 \catcode`\^^Z=\other
5754 \catcode`\^^[=\other
5755 \catcode`\^^\=\other
5756 \catcode`\^^]=\other
5757 \catcode`\^^^=\other
5758 \catcode`\^^_=\other
5759 \catcode`\@=\other
5760 \catcode`\^=\other
5761 % It was suggested to define this as 7, which would allow ^^e4 etc.
5762 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5763 % supported in the main text, it doesn't seem desirable. Furthermore,
5764 % that is not enough: for node names that actually contain a ^
5765 % character, we would end up writing a line like this: 'xrdef {'hat
5766 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5767 % argument, and \hat is not an expandable control sequence. It could
5768 % all be worked out, but why? Either we support ^^ or we don't.
5770 % The other change necessary for this was to define \auxhat:
5771 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5772 % and then to call \auxhat in \setq.
5774 \catcode`\~=\other
5775 \catcode`\[=\other
5776 \catcode`\]=\other
5777 \catcode`\"=\other
5778 \catcode`\_=\other
5779 \catcode`\|=\other
5780 \catcode`\<=\other
5781 \catcode`\>=\other
5782 \catcode`\$=\other
5783 \catcode`\#=\other
5784 \catcode`\&=\other
5785 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5786 % Make the characters 128-255 be printing characters
5788 \count 1=128
5789 \def\loop{%
5790 \catcode\count 1=\other
5791 \advance\count 1 by 1
5792 \ifnum \count 1<256 \loop \fi
5795 % The aux file uses ' as the escape (for now).
5796 % Turn off \ as an escape so we do not lose on
5797 % entries which were dumped with control sequences in their names.
5798 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5799 % Reference to such entries still does not work the way one would wish,
5800 % but at least they do not bomb out when the aux file is read in.
5801 \catcode`\{=1
5802 \catcode`\}=2
5803 \catcode`\%=\other
5804 \catcode`\'=0
5805 \catcode`\\=\other
5807 \openin 1 \jobname.aux
5808 \ifeof 1 \else
5809 \closein 1
5810 \input \jobname.aux
5811 \global\havexrefstrue
5812 \global\warnedobstrue
5814 % Open the new aux file. TeX will close it automatically at exit.
5815 \openout\auxfile=\jobname.aux
5816 \endgroup}
5819 % Footnotes.
5821 \newcount \footnoteno
5823 % The trailing space in the following definition for supereject is
5824 % vital for proper filling; pages come out unaligned when you do a
5825 % pagealignmacro call if that space before the closing brace is
5826 % removed. (Generally, numeric constants should always be followed by a
5827 % space to prevent strange expansion errors.)
5828 \def\supereject{\par\penalty -20000\footnoteno =0 }
5830 % @footnotestyle is meaningful for info output only.
5831 \let\footnotestyle=\comment
5833 \let\ptexfootnote=\footnote
5835 {\catcode `\@=11
5837 % Auto-number footnotes. Otherwise like plain.
5838 \gdef\footnote{%
5839 \global\advance\footnoteno by \@ne
5840 \edef\thisfootno{$^{\the\footnoteno}$}%
5842 % In case the footnote comes at the end of a sentence, preserve the
5843 % extra spacing after we do the footnote number.
5844 \let\@sf\empty
5845 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5847 % Remove inadvertent blank space before typesetting the footnote number.
5848 \unskip
5849 \thisfootno\@sf
5850 \footnotezzz
5853 % Don't bother with the trickery in plain.tex to not require the
5854 % footnote text as a parameter. Our footnotes don't need to be so general.
5856 % Oh yes, they do; otherwise, @ifset and anything else that uses
5857 % \parseargline fail inside footnotes because the tokens are fixed when
5858 % the footnote is read. --karl, 16nov96.
5860 \long\gdef\footnotezzz{\insert\footins\bgroup
5861 % We want to typeset this text as a normal paragraph, even if the
5862 % footnote reference occurs in (for example) a display environment.
5863 % So reset some parameters.
5864 \interlinepenalty\interfootnotelinepenalty
5865 \splittopskip\ht\strutbox % top baseline for broken footnotes
5866 \splitmaxdepth\dp\strutbox
5867 \floatingpenalty\@MM
5868 \leftskip\z@skip
5869 \rightskip\z@skip
5870 \spaceskip\z@skip
5871 \xspaceskip\z@skip
5872 \parindent\defaultparindent
5874 \smallfonts \rm
5876 % Because we use hanging indentation in footnotes, a @noindent appears
5877 % to exdent this text, so make it be a no-op. makeinfo does not use
5878 % hanging indentation so @noindent can still be needed within footnote
5879 % text after an @example or the like (not that this is good style).
5880 \let\noindent = \relax
5882 % Hang the footnote text off the number. Use \everypar in case the
5883 % footnote extends for more than one paragraph.
5884 \everypar = {\hang}%
5885 \textindent{\thisfootno}%
5887 % Don't crash into the line above the footnote text. Since this
5888 % expands into a box, it must come within the paragraph, lest it
5889 % provide a place where TeX can split the footnote.
5890 \footstrut
5891 \futurelet\next\fo@t
5893 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5894 \else\let\next\f@t\fi \next}
5895 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
5896 \def\f@t#1{#1\@foot}
5897 \def\@foot{\strut\par\egroup}
5899 }%end \catcode `\@=11
5901 % @| inserts a changebar to the left of the current line. It should
5902 % surround any changed text. This approach does *not* work if the
5903 % change spans more than two lines of output. To handle that, we would
5904 % have adopt a much more difficult approach (putting marks into the main
5905 % vertical list for the beginning and end of each change).
5907 \def\|{%
5908 % \vadjust can only be used in horizontal mode.
5909 \leavevmode
5911 % Append this vertical mode material after the current line in the output.
5912 \vadjust{%
5913 % We want to insert a rule with the height and depth of the current
5914 % leading; that is exactly what \strutbox is supposed to record.
5915 \vskip-\baselineskip
5917 % \vadjust-items are inserted at the left edge of the type. So
5918 % the \llap here moves out into the left-hand margin.
5919 \llap{%
5921 % For a thicker or thinner bar, change the `1pt'.
5922 \vrule height\baselineskip width1pt
5924 % This is the space between the bar and the text.
5925 \hskip 12pt
5930 % For a final copy, take out the rectangles
5931 % that mark overfull boxes (in case you have decided
5932 % that the text looks ok even though it passes the margin).
5934 \def\finalout{\overfullrule=0pt}
5936 % @image. We use the macros from epsf.tex to support this.
5937 % If epsf.tex is not installed and @image is used, we complain.
5939 % Check for and read epsf.tex up front. If we read it only at @image
5940 % time, we might be inside a group, and then its definitions would get
5941 % undone and the next image would fail.
5942 \openin 1 = epsf.tex
5943 \ifeof 1 \else
5944 \closein 1
5945 % Do not bother showing banner with post-v2.7 epsf.tex (available in
5946 % doc/epsf.tex until it shows up on ctan).
5947 \def\epsfannounce{\toks0 = }%
5948 \input epsf.tex
5951 % We will only complain once about lack of epsf.tex.
5952 \newif\ifwarnednoepsf
5953 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5954 work. It is also included in the Texinfo distribution, or you can get
5955 it from ftp://tug.org/tex/epsf.tex.}
5957 \def\image#1{%
5958 \ifx\epsfbox\undefined
5959 \ifwarnednoepsf \else
5960 \errhelp = \noepsfhelp
5961 \errmessage{epsf.tex not found, images will be ignored}%
5962 \global\warnednoepsftrue
5964 \else
5965 \imagexxx #1,,,,,\finish
5969 % Arguments to @image:
5970 % #1 is (mandatory) image filename; we tack on .eps extension.
5971 % #2 is (optional) width, #3 is (optional) height.
5972 % #4 is (ignored optional) html alt text.
5973 % #5 is (ignored optional) extension.
5974 % #6 is just the usual extra ignored arg for parsing this stuff.
5975 \newif\ifimagevmode
5976 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
5977 \catcode`\^^M = 5 % in case we're inside an example
5978 \normalturnoffactive % allow _ et al. in names
5979 % If the image is by itself, center it.
5980 \ifvmode
5981 \imagevmodetrue
5982 \nobreak\bigskip
5983 % Usually we'll have text after the image which will insert
5984 % \parskip glue, so insert it here too to equalize the space
5985 % above and below.
5986 \nobreak\vskip\parskip
5987 \nobreak
5988 \line\bgroup\hss
5991 % Output the image.
5992 \ifpdf
5993 \dopdfimage{#1}{#2}{#3}%
5994 \else
5995 % \epsfbox itself resets \epsf?size at each figure.
5996 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5997 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5998 \epsfbox{#1.eps}%
6001 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6002 \endgroup}
6005 \message{localization,}
6006 % and i18n.
6008 % @documentlanguage is usually given very early, just after
6009 % @setfilename. If done too late, it may not override everything
6010 % properly. Single argument is the language abbreviation.
6011 % It would be nice if we could set up a hyphenation file here.
6013 \def\documentlanguage{\parsearg\dodocumentlanguage}
6014 \def\dodocumentlanguage#1{%
6015 \tex % read txi-??.tex file in plain TeX.
6016 % Read the file if it exists.
6017 \openin 1 txi-#1.tex
6018 \ifeof1
6019 \errhelp = \nolanghelp
6020 \errmessage{Cannot read language file txi-#1.tex}%
6021 \let\temp = \relax
6022 \else
6023 \def\temp{\input txi-#1.tex }%
6025 \temp
6026 \endgroup
6028 \newhelp\nolanghelp{The given language definition file cannot be found or
6029 is empty. Maybe you need to install it? In the current directory
6030 should work if nowhere else does.}
6033 % @documentencoding should change something in TeX eventually, most
6034 % likely, but for now just recognize it.
6035 \let\documentencoding = \comment
6038 % Page size parameters.
6040 \newdimen\defaultparindent \defaultparindent = 15pt
6042 \chapheadingskip = 15pt plus 4pt minus 2pt
6043 \secheadingskip = 12pt plus 3pt minus 2pt
6044 \subsecheadingskip = 9pt plus 2pt minus 2pt
6046 % Prevent underfull vbox error messages.
6047 \vbadness = 10000
6049 % Don't be so finicky about underfull hboxes, either.
6050 \hbadness = 2000
6052 % Following George Bush, just get rid of widows and orphans.
6053 \widowpenalty=10000
6054 \clubpenalty=10000
6056 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6057 % using an old version of TeX, don't do anything. We want the amount of
6058 % stretch added to depend on the line length, hence the dependence on
6059 % \hsize. We call this whenever the paper size is set.
6061 \def\setemergencystretch{%
6062 \ifx\emergencystretch\thisisundefined
6063 % Allow us to assign to \emergencystretch anyway.
6064 \def\emergencystretch{\dimen0}%
6065 \else
6066 \emergencystretch = .15\hsize
6070 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6071 % 4) hoffset; 5) binding offset; 6) topskip, 7) pdf pageheight;
6072 % 8) pdf pagewidth. We also call \setleading{\textleading}, so
6073 % the caller should define \textleading. The caller should also
6074 % set \parskip.
6076 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6077 \voffset = #3\relax
6078 \topskip = #6\relax
6079 \splittopskip = \topskip
6081 \vsize = #1\relax
6082 \advance\vsize by \topskip
6083 \outervsize = \vsize
6084 \advance\outervsize by 2\topandbottommargin
6085 \pageheight = \vsize
6087 \hsize = #2\relax
6088 \outerhsize = \hsize
6089 \advance\outerhsize by 0.5in
6090 \pagewidth = \hsize
6092 \normaloffset = #4\relax
6093 \bindingoffset = #5\relax
6095 \setleading{\textleading}
6097 \parindent = \defaultparindent
6098 \setemergencystretch
6100 \ifpdf
6101 \pdfpageheight #7\relax
6102 \pdfpagewidth #8\relax
6106 % Use `small' versions.
6108 \def\smallenvironments{%
6109 \let\smalldisplay = \smalldisplayx
6110 \let\smallexample = \smalllispx
6111 \let\smallformat = \smallformatx
6112 \let\smalllisp = \smalllispx
6115 % @letterpaper (the default).
6116 \def\letterpaper{{\globaldefs = 1
6117 \parskip = 3pt plus 2pt minus 1pt
6118 \textleading = 13.2pt
6120 % If page is nothing but text, make it come out even.
6121 \internalpagesizes{46\baselineskip}{6in}%
6122 {\voffset}{.25in}%
6123 {\bindingoffset}{36pt}%
6124 {11in}{8.5in}%
6127 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6128 \def\smallbook{{\globaldefs = 1
6129 \parskip = 2pt plus 1pt
6130 \textleading = 12pt
6132 \internalpagesizes{7.5in}{5.in}%
6133 {\voffset}{.25in}%
6134 {\bindingoffset}{16pt}%
6135 {9.25in}{7in}%
6137 \lispnarrowing = 0.3in
6138 \tolerance = 700
6139 \hfuzz = 1pt
6140 \contentsrightmargin = 0pt
6141 \deftypemargin = 0pt
6142 \defbodyindent = .5cm
6143 \smallenvironments
6146 % Use @afourpaper to print on European A4 paper.
6147 \def\afourpaper{{\globaldefs = 1
6148 \parskip = 3pt plus 2pt minus 1pt
6149 \textleading = 12pt
6151 \internalpagesizes{53\baselineskip}{160mm}%
6152 {\voffset}{4mm}%
6153 {\bindingoffset}{44pt}%
6154 {297mm}{210mm}%
6156 \tolerance = 700
6157 \hfuzz = 1pt
6160 % Use @afivepaper to print on European A5 paper.
6161 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6162 % He also recommends making @example and @lisp be small.
6163 \def\afivepaper{{\globaldefs = 1
6164 \parskip = 2pt plus 1pt minus 0.1pt
6165 \textleading = 12.5pt
6167 \internalpagesizes{166mm}{120mm}%
6168 {\voffset}{-8mm}%
6169 {\bindingoffset}{8pt}%
6170 {210mm}{148mm}%
6172 \lispnarrowing = 0.2in
6173 \tolerance = 800
6174 \hfuzz = 1.2pt
6175 \contentsrightmargin = 0mm
6176 \deftypemargin = 0pt
6177 \defbodyindent = 2mm
6178 \tableindent = 12mm
6180 \smallenvironments
6183 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
6184 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
6185 \def\afourlatex{{\globaldefs = 1
6186 \textleading = 13.6pt
6188 \afourpaper
6189 \internalpagesizes{237mm}{150mm}%
6190 {3.6mm}{3.6mm}%
6191 {3mm}{7mm}%
6192 {297mm}{210mm}%
6194 % Must explicitly reset to 0 because we call \afourpaper, apparently,
6195 % although this does not entirely make sense.
6196 \globaldefs = 0
6199 % Use @afourwide to print on European A4 paper in wide format.
6200 \def\afourwide{%
6201 \afourpaper
6202 \internalpagesizes{6.5in}{9.5in}%
6203 {\hoffset}{\normaloffset}%
6204 {\bindingoffset}{7mm}%
6205 {297mm}{210mm}%
6208 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6209 % Perhaps we should allow setting the margins, \topskip, \parskip,
6210 % and/or leading, also. Or perhaps we should compute them somehow.
6212 \newdimen \tempdima
6213 \newdimen \tempdimb
6214 \def\pagesizes{\parsearg\pagesizesxxx}
6215 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6216 \def\pagesizesyyy#1,#2,#3\finish{{%
6217 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6218 \globaldefs = 1
6220 \parskip = 3pt plus 2pt minus 1pt
6221 \setleading{\textleading}%
6223 \tempdima #1\relax
6224 \advance\tempdima by 1in
6225 \tempdimb #2\relax
6226 \advance\tempdimb by 1in
6227 \internalpagesizes{#1}{\hsize}%
6228 {\voffset}{\normaloffset}%
6229 {\bindingoffset}{44pt}%
6230 {\tempdima}{\tempdimb}%
6233 % Set default to letter.
6235 \letterpaper
6238 \message{and turning on texinfo input format.}
6240 % Define macros to output various characters with catcode for normal text.
6241 \catcode`\"=\other
6242 \catcode`\~=\other
6243 \catcode`\^=\other
6244 \catcode`\_=\other
6245 \catcode`\|=\other
6246 \catcode`\<=\other
6247 \catcode`\>=\other
6248 \catcode`\+=\other
6249 \catcode`\$=\other
6250 \def\normaldoublequote{"}
6251 \def\normaltilde{~}
6252 \def\normalcaret{^}
6253 \def\normalunderscore{_}
6254 \def\normalverticalbar{|}
6255 \def\normalless{<}
6256 \def\normalgreater{>}
6257 \def\normalplus{+}
6258 \def\normaldollar{$}%$ font-lock fix
6260 % This macro is used to make a character print one way in ttfont
6261 % where it can probably just be output, and another way in other fonts,
6262 % where something hairier probably needs to be done.
6264 % #1 is what to print if we are indeed using \tt; #2 is what to print
6265 % otherwise. Since all the Computer Modern typewriter fonts have zero
6266 % interword stretch (and shrink), and it is reasonable to expect all
6267 % typewriter fonts to have this, we can check that font parameter.
6269 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6271 % Same as above, but check for italic font. Actually this also catches
6272 % non-italic slanted fonts since it is impossible to distinguish them from
6273 % italic fonts. But since this is only used by $ and it uses \sl anyway
6274 % this is not a problem.
6275 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6277 % Turn off all special characters except @
6278 % (and those which the user can use as if they were ordinary).
6279 % Most of these we simply print from the \tt font, but for some, we can
6280 % use math or other variants that look better in normal text.
6282 \catcode`\"=\active
6283 \def\activedoublequote{{\tt\char34}}
6284 \let"=\activedoublequote
6285 \catcode`\~=\active
6286 \def~{{\tt\char126}}
6287 \chardef\hat=`\^
6288 \catcode`\^=\active
6289 \def^{{\tt \hat}}
6291 \catcode`\_=\active
6292 \def_{\ifusingtt\normalunderscore\_}
6293 % Subroutine for the previous macro.
6294 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
6296 \catcode`\|=\active
6297 \def|{{\tt\char124}}
6298 \chardef \less=`\<
6299 \catcode`\<=\active
6300 \def<{{\tt \less}}
6301 \chardef \gtr=`\>
6302 \catcode`\>=\active
6303 \def>{{\tt \gtr}}
6304 \catcode`\+=\active
6305 \def+{{\tt \char 43}}
6306 \catcode`\$=\active
6307 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6308 %\catcode 27=\active
6309 %\def^^[{$\diamondsuit$}
6311 % Set up an active definition for =, but don't enable it most of the time.
6312 {\catcode`\==\active
6313 \global\def={{\tt \char 61}}}
6315 \catcode`+=\active
6316 \catcode`\_=\active
6318 % If a .fmt file is being used, characters that might appear in a file
6319 % name cannot be active until we have parsed the command line.
6320 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6321 % \otherifyactive is called near the end of this file.
6322 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6324 \catcode`\@=0
6326 % \rawbackslashxx output one backslash character in current font
6327 \global\chardef\rawbackslashxx=`\\
6328 %{\catcode`\\=\other
6329 %@gdef@rawbackslashxx{\}}
6331 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6332 {\catcode`\\=\active
6333 @gdef@rawbackslash{@let\=@rawbackslashxx }}
6335 % \normalbackslash outputs one backslash in fixed width font.
6336 \def\normalbackslash{{\tt\rawbackslashxx}}
6338 % \catcode 17=0 % Define control-q
6339 \catcode`\\=\active
6341 % Used sometimes to turn off (effectively) the active characters
6342 % even after parsing them.
6343 @def@turnoffactive{@let"=@normaldoublequote
6344 @let\=@realbackslash
6345 @let~=@normaltilde
6346 @let^=@normalcaret
6347 @let_=@normalunderscore
6348 @let|=@normalverticalbar
6349 @let<=@normalless
6350 @let>=@normalgreater
6351 @let+=@normalplus
6352 @let$=@normaldollar}%$ font-lock fix
6354 @def@normalturnoffactive{@let"=@normaldoublequote
6355 @let\=@normalbackslash
6356 @let~=@normaltilde
6357 @let^=@normalcaret
6358 @let_=@normalunderscore
6359 @let|=@normalverticalbar
6360 @let<=@normalless
6361 @let>=@normalgreater
6362 @let+=@normalplus
6363 @let$=@normaldollar}%$ font-lock fix
6365 % Make _ and + \other characters, temporarily.
6366 % This is canceled by @fixbackslash.
6367 @otherifyactive
6369 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6370 % That is what \eatinput is for; after that, the `\' should revert to printing
6371 % a backslash.
6373 @gdef@eatinput input texinfo{@fixbackslash}
6374 @global@let\ = @eatinput
6376 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6377 % the first `\{ in the file would cause an error. This macro tries to fix
6378 % that, assuming it is called before the first `\' could plausibly occur.
6379 % Also back turn on active characters that might appear in the input
6380 % file name, in case not using a pre-dumped format.
6382 @gdef@fixbackslash{%
6383 @ifx\@eatinput @let\ = @normalbackslash @fi
6384 @catcode`+=@active
6385 @catcode`@_=@active
6388 % Say @foo, not \foo, in error messages.
6389 @escapechar = `@@
6391 % These look ok in all fonts, so just make them not special.
6392 @catcode`@& = @other
6393 @catcode`@# = @other
6394 @catcode`@% = @other
6396 @c Set initial fonts.
6397 @textfonts
6401 @c Local variables:
6402 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6403 @c page-delimiter: "^\\\\message"
6404 @c time-stamp-start: "def\\\\texinfoversion{"
6405 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6406 @c time-stamp-end: "}"
6407 @c End: