(antlr-mode): Check that `c-Java-access-key' is
[emacs.git] / man / texinfo.tex
blob0b5b9033f2eeac06ad8e208e08a89c40818a41ce
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{2001-03-28.08}
8 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99,
9 % 2000, 01 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/tex/texinfo.tex
35 % ftp://us.ctan.org/macros/texinfo/texinfo.tex
36 % (and all CTAN mirrors, finger ctan@us.ctan.org for a list).
37 % /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38 % The texinfo.tex in any given Texinfo distribution could well be out
39 % of date, so if that's what you're using, please check.
40 % Texinfo has a small home page at http://texinfo.org/.
42 % Send bug reports to bug-texinfo@gnu.org. Please include including a
43 % complete document in each bug report with which we can reproduce the
44 % problem. Patches are, of course, greatly appreciated.
46 % To process a Texinfo manual with TeX, it's most reliable to use the
47 % texi2dvi shell script that comes with the distribution. For a simple
48 % manual foo.texi, however, you can get away with this:
49 % tex foo.texi
50 % texindex foo.??
51 % tex foo.texi
52 % tex foo.texi
53 % dvips foo.dvi -o # or whatever, to process the dvi file; this makes foo.ps.
54 % The extra runs of TeX get the cross-reference information correct.
55 % Sometimes one run after texindex suffices, and sometimes you need more
56 % than two; texi2dvi does it as many times as necessary.
58 % It is possible to adapt texinfo.tex for other languages. You can get
59 % the existing language-specific files from ftp://ftp.gnu.org/gnu/texinfo/.
61 \message{Loading texinfo [version \texinfoversion]:}
63 % If in a .fmt file, print the version number
64 % and turn on active characters that we couldn't do earlier because
65 % they might have appeared in the input file name.
66 \everyjob{\message{[Texinfo version \texinfoversion]}%
67 \catcode`+=\active \catcode`\_=\active}
69 % Save some parts of plain tex whose names we will redefine.
70 \let\ptexb=\b
71 \let\ptexbullet=\bullet
72 \let\ptexc=\c
73 \let\ptexcomma=\,
74 \let\ptexdot=\.
75 \let\ptexdots=\dots
76 \let\ptexend=\end
77 \let\ptexequiv=\equiv
78 \let\ptexexclam=\!
79 \let\ptexi=\i
80 \let\ptexlbrace=\{
81 \let\ptexrbrace=\}
82 \let\ptexstar=\*
83 \let\ptext=\t
85 % We never want plain's outer \+ definition in Texinfo.
86 % For @tex, we can use \tabalign.
87 \let\+ = \relax
89 \message{Basics,}
90 \chardef\other=12
92 % If this character appears in an error message or help string, it
93 % starts a new line in the output.
94 \newlinechar = `^^J
96 % Set up fixed words for English if not already set.
97 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
98 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
99 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
100 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
101 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
102 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
103 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
104 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
105 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
106 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
107 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
108 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
109 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
110 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
111 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
112 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
113 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
114 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
115 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
117 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
118 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
119 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
120 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
121 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
122 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
123 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
124 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
125 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
126 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
127 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
128 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
130 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
131 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
132 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
133 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
134 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
135 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
136 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
138 % Ignore a token.
140 \def\gobble#1{}
142 \hyphenation{ap-pen-dix}
143 \hyphenation{mini-buf-fer mini-buf-fers}
144 \hyphenation{eshell}
145 \hyphenation{white-space}
147 % Margin to add to right of even pages, to left of odd pages.
148 \newdimen \bindingoffset
149 \newdimen \normaloffset
150 \newdimen\pagewidth \newdimen\pageheight
152 % Sometimes it is convenient to have everything in the transcript file
153 % and nothing on the terminal. We don't just call \tracingall here,
154 % since that produces some useless output on the terminal.
156 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
157 \ifx\eTeXversion\undefined
158 \def\loggingall{\tracingcommands2 \tracingstats2
159 \tracingpages1 \tracingoutput1 \tracinglostchars1
160 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
161 \showboxbreadth\maxdimen\showboxdepth\maxdimen
163 \else
164 \def\loggingall{\tracingcommands3 \tracingstats2
165 \tracingpages1 \tracingoutput1 \tracinglostchars1
166 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
167 \tracingscantokens1 \tracingassigns1 \tracingifs1
168 \tracinggroups1 \tracingnesting2
169 \showboxbreadth\maxdimen\showboxdepth\maxdimen
173 % For @cropmarks command.
174 % Do @cropmarks to get crop marks.
176 \newif\ifcropmarks
177 \let\cropmarks = \cropmarkstrue
179 % Dimensions to add cropmarks at corners.
180 % Added by P. A. MacKay, 12 Nov. 1986
182 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
183 \newdimen\cornerlong \cornerlong=1pc
184 \newdimen\cornerthick \cornerthick=.3pt
185 \newdimen\topandbottommargin \topandbottommargin=.75in
187 % Main output routine.
188 \chardef\PAGE = 255
189 \output = {\onepageout{\pagecontents\PAGE}}
191 \newbox\headlinebox
192 \newbox\footlinebox
194 % \onepageout takes a vbox as an argument. Note that \pagecontents
195 % does insertions, but you have to call it yourself.
196 \def\onepageout#1{%
197 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
199 \ifodd\pageno \advance\hoffset by \bindingoffset
200 \else \advance\hoffset by -\bindingoffset\fi
202 % Do this outside of the \shipout so @code etc. will be expanded in
203 % the headline as they should be, not taken literally (outputting ''code).
204 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
205 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
208 % Have to do this stuff outside the \shipout because we want it to
209 % take effect in \write's, yet the group defined by the \vbox ends
210 % before the \shipout runs.
212 \escapechar = `\\ % use backslash in output files.
213 \indexdummies % don't expand commands in the output.
214 \normalturnoffactive % \ in index entries must not stay \, e.g., if
215 % the page break happens to be in the middle of an example.
216 \shipout\vbox{%
217 % Do this early so pdf references go to the beginning of the page.
218 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
220 \ifcropmarks \vbox to \outervsize\bgroup
221 \hsize = \outerhsize
222 \vskip-\topandbottommargin
223 \vtop to0pt{%
224 \line{\ewtop\hfil\ewtop}%
225 \nointerlineskip
226 \line{%
227 \vbox{\moveleft\cornerthick\nstop}%
228 \hfill
229 \vbox{\moveright\cornerthick\nstop}%
231 \vss}%
232 \vskip\topandbottommargin
233 \line\bgroup
234 \hfil % center the page within the outer (page) hsize.
235 \ifodd\pageno\hskip\bindingoffset\fi
236 \vbox\bgroup
239 \unvbox\headlinebox
240 \pagebody{#1}%
241 \ifdim\ht\footlinebox > 0pt
242 % Only leave this space if the footline is nonempty.
243 % (We lessened \vsize for it in \oddfootingxxx.)
244 % The \baselineskip=24pt in plain's \makefootline has no effect.
245 \vskip 2\baselineskip
246 \unvbox\footlinebox
249 \ifcropmarks
250 \egroup % end of \vbox\bgroup
251 \hfil\egroup % end of (centering) \line\bgroup
252 \vskip\topandbottommargin plus1fill minus1fill
253 \boxmaxdepth = \cornerthick
254 \vbox to0pt{\vss
255 \line{%
256 \vbox{\moveleft\cornerthick\nsbot}%
257 \hfill
258 \vbox{\moveright\cornerthick\nsbot}%
260 \nointerlineskip
261 \line{\ewbot\hfil\ewbot}%
263 \egroup % \vbox from first cropmarks clause
265 }% end of \shipout\vbox
266 }% end of group with \turnoffactive
267 \advancepageno
268 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
271 \newinsert\margin \dimen\margin=\maxdimen
273 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
274 {\catcode`\@ =11
275 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
276 % marginal hacks, juha@viisa.uucp (Juha Takala)
277 \ifvoid\margin\else % marginal info is present
278 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
279 \dimen@=\dp#1 \unvbox#1
280 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
281 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
284 % Here are the rules for the cropmarks. Note that they are
285 % offset so that the space between them is truly \outerhsize or \outervsize
286 % (P. A. MacKay, 12 November, 1986)
288 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
289 \def\nstop{\vbox
290 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
291 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
292 \def\nsbot{\vbox
293 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
295 % Parse an argument, then pass it to #1. The argument is the rest of
296 % the input line (except we remove a trailing comment). #1 should be a
297 % macro which expects an ordinary undelimited TeX argument.
299 \def\parsearg#1{%
300 \let\next = #1%
301 \begingroup
302 \obeylines
303 \futurelet\temp\parseargx
306 % If the next token is an obeyed space (from an @example environment or
307 % the like), remove it and recurse. Otherwise, we're done.
308 \def\parseargx{%
309 % \obeyedspace is defined far below, after the definition of \sepspaces.
310 \ifx\obeyedspace\temp
311 \expandafter\parseargdiscardspace
312 \else
313 \expandafter\parseargline
317 % Remove a single space (as the delimiter token to the macro call).
318 {\obeyspaces %
319 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
321 {\obeylines %
322 \gdef\parseargline#1^^M{%
323 \endgroup % End of the group started in \parsearg.
325 % First remove any @c comment, then any @comment.
326 % Result of each macro is put in \toks0.
327 \argremovec #1\c\relax %
328 \expandafter\argremovecomment \the\toks0 \comment\relax %
330 % Call the caller's macro, saved as \next in \parsearg.
331 \expandafter\next\expandafter{\the\toks0}%
335 % Since all \c{,omment} does is throw away the argument, we can let TeX
336 % do that for us. The \relax here is matched by the \relax in the call
337 % in \parseargline; it could be more or less anything, its purpose is
338 % just to delimit the argument to the \c.
339 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
340 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
342 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
343 % @end itemize @c foo
344 % will have two active spaces as part of the argument with the
345 % `itemize'. Here we remove all active spaces from #1, and assign the
346 % result to \toks0.
348 % This loses if there are any *other* active characters besides spaces
349 % in the argument -- _ ^ +, for example -- since they get expanded.
350 % Fortunately, Texinfo does not define any such commands. (If it ever
351 % does, the catcode of the characters in questionwill have to be changed
352 % here.) But this means we cannot call \removeactivespaces as part of
353 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
354 % that \parsearg gets might well have any character at all in it.
356 \def\removeactivespaces#1{%
357 \begingroup
358 \ignoreactivespaces
359 \edef\temp{#1}%
360 \global\toks0 = \expandafter{\temp}%
361 \endgroup
364 % Change the active space to expand to nothing.
366 \begingroup
367 \obeyspaces
368 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
369 \endgroup
372 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
374 %% These are used to keep @begin/@end levels from running away
375 %% Call \inENV within environments (after a \begingroup)
376 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
377 \def\ENVcheck{%
378 \ifENV\errmessage{Still within an environment; press RETURN to continue}
379 \endgroup\fi} % This is not perfect, but it should reduce lossage
381 % @begin foo is the same as @foo, for now.
382 \newhelp\EMsimple{Press RETURN to continue.}
384 \outer\def\begin{\parsearg\beginxxx}
386 \def\beginxxx #1{%
387 \expandafter\ifx\csname #1\endcsname\relax
388 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
389 \csname #1\endcsname\fi}
391 % @end foo executes the definition of \Efoo.
393 \def\end{\parsearg\endxxx}
394 \def\endxxx #1{%
395 \removeactivespaces{#1}%
396 \edef\endthing{\the\toks0}%
398 \expandafter\ifx\csname E\endthing\endcsname\relax
399 \expandafter\ifx\csname \endthing\endcsname\relax
400 % There's no \foo, i.e., no ``environment'' foo.
401 \errhelp = \EMsimple
402 \errmessage{Undefined command `@end \endthing'}%
403 \else
404 \unmatchedenderror\endthing
406 \else
407 % Everything's ok; the right environment has been started.
408 \csname E\endthing\endcsname
412 % There is an environment #1, but it hasn't been started. Give an error.
414 \def\unmatchedenderror#1{%
415 \errhelp = \EMsimple
416 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
419 % Define the control sequence \E#1 to give an unmatched @end error.
421 \def\defineunmatchedend#1{%
422 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
426 % Single-spacing is done by various environments (specifically, in
427 % \nonfillstart and \quotations).
428 \newskip\singlespaceskip \singlespaceskip = 12.5pt
429 \def\singlespace{%
430 % Why was this kern here? It messes up equalizing space above and below
431 % environments. --karl, 6may93
432 %{\advance \baselineskip by -\singlespaceskip
433 %\kern \baselineskip}%
434 \setleading \singlespaceskip
437 %% Simple single-character @ commands
439 % @@ prints an @
440 % Kludge this until the fonts are right (grr).
441 \def\@{{\tt\char64}}
443 % This is turned off because it was never documented
444 % and you can use @w{...} around a quote to suppress ligatures.
445 %% Define @` and @' to be the same as ` and '
446 %% but suppressing ligatures.
447 %\def\`{{`}}
448 %\def\'{{'}}
450 % Used to generate quoted braces.
451 \def\mylbrace {{\tt\char123}}
452 \def\myrbrace {{\tt\char125}}
453 \let\{=\mylbrace
454 \let\}=\myrbrace
455 \begingroup
456 % Definitions to produce actual \{ & \} command in an index.
457 \catcode`\{ = 12 \catcode`\} = 12
458 \catcode`\[ = 1 \catcode`\] = 2
459 \catcode`\@ = 0 \catcode`\\ = 12
460 @gdef@lbracecmd[\{]%
461 @gdef@rbracecmd[\}]%
462 @endgroup
464 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
465 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
466 \let\, = \c
467 \let\dotaccent = \.
468 \def\ringaccent#1{{\accent23 #1}}
469 \let\tieaccent = \t
470 \let\ubaraccent = \b
471 \let\udotaccent = \d
473 % Other special characters: @questiondown @exclamdown
474 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
475 \def\questiondown{?`}
476 \def\exclamdown{!`}
478 % Dotless i and dotless j, used for accents.
479 \def\imacro{i}
480 \def\jmacro{j}
481 \def\dotless#1{%
482 \def\temp{#1}%
483 \ifx\temp\imacro \ptexi
484 \else\ifx\temp\jmacro \j
485 \else \errmessage{@dotless can be used only with i or j}%
486 \fi\fi
489 % Be sure we're in horizontal mode when doing a tie, since we make space
490 % equivalent to this in @example-like environments. Otherwise, a space
491 % at the beginning of a line will start with \penalty -- and
492 % since \penalty is valid in vertical mode, we'd end up putting the
493 % penalty on the vertical list instead of in the new paragraph.
494 {\catcode`@ = 11
495 % Avoid using \@M directly, because that causes trouble
496 % if the definition is written into an index file.
497 \global\let\tiepenalty = \@M
498 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
501 % @: forces normal size whitespace following.
502 \def\:{\spacefactor=1000 }
504 % @* forces a line break.
505 \def\*{\hfil\break\hbox{}\ignorespaces}
507 % @. is an end-of-sentence period.
508 \def\.{.\spacefactor=3000 }
510 % @! is an end-of-sentence bang.
511 \def\!{!\spacefactor=3000 }
513 % @? is an end-of-sentence query.
514 \def\?{?\spacefactor=3000 }
516 % @w prevents a word break. Without the \leavevmode, @w at the
517 % beginning of a paragraph, when TeX is still in vertical mode, would
518 % produce a whole line of output instead of starting the paragraph.
519 \def\w#1{\leavevmode\hbox{#1}}
521 % @group ... @end group forces ... to be all on one page, by enclosing
522 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
523 % to keep its height that of a normal line. According to the rules for
524 % \topskip (p.114 of the TeXbook), the glue inserted is
525 % max (\topskip - \ht (first item), 0). If that height is large,
526 % therefore, no glue is inserted, and the space between the headline and
527 % the text is small, which looks bad.
529 \def\group{\begingroup
530 \ifnum\catcode13=\active \else
531 \errhelp = \groupinvalidhelp
532 \errmessage{@group invalid in context where filling is enabled}%
535 % The \vtop we start below produces a box with normal height and large
536 % depth; thus, TeX puts \baselineskip glue before it, and (when the
537 % next line of text is done) \lineskip glue after it. (See p.82 of
538 % the TeXbook.) Thus, space below is not quite equal to space
539 % above. But it's pretty close.
540 \def\Egroup{%
541 \egroup % End the \vtop.
542 \endgroup % End the \group.
545 \vtop\bgroup
546 % We have to put a strut on the last line in case the @group is in
547 % the midst of an example, rather than completely enclosing it.
548 % Otherwise, the interline space between the last line of the group
549 % and the first line afterwards is too small. But we can't put the
550 % strut in \Egroup, since there it would be on a line by itself.
551 % Hence this just inserts a strut at the beginning of each line.
552 \everypar = {\strut}%
554 % Since we have a strut on every line, we don't need any of TeX's
555 % normal interline spacing.
556 \offinterlineskip
558 % OK, but now we have to do something about blank
559 % lines in the input in @example-like environments, which normally
560 % just turn into \lisppar, which will insert no space now that we've
561 % turned off the interline space. Simplest is to make them be an
562 % empty paragraph.
563 \ifx\par\lisppar
564 \edef\par{\leavevmode \par}%
566 % Reset ^^M's definition to new definition of \par.
567 \obeylines
570 % Do @comment since we are called inside an environment such as
571 % @example, where each end-of-line in the input causes an
572 % end-of-line in the output. We don't want the end-of-line after
573 % the `@group' to put extra space in the output. Since @group
574 % should appear on a line by itself (according to the Texinfo
575 % manual), we don't worry about eating any user text.
576 \comment
579 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
580 % message, so this ends up printing `@group can only ...'.
582 \newhelp\groupinvalidhelp{%
583 group can only be used in environments such as @example,^^J%
584 where each line of input produces a line of output.}
586 % @need space-in-mils
587 % forces a page break if there is not space-in-mils remaining.
589 \newdimen\mil \mil=0.001in
591 \def\need{\parsearg\needx}
593 % Old definition--didn't work.
594 %\def\needx #1{\par %
595 %% This method tries to make TeX break the page naturally
596 %% if the depth of the box does not fit.
597 %{\baselineskip=0pt%
598 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
599 %\prevdepth=-1000pt
602 \def\needx#1{%
603 % Ensure vertical mode, so we don't make a big box in the middle of a
604 % paragraph.
605 \par
607 % If the @need value is less than one line space, it's useless.
608 \dimen0 = #1\mil
609 \dimen2 = \ht\strutbox
610 \advance\dimen2 by \dp\strutbox
611 \ifdim\dimen0 > \dimen2
613 % Do a \strut just to make the height of this box be normal, so the
614 % normal leading is inserted relative to the preceding line.
615 % And a page break here is fine.
616 \vtop to #1\mil{\strut\vfil}%
618 % TeX does not even consider page breaks if a penalty added to the
619 % main vertical list is 10000 or more. But in order to see if the
620 % empty box we just added fits on the page, we must make it consider
621 % page breaks. On the other hand, we don't want to actually break the
622 % page after the empty box. So we use a penalty of 9999.
624 % There is an extremely small chance that TeX will actually break the
625 % page at this \penalty, if there are no other feasible breakpoints in
626 % sight. (If the user is using lots of big @group commands, which
627 % almost-but-not-quite fill up a page, TeX will have a hard time doing
628 % good page breaking, for example.) However, I could not construct an
629 % example where a page broke at this \penalty; if it happens in a real
630 % document, then we can reconsider our strategy.
631 \penalty9999
633 % Back up by the size of the box, whether we did a page break or not.
634 \kern -#1\mil
636 % Do not allow a page break right after this kern.
637 \nobreak
641 % @br forces paragraph break
643 \let\br = \par
645 % @dots{} output an ellipsis using the current font.
646 % We do .5em per period so that it has the same spacing in a typewriter
647 % font as three actual period characters.
649 \def\dots{%
650 \leavevmode
651 \hbox to 1.5em{%
652 \hskip 0pt plus 0.25fil minus 0.25fil
653 .\hss.\hss.%
654 \hskip 0pt plus 0.5fil minus 0.5fil
658 % @enddots{} is an end-of-sentence ellipsis.
660 \def\enddots{%
661 \leavevmode
662 \hbox to 2em{%
663 \hskip 0pt plus 0.25fil minus 0.25fil
664 .\hss.\hss.\hss.%
665 \hskip 0pt plus 0.5fil minus 0.5fil
667 \spacefactor=3000
671 % @page forces the start of a new page
673 \def\page{\par\vfill\supereject}
675 % @exdent text....
676 % outputs text on separate line in roman font, starting at standard page margin
678 % This records the amount of indent in the innermost environment.
679 % That's how much \exdent should take out.
680 \newskip\exdentamount
682 % This defn is used inside fill environments such as @defun.
683 \def\exdent{\parsearg\exdentyyy}
684 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
686 % This defn is used inside nofill environments such as @example.
687 \def\nofillexdent{\parsearg\nofillexdentyyy}
688 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
689 \leftline{\hskip\leftskip{\rm#1}}}}
691 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
692 % paragraph. For more general purposes, use the \margin insertion
693 % class. WHICH is `l' or `r'.
695 \newskip\inmarginspacing \inmarginspacing=1cm
696 \def\strutdepth{\dp\strutbox}
698 \def\doinmargin#1#2{\strut\vadjust{%
699 \nobreak
700 \kern-\strutdepth
701 \vtop to \strutdepth{%
702 \baselineskip=\strutdepth
703 \vss
704 % if you have multiple lines of stuff to put here, you'll need to
705 % make the vbox yourself of the appropriate size.
706 \ifx#1l%
707 \llap{\ignorespaces #2\hskip\inmarginspacing}%
708 \else
709 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
711 \null
714 \def\inleftmargin{\doinmargin l}
715 \def\inrightmargin{\doinmargin r}
717 % @inmargin{TEXT [, RIGHT-TEXT]}
718 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
719 % else use TEXT for both).
721 \def\inmargin#1{\parseinmargin #1,,\finish}
722 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
723 \setbox0 = \hbox{\ignorespaces #2}%
724 \ifdim\wd0 > 0pt
725 \def\lefttext{#1}% have both texts
726 \def\righttext{#2}%
727 \else
728 \def\lefttext{#1}% have only one text
729 \def\righttext{#1}%
732 \ifodd\pageno
733 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
734 \else
735 \def\temp{\inleftmargin\lefttext}%
737 \temp
740 % @include file insert text of that file as input.
741 % Allow normal characters that we make active in the argument (a file name).
742 \def\include{\begingroup
743 \catcode`\\=12
744 \catcode`~=12
745 \catcode`^=12
746 \catcode`_=12
747 \catcode`|=12
748 \catcode`<=12
749 \catcode`>=12
750 \catcode`+=12
751 \parsearg\includezzz}
752 % Restore active chars for included file.
753 \def\includezzz#1{\endgroup\begingroup
754 % Read the included file in a group so nested @include's work.
755 \def\thisfile{#1}%
756 \input\thisfile
757 \endgroup}
759 \def\thisfile{}
761 % @center line outputs that line, centered
763 \def\center{\parsearg\centerzzz}
764 \def\centerzzz #1{{\advance\hsize by -\leftskip
765 \advance\hsize by -\rightskip
766 \centerline{#1}}}
768 % @sp n outputs n lines of vertical space
770 \def\sp{\parsearg\spxxx}
771 \def\spxxx #1{\vskip #1\baselineskip}
773 % @comment ...line which is ignored...
774 % @c is the same as @comment
775 % @ignore ... @end ignore is another way to write a comment
777 \def\comment{\begingroup \catcode`\^^M=\other%
778 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
779 \commentxxx}
780 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
782 \let\c=\comment
784 % @paragraphindent NCHARS
785 % We'll use ems for NCHARS, close enough.
786 % We cannot implement @paragraphindent asis, though.
788 \def\asisword{asis} % no translation, these are keywords
789 \def\noneword{none}
791 \def\paragraphindent{\parsearg\doparagraphindent}
792 \def\doparagraphindent#1{%
793 \def\temp{#1}%
794 \ifx\temp\asisword
795 \else
796 \ifx\temp\noneword
797 \defaultparindent = 0pt
798 \else
799 \defaultparindent = #1em
802 \parindent = \defaultparindent
805 % @exampleindent NCHARS
806 % We'll use ems for NCHARS like @paragraphindent.
807 % It seems @exampleindent asis isn't necessary, but
808 % I preserve it to make it similar to @paragraphindent.
809 \def\exampleindent{\parsearg\doexampleindent}
810 \def\doexampleindent#1{%
811 \def\temp{#1}%
812 \ifx\temp\asisword
813 \else
814 \ifx\temp\noneword
815 \lispnarrowing = 0pt
816 \else
817 \lispnarrowing = #1em
822 % @asis just yields its argument. Used with @table, for example.
824 \def\asis#1{#1}
826 % @math means output in math mode.
827 % We don't use $'s directly in the definition of \math because control
828 % sequences like \math are expanded when the toc file is written. Then,
829 % we read the toc file back, the $'s will be normal characters (as they
830 % should be, according to the definition of Texinfo). So we must use a
831 % control sequence to switch into and out of math mode.
833 % This isn't quite enough for @math to work properly in indices, but it
834 % seems unlikely it will ever be needed there.
836 \let\implicitmath = $
837 \def\math#1{\implicitmath #1\implicitmath}
839 % @bullet and @minus need the same treatment as @math, just above.
840 \def\bullet{\implicitmath\ptexbullet\implicitmath}
841 \def\minus{\implicitmath-\implicitmath}
843 % @refill is a no-op.
844 \let\refill=\relax
846 % If working on a large document in chapters, it is convenient to
847 % be able to disable indexing, cross-referencing, and contents, for test runs.
848 % This is done with @novalidate (before @setfilename).
850 \newif\iflinks \linkstrue % by default we want the aux files.
851 \let\novalidate = \linksfalse
853 % @setfilename is done at the beginning of every texinfo file.
854 % So open here the files we need to have open while reading the input.
855 % This makes it possible to make a .fmt file for texinfo.
856 \def\setfilename{%
857 \iflinks
858 \readauxfile
859 \fi % \openindices needs to do some work in any case.
860 \openindices
861 \fixbackslash % Turn off hack to swallow `\input texinfo'.
862 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
864 % If texinfo.cnf is present on the system, read it.
865 % Useful for site-wide @afourpaper, etc.
866 % Just to be on the safe side, close the input stream before the \input.
867 \openin 1 texinfo.cnf
868 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
869 \closein1
870 \temp
872 \comment % Ignore the actual filename.
875 % Called from \setfilename.
877 \def\openindices{%
878 \newindex{cp}%
879 \newcodeindex{fn}%
880 \newcodeindex{vr}%
881 \newcodeindex{tp}%
882 \newcodeindex{ky}%
883 \newcodeindex{pg}%
886 % @bye.
887 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
890 \message{pdf,}
891 % adobe `portable' document format
892 \newcount\tempnum
893 \newcount\lnkcount
894 \newtoks\filename
895 \newcount\filenamelength
896 \newcount\pgn
897 \newtoks\toksA
898 \newtoks\toksB
899 \newtoks\toksC
900 \newtoks\toksD
901 \newbox\boxA
902 \newcount\countA
903 \newif\ifpdf
904 \newif\ifpdfmakepagedest
906 \ifx\pdfoutput\undefined
907 \pdffalse
908 \let\pdfmkdest = \gobble
909 \let\pdfurl = \gobble
910 \let\endlink = \relax
911 \let\linkcolor = \relax
912 \let\pdfmakeoutlines = \relax
913 \else
914 \pdftrue
915 \pdfoutput = 1
916 \input pdfcolor
917 \def\dopdfimage#1#2#3{%
918 \def\imagewidth{#2}%
919 \def\imageheight{#3}%
920 \ifnum\pdftexversion < 14
921 \pdfimage
922 \else
923 \pdfximage
925 \ifx\empty\imagewidth\else width \imagewidth \fi
926 \ifx\empty\imageheight\else height \imageheight \fi
927 \ifnum\pdftexversion<13
928 #1.pdf%
929 \else
930 {#1.pdf}%
932 \ifnum\pdftexversion < 14 \else
933 \pdfrefximage \pdflastximage
934 \fi}
935 \def\pdfmkdest#1{\pdfdest name{#1} xyz}
936 \def\pdfmkpgn#1{#1@}
937 \let\linkcolor = \Blue % was Cyan, but that seems light?
938 \def\endlink{\Black\pdfendlink}
939 % Adding outlines to PDF; macros for calculating structure of outlines
940 % come from Petr Olsak
941 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
942 \else \csname#1\endcsname \fi}
943 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
944 \advance\tempnum by1
945 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
946 \def\pdfmakeoutlines{{%
947 \openin 1 \jobname.toc
948 \ifeof 1\else\bgroup
949 \closein 1
950 \indexnofonts
951 \def\tt{}
952 \let\_ = \normalunderscore
953 % Thanh's hack / proper braces in bookmarks
954 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
955 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
957 \def\chapentry ##1##2##3{}
958 \def\unnumbchapentry ##1##2{}
959 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
960 \def\unnumbsecentry ##1##2{}
961 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
962 \def\unnumbsubsecentry ##1##2{}
963 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
964 \def\unnumbsubsubsecentry ##1##2{}
965 \input \jobname.toc
966 \def\chapentry ##1##2##3{%
967 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
968 \def\unnumbchapentry ##1##2{%
969 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
970 \def\secentry ##1##2##3##4{%
971 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
972 \def\unnumbsecentry ##1##2{%
973 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
974 \def\subsecentry ##1##2##3##4##5{%
975 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
976 \def\unnumbsubsecentry ##1##2{%
977 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
978 \def\subsubsecentry ##1##2##3##4##5##6{%
979 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
980 \def\unnumbsubsubsecentry ##1##2{%
981 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
982 \input \jobname.toc
983 \egroup\fi
985 \def\makelinks #1,{%
986 \def\params{#1}\def\E{END}%
987 \ifx\params\E
988 \let\nextmakelinks=\relax
989 \else
990 \let\nextmakelinks=\makelinks
991 \ifnum\lnkcount>0,\fi
992 \picknum{#1}%
993 \startlink attr{/Border [0 0 0]}
994 goto name{\pdfmkpgn{\the\pgn}}%
995 \linkcolor #1%
996 \advance\lnkcount by 1%
997 \endlink
999 \nextmakelinks
1001 \def\picknum#1{\expandafter\pn#1}
1002 \def\pn#1{%
1003 \def\p{#1}%
1004 \ifx\p\lbrace
1005 \let\nextpn=\ppn
1006 \else
1007 \let\nextpn=\ppnn
1008 \def\first{#1}
1010 \nextpn
1012 \def\ppn#1{\pgn=#1\gobble}
1013 \def\ppnn{\pgn=\first}
1014 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1015 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1016 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1017 \ifx\PP\D\let\nextsp\relax
1018 \else\let\nextsp\skipspaces
1019 \ifx\p\space\else\addtokens{\filename}{\PP}%
1020 \advance\filenamelength by 1
1023 \nextsp}
1024 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1025 \ifnum\pdftexversion < 14
1026 \let \startlink \pdfannotlink
1027 \else
1028 \let \startlink \pdfstartlink
1030 \def\pdfurl#1{%
1031 \begingroup
1032 \normalturnoffactive\def\@{@}%
1033 \leavevmode\Red
1034 \startlink attr{/Border [0 0 0]}%
1035 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1036 % #1
1037 \endgroup}
1038 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1039 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1040 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1041 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1042 \def\maketoks{%
1043 \expandafter\poptoks\the\toksA|ENDTOKS|
1044 \ifx\first0\adn0
1045 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1046 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1047 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1048 \else
1049 \ifnum0=\countA\else\makelink\fi
1050 \ifx\first.\let\next=\done\else
1051 \let\next=\maketoks
1052 \addtokens{\toksB}{\the\toksD}
1053 \ifx\first,\addtokens{\toksB}{\space}\fi
1055 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1056 \next}
1057 \def\makelink{\addtokens{\toksB}%
1058 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1059 \def\pdflink#1{%
1060 \startlink attr{/Border [0 0 0]} goto name{\mkpgn{#1}}
1061 \linkcolor #1\endlink}
1062 \def\mkpgn#1{#1@}
1063 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1064 \fi % \ifx\pdfoutput
1067 \message{fonts,}
1068 % Font-change commands.
1070 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1071 % So we set up a \sf analogous to plain's \rm, etc.
1072 \newfam\sffam
1073 \def\sf{\fam=\sffam \tensf}
1074 \let\li = \sf % Sometimes we call it \li, not \sf.
1076 % We don't need math for this one.
1077 \def\ttsl{\tenttsl}
1079 % Use Computer Modern fonts at \magstephalf (11pt).
1080 \newcount\mainmagstep
1081 \mainmagstep=\magstephalf
1083 % Set the font macro #1 to the font named #2, adding on the
1084 % specified font prefix (normally `cm').
1085 % #3 is the font's design size, #4 is a scale factor
1086 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1088 % Use cm as the default font prefix.
1089 % To specify the font prefix, you must define \fontprefix
1090 % before you read in texinfo.tex.
1091 \ifx\fontprefix\undefined
1092 \def\fontprefix{cm}
1094 % Support font families that don't use the same naming scheme as CM.
1095 \def\rmshape{r}
1096 \def\rmbshape{bx} %where the normal face is bold
1097 \def\bfshape{b}
1098 \def\bxshape{bx}
1099 \def\ttshape{tt}
1100 \def\ttbshape{tt}
1101 \def\ttslshape{sltt}
1102 \def\itshape{ti}
1103 \def\itbshape{bxti}
1104 \def\slshape{sl}
1105 \def\slbshape{bxsl}
1106 \def\sfshape{ss}
1107 \def\sfbshape{ss}
1108 \def\scshape{csc}
1109 \def\scbshape{csc}
1111 \ifx\bigger\relax
1112 \let\mainmagstep=\magstep1
1113 \setfont\textrm\rmshape{12}{1000}
1114 \setfont\texttt\ttshape{12}{1000}
1115 \else
1116 \setfont\textrm\rmshape{10}{\mainmagstep}
1117 \setfont\texttt\ttshape{10}{\mainmagstep}
1119 % Instead of cmb10, you many want to use cmbx10.
1120 % cmbx10 is a prettier font on its own, but cmb10
1121 % looks better when embedded in a line with cmr10.
1122 \setfont\textbf\bfshape{10}{\mainmagstep}
1123 \setfont\textit\itshape{10}{\mainmagstep}
1124 \setfont\textsl\slshape{10}{\mainmagstep}
1125 \setfont\textsf\sfshape{10}{\mainmagstep}
1126 \setfont\textsc\scshape{10}{\mainmagstep}
1127 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1128 \font\texti=cmmi10 scaled \mainmagstep
1129 \font\textsy=cmsy10 scaled \mainmagstep
1131 % A few fonts for @defun, etc.
1132 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1133 \setfont\deftt\ttshape{10}{\magstep1}
1134 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1136 % Fonts for indices, footnotes, small examples (9pt).
1137 \setfont\smallrm\rmshape{9}{1000}
1138 \setfont\smalltt\ttshape{9}{1000}
1139 \setfont\smallbf\bfshape{10}{900}
1140 \setfont\smallit\itshape{9}{1000}
1141 \setfont\smallsl\slshape{9}{1000}
1142 \setfont\smallsf\sfshape{9}{1000}
1143 \setfont\smallsc\scshape{10}{900}
1144 \setfont\smallttsl\ttslshape{10}{900}
1145 \font\smalli=cmmi9
1146 \font\smallsy=cmsy9
1148 % Fonts for title page:
1149 \setfont\titlerm\rmbshape{12}{\magstep3}
1150 \setfont\titleit\itbshape{10}{\magstep4}
1151 \setfont\titlesl\slbshape{10}{\magstep4}
1152 \setfont\titlett\ttbshape{12}{\magstep3}
1153 \setfont\titlettsl\ttslshape{10}{\magstep4}
1154 \setfont\titlesf\sfbshape{17}{\magstep1}
1155 \let\titlebf=\titlerm
1156 \setfont\titlesc\scbshape{10}{\magstep4}
1157 \font\titlei=cmmi12 scaled \magstep3
1158 \font\titlesy=cmsy10 scaled \magstep4
1159 \def\authorrm{\secrm}
1161 % Chapter (and unnumbered) fonts (17.28pt).
1162 \setfont\chaprm\rmbshape{12}{\magstep2}
1163 \setfont\chapit\itbshape{10}{\magstep3}
1164 \setfont\chapsl\slbshape{10}{\magstep3}
1165 \setfont\chaptt\ttbshape{12}{\magstep2}
1166 \setfont\chapttsl\ttslshape{10}{\magstep3}
1167 \setfont\chapsf\sfbshape{17}{1000}
1168 \let\chapbf=\chaprm
1169 \setfont\chapsc\scbshape{10}{\magstep3}
1170 \font\chapi=cmmi12 scaled \magstep2
1171 \font\chapsy=cmsy10 scaled \magstep3
1173 % Section fonts (14.4pt).
1174 \setfont\secrm\rmbshape{12}{\magstep1}
1175 \setfont\secit\itbshape{10}{\magstep2}
1176 \setfont\secsl\slbshape{10}{\magstep2}
1177 \setfont\sectt\ttbshape{12}{\magstep1}
1178 \setfont\secttsl\ttslshape{10}{\magstep2}
1179 \setfont\secsf\sfbshape{12}{\magstep1}
1180 \let\secbf\secrm
1181 \setfont\secsc\scbshape{10}{\magstep2}
1182 \font\seci=cmmi12 scaled \magstep1
1183 \font\secsy=cmsy10 scaled \magstep2
1185 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1186 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1187 % \setfont\ssecsl\slshape{10}{\magstep1}
1188 % \setfont\ssectt\ttshape{10}{\magstep1}
1189 % \setfont\ssecsf\sfshape{10}{\magstep1}
1191 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1192 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1193 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1194 %\setfont\ssectt\ttshape{10}{1315}
1195 %\setfont\ssecsf\sfshape{10}{1315}
1197 %\let\ssecbf=\ssecrm
1199 % Subsection fonts (13.15pt).
1200 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1201 \setfont\ssecit\itbshape{10}{1315}
1202 \setfont\ssecsl\slbshape{10}{1315}
1203 \setfont\ssectt\ttbshape{12}{\magstephalf}
1204 \setfont\ssecttsl\ttslshape{10}{1315}
1205 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1206 \let\ssecbf\ssecrm
1207 \setfont\ssecsc\scbshape{10}{\magstep1}
1208 \font\sseci=cmmi12 scaled \magstephalf
1209 \font\ssecsy=cmsy10 scaled 1315
1210 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1211 % but that is not a standard magnification.
1213 % In order for the font changes to affect most math symbols and letters,
1214 % we have to define the \textfont of the standard families. Since
1215 % texinfo doesn't allow for producing subscripts and superscripts, we
1216 % don't bother to reset \scriptfont and \scriptscriptfont (which would
1217 % also require loading a lot more fonts).
1219 \def\resetmathfonts{%
1220 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1221 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1222 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1226 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1227 % of just \STYLE. We do this so that font changes will continue to work
1228 % in math mode, where it is the current \fam that is relevant in most
1229 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1230 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1231 % redefine \bf itself.
1232 \def\textfonts{%
1233 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1234 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1235 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1236 \resetmathfonts}
1237 \def\titlefonts{%
1238 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1239 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1240 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1241 \let\tenttsl=\titlettsl
1242 \resetmathfonts \setleading{25pt}}
1243 \def\titlefont#1{{\titlefonts\rm #1}}
1244 \def\chapfonts{%
1245 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1246 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1247 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1248 \resetmathfonts \setleading{19pt}}
1249 \def\secfonts{%
1250 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1251 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1252 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1253 \resetmathfonts \setleading{16pt}}
1254 \def\subsecfonts{%
1255 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1256 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1257 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1258 \resetmathfonts \setleading{15pt}}
1259 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1260 \def\smallfonts{%
1261 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1262 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1263 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1264 \let\tenttsl=\smallttsl
1265 \resetmathfonts \setleading{11pt}}
1267 % Set up the default fonts, so we can use them for creating boxes.
1269 \textfonts
1271 % Define these so they can be easily changed for other fonts.
1272 \def\angleleft{$\langle$}
1273 \def\angleright{$\rangle$}
1275 % Count depth in font-changes, for error checks
1276 \newcount\fontdepth \fontdepth=0
1278 % Fonts for short table of contents.
1279 \setfont\shortcontrm\rmshape{12}{1000}
1280 \setfont\shortcontbf\bxshape{12}{1000}
1281 \setfont\shortcontsl\slshape{12}{1000}
1283 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1284 %% serif) and @ii for TeX italic
1286 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1287 % unless the following character is such as not to need one.
1288 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1289 \def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx}
1290 \def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx}
1292 \let\i=\smartitalic
1293 \let\var=\smartslanted
1294 \let\dfn=\smartslanted
1295 \let\emph=\smartitalic
1296 \let\cite=\smartslanted
1298 \def\b#1{{\bf #1}}
1299 \let\strong=\b
1301 % We can't just use \exhyphenpenalty, because that only has effect at
1302 % the end of a paragraph. Restore normal hyphenation at the end of the
1303 % group within which \nohyphenation is presumably called.
1305 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1306 \def\restorehyphenation{\hyphenchar\font = `- }
1308 \def\t#1{%
1309 {\tt \rawbackslash \frenchspacing #1}%
1310 \null
1312 \let\ttfont=\t
1313 \def\samp#1{`\tclose{#1}'\null}
1314 \setfont\keyrm\rmshape{8}{1000}
1315 \font\keysy=cmsy9
1316 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1317 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1318 \vbox{\hrule\kern-0.4pt
1319 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1320 \kern-0.4pt\hrule}%
1321 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1322 % The old definition, with no lozenge:
1323 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1324 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1326 % @file, @option are the same as @samp.
1327 \let\file=\samp
1328 \let\option=\samp
1330 % @code is a modification of @t,
1331 % which makes spaces the same size as normal in the surrounding text.
1332 \def\tclose#1{%
1334 % Change normal interword space to be same as for the current font.
1335 \spaceskip = \fontdimen2\font
1337 % Switch to typewriter.
1340 % But `\ ' produces the large typewriter interword space.
1341 \def\ {{\spaceskip = 0pt{} }}%
1343 % Turn off hyphenation.
1344 \nohyphenation
1346 \rawbackslash
1347 \frenchspacing
1350 \null
1353 % We *must* turn on hyphenation at `-' and `_' in \code.
1354 % Otherwise, it is too hard to avoid overfull hboxes
1355 % in the Emacs manual, the Library manual, etc.
1357 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1358 % both hyphenation at - and hyphenation within words.
1359 % We must therefore turn them both off (\tclose does that)
1360 % and arrange explicitly to hyphenate at a dash.
1361 % -- rms.
1363 \catcode`\-=\active
1364 \catcode`\_=\active
1366 \global\def\code{\begingroup
1367 \catcode`\-=\active \let-\codedash
1368 \catcode`\_=\active \let_\codeunder
1369 \codex
1372 % If we end up with any active - characters when handling the index,
1373 % just treat them as a normal -.
1374 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1377 \def\realdash{-}
1378 \def\codedash{-\discretionary{}{}{}}
1379 \def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}}
1380 \def\codex #1{\tclose{#1}\endgroup}
1382 %\let\exp=\tclose %Was temporary
1384 % @kbd is like @code, except that if the argument is just one @key command,
1385 % then @kbd has no effect.
1387 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1388 % `example' (@kbd uses ttsl only inside of @example and friends),
1389 % or `code' (@kbd uses normal tty font always).
1390 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1391 \def\kbdinputstylexxx#1{%
1392 \def\arg{#1}%
1393 \ifx\arg\worddistinct
1394 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1395 \else\ifx\arg\wordexample
1396 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1397 \else\ifx\arg\wordcode
1398 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1399 \fi\fi\fi
1401 \def\worddistinct{distinct}
1402 \def\wordexample{example}
1403 \def\wordcode{code}
1405 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1406 % the catcodes are wrong for parsearg to work.)
1407 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1409 \def\xkey{\key}
1410 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1411 \ifx\one\xkey\ifx\threex\three \key{#2}%
1412 \else{\tclose{\kbdfont\look}}\fi
1413 \else{\tclose{\kbdfont\look}}\fi}
1415 % For @url, @env, @command quotes seem unnecessary, so use \code.
1416 \let\url=\code
1417 \let\env=\code
1418 \let\command=\code
1420 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1421 % second argument specifying the text to display and an optional third
1422 % arg as text to display instead of (rather than in addition to) the url
1423 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1424 % a hypertex \special here.
1426 \def\uref#1{\douref #1,,,\finish}
1427 \def\douref#1,#2,#3,#4\finish{\begingroup
1428 \unsepspaces
1429 \pdfurl{#1}%
1430 \setbox0 = \hbox{\ignorespaces #3}%
1431 \ifdim\wd0 > 0pt
1432 \unhbox0 % third arg given, show only that
1433 \else
1434 \setbox0 = \hbox{\ignorespaces #2}%
1435 \ifdim\wd0 > 0pt
1436 \ifpdf
1437 \unhbox0 % PDF: 2nd arg given, show only it
1438 \else
1439 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1441 \else
1442 \code{#1}% only url given, so show it
1445 \endlink
1446 \endgroup}
1448 % rms does not like angle brackets --karl, 17may97.
1449 % So now @email is just like @uref, unless we are pdf.
1451 %\def\email#1{\angleleft{\tt #1}\angleright}
1452 \ifpdf
1453 \def\email#1{\doemail#1,,\finish}
1454 \def\doemail#1,#2,#3\finish{\begingroup
1455 \unsepspaces
1456 \pdfurl{mailto:#1}%
1457 \setbox0 = \hbox{\ignorespaces #2}%
1458 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1459 \endlink
1460 \endgroup}
1461 \else
1462 \let\email=\uref
1465 % Check if we are currently using a typewriter font. Since all the
1466 % Computer Modern typewriter fonts have zero interword stretch (and
1467 % shrink), and it is reasonable to expect all typewriter fonts to have
1468 % this property, we can check that font parameter.
1470 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1472 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1473 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1475 \def\dmn#1{\thinspace #1}
1477 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1479 % @l was never documented to mean ``switch to the Lisp font'',
1480 % and it is not used as such in any manual I can find. We need it for
1481 % Polish suppressed-l. --karl, 22sep96.
1482 %\def\l#1{{\li #1}\null}
1484 % Explicit font changes: @r, @sc, undocumented @ii.
1485 \def\r#1{{\rm #1}} % roman font
1486 \def\sc#1{{\smallcaps#1}} % smallcaps font
1487 \def\ii#1{{\it #1}} % italic font
1489 % @acronym downcases the argument and prints in smallcaps.
1490 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1492 % @pounds{} is a sterling sign.
1493 \def\pounds{{\it\$}}
1496 \message{page headings,}
1498 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1499 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1501 % First the title page. Must do @settitle before @titlepage.
1502 \newif\ifseenauthor
1503 \newif\iffinishedtitlepage
1505 % Do an implicit @contents or @shortcontents after @end titlepage if the
1506 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1508 \newif\ifsetcontentsaftertitlepage
1509 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1510 \newif\ifsetshortcontentsaftertitlepage
1511 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1513 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1514 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1515 \endgroup\page\hbox{}\page}
1517 \def\titlepage{\begingroup \parindent=0pt \textfonts
1518 \let\subtitlerm=\tenrm
1519 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1521 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1523 % Leave some space at the very top of the page.
1524 \vglue\titlepagetopglue
1526 % Now you can print the title using @title.
1527 \def\title{\parsearg\titlezzz}%
1528 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1529 % print a rule at the page bottom also.
1530 \finishedtitlepagefalse
1531 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1532 % No rule at page bottom unless we print one at the top with @title.
1533 \finishedtitlepagetrue
1535 % Now you can put text using @subtitle.
1536 \def\subtitle{\parsearg\subtitlezzz}%
1537 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1539 % @author should come last, but may come many times.
1540 \def\author{\parsearg\authorzzz}%
1541 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1542 {\authorfont \leftline{##1}}}%
1544 % Most title ``pages'' are actually two pages long, with space
1545 % at the top of the second. We don't want the ragged left on the second.
1546 \let\oldpage = \page
1547 \def\page{%
1548 \iffinishedtitlepage\else
1549 \finishtitlepage
1551 \oldpage
1552 \let\page = \oldpage
1553 \hbox{}}%
1554 % \def\page{\oldpage \hbox{}}
1557 \def\Etitlepage{%
1558 \iffinishedtitlepage\else
1559 \finishtitlepage
1561 % It is important to do the page break before ending the group,
1562 % because the headline and footline are only empty inside the group.
1563 % If we use the new definition of \page, we always get a blank page
1564 % after the title page, which we certainly don't want.
1565 \oldpage
1566 \endgroup
1568 % If they want short, they certainly want long too.
1569 \ifsetshortcontentsaftertitlepage
1570 \shortcontents
1571 \contents
1572 \global\let\shortcontents = \relax
1573 \global\let\contents = \relax
1576 \ifsetcontentsaftertitlepage
1577 \contents
1578 \global\let\contents = \relax
1579 \global\let\shortcontents = \relax
1582 \ifpdf \pdfmakepagedesttrue \fi
1584 \HEADINGSon
1587 \def\finishtitlepage{%
1588 \vskip4pt \hrule height 2pt width \hsize
1589 \vskip\titlepagebottomglue
1590 \finishedtitlepagetrue
1593 %%% Set up page headings and footings.
1595 \let\thispage=\folio
1597 \newtoks\evenheadline % headline on even pages
1598 \newtoks\oddheadline % headline on odd pages
1599 \newtoks\evenfootline % footline on even pages
1600 \newtoks\oddfootline % footline on odd pages
1602 % Now make Tex use those variables
1603 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1604 \else \the\evenheadline \fi}}
1605 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1606 \else \the\evenfootline \fi}\HEADINGShook}
1607 \let\HEADINGShook=\relax
1609 % Commands to set those variables.
1610 % For example, this is what @headings on does
1611 % @evenheading @thistitle|@thispage|@thischapter
1612 % @oddheading @thischapter|@thispage|@thistitle
1613 % @evenfooting @thisfile||
1614 % @oddfooting ||@thisfile
1616 \def\evenheading{\parsearg\evenheadingxxx}
1617 \def\oddheading{\parsearg\oddheadingxxx}
1618 \def\everyheading{\parsearg\everyheadingxxx}
1620 \def\evenfooting{\parsearg\evenfootingxxx}
1621 \def\oddfooting{\parsearg\oddfootingxxx}
1622 \def\everyfooting{\parsearg\everyfootingxxx}
1624 {\catcode`\@=0 %
1626 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1627 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1628 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1630 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1631 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1632 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1634 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1636 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1637 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1638 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1640 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1641 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1642 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1644 % Leave some space for the footline. Hopefully ok to assume
1645 % @evenfooting will not be used by itself.
1646 \global\advance\pageheight by -\baselineskip
1647 \global\advance\vsize by -\baselineskip
1650 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1652 }% unbind the catcode of @.
1654 % @headings double turns headings on for double-sided printing.
1655 % @headings single turns headings on for single-sided printing.
1656 % @headings off turns them off.
1657 % @headings on same as @headings double, retained for compatibility.
1658 % @headings after turns on double-sided headings after this page.
1659 % @headings doubleafter turns on double-sided headings after this page.
1660 % @headings singleafter turns on single-sided headings after this page.
1661 % By default, they are off at the start of a document,
1662 % and turned `on' after @end titlepage.
1664 \def\headings #1 {\csname HEADINGS#1\endcsname}
1666 \def\HEADINGSoff{
1667 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1668 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1669 \HEADINGSoff
1670 % When we turn headings on, set the page number to 1.
1671 % For double-sided printing, put current file name in lower left corner,
1672 % chapter name on inside top of right hand pages, document
1673 % title on inside top of left hand pages, and page numbers on outside top
1674 % edge of all pages.
1675 \def\HEADINGSdouble{
1676 \global\pageno=1
1677 \global\evenfootline={\hfil}
1678 \global\oddfootline={\hfil}
1679 \global\evenheadline={\line{\folio\hfil\thistitle}}
1680 \global\oddheadline={\line{\thischapter\hfil\folio}}
1681 \global\let\contentsalignmacro = \chapoddpage
1683 \let\contentsalignmacro = \chappager
1685 % For single-sided printing, chapter title goes across top left of page,
1686 % page number on top right.
1687 \def\HEADINGSsingle{
1688 \global\pageno=1
1689 \global\evenfootline={\hfil}
1690 \global\oddfootline={\hfil}
1691 \global\evenheadline={\line{\thischapter\hfil\folio}}
1692 \global\oddheadline={\line{\thischapter\hfil\folio}}
1693 \global\let\contentsalignmacro = \chappager
1695 \def\HEADINGSon{\HEADINGSdouble}
1697 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1698 \let\HEADINGSdoubleafter=\HEADINGSafter
1699 \def\HEADINGSdoublex{%
1700 \global\evenfootline={\hfil}
1701 \global\oddfootline={\hfil}
1702 \global\evenheadline={\line{\folio\hfil\thistitle}}
1703 \global\oddheadline={\line{\thischapter\hfil\folio}}
1704 \global\let\contentsalignmacro = \chapoddpage
1707 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1708 \def\HEADINGSsinglex{%
1709 \global\evenfootline={\hfil}
1710 \global\oddfootline={\hfil}
1711 \global\evenheadline={\line{\thischapter\hfil\folio}}
1712 \global\oddheadline={\line{\thischapter\hfil\folio}}
1713 \global\let\contentsalignmacro = \chappager
1716 % Subroutines used in generating headings
1717 % This produces Day Month Year style of output.
1718 % Only define if not already defined, in case a txi-??.tex file has set
1719 % up a different format (e.g., txi-cs.tex does this).
1720 \ifx\today\undefined
1721 \def\today{%
1722 \number\day\space
1723 \ifcase\month
1724 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1725 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1726 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1728 \space\number\year}
1731 % @settitle line... specifies the title of the document, for headings.
1732 % It generates no output of its own.
1733 \def\thistitle{\putwordNoTitle}
1734 \def\settitle{\parsearg\settitlezzz}
1735 \def\settitlezzz #1{\gdef\thistitle{#1}}
1738 \message{tables,}
1739 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1741 % default indentation of table text
1742 \newdimen\tableindent \tableindent=.8in
1743 % default indentation of @itemize and @enumerate text
1744 \newdimen\itemindent \itemindent=.3in
1745 % margin between end of table item and start of table text.
1746 \newdimen\itemmargin \itemmargin=.1in
1748 % used internally for \itemindent minus \itemmargin
1749 \newdimen\itemmax
1751 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1752 % these defs.
1753 % They also define \itemindex
1754 % to index the item name in whatever manner is desired (perhaps none).
1756 \newif\ifitemxneedsnegativevskip
1758 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1760 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1761 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1763 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1764 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1766 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1767 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1769 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1770 \itemzzz {#1}}
1772 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1773 \itemzzz {#1}}
1775 \def\itemzzz #1{\begingroup %
1776 \advance\hsize by -\rightskip
1777 \advance\hsize by -\tableindent
1778 \setbox0=\hbox{\itemfont{#1}}%
1779 \itemindex{#1}%
1780 \nobreak % This prevents a break before @itemx.
1782 % If the item text does not fit in the space we have, put it on a line
1783 % by itself, and do not allow a page break either before or after that
1784 % line. We do not start a paragraph here because then if the next
1785 % command is, e.g., @kindex, the whatsit would get put into the
1786 % horizontal list on a line by itself, resulting in extra blank space.
1787 \ifdim \wd0>\itemmax
1789 % Make this a paragraph so we get the \parskip glue and wrapping,
1790 % but leave it ragged-right.
1791 \begingroup
1792 \advance\leftskip by-\tableindent
1793 \advance\hsize by\tableindent
1794 \advance\rightskip by0pt plus1fil
1795 \leavevmode\unhbox0\par
1796 \endgroup
1798 % We're going to be starting a paragraph, but we don't want the
1799 % \parskip glue -- logically it's part of the @item we just started.
1800 \nobreak \vskip-\parskip
1802 % Stop a page break at the \parskip glue coming up. Unfortunately
1803 % we can't prevent a possible page break at the following
1804 % \baselineskip glue.
1805 \nobreak
1806 \endgroup
1807 \itemxneedsnegativevskipfalse
1808 \else
1809 % The item text fits into the space. Start a paragraph, so that the
1810 % following text (if any) will end up on the same line.
1811 \noindent
1812 % Do this with kerns and \unhbox so that if there is a footnote in
1813 % the item text, it can migrate to the main vertical list and
1814 % eventually be printed.
1815 \nobreak\kern-\tableindent
1816 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1817 \unhbox0
1818 \nobreak\kern\dimen0
1819 \endgroup
1820 \itemxneedsnegativevskiptrue
1824 \def\item{\errmessage{@item while not in a table}}
1825 \def\itemx{\errmessage{@itemx while not in a table}}
1826 \def\kitem{\errmessage{@kitem while not in a table}}
1827 \def\kitemx{\errmessage{@kitemx while not in a table}}
1828 \def\xitem{\errmessage{@xitem while not in a table}}
1829 \def\xitemx{\errmessage{@xitemx while not in a table}}
1831 % Contains a kludge to get @end[description] to work.
1832 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1834 % @table, @ftable, @vtable.
1835 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1836 {\obeylines\obeyspaces%
1837 \gdef\tablex #1^^M{%
1838 \tabley\dontindex#1 \endtabley}}
1840 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1841 {\obeylines\obeyspaces%
1842 \gdef\ftablex #1^^M{%
1843 \tabley\fnitemindex#1 \endtabley
1844 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1845 \let\Etable=\relax}}
1847 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1848 {\obeylines\obeyspaces%
1849 \gdef\vtablex #1^^M{%
1850 \tabley\vritemindex#1 \endtabley
1851 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1852 \let\Etable=\relax}}
1854 \def\dontindex #1{}
1855 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1856 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1858 {\obeyspaces %
1859 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1860 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1862 \def\tablez #1#2#3#4#5#6{%
1863 \aboveenvbreak %
1864 \begingroup %
1865 \def\Edescription{\Etable}% Necessary kludge.
1866 \let\itemindex=#1%
1867 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1868 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1869 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1870 \def\itemfont{#2}%
1871 \itemmax=\tableindent %
1872 \advance \itemmax by -\itemmargin %
1873 \advance \leftskip by \tableindent %
1874 \exdentamount=\tableindent
1875 \parindent = 0pt
1876 \parskip = \smallskipamount
1877 \ifdim \parskip=0pt \parskip=2pt \fi%
1878 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1879 \let\item = \internalBitem %
1880 \let\itemx = \internalBitemx %
1881 \let\kitem = \internalBkitem %
1882 \let\kitemx = \internalBkitemx %
1883 \let\xitem = \internalBxitem %
1884 \let\xitemx = \internalBxitemx %
1887 % This is the counter used by @enumerate, which is really @itemize
1889 \newcount \itemno
1891 \def\itemize{\parsearg\itemizezzz}
1893 \def\itemizezzz #1{%
1894 \begingroup % ended by the @end itemize
1895 \itemizey {#1}{\Eitemize}
1898 \def\itemizey #1#2{%
1899 \aboveenvbreak %
1900 \itemmax=\itemindent %
1901 \advance \itemmax by -\itemmargin %
1902 \advance \leftskip by \itemindent %
1903 \exdentamount=\itemindent
1904 \parindent = 0pt %
1905 \parskip = \smallskipamount %
1906 \ifdim \parskip=0pt \parskip=2pt \fi%
1907 \def#2{\endgraf\afterenvbreak\endgroup}%
1908 \def\itemcontents{#1}%
1909 \let\item=\itemizeitem}
1911 % Set sfcode to normal for the chars that usually have another value.
1912 % These are `.?!:;,'
1913 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1914 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1916 % \splitoff TOKENS\endmark defines \first to be the first token in
1917 % TOKENS, and \rest to be the remainder.
1919 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1921 % Allow an optional argument of an uppercase letter, lowercase letter,
1922 % or number, to specify the first label in the enumerated list. No
1923 % argument is the same as `1'.
1925 \def\enumerate{\parsearg\enumeratezzz}
1926 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1927 \def\enumeratey #1 #2\endenumeratey{%
1928 \begingroup % ended by the @end enumerate
1930 % If we were given no argument, pretend we were given `1'.
1931 \def\thearg{#1}%
1932 \ifx\thearg\empty \def\thearg{1}\fi
1934 % Detect if the argument is a single token. If so, it might be a
1935 % letter. Otherwise, the only valid thing it can be is a number.
1936 % (We will always have one token, because of the test we just made.
1937 % This is a good thing, since \splitoff doesn't work given nothing at
1938 % all -- the first parameter is undelimited.)
1939 \expandafter\splitoff\thearg\endmark
1940 \ifx\rest\empty
1941 % Only one token in the argument. It could still be anything.
1942 % A ``lowercase letter'' is one whose \lccode is nonzero.
1943 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1944 % not equal to itself.
1945 % Otherwise, we assume it's a number.
1947 % We need the \relax at the end of the \ifnum lines to stop TeX from
1948 % continuing to look for a <number>.
1950 \ifnum\lccode\expandafter`\thearg=0\relax
1951 \numericenumerate % a number (we hope)
1952 \else
1953 % It's a letter.
1954 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1955 \lowercaseenumerate % lowercase letter
1956 \else
1957 \uppercaseenumerate % uppercase letter
1960 \else
1961 % Multiple tokens in the argument. We hope it's a number.
1962 \numericenumerate
1966 % An @enumerate whose labels are integers. The starting integer is
1967 % given in \thearg.
1969 \def\numericenumerate{%
1970 \itemno = \thearg
1971 \startenumeration{\the\itemno}%
1974 % The starting (lowercase) letter is in \thearg.
1975 \def\lowercaseenumerate{%
1976 \itemno = \expandafter`\thearg
1977 \startenumeration{%
1978 % Be sure we're not beyond the end of the alphabet.
1979 \ifnum\itemno=0
1980 \errmessage{No more lowercase letters in @enumerate; get a bigger
1981 alphabet}%
1983 \char\lccode\itemno
1987 % The starting (uppercase) letter is in \thearg.
1988 \def\uppercaseenumerate{%
1989 \itemno = \expandafter`\thearg
1990 \startenumeration{%
1991 % Be sure we're not beyond the end of the alphabet.
1992 \ifnum\itemno=0
1993 \errmessage{No more uppercase letters in @enumerate; get a bigger
1994 alphabet}
1996 \char\uccode\itemno
2000 % Call itemizey, adding a period to the first argument and supplying the
2001 % common last two arguments. Also subtract one from the initial value in
2002 % \itemno, since @item increments \itemno.
2004 \def\startenumeration#1{%
2005 \advance\itemno by -1
2006 \itemizey{#1.}\Eenumerate\flushcr
2009 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2010 % to @enumerate.
2012 \def\alphaenumerate{\enumerate{a}}
2013 \def\capsenumerate{\enumerate{A}}
2014 \def\Ealphaenumerate{\Eenumerate}
2015 \def\Ecapsenumerate{\Eenumerate}
2017 % Definition of @item while inside @itemize.
2019 \def\itemizeitem{%
2020 \advance\itemno by 1
2021 {\let\par=\endgraf \smallbreak}%
2022 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2023 {\parskip=0in \hskip 0pt
2024 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2025 \vadjust{\penalty 1200}}%
2026 \flushcr}
2028 % @multitable macros
2029 % Amy Hendrickson, 8/18/94, 3/6/96
2031 % @multitable ... @end multitable will make as many columns as desired.
2032 % Contents of each column will wrap at width given in preamble. Width
2033 % can be specified either with sample text given in a template line,
2034 % or in percent of \hsize, the current width of text on page.
2036 % Table can continue over pages but will only break between lines.
2038 % To make preamble:
2040 % Either define widths of columns in terms of percent of \hsize:
2041 % @multitable @columnfractions .25 .3 .45
2042 % @item ...
2044 % Numbers following @columnfractions are the percent of the total
2045 % current hsize to be used for each column. You may use as many
2046 % columns as desired.
2049 % Or use a template:
2050 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2051 % @item ...
2052 % using the widest term desired in each column.
2054 % For those who want to use more than one line's worth of words in
2055 % the preamble, break the line within one argument and it
2056 % will parse correctly, i.e.,
2058 % @multitable {Column 1 template} {Column 2 template} {Column 3
2059 % template}
2060 % Not:
2061 % @multitable {Column 1 template} {Column 2 template}
2062 % {Column 3 template}
2064 % Each new table line starts with @item, each subsequent new column
2065 % starts with @tab. Empty columns may be produced by supplying @tab's
2066 % with nothing between them for as many times as empty columns are needed,
2067 % ie, @tab@tab@tab will produce two empty columns.
2069 % @item, @tab, @multitable or @end multitable do not need to be on their
2070 % own lines, but it will not hurt if they are.
2072 % Sample multitable:
2074 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2075 % @item first col stuff @tab second col stuff @tab third col
2076 % @item
2077 % first col stuff
2078 % @tab
2079 % second col stuff
2080 % @tab
2081 % third col
2082 % @item first col stuff @tab second col stuff
2083 % @tab Many paragraphs of text may be used in any column.
2085 % They will wrap at the width determined by the template.
2086 % @item@tab@tab This will be in third column.
2087 % @end multitable
2089 % Default dimensions may be reset by user.
2090 % @multitableparskip is vertical space between paragraphs in table.
2091 % @multitableparindent is paragraph indent in table.
2092 % @multitablecolmargin is horizontal space to be left between columns.
2093 % @multitablelinespace is space to leave between table items, baseline
2094 % to baseline.
2095 % 0pt means it depends on current normal line spacing.
2097 \newskip\multitableparskip
2098 \newskip\multitableparindent
2099 \newdimen\multitablecolspace
2100 \newskip\multitablelinespace
2101 \multitableparskip=0pt
2102 \multitableparindent=6pt
2103 \multitablecolspace=12pt
2104 \multitablelinespace=0pt
2106 % Macros used to set up halign preamble:
2108 \let\endsetuptable\relax
2109 \def\xendsetuptable{\endsetuptable}
2110 \let\columnfractions\relax
2111 \def\xcolumnfractions{\columnfractions}
2112 \newif\ifsetpercent
2114 % #1 is the part of the @columnfraction before the decimal point, which
2115 % is presumably either 0 or the empty string (but we don't check, we
2116 % just throw it away). #2 is the decimal part, which we use as the
2117 % percent of \hsize for this column.
2118 \def\pickupwholefraction#1.#2 {%
2119 \global\advance\colcount by 1
2120 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2121 \setuptable
2124 \newcount\colcount
2125 \def\setuptable#1{%
2126 \def\firstarg{#1}%
2127 \ifx\firstarg\xendsetuptable
2128 \let\go = \relax
2129 \else
2130 \ifx\firstarg\xcolumnfractions
2131 \global\setpercenttrue
2132 \else
2133 \ifsetpercent
2134 \let\go\pickupwholefraction
2135 \else
2136 \global\advance\colcount by 1
2137 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2138 % typically that is always in the input, anyway.
2139 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2142 \ifx\go\pickupwholefraction
2143 % Put the argument back for the \pickupwholefraction call, so
2144 % we'll always have a period there to be parsed.
2145 \def\go{\pickupwholefraction#1}%
2146 \else
2147 \let\go = \setuptable
2148 \fi%
2153 % This used to have \hskip1sp. But then the space in a template line is
2154 % not enough. That is bad. So let's go back to just & until we
2155 % encounter the problem it was intended to solve again.
2156 % --karl, nathan@acm.org, 20apr99.
2157 \def\tab{&}
2159 % @multitable ... @end multitable definitions:
2161 \def\multitable{\parsearg\dotable}
2162 \def\dotable#1{\bgroup
2163 \vskip\parskip
2164 \let\item\crcr
2165 \tolerance=9500
2166 \hbadness=9500
2167 \setmultitablespacing
2168 \parskip=\multitableparskip
2169 \parindent=\multitableparindent
2170 \overfullrule=0pt
2171 \global\colcount=0
2172 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2174 % To parse everything between @multitable and @item:
2175 \setuptable#1 \endsetuptable
2177 % \everycr will reset column counter, \colcount, at the end of
2178 % each line. Every column entry will cause \colcount to advance by one.
2179 % The table preamble
2180 % looks at the current \colcount to find the correct column width.
2181 \everycr{\noalign{%
2183 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2184 % Maybe so, but it also creates really weird page breaks when the table
2185 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2186 % manifests itself, so it can be fixed for real --karl.
2187 \global\colcount=0\relax}}%
2189 % This preamble sets up a generic column definition, which will
2190 % be used as many times as user calls for columns.
2191 % \vtop will set a single line and will also let text wrap and
2192 % continue for many paragraphs if desired.
2193 \halign\bgroup&\global\advance\colcount by 1\relax
2194 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2196 % In order to keep entries from bumping into each other
2197 % we will add a \leftskip of \multitablecolspace to all columns after
2198 % the first one.
2200 % If a template has been used, we will add \multitablecolspace
2201 % to the width of each template entry.
2203 % If the user has set preamble in terms of percent of \hsize we will
2204 % use that dimension as the width of the column, and the \leftskip
2205 % will keep entries from bumping into each other. Table will start at
2206 % left margin and final column will justify at right margin.
2208 % Make sure we don't inherit \rightskip from the outer environment.
2209 \rightskip=0pt
2210 \ifnum\colcount=1
2211 % The first column will be indented with the surrounding text.
2212 \advance\hsize by\leftskip
2213 \else
2214 \ifsetpercent \else
2215 % If user has not set preamble in terms of percent of \hsize
2216 % we will advance \hsize by \multitablecolspace.
2217 \advance\hsize by \multitablecolspace
2219 % In either case we will make \leftskip=\multitablecolspace:
2220 \leftskip=\multitablecolspace
2222 % Ignoring space at the beginning and end avoids an occasional spurious
2223 % blank line, when TeX decides to break the line at the space before the
2224 % box from the multistrut, so the strut ends up on a line by itself.
2225 % For example:
2226 % @multitable @columnfractions .11 .89
2227 % @item @code{#}
2228 % @tab Legal holiday which is valid in major parts of the whole country.
2229 % Is automatically provided with highlighting sequences respectively marking
2230 % characters.
2231 \noindent\ignorespaces##\unskip\multistrut}\cr
2234 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2235 % If so, do nothing. If not, give it an appropriate dimension based on
2236 % current baselineskip.
2237 \ifdim\multitablelinespace=0pt
2238 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2239 \global\advance\multitablelinespace by-\ht0
2240 %% strut to put in table in case some entry doesn't have descenders,
2241 %% to keep lines equally spaced
2242 \let\multistrut = \strut
2243 \else
2244 %% FIXME: what is \box0 supposed to be?
2245 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2246 width0pt\relax} \fi
2247 %% Test to see if parskip is larger than space between lines of
2248 %% table. If not, do nothing.
2249 %% If so, set to same dimension as multitablelinespace.
2250 \ifdim\multitableparskip>\multitablelinespace
2251 \global\multitableparskip=\multitablelinespace
2252 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2253 %% than skip between lines in the table.
2254 \fi%
2255 \ifdim\multitableparskip=0pt
2256 \global\multitableparskip=\multitablelinespace
2257 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2258 %% than skip between lines in the table.
2259 \fi}
2262 \message{conditionals,}
2263 % Prevent errors for section commands.
2264 % Used in @ignore and in failing conditionals.
2265 \def\ignoresections{%
2266 \let\chapter=\relax
2267 \let\unnumbered=\relax
2268 \let\top=\relax
2269 \let\unnumberedsec=\relax
2270 \let\unnumberedsection=\relax
2271 \let\unnumberedsubsec=\relax
2272 \let\unnumberedsubsection=\relax
2273 \let\unnumberedsubsubsec=\relax
2274 \let\unnumberedsubsubsection=\relax
2275 \let\section=\relax
2276 \let\subsec=\relax
2277 \let\subsubsec=\relax
2278 \let\subsection=\relax
2279 \let\subsubsection=\relax
2280 \let\appendix=\relax
2281 \let\appendixsec=\relax
2282 \let\appendixsection=\relax
2283 \let\appendixsubsec=\relax
2284 \let\appendixsubsection=\relax
2285 \let\appendixsubsubsec=\relax
2286 \let\appendixsubsubsection=\relax
2287 \let\contents=\relax
2288 \let\smallbook=\relax
2289 \let\titlepage=\relax
2292 % Used in nested conditionals, where we have to parse the Texinfo source
2293 % and so want to turn off most commands, in case they are used
2294 % incorrectly.
2296 \def\ignoremorecommands{%
2297 \let\defcodeindex = \relax
2298 \let\defcv = \relax
2299 \let\deffn = \relax
2300 \let\deffnx = \relax
2301 \let\defindex = \relax
2302 \let\defivar = \relax
2303 \let\defmac = \relax
2304 \let\defmethod = \relax
2305 \let\defop = \relax
2306 \let\defopt = \relax
2307 \let\defspec = \relax
2308 \let\deftp = \relax
2309 \let\deftypefn = \relax
2310 \let\deftypefun = \relax
2311 \let\deftypeivar = \relax
2312 \let\deftypeop = \relax
2313 \let\deftypevar = \relax
2314 \let\deftypevr = \relax
2315 \let\defun = \relax
2316 \let\defvar = \relax
2317 \let\defvr = \relax
2318 \let\ref = \relax
2319 \let\xref = \relax
2320 \let\printindex = \relax
2321 \let\pxref = \relax
2322 \let\settitle = \relax
2323 \let\setchapternewpage = \relax
2324 \let\setchapterstyle = \relax
2325 \let\everyheading = \relax
2326 \let\evenheading = \relax
2327 \let\oddheading = \relax
2328 \let\everyfooting = \relax
2329 \let\evenfooting = \relax
2330 \let\oddfooting = \relax
2331 \let\headings = \relax
2332 \let\include = \relax
2333 \let\lowersections = \relax
2334 \let\down = \relax
2335 \let\raisesections = \relax
2336 \let\up = \relax
2337 \let\set = \relax
2338 \let\clear = \relax
2339 \let\item = \relax
2342 % Ignore @ignore ... @end ignore.
2344 \def\ignore{\doignore{ignore}}
2346 % Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text.
2348 \def\ifinfo{\doignore{ifinfo}}
2349 \def\ifhtml{\doignore{ifhtml}}
2350 \def\ifnottex{\doignore{ifnottex}}
2351 \def\html{\doignore{html}}
2352 \def\menu{\doignore{menu}}
2353 \def\direntry{\doignore{direntry}}
2355 % @dircategory CATEGORY -- specify a category of the dir file
2356 % which this file should belong to. Ignore this in TeX.
2357 \let\dircategory = \comment
2359 % Ignore text until a line `@end #1'.
2361 \def\doignore#1{\begingroup
2362 % Don't complain about control sequences we have declared \outer.
2363 \ignoresections
2365 % Define a command to swallow text until we reach `@end #1'.
2366 % This @ is a catcode 12 token (that is the normal catcode of @ in
2367 % this texinfo.tex file). We change the catcode of @ below to match.
2368 \long\def\doignoretext##1@end #1{\enddoignore}%
2370 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2371 \catcode32 = 10
2373 % Ignore braces, too, so mismatched braces don't cause trouble.
2374 \catcode`\{ = 9
2375 \catcode`\} = 9
2377 % We must not have @c interpreted as a control sequence.
2378 \catcode`\@ = 12
2380 % Make the letter c a comment character so that the rest of the line
2381 % will be ignored. This way, the document can have (for example)
2382 % @c @end ifinfo
2383 % and the @end ifinfo will be properly ignored.
2384 % (We've just changed @ to catcode 12.)
2385 \catcode`\c = 14
2387 % And now expand that command.
2388 \doignoretext
2391 % What we do to finish off ignored text.
2393 \def\enddoignore{\endgroup\ignorespaces}%
2395 \newif\ifwarnedobs\warnedobsfalse
2396 \def\obstexwarn{%
2397 \ifwarnedobs\relax\else
2398 % We need to warn folks that they may have trouble with TeX 3.0.
2399 % This uses \immediate\write16 rather than \message to get newlines.
2400 \immediate\write16{}
2401 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2402 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2403 \immediate\write16{If you are running another version of TeX, relax.}
2404 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2405 \immediate\write16{ Then upgrade your TeX installation if you can.}
2406 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2407 \immediate\write16{If you are stuck with version 3.0, run the}
2408 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2409 \immediate\write16{ to use a workaround.}
2410 \immediate\write16{}
2411 \global\warnedobstrue
2415 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2416 % workaround (which requires the file ``dummy.tfm'' to be installed),
2417 % uncomment the following line:
2418 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2420 % Ignore text, except that we keep track of conditional commands for
2421 % purposes of nesting, up to an `@end #1' command.
2423 \def\nestedignore#1{%
2424 \obstexwarn
2425 % We must actually expand the ignored text to look for the @end
2426 % command, so that nested ignore constructs work. Thus, we put the
2427 % text into a \vbox and then do nothing with the result. To minimize
2428 % the change of memory overflow, we follow the approach outlined on
2429 % page 401 of the TeXbook: make the current font be a dummy font.
2431 \setbox0 = \vbox\bgroup
2432 % Don't complain about control sequences we have declared \outer.
2433 \ignoresections
2435 % Define `@end #1' to end the box, which will in turn undefine the
2436 % @end command again.
2437 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2439 % We are going to be parsing Texinfo commands. Most cause no
2440 % trouble when they are used incorrectly, but some commands do
2441 % complicated argument parsing or otherwise get confused, so we
2442 % undefine them.
2444 % We can't do anything about stray @-signs, unfortunately;
2445 % they'll produce `undefined control sequence' errors.
2446 \ignoremorecommands
2448 % Set the current font to be \nullfont, a TeX primitive, and define
2449 % all the font commands to also use \nullfont. We don't use
2450 % dummy.tfm, as suggested in the TeXbook, because not all sites
2451 % might have that installed. Therefore, math mode will still
2452 % produce output, but that should be an extremely small amount of
2453 % stuff compared to the main input.
2455 \nullfont
2456 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2457 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2458 \let\tensf=\nullfont
2459 % Similarly for index fonts (mostly for their use in smallexample).
2460 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2461 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2462 \let\smallsf=\nullfont
2464 % Don't complain when characters are missing from the fonts.
2465 \tracinglostchars = 0
2467 % Don't bother to do space factor calculations.
2468 \frenchspacing
2470 % Don't report underfull hboxes.
2471 \hbadness = 10000
2473 % Do minimal line-breaking.
2474 \pretolerance = 10000
2476 % Do not execute instructions in @tex
2477 \def\tex{\doignore{tex}}%
2478 % Do not execute macro definitions.
2479 % `c' is a comment character, so the word `macro' will get cut off.
2480 \def\macro{\doignore{ma}}%
2483 % @set VAR sets the variable VAR to an empty value.
2484 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2486 % Since we want to separate VAR from REST-OF-LINE (which might be
2487 % empty), we can't just use \parsearg; we have to insert a space of our
2488 % own to delimit the rest of the line, and then take it out again if we
2489 % didn't need it. Make sure the catcode of space is correct to avoid
2490 % losing inside @example, for instance.
2492 \def\set{\begingroup\catcode` =10
2493 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2494 \parsearg\setxxx}
2495 \def\setxxx#1{\setyyy#1 \endsetyyy}
2496 \def\setyyy#1 #2\endsetyyy{%
2497 \def\temp{#2}%
2498 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2499 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2501 \endgroup
2503 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2504 % \next or other control sequences that we've defined might get us into
2505 % an infinite loop. Consider `@set foo @cite{bar}'.
2506 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2508 % @clear VAR clears (i.e., unsets) the variable VAR.
2510 \def\clear{\parsearg\clearxxx}
2511 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2513 % @value{foo} gets the text saved in variable foo.
2515 \catcode`\_ = \active
2517 % We might end up with active _ or - characters in the argument if
2518 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2519 % such active characters to their normal equivalents.
2520 \gdef\value{\begingroup
2521 \catcode`\-=12 \catcode`\_=12
2522 \indexbreaks \let_\normalunderscore
2523 \valuexxx}
2525 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2527 % We have this subroutine so that we can handle at least some @value's
2528 % properly in indexes (we \let\value to this in \indexdummies). Ones
2529 % whose names contain - or _ still won't work, but we can't do anything
2530 % about that. The command has to be fully expandable, since the result
2531 % winds up in the index file. This means that if the variable's value
2532 % contains other Texinfo commands, it's almost certain it will fail
2533 % (although perhaps we could fix that with sufficient work to do a
2534 % one-level expansion on the result, instead of complete).
2536 \def\expandablevalue#1{%
2537 \expandafter\ifx\csname SET#1\endcsname\relax
2538 {[No value for ``#1'']}%
2539 \else
2540 \csname SET#1\endcsname
2544 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2545 % with @set.
2547 \def\ifset{\parsearg\ifsetxxx}
2548 \def\ifsetxxx #1{%
2549 \expandafter\ifx\csname SET#1\endcsname\relax
2550 \expandafter\ifsetfail
2551 \else
2552 \expandafter\ifsetsucceed
2555 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2556 \def\ifsetfail{\nestedignore{ifset}}
2557 \defineunmatchedend{ifset}
2559 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2560 % defined with @set, or has been undefined with @clear.
2562 \def\ifclear{\parsearg\ifclearxxx}
2563 \def\ifclearxxx #1{%
2564 \expandafter\ifx\csname SET#1\endcsname\relax
2565 \expandafter\ifclearsucceed
2566 \else
2567 \expandafter\ifclearfail
2570 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2571 \def\ifclearfail{\nestedignore{ifclear}}
2572 \defineunmatchedend{ifclear}
2574 % @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
2575 % following, through the first @end iftex (etc.). Make `@end iftex'
2576 % (etc.) valid only after an @iftex.
2578 \def\iftex{\conditionalsucceed{iftex}}
2579 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2580 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2581 \defineunmatchedend{iftex}
2582 \defineunmatchedend{ifnothtml}
2583 \defineunmatchedend{ifnotinfo}
2585 % We can't just want to start a group at @iftex (for example) and end it
2586 % at @end iftex, since then @set commands inside the conditional have no
2587 % effect (they'd get reverted at the end of the group). So we must
2588 % define \Eiftex to redefine itself to be its previous value. (We can't
2589 % just define it to fail again with an ``unmatched end'' error, since
2590 % the @ifset might be nested.)
2592 \def\conditionalsucceed#1{%
2593 \edef\temp{%
2594 % Remember the current value of \E#1.
2595 \let\nece{prevE#1} = \nece{E#1}%
2597 % At the `@end #1', redefine \E#1 to be its previous value.
2598 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2600 \temp
2603 % We need to expand lots of \csname's, but we don't want to expand the
2604 % control sequences after we've constructed them.
2606 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2608 % @defininfoenclose.
2609 \let\definfoenclose=\comment
2612 \message{indexing,}
2613 % Index generation facilities
2615 % Define \newwrite to be identical to plain tex's \newwrite
2616 % except not \outer, so it can be used within \newindex.
2617 {\catcode`\@=11
2618 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2620 % \newindex {foo} defines an index named foo.
2621 % It automatically defines \fooindex such that
2622 % \fooindex ...rest of line... puts an entry in the index foo.
2623 % It also defines \fooindfile to be the number of the output channel for
2624 % the file that accumulates this index. The file's extension is foo.
2625 % The name of an index should be no more than 2 characters long
2626 % for the sake of vms.
2628 \def\newindex#1{%
2629 \iflinks
2630 \expandafter\newwrite \csname#1indfile\endcsname
2631 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2633 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2634 \noexpand\doindex{#1}}
2637 % @defindex foo == \newindex{foo}
2639 \def\defindex{\parsearg\newindex}
2641 % Define @defcodeindex, like @defindex except put all entries in @code.
2643 \def\defcodeindex{\parsearg\newcodeindex}
2645 \def\newcodeindex#1{%
2646 \iflinks
2647 \expandafter\newwrite \csname#1indfile\endcsname
2648 \openout \csname#1indfile\endcsname \jobname.#1
2650 \expandafter\xdef\csname#1index\endcsname{%
2651 \noexpand\docodeindex{#1}}%
2655 % @synindex foo bar makes index foo feed into index bar.
2656 % Do this instead of @defindex foo if you don't want it as a separate index.
2658 % @syncodeindex foo bar similar, but put all entries made for index foo
2659 % inside @code.
2661 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2662 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2664 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2665 % #3 the target index (bar).
2666 \def\dosynindex#1#2#3{%
2667 % Only do \closeout if we haven't already done it, else we'll end up
2668 % closing the target index.
2669 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2670 % The \closeout helps reduce unnecessary open files; the limit on the
2671 % Acorn RISC OS is a mere 16 files.
2672 \expandafter\closeout\csname#2indfile\endcsname
2673 \expandafter\let\csname\donesynindex#2\endcsname = 1
2675 % redefine \fooindfile:
2676 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2677 \expandafter\let\csname#2indfile\endcsname=\temp
2678 % redefine \fooindex:
2679 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2682 % Define \doindex, the driver for all \fooindex macros.
2683 % Argument #1 is generated by the calling \fooindex macro,
2684 % and it is "foo", the name of the index.
2686 % \doindex just uses \parsearg; it calls \doind for the actual work.
2687 % This is because \doind is more useful to call from other macros.
2689 % There is also \dosubind {index}{topic}{subtopic}
2690 % which makes an entry in a two-level index such as the operation index.
2692 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2693 \def\singleindexer #1{\doind{\indexname}{#1}}
2695 % like the previous two, but they put @code around the argument.
2696 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2697 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2699 \def\indexdummies{%
2700 \def\ { }%
2701 % Take care of the plain tex accent commands.
2702 \def\"{\realbackslash "}%
2703 \def\`{\realbackslash `}%
2704 \def\'{\realbackslash '}%
2705 \def\^{\realbackslash ^}%
2706 \def\~{\realbackslash ~}%
2707 \def\={\realbackslash =}%
2708 \def\b{\realbackslash b}%
2709 \def\c{\realbackslash c}%
2710 \def\d{\realbackslash d}%
2711 \def\u{\realbackslash u}%
2712 \def\v{\realbackslash v}%
2713 \def\H{\realbackslash H}%
2714 % Take care of the plain tex special European modified letters.
2715 \def\oe{\realbackslash oe}%
2716 \def\ae{\realbackslash ae}%
2717 \def\aa{\realbackslash aa}%
2718 \def\OE{\realbackslash OE}%
2719 \def\AE{\realbackslash AE}%
2720 \def\AA{\realbackslash AA}%
2721 \def\o{\realbackslash o}%
2722 \def\O{\realbackslash O}%
2723 \def\l{\realbackslash l}%
2724 \def\L{\realbackslash L}%
2725 \def\ss{\realbackslash ss}%
2726 % Take care of texinfo commands likely to appear in an index entry.
2727 % (Must be a way to avoid doing expansion at all, and thus not have to
2728 % laboriously list every single command here.)
2729 \def\@{@}% will be @@ when we switch to @ as escape char.
2730 % Need these in case \tex is in effect and \{ is a \delimiter again.
2731 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2732 % braces and backslashes are used only as delimiters.
2733 \let\{ = \mylbrace
2734 \let\} = \myrbrace
2735 \def\_{{\realbackslash _}}%
2736 \def\w{\realbackslash w }%
2737 \def\bf{\realbackslash bf }%
2738 %\def\rm{\realbackslash rm }%
2739 \def\sl{\realbackslash sl }%
2740 \def\sf{\realbackslash sf}%
2741 \def\tt{\realbackslash tt}%
2742 \def\gtr{\realbackslash gtr}%
2743 \def\less{\realbackslash less}%
2744 \def\hat{\realbackslash hat}%
2745 \def\TeX{\realbackslash TeX}%
2746 \def\dots{\realbackslash dots }%
2747 \def\result{\realbackslash result}%
2748 \def\equiv{\realbackslash equiv}%
2749 \def\expansion{\realbackslash expansion}%
2750 \def\print{\realbackslash print}%
2751 \def\error{\realbackslash error}%
2752 \def\point{\realbackslash point}%
2753 \def\copyright{\realbackslash copyright}%
2754 \def\tclose##1{\realbackslash tclose {##1}}%
2755 \def\code##1{\realbackslash code {##1}}%
2756 \def\uref##1{\realbackslash uref {##1}}%
2757 \def\url##1{\realbackslash url {##1}}%
2758 \def\env##1{\realbackslash env {##1}}%
2759 \def\command##1{\realbackslash command {##1}}%
2760 \def\option##1{\realbackslash option {##1}}%
2761 \def\dotless##1{\realbackslash dotless {##1}}%
2762 \def\samp##1{\realbackslash samp {##1}}%
2763 \def\,##1{\realbackslash ,{##1}}%
2764 \def\t##1{\realbackslash t {##1}}%
2765 \def\r##1{\realbackslash r {##1}}%
2766 \def\i##1{\realbackslash i {##1}}%
2767 \def\b##1{\realbackslash b {##1}}%
2768 \def\sc##1{\realbackslash sc {##1}}%
2769 \def\cite##1{\realbackslash cite {##1}}%
2770 \def\key##1{\realbackslash key {##1}}%
2771 \def\file##1{\realbackslash file {##1}}%
2772 \def\var##1{\realbackslash var {##1}}%
2773 \def\kbd##1{\realbackslash kbd {##1}}%
2774 \def\dfn##1{\realbackslash dfn {##1}}%
2775 \def\emph##1{\realbackslash emph {##1}}%
2776 \def\acronym##1{\realbackslash acronym {##1}}%
2778 % Handle some cases of @value -- where the variable name does not
2779 % contain - or _, and the value does not contain any
2780 % (non-fully-expandable) commands.
2781 \let\value = \expandablevalue
2783 \unsepspaces
2784 % Turn off macro expansion
2785 \turnoffmacros
2788 % If an index command is used in an @example environment, any spaces
2789 % therein should become regular spaces in the raw index file, not the
2790 % expansion of \tie (\\leavevmode \penalty \@M \ ).
2791 {\obeyspaces
2792 \gdef\unsepspaces{\obeyspaces\let =\space}}
2794 % \indexnofonts no-ops all font-change commands.
2795 % This is used when outputting the strings to sort the index by.
2796 \def\indexdummyfont#1{#1}
2797 \def\indexdummytex{TeX}
2798 \def\indexdummydots{...}
2800 \def\indexnofonts{%
2801 % Just ignore accents.
2802 \let\,=\indexdummyfont
2803 \let\"=\indexdummyfont
2804 \let\`=\indexdummyfont
2805 \let\'=\indexdummyfont
2806 \let\^=\indexdummyfont
2807 \let\~=\indexdummyfont
2808 \let\==\indexdummyfont
2809 \let\b=\indexdummyfont
2810 \let\c=\indexdummyfont
2811 \let\d=\indexdummyfont
2812 \let\u=\indexdummyfont
2813 \let\v=\indexdummyfont
2814 \let\H=\indexdummyfont
2815 \let\dotless=\indexdummyfont
2816 % Take care of the plain tex special European modified letters.
2817 \def\oe{oe}%
2818 \def\ae{ae}%
2819 \def\aa{aa}%
2820 \def\OE{OE}%
2821 \def\AE{AE}%
2822 \def\AA{AA}%
2823 \def\o{o}%
2824 \def\O{O}%
2825 \def\l{l}%
2826 \def\L{L}%
2827 \def\ss{ss}%
2828 \let\w=\indexdummyfont
2829 \let\t=\indexdummyfont
2830 \let\r=\indexdummyfont
2831 \let\i=\indexdummyfont
2832 \let\b=\indexdummyfont
2833 \let\emph=\indexdummyfont
2834 \let\strong=\indexdummyfont
2835 \let\cite=\indexdummyfont
2836 \let\sc=\indexdummyfont
2837 %Don't no-op \tt, since it isn't a user-level command
2838 % and is used in the definitions of the active chars like <, >, |...
2839 %\let\tt=\indexdummyfont
2840 \let\tclose=\indexdummyfont
2841 \let\code=\indexdummyfont
2842 \let\url=\indexdummyfont
2843 \let\uref=\indexdummyfont
2844 \let\env=\indexdummyfont
2845 \let\acronym=\indexdummyfont
2846 \let\command=\indexdummyfont
2847 \let\option=\indexdummyfont
2848 \let\file=\indexdummyfont
2849 \let\samp=\indexdummyfont
2850 \let\kbd=\indexdummyfont
2851 \let\key=\indexdummyfont
2852 \let\var=\indexdummyfont
2853 \let\TeX=\indexdummytex
2854 \let\dots=\indexdummydots
2855 \def\@{@}%
2858 % To define \realbackslash, we must make \ not be an escape.
2859 % We must first make another character (@) an escape
2860 % so we do not become unable to do a definition.
2862 {\catcode`\@=0 \catcode`\\=\other
2863 @gdef@realbackslash{\}}
2865 \let\indexbackslash=0 %overridden during \printindex.
2866 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2868 % For \ifx comparisons.
2869 \def\emptymacro{\empty}
2871 % Most index entries go through here, but \dosubind is the general case.
2873 \def\doind#1#2{\dosubind{#1}{#2}\empty}
2875 % Workhorse for all \fooindexes.
2876 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2877 % \empty if called from \doind, as we usually are. The main exception
2878 % is with defuns, which call us directly.
2880 \def\dosubind#1#2#3{%
2881 % Put the index entry in the margin if desired.
2882 \ifx\SETmarginindex\relax\else
2883 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2886 \count255=\lastpenalty
2888 \indexdummies % Must do this here, since \bf, etc expand at this stage
2889 \escapechar=`\\
2891 \let\folio = 0% We will expand all macros now EXCEPT \folio.
2892 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2893 % so it will be output as is; and it will print as backslash.
2895 \def\thirdarg{#3}%
2897 % If third arg is present, precede it with space in sort key.
2898 \ifx\thirdarg\emptymacro
2899 \let\subentry = \empty
2900 \else
2901 \def\subentry{ #3}%
2904 % First process the index entry with all font commands turned
2905 % off to get the string to sort by.
2906 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
2908 % Now the real index entry with the fonts.
2909 \toks0 = {#2}%
2911 % If the third (subentry) arg is present, add it to the index
2912 % line to write.
2913 \ifx\thirdarg\emptymacro \else
2914 \toks0 = \expandafter{\the\toks0{#3}}%
2917 % Set up the complete index entry, with both the sort key and
2918 % the original text, including any font commands. We write
2919 % three arguments to \entry to the .?? file (four in the
2920 % subentry case), texindex reduces to two when writing the .??s
2921 % sorted result.
2922 \edef\temp{%
2923 \write\csname#1indfile\endcsname{%
2924 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2927 % If a skip is the last thing on the list now, preserve it
2928 % by backing up by \lastskip, doing the \write, then inserting
2929 % the skip again. Otherwise, the whatsit generated by the
2930 % \write will make \lastskip zero. The result is that sequences
2931 % like this:
2932 % @end defun
2933 % @tindex whatever
2934 % @defun ...
2935 % will have extra space inserted, because the \medbreak in the
2936 % start of the @defun won't see the skip inserted by the @end of
2937 % the previous defun.
2939 % But don't do any of this if we're not in vertical mode. We
2940 % don't want to do a \vskip and prematurely end a paragraph.
2942 % Avoid page breaks due to these extra skips, too.
2944 \iflinks
2945 \ifvmode
2946 \skip0 = \lastskip
2947 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
2950 \temp % do the write
2953 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
2957 \penalty\count255
2961 % The index entry written in the file actually looks like
2962 % \entry {sortstring}{page}{topic}
2963 % or
2964 % \entry {sortstring}{page}{topic}{subtopic}
2965 % The texindex program reads in these files and writes files
2966 % containing these kinds of lines:
2967 % \initial {c}
2968 % before the first topic whose initial is c
2969 % \entry {topic}{pagelist}
2970 % for a topic that is used without subtopics
2971 % \primary {topic}
2972 % for the beginning of a topic that is used with subtopics
2973 % \secondary {subtopic}{pagelist}
2974 % for each subtopic.
2976 % Define the user-accessible indexing commands
2977 % @findex, @vindex, @kindex, @cindex.
2979 \def\findex {\fnindex}
2980 \def\kindex {\kyindex}
2981 \def\cindex {\cpindex}
2982 \def\vindex {\vrindex}
2983 \def\tindex {\tpindex}
2984 \def\pindex {\pgindex}
2986 \def\cindexsub {\begingroup\obeylines\cindexsub}
2987 {\obeylines %
2988 \gdef\cindexsub "#1" #2^^M{\endgroup %
2989 \dosubind{cp}{#2}{#1}}}
2991 % Define the macros used in formatting output of the sorted index material.
2993 % @printindex causes a particular index (the ??s file) to get printed.
2994 % It does not print any chapter heading (usually an @unnumbered).
2996 \def\printindex{\parsearg\doprintindex}
2997 \def\doprintindex#1{\begingroup
2998 \dobreak \chapheadingskip{10000}%
3000 \smallfonts \rm
3001 \tolerance = 9500
3002 \indexbreaks
3004 % See if the index file exists and is nonempty.
3005 % Change catcode of @ here so that if the index file contains
3006 % \initial {@}
3007 % as its first line, TeX doesn't complain about mismatched braces
3008 % (because it thinks @} is a control sequence).
3009 \catcode`\@ = 11
3010 \openin 1 \jobname.#1s
3011 \ifeof 1
3012 % \enddoublecolumns gets confused if there is no text in the index,
3013 % and it loses the chapter title and the aux file entries for the
3014 % index. The easiest way to prevent this problem is to make sure
3015 % there is some text.
3016 \putwordIndexNonexistent
3017 \else
3019 % If the index file exists but is empty, then \openin leaves \ifeof
3020 % false. We have to make TeX try to read something from the file, so
3021 % it can discover if there is anything in it.
3022 \read 1 to \temp
3023 \ifeof 1
3024 \putwordIndexIsEmpty
3025 \else
3026 % Index files are almost Texinfo source, but we use \ as the escape
3027 % character. It would be better to use @, but that's too big a change
3028 % to make right now.
3029 \def\indexbackslash{\rawbackslashxx}%
3030 \catcode`\\ = 0
3031 \escapechar = `\\
3032 \begindoublecolumns
3033 \input \jobname.#1s
3034 \enddoublecolumns
3037 \closein 1
3038 \endgroup}
3040 % These macros are used by the sorted index file itself.
3041 % Change them to control the appearance of the index.
3043 \def\initial#1{{%
3044 % Some minor font changes for the special characters.
3045 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3047 % Remove any glue we may have, we'll be inserting our own.
3048 \removelastskip
3050 % We like breaks before the index initials, so insert a bonus.
3051 \penalty -300
3053 % Typeset the initial. Making this add up to a whole number of
3054 % baselineskips increases the chance of the dots lining up from column
3055 % to column. It still won't often be perfect, because of the stretch
3056 % we need before each entry, but it's better.
3058 % No shrink because it confuses \balancecolumns.
3059 \vskip 1.67\baselineskip plus .5\baselineskip
3060 \leftline{\secbf #1}%
3061 \vskip .33\baselineskip plus .1\baselineskip
3063 % Do our best not to break after the initial.
3064 \nobreak
3067 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3068 % flush to the right margin. It is used for index and table of contents
3069 % entries. The paragraph is indented by \leftskip.
3071 \def\entry#1#2{\begingroup
3073 % Start a new paragraph if necessary, so our assignments below can't
3074 % affect previous text.
3075 \par
3077 % Do not fill out the last line with white space.
3078 \parfillskip = 0in
3080 % No extra space above this paragraph.
3081 \parskip = 0in
3083 % Do not prefer a separate line ending with a hyphen to fewer lines.
3084 \finalhyphendemerits = 0
3086 % \hangindent is only relevant when the entry text and page number
3087 % don't both fit on one line. In that case, bob suggests starting the
3088 % dots pretty far over on the line. Unfortunately, a large
3089 % indentation looks wrong when the entry text itself is broken across
3090 % lines. So we use a small indentation and put up with long leaders.
3092 % \hangafter is reset to 1 (which is the value we want) at the start
3093 % of each paragraph, so we need not do anything with that.
3094 \hangindent = 2em
3096 % When the entry text needs to be broken, just fill out the first line
3097 % with blank space.
3098 \rightskip = 0pt plus1fil
3100 % A bit of stretch before each entry for the benefit of balancing columns.
3101 \vskip 0pt plus1pt
3103 % Start a ``paragraph'' for the index entry so the line breaking
3104 % parameters we've set above will have an effect.
3105 \noindent
3107 % Insert the text of the index entry. TeX will do line-breaking on it.
3109 % The following is kludged to not output a line of dots in the index if
3110 % there are no page numbers. The next person who breaks this will be
3111 % cursed by a Unix daemon.
3112 \def\tempa{{\rm }}%
3113 \def\tempb{#2}%
3114 \edef\tempc{\tempa}%
3115 \edef\tempd{\tempb}%
3116 \ifx\tempc\tempd\ \else%
3118 % If we must, put the page number on a line of its own, and fill out
3119 % this line with blank space. (The \hfil is overwhelmed with the
3120 % fill leaders glue in \indexdotfill if the page number does fit.)
3121 \hfil\penalty50
3122 \null\nobreak\indexdotfill % Have leaders before the page number.
3124 % The `\ ' here is removed by the implicit \unskip that TeX does as
3125 % part of (the primitive) \par. Without it, a spurious underfull
3126 % \hbox ensues.
3127 \ifpdf
3128 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3129 \else
3130 \ #2% The page number ends the paragraph.
3132 \fi%
3133 \par
3134 \endgroup}
3136 % Like \dotfill except takes at least 1 em.
3137 \def\indexdotfill{\cleaders
3138 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3140 \def\primary #1{\line{#1\hfil}}
3142 \newskip\secondaryindent \secondaryindent=0.5cm
3143 \def\secondary#1#2{{%
3144 \parfillskip=0in
3145 \parskip=0in
3146 \hangindent=1in
3147 \hangafter=1
3148 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3149 \ifpdf
3150 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3151 \else
3154 \par
3157 % Define two-column mode, which we use to typeset indexes.
3158 % Adapted from the TeXbook, page 416, which is to say,
3159 % the manmac.tex format used to print the TeXbook itself.
3160 \catcode`\@=11
3162 \newbox\partialpage
3163 \newdimen\doublecolumnhsize
3165 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3166 % Grab any single-column material above us.
3167 \output = {%
3169 % Here is a possibility not foreseen in manmac: if we accumulate a
3170 % whole lot of material, we might end up calling this \output
3171 % routine twice in a row (see the doublecol-lose test, which is
3172 % essentially a couple of indexes with @setchapternewpage off). In
3173 % that case we just ship out what is in \partialpage with the normal
3174 % output routine. Generally, \partialpage will be empty when this
3175 % runs and this will be a no-op. See the indexspread.tex test case.
3176 \ifvoid\partialpage \else
3177 \onepageout{\pagecontents\partialpage}%
3180 \global\setbox\partialpage = \vbox{%
3181 % Unvbox the main output page.
3182 \unvbox\PAGE
3183 \kern-\topskip \kern\baselineskip
3186 \eject % run that output routine to set \partialpage
3188 % Use the double-column output routine for subsequent pages.
3189 \output = {\doublecolumnout}%
3191 % Change the page size parameters. We could do this once outside this
3192 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3193 % format, but then we repeat the same computation. Repeating a couple
3194 % of assignments once per index is clearly meaningless for the
3195 % execution time, so we may as well do it in one place.
3197 % First we halve the line length, less a little for the gutter between
3198 % the columns. We compute the gutter based on the line length, so it
3199 % changes automatically with the paper format. The magic constant
3200 % below is chosen so that the gutter has the same value (well, +-<1pt)
3201 % as it did when we hard-coded it.
3203 % We put the result in a separate register, \doublecolumhsize, so we
3204 % can restore it in \pagesofar, after \hsize itself has (potentially)
3205 % been clobbered.
3207 \doublecolumnhsize = \hsize
3208 \advance\doublecolumnhsize by -.04154\hsize
3209 \divide\doublecolumnhsize by 2
3210 \hsize = \doublecolumnhsize
3212 % Double the \vsize as well. (We don't need a separate register here,
3213 % since nobody clobbers \vsize.)
3214 \vsize = 2\vsize
3217 % The double-column output routine for all double-column pages except
3218 % the last.
3220 \def\doublecolumnout{%
3221 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3222 % Get the available space for the double columns -- the normal
3223 % (undoubled) page height minus any material left over from the
3224 % previous page.
3225 \dimen@ = \vsize
3226 \divide\dimen@ by 2
3227 \advance\dimen@ by -\ht\partialpage
3229 % box0 will be the left-hand column, box2 the right.
3230 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3231 \onepageout\pagesofar
3232 \unvbox255
3233 \penalty\outputpenalty
3236 % Re-output the contents of the output page -- any previous material,
3237 % followed by the two boxes we just split, in box0 and box2.
3238 \def\pagesofar{%
3239 \unvbox\partialpage
3241 \hsize = \doublecolumnhsize
3242 \wd0=\hsize \wd2=\hsize
3243 \hbox to\pagewidth{\box0\hfil\box2}%
3246 % All done with double columns.
3247 \def\enddoublecolumns{%
3248 \output = {%
3249 % Split the last of the double-column material. Leave it on the
3250 % current page, no automatic page break.
3251 \balancecolumns
3253 % If we end up splitting too much material for the current page,
3254 % though, there will be another page break right after this \output
3255 % invocation ends. Having called \balancecolumns once, we do not
3256 % want to call it again. Therefore, reset \output to its normal
3257 % definition right away. (We hope \balancecolumns will never be
3258 % called on to balance too much material, but if it is, this makes
3259 % the output somewhat more palatable.)
3260 \global\output = {\onepageout{\pagecontents\PAGE}}%
3262 \eject
3263 \endgroup % started in \begindoublecolumns
3265 % \pagegoal was set to the doubled \vsize above, since we restarted
3266 % the current page. We're now back to normal single-column
3267 % typesetting, so reset \pagegoal to the normal \vsize (after the
3268 % \endgroup where \vsize got restored).
3269 \pagegoal = \vsize
3272 % Called at the end of the double column material.
3273 \def\balancecolumns{%
3274 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3275 \dimen@ = \ht0
3276 \advance\dimen@ by \topskip
3277 \advance\dimen@ by-\baselineskip
3278 \divide\dimen@ by 2 % target to split to
3279 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3280 \splittopskip = \topskip
3281 % Loop until we get a decent breakpoint.
3283 \vbadness = 10000
3284 \loop
3285 \global\setbox3 = \copy0
3286 \global\setbox1 = \vsplit3 to \dimen@
3287 \ifdim\ht3>\dimen@
3288 \global\advance\dimen@ by 1pt
3289 \repeat
3291 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3292 \setbox0=\vbox to\dimen@{\unvbox1}%
3293 \setbox2=\vbox to\dimen@{\unvbox3}%
3295 \pagesofar
3297 \catcode`\@ = \other
3300 \message{sectioning,}
3301 % Chapters, sections, etc.
3303 \newcount\chapno
3304 \newcount\secno \secno=0
3305 \newcount\subsecno \subsecno=0
3306 \newcount\subsubsecno \subsubsecno=0
3308 % This counter is funny since it counts through charcodes of letters A, B, ...
3309 \newcount\appendixno \appendixno = `\@
3310 % \def\appendixletter{\char\the\appendixno}
3311 % We do the following for the sake of pdftex, which needs the actual
3312 % letter in the expansion, not just typeset.
3313 \def\appendixletter{%
3314 \ifnum\appendixno=`A A%
3315 \else\ifnum\appendixno=`B B%
3316 \else\ifnum\appendixno=`C C%
3317 \else\ifnum\appendixno=`D D%
3318 \else\ifnum\appendixno=`E E%
3319 \else\ifnum\appendixno=`F F%
3320 \else\ifnum\appendixno=`G G%
3321 \else\ifnum\appendixno=`H H%
3322 \else\ifnum\appendixno=`I I%
3323 \else\ifnum\appendixno=`J J%
3324 \else\ifnum\appendixno=`K K%
3325 \else\ifnum\appendixno=`L L%
3326 \else\ifnum\appendixno=`M M%
3327 \else\ifnum\appendixno=`N N%
3328 \else\ifnum\appendixno=`O O%
3329 \else\ifnum\appendixno=`P P%
3330 \else\ifnum\appendixno=`Q Q%
3331 \else\ifnum\appendixno=`R R%
3332 \else\ifnum\appendixno=`S S%
3333 \else\ifnum\appendixno=`T T%
3334 \else\ifnum\appendixno=`U U%
3335 \else\ifnum\appendixno=`V V%
3336 \else\ifnum\appendixno=`W W%
3337 \else\ifnum\appendixno=`X X%
3338 \else\ifnum\appendixno=`Y Y%
3339 \else\ifnum\appendixno=`Z Z%
3340 % The \the is necessary, despite appearances, because \appendixletter is
3341 % expanded while writing the .toc file. \char\appendixno is not
3342 % expandable, thus it is written literally, thus all appendixes come out
3343 % with the same letter (or @) in the toc without it.
3344 \else\char\the\appendixno
3345 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3346 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3348 % Each @chapter defines this as the name of the chapter.
3349 % page headings and footings can use it. @section does likewise.
3350 \def\thischapter{}
3351 \def\thissection{}
3353 \newcount\absseclevel % used to calculate proper heading level
3354 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3356 % @raisesections: treat @section as chapter, @subsection as section, etc.
3357 \def\raisesections{\global\advance\secbase by -1}
3358 \let\up=\raisesections % original BFox name
3360 % @lowersections: treat @chapter as section, @section as subsection, etc.
3361 \def\lowersections{\global\advance\secbase by 1}
3362 \let\down=\lowersections % original BFox name
3364 % Choose a numbered-heading macro
3365 % #1 is heading level if unmodified by @raisesections or @lowersections
3366 % #2 is text for heading
3367 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3368 \ifcase\absseclevel
3369 \chapterzzz{#2}
3371 \seczzz{#2}
3373 \numberedsubseczzz{#2}
3375 \numberedsubsubseczzz{#2}
3376 \else
3377 \ifnum \absseclevel<0
3378 \chapterzzz{#2}
3379 \else
3380 \numberedsubsubseczzz{#2}
3385 % like \numhead, but chooses appendix heading levels
3386 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3387 \ifcase\absseclevel
3388 \appendixzzz{#2}
3390 \appendixsectionzzz{#2}
3392 \appendixsubseczzz{#2}
3394 \appendixsubsubseczzz{#2}
3395 \else
3396 \ifnum \absseclevel<0
3397 \appendixzzz{#2}
3398 \else
3399 \appendixsubsubseczzz{#2}
3404 % like \numhead, but chooses numberless heading levels
3405 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3406 \ifcase\absseclevel
3407 \unnumberedzzz{#2}
3409 \unnumberedseczzz{#2}
3411 \unnumberedsubseczzz{#2}
3413 \unnumberedsubsubseczzz{#2}
3414 \else
3415 \ifnum \absseclevel<0
3416 \unnumberedzzz{#2}
3417 \else
3418 \unnumberedsubsubseczzz{#2}
3423 % @chapter, @appendix, @unnumbered.
3424 \def\thischaptername{No Chapter Title}
3425 \outer\def\chapter{\parsearg\chapteryyy}
3426 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3427 \def\chapterzzz #1{%
3428 \secno=0 \subsecno=0 \subsubsecno=0
3429 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3430 \chapmacro {#1}{\the\chapno}%
3431 \gdef\thissection{#1}%
3432 \gdef\thischaptername{#1}%
3433 % We don't substitute the actual chapter name into \thischapter
3434 % because we don't want its macros evaluated now.
3435 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3436 \toks0 = {#1}%
3437 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3438 {\the\chapno}}}%
3439 \temp
3440 \donoderef
3441 \global\let\section = \numberedsec
3442 \global\let\subsection = \numberedsubsec
3443 \global\let\subsubsection = \numberedsubsubsec
3446 \outer\def\appendix{\parsearg\appendixyyy}
3447 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3448 \def\appendixzzz #1{%
3449 \secno=0 \subsecno=0 \subsubsecno=0
3450 \global\advance \appendixno by 1
3451 \message{\putwordAppendix\space \appendixletter}%
3452 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3453 \gdef\thissection{#1}%
3454 \gdef\thischaptername{#1}%
3455 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3456 \toks0 = {#1}%
3457 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3458 {\putwordAppendix{} \appendixletter}}}%
3459 \temp
3460 \appendixnoderef
3461 \global\let\section = \appendixsec
3462 \global\let\subsection = \appendixsubsec
3463 \global\let\subsubsection = \appendixsubsubsec
3466 % @centerchap is like @unnumbered, but the heading is centered.
3467 \outer\def\centerchap{\parsearg\centerchapyyy}
3468 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3470 % @top is like @unnumbered.
3471 \outer\def\top{\parsearg\unnumberedyyy}
3473 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3474 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3475 \def\unnumberedzzz #1{%
3476 \secno=0 \subsecno=0 \subsubsecno=0
3478 % This used to be simply \message{#1}, but TeX fully expands the
3479 % argument to \message. Therefore, if #1 contained @-commands, TeX
3480 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3481 % expanded @cite (which turns out to cause errors because \cite is meant
3482 % to be executed, not expanded).
3484 % Anyway, we don't want the fully-expanded definition of @cite to appear
3485 % as a result of the \message, we just want `@cite' itself. We use
3486 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3487 % simply yielding the contents of <toks register>. (We also do this for
3488 % the toc entries.)
3489 \toks0 = {#1}\message{(\the\toks0)}%
3491 \unnumbchapmacro {#1}%
3492 \gdef\thischapter{#1}\gdef\thissection{#1}%
3493 \toks0 = {#1}%
3494 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3495 \temp
3496 \unnumbnoderef
3497 \global\let\section = \unnumberedsec
3498 \global\let\subsection = \unnumberedsubsec
3499 \global\let\subsubsection = \unnumberedsubsubsec
3502 % Sections.
3503 \outer\def\numberedsec{\parsearg\secyyy}
3504 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3505 \def\seczzz #1{%
3506 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3507 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3508 \toks0 = {#1}%
3509 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3510 {\the\chapno}{\the\secno}}}%
3511 \temp
3512 \donoderef
3513 \nobreak
3516 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3517 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3518 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3519 \def\appendixsectionzzz #1{%
3520 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3521 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3522 \toks0 = {#1}%
3523 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3524 {\appendixletter}{\the\secno}}}%
3525 \temp
3526 \appendixnoderef
3527 \nobreak
3530 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3531 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3532 \def\unnumberedseczzz #1{%
3533 \plainsecheading {#1}\gdef\thissection{#1}%
3534 \toks0 = {#1}%
3535 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}%
3536 \temp
3537 \unnumbnoderef
3538 \nobreak
3541 % Subsections.
3542 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3543 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3544 \def\numberedsubseczzz #1{%
3545 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3546 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3547 \toks0 = {#1}%
3548 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3549 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3550 \temp
3551 \donoderef
3552 \nobreak
3555 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3556 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3557 \def\appendixsubseczzz #1{%
3558 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3559 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3560 \toks0 = {#1}%
3561 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3562 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3563 \temp
3564 \appendixnoderef
3565 \nobreak
3568 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3569 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3570 \def\unnumberedsubseczzz #1{%
3571 \plainsubsecheading {#1}\gdef\thissection{#1}%
3572 \toks0 = {#1}%
3573 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3574 {\the\toks0}}}%
3575 \temp
3576 \unnumbnoderef
3577 \nobreak
3580 % Subsubsections.
3581 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3582 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3583 \def\numberedsubsubseczzz #1{%
3584 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3585 \subsubsecheading {#1}
3586 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3587 \toks0 = {#1}%
3588 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3589 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3590 \temp
3591 \donoderef
3592 \nobreak
3595 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3596 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3597 \def\appendixsubsubseczzz #1{%
3598 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3599 \subsubsecheading {#1}
3600 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3601 \toks0 = {#1}%
3602 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3603 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3604 \temp
3605 \appendixnoderef
3606 \nobreak
3609 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3610 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3611 \def\unnumberedsubsubseczzz #1{%
3612 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3613 \toks0 = {#1}%
3614 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3615 {\the\toks0}}}%
3616 \temp
3617 \unnumbnoderef
3618 \nobreak
3621 % These are variants which are not "outer", so they can appear in @ifinfo.
3622 % Actually, they should now be obsolete; ordinary section commands should work.
3623 \def\infotop{\parsearg\unnumberedzzz}
3624 \def\infounnumbered{\parsearg\unnumberedzzz}
3625 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3626 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3627 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3629 \def\infoappendix{\parsearg\appendixzzz}
3630 \def\infoappendixsec{\parsearg\appendixseczzz}
3631 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3632 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3634 \def\infochapter{\parsearg\chapterzzz}
3635 \def\infosection{\parsearg\sectionzzz}
3636 \def\infosubsection{\parsearg\subsectionzzz}
3637 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3639 % These macros control what the section commands do, according
3640 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3641 % Define them by default for a numbered chapter.
3642 \global\let\section = \numberedsec
3643 \global\let\subsection = \numberedsubsec
3644 \global\let\subsubsection = \numberedsubsubsec
3646 % Define @majorheading, @heading and @subheading
3648 % NOTE on use of \vbox for chapter headings, section headings, and such:
3649 % 1) We use \vbox rather than the earlier \line to permit
3650 % overlong headings to fold.
3651 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3652 % heading is obnoxious; this forbids it.
3653 % 3) Likewise, headings look best if no \parindent is used, and
3654 % if justification is not attempted. Hence \raggedright.
3657 \def\majorheading{\parsearg\majorheadingzzz}
3658 \def\majorheadingzzz #1{%
3659 {\advance\chapheadingskip by 10pt \chapbreak }%
3660 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3661 \parindent=0pt\raggedright
3662 \rm #1\hfill}}\bigskip \par\penalty 200}
3664 \def\chapheading{\parsearg\chapheadingzzz}
3665 \def\chapheadingzzz #1{\chapbreak %
3666 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3667 \parindent=0pt\raggedright
3668 \rm #1\hfill}}\bigskip \par\penalty 200}
3670 % @heading, @subheading, @subsubheading.
3671 \def\heading{\parsearg\plainsecheading}
3672 \def\subheading{\parsearg\plainsubsecheading}
3673 \def\subsubheading{\parsearg\plainsubsubsecheading}
3675 % These macros generate a chapter, section, etc. heading only
3676 % (including whitespace, linebreaking, etc. around it),
3677 % given all the information in convenient, parsed form.
3679 %%% Args are the skip and penalty (usually negative)
3680 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3682 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3684 %%% Define plain chapter starts, and page on/off switching for it
3685 % Parameter controlling skip before chapter headings (if needed)
3687 \newskip\chapheadingskip
3689 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3690 \def\chappager{\par\vfill\supereject}
3691 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3693 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3695 \def\CHAPPAGoff{%
3696 \global\let\contentsalignmacro = \chappager
3697 \global\let\pchapsepmacro=\chapbreak
3698 \global\let\pagealignmacro=\chappager}
3700 \def\CHAPPAGon{%
3701 \global\let\contentsalignmacro = \chappager
3702 \global\let\pchapsepmacro=\chappager
3703 \global\let\pagealignmacro=\chappager
3704 \global\def\HEADINGSon{\HEADINGSsingle}}
3706 \def\CHAPPAGodd{
3707 \global\let\contentsalignmacro = \chapoddpage
3708 \global\let\pchapsepmacro=\chapoddpage
3709 \global\let\pagealignmacro=\chapoddpage
3710 \global\def\HEADINGSon{\HEADINGSdouble}}
3712 \CHAPPAGon
3714 \def\CHAPFplain{
3715 \global\let\chapmacro=\chfplain
3716 \global\let\unnumbchapmacro=\unnchfplain
3717 \global\let\centerchapmacro=\centerchfplain}
3719 % Plain chapter opening.
3720 % #1 is the text, #2 the chapter number or empty if unnumbered.
3721 \def\chfplain#1#2{%
3722 \pchapsepmacro
3724 \chapfonts \rm
3725 \def\chapnum{#2}%
3726 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3727 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3728 \hangindent = \wd0 \centerparametersmaybe
3729 \unhbox0 #1\par}%
3731 \nobreak\bigskip % no page break after a chapter title
3732 \nobreak
3735 % Plain opening for unnumbered.
3736 \def\unnchfplain#1{\chfplain{#1}{}}
3738 % @centerchap -- centered and unnumbered.
3739 \let\centerparametersmaybe = \relax
3740 \def\centerchfplain#1{{%
3741 \def\centerparametersmaybe{%
3742 \advance\rightskip by 3\rightskip
3743 \leftskip = \rightskip
3744 \parfillskip = 0pt
3746 \chfplain{#1}{}%
3749 \CHAPFplain % The default
3751 \def\unnchfopen #1{%
3752 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3753 \parindent=0pt\raggedright
3754 \rm #1\hfill}}\bigskip \par\nobreak
3757 \def\chfopen #1#2{\chapoddpage {\chapfonts
3758 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3759 \par\penalty 5000 %
3762 \def\centerchfopen #1{%
3763 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3764 \parindent=0pt
3765 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3768 \def\CHAPFopen{
3769 \global\let\chapmacro=\chfopen
3770 \global\let\unnumbchapmacro=\unnchfopen
3771 \global\let\centerchapmacro=\centerchfopen}
3774 % Section titles.
3775 \newskip\secheadingskip
3776 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3777 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3778 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3780 % Subsection titles.
3781 \newskip \subsecheadingskip
3782 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3783 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3784 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3786 % Subsubsection titles.
3787 \let\subsubsecheadingskip = \subsecheadingskip
3788 \let\subsubsecheadingbreak = \subsecheadingbreak
3789 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3790 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3793 % Print any size section title.
3795 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3796 % number (maybe empty), #3 the text.
3797 \def\sectionheading#1#2#3{%
3799 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3800 \csname #1headingbreak\endcsname
3803 % Switch to the right set of fonts.
3804 \csname #1fonts\endcsname \rm
3806 % Only insert the separating space if we have a section number.
3807 \def\secnum{#2}%
3808 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3810 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3811 \hangindent = \wd0 % zero if no section number
3812 \unhbox0 #3}%
3814 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3818 \message{toc,}
3819 % Table of contents.
3820 \newwrite\tocfile
3822 % Write an entry to the toc file, opening it if necessary.
3823 % Called from @chapter, etc. We supply {\folio} at the end of the
3824 % argument, which will end up as the last argument to the \...entry macro.
3826 % We open the .toc file here instead of at @setfilename or any other
3827 % given time so that @contents can be put in the document anywhere.
3829 \newif\iftocfileopened
3830 \def\writetocentry#1{%
3831 \iftocfileopened\else
3832 \immediate\openout\tocfile = \jobname.toc
3833 \global\tocfileopenedtrue
3835 \iflinks \write\tocfile{#1{\folio}}\fi
3838 \newskip\contentsrightmargin \contentsrightmargin=1in
3839 \newcount\savepageno
3840 \newcount\lastnegativepageno \lastnegativepageno = -1
3842 % Finish up the main text and prepare to read what we've written
3843 % to \tocfile.
3845 \def\startcontents#1{%
3846 % If @setchapternewpage on, and @headings double, the contents should
3847 % start on an odd page, unlike chapters. Thus, we maintain
3848 % \contentsalignmacro in parallel with \pagealignmacro.
3849 % From: Torbjorn Granlund <tege@matematik.su.se>
3850 \contentsalignmacro
3851 \immediate\closeout\tocfile
3853 % Don't need to put `Contents' or `Short Contents' in the headline.
3854 % It is abundantly clear what they are.
3855 \unnumbchapmacro{#1}\def\thischapter{}%
3856 \savepageno = \pageno
3857 \begingroup % Set up to handle contents files properly.
3858 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3859 % We can't do this, because then an actual ^ in a section
3860 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3861 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3862 \raggedbottom % Worry more about breakpoints than the bottom.
3863 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3865 % Roman numerals for page numbers.
3866 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3870 % Normal (long) toc.
3871 \def\contents{%
3872 \startcontents{\putwordTOC}%
3873 \openin 1 \jobname.toc
3874 \ifeof 1 \else
3875 \closein 1
3876 \input \jobname.toc
3878 \vfill \eject
3879 \contentsalignmacro % in case @setchapternewpage odd is in effect
3880 \pdfmakeoutlines
3881 \endgroup
3882 \lastnegativepageno = \pageno
3883 \pageno = \savepageno
3886 % And just the chapters.
3887 \def\summarycontents{%
3888 \startcontents{\putwordShortTOC}%
3890 \let\chapentry = \shortchapentry
3891 \let\unnumbchapentry = \shortunnumberedentry
3892 % We want a true roman here for the page numbers.
3893 \secfonts
3894 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3896 \hyphenpenalty = 10000
3897 \advance\baselineskip by 1pt % Open it up a little.
3898 \def\secentry ##1##2##3##4{}
3899 \def\unnumbsecentry ##1##2{}
3900 \def\subsecentry ##1##2##3##4##5{}
3901 \def\unnumbsubsecentry ##1##2{}
3902 \def\subsubsecentry ##1##2##3##4##5##6{}
3903 \def\unnumbsubsubsecentry ##1##2{}
3904 \openin 1 \jobname.toc
3905 \ifeof 1 \else
3906 \closein 1
3907 \input \jobname.toc
3909 \vfill \eject
3910 \contentsalignmacro % in case @setchapternewpage odd is in effect
3911 \endgroup
3912 \lastnegativepageno = \pageno
3913 \pageno = \savepageno
3915 \let\shortcontents = \summarycontents
3917 \ifpdf
3918 \pdfcatalog{/PageMode /UseOutlines}%
3921 % These macros generate individual entries in the table of contents.
3922 % The first argument is the chapter or section name.
3923 % The last argument is the page number.
3924 % The arguments in between are the chapter number, section number, ...
3926 % Chapter-level things, for both the long and short contents.
3927 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3929 % See comments in \dochapentry re vbox and related settings
3930 \def\shortchapentry#1#2#3{%
3931 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
3934 % Typeset the label for a chapter or appendix for the short contents.
3935 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3936 % We could simplify the code here by writing out an \appendixentry
3937 % command in the toc file for appendices, instead of using \chapentry
3938 % for both, but it doesn't seem worth it.
3940 \newdimen\shortappendixwidth
3942 \def\shortchaplabel#1{%
3943 % Compute width of word "Appendix", may change with language.
3944 \setbox0 = \hbox{\shortcontrm \putwordAppendix}%
3945 \shortappendixwidth = \wd0
3947 % We typeset #1 in a box of constant width, regardless of the text of
3948 % #1, so the chapter titles will come out aligned.
3949 \setbox0 = \hbox{#1}%
3950 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3952 % This space should be plenty, since a single number is .5em, and the
3953 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3954 % (This space doesn't include the extra space that gets added after
3955 % the label; that gets put in by \shortchapentry above.)
3956 \advance\dimen0 by 1.1em
3957 \hbox to \dimen0{#1\hfil}%
3960 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3961 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
3963 % Sections.
3964 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
3965 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
3967 % Subsections.
3968 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
3969 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
3971 % And subsubsections.
3972 \def\subsubsecentry#1#2#3#4#5#6{%
3973 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
3974 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
3976 % This parameter controls the indentation of the various levels.
3977 \newdimen\tocindent \tocindent = 3pc
3979 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
3980 % page number.
3982 % If the toc has to be broken over pages, we want it to be at chapters
3983 % if at all possible; hence the \penalty.
3984 \def\dochapentry#1#2{%
3985 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
3986 \begingroup
3987 \chapentryfonts
3988 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3989 \endgroup
3990 \nobreak\vskip .25\baselineskip plus.1\baselineskip
3993 \def\dosecentry#1#2{\begingroup
3994 \secentryfonts \leftskip=\tocindent
3995 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3996 \endgroup}
3998 \def\dosubsecentry#1#2{\begingroup
3999 \subsecentryfonts \leftskip=2\tocindent
4000 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4001 \endgroup}
4003 \def\dosubsubsecentry#1#2{\begingroup
4004 \subsubsecentryfonts \leftskip=3\tocindent
4005 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4006 \endgroup}
4008 % Final typesetting of a toc entry; we use the same \entry macro as for
4009 % the index entries, but we want to suppress hyphenation here. (We
4010 % can't do that in the \entry macro, since index entries might consist
4011 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4012 \def\tocentry#1#2{\begingroup
4013 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4014 % Do not use \turnoffactive in these arguments. Since the toc is
4015 % typeset in cmr, so characters such as _ would come out wrong; we
4016 % have to do the usual translation tricks.
4017 \entry{#1}{#2}%
4018 \endgroup}
4020 % Space between chapter (or whatever) number and the title.
4021 \def\labelspace{\hskip1em \relax}
4023 \def\dopageno#1{{\rm #1}}
4024 \def\doshortpageno#1{{\rm #1}}
4026 \def\chapentryfonts{\secfonts \rm}
4027 \def\secentryfonts{\textfonts}
4028 \let\subsecentryfonts = \textfonts
4029 \let\subsubsecentryfonts = \textfonts
4032 \message{environments,}
4033 % @foo ... @end foo.
4035 % Since these characters are used in examples, it should be an even number of
4036 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4037 % Furthermore, these definitions must come after we define our fonts.
4038 \newbox\dblarrowbox \newbox\longdblarrowbox
4039 \newbox\pushcharbox \newbox\bullbox
4040 \newbox\equivbox \newbox\errorbox
4042 %{\tentt
4043 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
4044 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
4045 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
4046 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
4047 % Adapted from the manmac format (p.420 of TeXbook)
4048 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
4049 % depth .1ex\hfil}
4052 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4053 \def\point{$\star$}
4054 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4055 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4056 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4057 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4059 % Adapted from the TeXbook's \boxit.
4060 {\tentt \global\dimen0 = 3em}% Width of the box.
4061 \dimen2 = .55pt % Thickness of rules
4062 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4063 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4065 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4066 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4067 \advance\hsize by -2\dimen2 % Rules.
4068 \vbox{
4069 \hrule height\dimen2
4070 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4071 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4072 \kern3pt\vrule width\dimen2}% Space to right.
4073 \hrule height\dimen2}
4074 \hfil}
4076 % The @error{} command.
4077 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4079 % @tex ... @end tex escapes into raw Tex temporarily.
4080 % One exception: @ is still an escape character, so that @end tex works.
4081 % But \@ or @@ will get a plain tex @ character.
4083 \def\tex{\begingroup
4084 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4085 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4086 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4087 \catcode `\%=14
4088 \catcode 43=12 % plus
4089 \catcode`\"=12
4090 \catcode`\==12
4091 \catcode`\|=12
4092 \catcode`\<=12
4093 \catcode`\>=12
4094 \escapechar=`\\
4096 \let\b=\ptexb
4097 \let\bullet=\ptexbullet
4098 \let\c=\ptexc
4099 \let\,=\ptexcomma
4100 \let\.=\ptexdot
4101 \let\dots=\ptexdots
4102 \let\equiv=\ptexequiv
4103 \let\!=\ptexexclam
4104 \let\i=\ptexi
4105 \let\{=\ptexlbrace
4106 \let\+=\tabalign
4107 \let\}=\ptexrbrace
4108 \let\*=\ptexstar
4109 \let\t=\ptext
4111 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4112 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4113 \def\@{@}%
4114 \let\Etex=\endgroup}
4116 % Define @lisp ... @endlisp.
4117 % @lisp does a \begingroup so it can rebind things,
4118 % including the definition of @endlisp (which normally is erroneous).
4120 % Amount to narrow the margins by for @lisp.
4121 \newskip\lispnarrowing \lispnarrowing=0.4in
4123 % This is the definition that ^^M gets inside @lisp, @example, and other
4124 % such environments. \null is better than a space, since it doesn't
4125 % have any width.
4126 \def\lisppar{\null\endgraf}
4128 % Make each space character in the input produce a normal interword
4129 % space in the output. Don't allow a line break at this space, as this
4130 % is used only in environments like @example, where each line of input
4131 % should produce a line of output anyway.
4133 {\obeyspaces %
4134 \gdef\sepspaces{\obeyspaces\let =\tie}}
4136 % Define \obeyedspace to be our active space, whatever it is. This is
4137 % for use in \parsearg.
4138 {\sepspaces%
4139 \global\let\obeyedspace= }
4141 % This space is always present above and below environments.
4142 \newskip\envskipamount \envskipamount = 0pt
4144 % Make spacing and below environment symmetrical. We use \parskip here
4145 % to help in doing that, since in @example-like environments \parskip
4146 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4147 % start of the next paragraph will insert \parskip
4149 \def\aboveenvbreak{{\advance\envskipamount by \parskip
4150 \endgraf \ifdim\lastskip<\envskipamount
4151 \removelastskip \penalty-50 \vskip\envskipamount \fi}}
4153 \let\afterenvbreak = \aboveenvbreak
4155 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4156 \let\nonarrowing=\relax
4158 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4159 % environment contents.
4160 \font\circle=lcircle10
4161 \newdimen\circthick
4162 \newdimen\cartouter\newdimen\cartinner
4163 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4164 \circthick=\fontdimen8\circle
4166 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4167 \def\ctr{{\hskip 6pt\circle\char'010}}
4168 \def\cbl{{\circle\char'012\hskip -6pt}}
4169 \def\cbr{{\hskip 6pt\circle\char'011}}
4170 \def\carttop{\hbox to \cartouter{\hskip\lskip
4171 \ctl\leaders\hrule height\circthick\hfil\ctr
4172 \hskip\rskip}}
4173 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4174 \cbl\leaders\hrule height\circthick\hfil\cbr
4175 \hskip\rskip}}
4177 \newskip\lskip\newskip\rskip
4179 \long\def\cartouche{%
4180 \begingroup
4181 \lskip=\leftskip \rskip=\rightskip
4182 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4183 \cartinner=\hsize \advance\cartinner by-\lskip
4184 \advance\cartinner by-\rskip
4185 \cartouter=\hsize
4186 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4187 % side, and for 6pt waste from
4188 % each corner char, and rule thickness
4189 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4190 % Flag to tell @lisp, etc., not to narrow margin.
4191 \let\nonarrowing=\comment
4192 \vbox\bgroup
4193 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4194 \carttop
4195 \hbox\bgroup
4196 \hskip\lskip
4197 \vrule\kern3pt
4198 \vbox\bgroup
4199 \hsize=\cartinner
4200 \kern3pt
4201 \begingroup
4202 \baselineskip=\normbskip
4203 \lineskip=\normlskip
4204 \parskip=\normpskip
4205 \vskip -\parskip
4206 \def\Ecartouche{%
4207 \endgroup
4208 \kern3pt
4209 \egroup
4210 \kern3pt\vrule
4211 \hskip\rskip
4212 \egroup
4213 \cartbot
4214 \egroup
4215 \endgroup
4219 % This macro is called at the beginning of all the @example variants,
4220 % inside a group.
4221 \def\nonfillstart{%
4222 \aboveenvbreak
4223 \inENV % This group ends at the end of the body
4224 \hfuzz = 12pt % Don't be fussy
4225 \sepspaces % Make spaces be word-separators rather than space tokens.
4226 \singlespace
4227 \let\par = \lisppar % don't ignore blank lines
4228 \obeylines % each line of input is a line of output
4229 \parskip = 0pt
4230 \parindent = 0pt
4231 \emergencystretch = 0pt % don't try to avoid overfull boxes
4232 % @cartouche defines \nonarrowing to inhibit narrowing
4233 % at next level down.
4234 \ifx\nonarrowing\relax
4235 \advance \leftskip by \lispnarrowing
4236 \exdentamount=\lispnarrowing
4237 \let\exdent=\nofillexdent
4238 \let\nonarrowing=\relax
4242 % Define the \E... control sequence only if we are inside the particular
4243 % environment, so the error checking in \end will work.
4245 % To end an @example-like environment, we first end the paragraph (via
4246 % \afterenvbreak's vertical glue), and then the group. That way we keep
4247 % the zero \parskip that the environments set -- \parskip glue will be
4248 % inserted at the beginning of the next paragraph in the document, after
4249 % the environment.
4251 \def\nonfillfinish{\afterenvbreak\endgroup}
4253 % @lisp: indented, narrowed, typewriter font.
4254 \def\lisp{\begingroup
4255 \nonfillstart
4256 \let\Elisp = \nonfillfinish
4258 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4259 \gobble % eat return
4262 % @example: Same as @lisp.
4263 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4265 % @small... is usually equivalent to the non-small (@smallbook
4266 % redefines). We must call \example (or whatever) last in the
4267 % definition, since it reads the return following the @example (or
4268 % whatever) command.
4270 % This actually allows (for example) @end display inside an
4271 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4273 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4274 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4275 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4276 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4278 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4279 % Originally contributed by Pavel@xerox.
4280 \def\smalllispx{\begingroup
4281 \def\Esmalllisp{\nonfillfinish\endgroup}%
4282 \def\Esmallexample{\nonfillfinish\endgroup}%
4283 \smallfonts
4284 \lisp
4287 % @display: same as @lisp except keep current font.
4289 \def\display{\begingroup
4290 \nonfillstart
4291 \let\Edisplay = \nonfillfinish
4292 \gobble
4295 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4297 \def\smalldisplayx{\begingroup
4298 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4299 \smallfonts \rm
4300 \display
4303 % @format: same as @display except don't narrow margins.
4305 \def\format{\begingroup
4306 \let\nonarrowing = t
4307 \nonfillstart
4308 \let\Eformat = \nonfillfinish
4309 \gobble
4312 % @smallformat (when @smallbook): @format plus smaller fonts.
4314 \def\smallformatx{\begingroup
4315 \def\Esmallformat{\nonfillfinish\endgroup}%
4316 \smallfonts \rm
4317 \format
4320 % @flushleft (same as @format).
4322 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4324 % @flushright.
4326 \def\flushright{\begingroup
4327 \let\nonarrowing = t
4328 \nonfillstart
4329 \let\Eflushright = \nonfillfinish
4330 \advance\leftskip by 0pt plus 1fill
4331 \gobble
4335 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4336 % and narrows the margins.
4338 \def\quotation{%
4339 \begingroup\inENV %This group ends at the end of the @quotation body
4340 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4341 \singlespace
4342 \parindent=0pt
4343 % We have retained a nonzero parskip for the environment, since we're
4344 % doing normal filling. So to avoid extra space below the environment...
4345 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4347 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4348 \ifx\nonarrowing\relax
4349 \advance\leftskip by \lispnarrowing
4350 \advance\rightskip by \lispnarrowing
4351 \exdentamount = \lispnarrowing
4352 \let\nonarrowing = \relax
4357 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4358 % If we want to allow any <char> as delimiter,
4359 % we need the curly braces so that makeinfo sees the @verb command, eg:
4360 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4362 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4364 % [Knuth] p. 344; only we need to do '@' too
4365 \def\dospecials{%
4366 \do\ \do\\\do\@\do\{\do\}\do\$\do\&%
4367 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~}
4369 % [Knuth] p. 380
4370 \def\uncatcodespecials{%
4371 \def\do##1{\catcode`##1=12}\dospecials}
4373 % [Knuth] pp. 380,381,391
4374 % Disable Spanish ligatures ?` and !` of \tt font
4375 \begingroup
4376 \catcode`\`=\active\gdef`{\relax\lq}
4377 \endgroup
4379 % Setup for the @verb command.
4381 % Eight spaces for a tab
4382 \begingroup
4383 \catcode`\^^I=\active
4384 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4385 \endgroup
4387 \def\setupverb{%
4388 \tt % easiest (and conventionally used) font for verbatim
4389 \def\par{\leavevmode\endgraf}%
4390 \catcode`\`=\active
4391 \tabeightspaces
4392 % Respect line breaks,
4393 % print special symbols as themselves, and
4394 % make each space count
4395 % must do in this order:
4396 \obeylines \uncatcodespecials \sepspaces
4399 % Setup for the @verbatim environment
4401 % Real tab expansion
4402 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4404 \def\starttabbox{\setbox0=\hbox\bgroup}
4405 \begingroup
4406 \catcode`\^^I=\active
4407 \gdef\tabexpand{%
4408 \catcode`\^^I=\active
4409 \def^^I{\leavevmode\egroup
4410 \dimen0=\wd0 % the width so far, or since the previous tab
4411 \divide\dimen0 by\tabw
4412 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4413 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4414 \wd0=\dimen0 \box0 \starttabbox
4417 \endgroup
4418 \def\setupverbatim{%
4419 % Easiest (and conventionally used) font for verbatim
4421 \def\par{\leavevmode\egroup\box0\endgraf}%
4422 \catcode`\`=\active
4423 \tabexpand
4424 % Respect line breaks,
4425 % print special symbols as themselves, and
4426 % make each space count
4427 % must do in this order:
4428 \obeylines \uncatcodespecials \sepspaces
4429 \everypar{\starttabbox}%
4432 % Do the @verb magic: verbatim text is quoted by unique
4433 % delimiter characters. Before first delimiter expect a
4434 % right brace, after last delimiter expect closing brace:
4436 % \def\doverb'{'<char>#1<char>'}'{#1}
4438 % [Knuth] p. 382; only eat outer {}
4439 \begingroup
4440 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4441 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4442 \endgroup
4444 \def\verb{\begingroup\setupverb\doverb}
4447 % Do the @verbatim magic: define the macro \doverbatim so that
4448 % the (first) argument ends when '@end verbatim' is reached, ie:
4450 % \def\doverbatim#1@end verbatim{#1}
4452 % For Texinfo it's a lot easier than for LaTeX,
4453 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4454 % we need not redefine '\', '{' and '}'
4456 % Inspired by LaTeX's verbatim command set [latex.ltx]
4457 %% Include LaTeX hack for completeness -- never know
4458 %% \begingroup
4459 %% \catcode`|=0 \catcode`[=1
4460 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4461 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4462 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4463 %% |endgroup
4464 \begingroup
4465 \catcode`\ =\active
4466 \gdef\doverbatim#1@end verbatim{#1\end{verbatim}}
4467 \endgroup
4469 \def\verbatim{%
4470 \def\Everbatim{\nonfillfinish\endgroup}%
4471 \begingroup
4472 \nonfillstart
4473 \advance\leftskip by -\defbodyindent
4474 \begingroup\setupverbatim\doverbatim
4477 % @verbatiminclude FILE - insert text of file in verbatim environment.
4479 % Allow normal characters that we make active in the argument (a file name).
4480 \def\verbatiminclude{%
4481 \begingroup
4482 \catcode`\\=12
4483 \catcode`~=12
4484 \catcode`^=12
4485 \catcode`_=12
4486 \catcode`|=12
4487 \catcode`<=12
4488 \catcode`>=12
4489 \catcode`+=12
4490 \parsearg\doverbatiminclude
4492 \def\setupverbatiminclude{%
4493 \begingroup
4494 \nonfillstart
4495 \advance\leftskip by -\defbodyindent
4496 \begingroup\setupverbatim
4499 \def\doverbatiminclude#1{%
4500 % Restore active chars for included file.
4501 \endgroup
4502 \begingroup
4503 \def\thisfile{#1}%
4504 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4505 \endgroup\nonfillfinish\endgroup
4509 \message{defuns,}
4510 % @defun etc.
4512 % Allow user to change definition object font (\df) internally
4513 \def\setdeffont #1 {\csname DEF#1\endcsname}
4515 \newskip\defbodyindent \defbodyindent=.4in
4516 \newskip\defargsindent \defargsindent=50pt
4517 \newskip\deftypemargin \deftypemargin=12pt
4518 \newskip\deflastargmargin \deflastargmargin=18pt
4520 \newcount\parencount
4521 % define \functionparens, which makes ( and ) and & do special things.
4522 % \functionparens affects the group it is contained in.
4523 \def\activeparens{%
4524 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4525 \catcode`\[=\active \catcode`\]=\active}
4527 % Make control sequences which act like normal parenthesis chars.
4528 \let\lparen = ( \let\rparen = )
4530 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4532 % Be sure that we always have a definition for `(', etc. For example,
4533 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4534 % so TeX would otherwise complain about undefined control sequence.
4535 \global\let(=\lparen \global\let)=\rparen
4536 \global\let[=\lbrack \global\let]=\rbrack
4538 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4539 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4540 % This is used to turn on special parens
4541 % but make & act ordinary (given that it's active).
4542 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4544 % Definitions of (, ) and & used in args for functions.
4545 % This is the definition of ( outside of all parentheses.
4546 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4547 \global\advance\parencount by 1
4550 % This is the definition of ( when already inside a level of parens.
4551 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4553 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4554 % also in that case restore the outer-level definition of (.
4555 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4556 \global\advance \parencount by -1 }
4557 % If we encounter &foo, then turn on ()-hacking afterwards
4558 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
4560 \gdef\normalparens{\boldbrax\let&=\ampnr}
4561 } % End of definition inside \activeparens
4562 %% These parens (in \boldbrax) actually are a little bolder than the
4563 %% contained text. This is especially needed for [ and ]
4564 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4565 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4566 \let\ampnr = \&
4567 \def\lbrb{{\bf\char`\[}}
4568 \def\rbrb{{\bf\char`\]}}
4570 % Active &'s sneak into the index arguments, so make sure it's defined.
4572 \catcode`& = 13
4573 \global\let& = \ampnr
4576 % First, defname, which formats the header line itself.
4577 % #1 should be the function name.
4578 % #2 should be the type of definition, such as "Function".
4580 \def\defname #1#2{%
4581 % Get the values of \leftskip and \rightskip as they were
4582 % outside the @def...
4583 \dimen2=\leftskip
4584 \advance\dimen2 by -\defbodyindent
4585 \noindent
4586 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4587 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4588 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4589 \parshape 2 0in \dimen0 \defargsindent \dimen1
4590 % Now output arg 2 ("Function" or some such)
4591 % ending at \deftypemargin from the right margin,
4592 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4593 {% Adjust \hsize to exclude the ambient margins,
4594 % so that \rightline will obey them.
4595 \advance \hsize by -\dimen2
4596 \rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4597 % Make all lines underfull and no complaints:
4598 \tolerance=10000 \hbadness=10000
4599 \advance\leftskip by -\defbodyindent
4600 \exdentamount=\defbodyindent
4601 {\df #1}\enskip % Generate function name
4604 % Actually process the body of a definition
4605 % #1 should be the terminating control sequence, such as \Edefun.
4606 % #2 should be the "another name" control sequence, such as \defunx.
4607 % #3 should be the control sequence that actually processes the header,
4608 % such as \defunheader.
4610 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4611 \medbreak %
4612 % Define the end token that this defining construct specifies
4613 % so that it will exit this group.
4614 \def#1{\endgraf\endgroup\medbreak}%
4615 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4616 \parindent=0in
4617 \advance\leftskip by \defbodyindent
4618 \exdentamount=\defbodyindent
4619 \begingroup %
4620 \catcode 61=\active % 61 is `='
4621 \obeylines\activeparens\spacesplit#3}
4623 % #1 is the \E... control sequence to end the definition (which we define).
4624 % #2 is the \...x control sequence for consecutive fns (which we define).
4625 % #3 is the control sequence to call to resume processing.
4626 % #4, delimited by the space, is the class name.
4628 \def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4629 \medbreak %
4630 % Define the end token that this defining construct specifies
4631 % so that it will exit this group.
4632 \def#1{\endgraf\endgroup\medbreak}%
4633 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4634 \parindent=0in
4635 \advance\leftskip by \defbodyindent
4636 \exdentamount=\defbodyindent
4637 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4639 % Used for @deftypemethod and @deftypeivar.
4640 % #1 is the \E... control sequence to end the definition (which we define).
4641 % #2 is the \...x control sequence for consecutive fns (which we define).
4642 % #3 is the control sequence to call to resume processing.
4643 % #4, delimited by a space, is the class name.
4644 % #5 is the method's return type.
4646 \def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4647 \medbreak
4648 \def#1{\endgraf\endgroup\medbreak}%
4649 \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4650 \parindent=0in
4651 \advance\leftskip by \defbodyindent
4652 \exdentamount=\defbodyindent
4653 \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4655 % Used for @deftypeop. The change from \deftypemethparsebody is an
4656 % extra argument at the beginning which is the `category', instead of it
4657 % being the hardwired string `Method' or `Instance Variable'. We have
4658 % to account for this both in the \...x definition and in parsing the
4659 % input at hand. Thus also need a control sequence (passed as #5) for
4660 % the \E... definition to assign the category name to.
4662 \def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4663 \medbreak
4664 \def#1{\endgraf\endgroup\medbreak}%
4665 \def#2##1 ##2 ##3 {%
4666 \def#4{##1}%
4667 \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4668 \parindent=0in
4669 \advance\leftskip by \defbodyindent
4670 \exdentamount=\defbodyindent
4671 \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4673 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4674 \medbreak %
4675 % Define the end token that this defining construct specifies
4676 % so that it will exit this group.
4677 \def#1{\endgraf\endgroup\medbreak}%
4678 \def#2##1 ##2 {\def#4{##1}%
4679 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4680 \parindent=0in
4681 \advance\leftskip by \defbodyindent
4682 \exdentamount=\defbodyindent
4683 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4685 % These parsing functions are similar to the preceding ones
4686 % except that they do not make parens into active characters.
4687 % These are used for "variables" since they have no arguments.
4689 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4690 \medbreak %
4691 % Define the end token that this defining construct specifies
4692 % so that it will exit this group.
4693 \def#1{\endgraf\endgroup\medbreak}%
4694 \def#2{\begingroup\obeylines\spacesplit#3}%
4695 \parindent=0in
4696 \advance\leftskip by \defbodyindent
4697 \exdentamount=\defbodyindent
4698 \begingroup %
4699 \catcode 61=\active %
4700 \obeylines\spacesplit#3}
4702 % This is used for \def{tp,vr}parsebody. It could probably be used for
4703 % some of the others, too, with some judicious conditionals.
4705 \def\parsebodycommon#1#2#3{%
4706 \begingroup\inENV %
4707 \medbreak %
4708 % Define the end token that this defining construct specifies
4709 % so that it will exit this group.
4710 \def#1{\endgraf\endgroup\medbreak}%
4711 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4712 \parindent=0in
4713 \advance\leftskip by \defbodyindent
4714 \exdentamount=\defbodyindent
4715 \begingroup\obeylines
4718 \def\defvrparsebody#1#2#3#4 {%
4719 \parsebodycommon{#1}{#2}{#3}%
4720 \spacesplit{#3{#4}}%
4723 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4724 % type is just `struct', because we lose the braces in `{struct
4725 % termios}' when \spacesplit reads its undelimited argument. Sigh.
4726 % \let\deftpparsebody=\defvrparsebody
4728 % So, to get around this, we put \empty in with the type name. That
4729 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4730 % won't strip off the braces.
4732 \def\deftpparsebody #1#2#3#4 {%
4733 \parsebodycommon{#1}{#2}{#3}%
4734 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4737 % Fine, but then we have to eventually remove the \empty *and* the
4738 % braces (if any). That's what this does.
4740 \def\removeemptybraces\empty#1\relax{#1}
4742 % After \spacesplit has done its work, this is called -- #1 is the final
4743 % thing to call, #2 the type name (which starts with \empty), and #3
4744 % (which might be empty) the arguments.
4746 \def\parsetpheaderline#1#2#3{%
4747 #1{\removeemptybraces#2\relax}{#3}%
4750 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4751 \medbreak %
4752 % Define the end token that this defining construct specifies
4753 % so that it will exit this group.
4754 \def#1{\endgraf\endgroup\medbreak}%
4755 \def#2##1 ##2 {\def#4{##1}%
4756 \begingroup\obeylines\spacesplit{#3{##2}}}%
4757 \parindent=0in
4758 \advance\leftskip by \defbodyindent
4759 \exdentamount=\defbodyindent
4760 \begingroup\obeylines\spacesplit{#3{#5}}}
4762 % Split up #2 at the first space token.
4763 % call #1 with two arguments:
4764 % the first is all of #2 before the space token,
4765 % the second is all of #2 after that space token.
4766 % If #2 contains no space token, all of it is passed as the first arg
4767 % and the second is passed as empty.
4769 {\obeylines
4770 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4771 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4772 \ifx\relax #3%
4773 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4775 % So much for the things common to all kinds of definitions.
4777 % Define @defun.
4779 % First, define the processing that is wanted for arguments of \defun
4780 % Use this to expand the args and terminate the paragraph they make up
4782 \def\defunargs#1{\functionparens \sl
4783 % Expand, preventing hyphenation at `-' chars.
4784 % Note that groups don't affect changes in \hyphenchar.
4785 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4786 {\tensl\hyphenchar\font=0}%
4788 {\tensl\hyphenchar\font=45}%
4789 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4790 \interlinepenalty=10000
4791 \advance\rightskip by 0pt plus 1fil
4792 \endgraf\nobreak\vskip -\parskip\nobreak
4795 \def\deftypefunargs #1{%
4796 % Expand, preventing hyphenation at `-' chars.
4797 % Note that groups don't affect changes in \hyphenchar.
4798 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4799 \boldbraxnoamp
4800 \tclose{#1}% avoid \code because of side effects on active chars
4801 \interlinepenalty=10000
4802 \advance\rightskip by 0pt plus 1fil
4803 \endgraf\nobreak\vskip -\parskip\nobreak
4806 % Do complete processing of one @defun or @defunx line already parsed.
4808 % @deffn Command forward-char nchars
4810 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4812 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4813 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4814 \catcode 61=\other % Turn off change made in \defparsebody
4817 % @defun == @deffn Function
4819 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4821 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4822 \begingroup\defname {#1}{\putwordDeffunc}%
4823 \defunargs {#2}\endgroup %
4824 \catcode 61=\other % Turn off change made in \defparsebody
4827 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4829 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4831 % #1 is the data type. #2 is the name and args.
4832 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4833 % #1 is the data type, #2 the name, #3 the args.
4834 \def\deftypefunheaderx #1#2 #3\relax{%
4835 \doind {fn}{\code{#2}}% Make entry in function index
4836 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}%
4837 \deftypefunargs {#3}\endgroup %
4838 \catcode 61=\other % Turn off change made in \defparsebody
4841 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4843 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4845 % \defheaderxcond#1\relax$$$
4846 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4847 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4849 % #1 is the classification. #2 is the data type. #3 is the name and args.
4850 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4851 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4852 \def\deftypefnheaderx #1#2#3 #4\relax{%
4853 \doind {fn}{\code{#3}}% Make entry in function index
4854 \begingroup
4855 \normalparens % notably, turn off `&' magic, which prevents
4856 % at least some C++ text from working
4857 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
4858 \deftypefunargs {#4}\endgroup %
4859 \catcode 61=\other % Turn off change made in \defparsebody
4862 % @defmac == @deffn Macro
4864 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4866 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4867 \begingroup\defname {#1}{\putwordDefmac}%
4868 \defunargs {#2}\endgroup %
4869 \catcode 61=\other % Turn off change made in \defparsebody
4872 % @defspec == @deffn Special Form
4874 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4876 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4877 \begingroup\defname {#1}{\putwordDefspec}%
4878 \defunargs {#2}\endgroup %
4879 \catcode 61=\other % Turn off change made in \defparsebody
4882 % @defop CATEGORY CLASS OPERATION ARG...
4884 \def\defop #1 {\def\defoptype{#1}%
4885 \defopparsebody\Edefop\defopx\defopheader\defoptype}
4887 \def\defopheader#1#2#3{%
4888 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4889 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4890 \defunargs {#3}\endgroup %
4893 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4895 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
4896 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
4897 \deftypeopcategory}
4899 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4900 \def\deftypeopheader#1#2#3#4{%
4901 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4902 \begingroup
4903 \defname{\defheaderxcond#2\relax$$$#3}
4904 {\deftypeopcategory\ \putwordon\ \code{#1}}%
4905 \deftypefunargs{#4}%
4906 \endgroup
4909 % @deftypemethod CLASS TYPE METHOD ARG...
4911 \def\deftypemethod{%
4912 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4914 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4915 \def\deftypemethodheader#1#2#3#4{%
4916 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4917 \begingroup
4918 \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}%
4919 \deftypefunargs{#4}%
4920 \endgroup
4923 % @deftypeivar CLASS TYPE VARNAME
4925 \def\deftypeivar{%
4926 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
4928 % #1 is the class name, #2 the data type, #3 the variable name.
4929 \def\deftypeivarheader#1#2#3{%
4930 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
4931 \begingroup
4932 \defname{\defheaderxcond#2\relax$$$#3}
4933 {\putwordInstanceVariableof\ \code{#1}}%
4934 \defvarargs{#3}%
4935 \endgroup
4938 % @defmethod == @defop Method
4940 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
4942 % #1 is the class name, #2 the method name, #3 the args.
4943 \def\defmethodheader#1#2#3{%
4944 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
4945 \begingroup
4946 \defname{#2}{\putwordMethodon\ \code{#1}}%
4947 \defunargs{#3}%
4948 \endgroup
4951 % @defcv {Class Option} foo-class foo-flag
4953 \def\defcv #1 {\def\defcvtype{#1}%
4954 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
4956 \def\defcvarheader #1#2#3{%
4957 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
4958 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
4959 \defvarargs {#3}\endgroup %
4962 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
4964 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
4966 \def\defivarheader#1#2#3{%
4967 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
4968 \begingroup
4969 \defname{#2}{\putwordInstanceVariableof\ #1}%
4970 \defvarargs{#3}%
4971 \endgroup
4974 % @defvar
4975 % First, define the processing that is wanted for arguments of @defvar.
4976 % This is actually simple: just print them in roman.
4977 % This must expand the args and terminate the paragraph they make up
4978 \def\defvarargs #1{\normalparens #1%
4979 \interlinepenalty=10000
4980 \endgraf\nobreak\vskip -\parskip\nobreak}
4982 % @defvr Counter foo-count
4984 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
4986 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
4987 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
4989 % @defvar == @defvr Variable
4991 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
4993 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4994 \begingroup\defname {#1}{\putwordDefvar}%
4995 \defvarargs {#2}\endgroup %
4998 % @defopt == @defvr {User Option}
5000 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5002 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5003 \begingroup\defname {#1}{\putwordDefopt}%
5004 \defvarargs {#2}\endgroup %
5007 % @deftypevar int foobar
5009 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5011 % #1 is the data type. #2 is the name, perhaps followed by text that
5012 % is actually part of the data type, which should not be put into the index.
5013 \def\deftypevarheader #1#2{%
5014 \dovarind#2 \relax% Make entry in variables index
5015 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}%
5016 \interlinepenalty=10000
5017 \endgraf\nobreak\vskip -\parskip\nobreak
5018 \endgroup}
5019 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5021 % @deftypevr {Global Flag} int enable
5023 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5025 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5026 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
5027 \interlinepenalty=10000
5028 \endgraf\nobreak\vskip -\parskip\nobreak
5029 \endgroup}
5031 % Now define @deftp
5032 % Args are printed in bold, a slight difference from @defvar.
5034 \def\deftpargs #1{\bf \defvarargs{#1}}
5036 % @deftp Class window height width ...
5038 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5040 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5041 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5043 % These definitions are used if you use @defunx (etc.)
5044 % anywhere other than immediately after a @defun or @defunx.
5046 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5047 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5048 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5049 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5050 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5051 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5052 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5053 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5054 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5055 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5056 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5057 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5058 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5059 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5060 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5061 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5062 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5063 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5064 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5067 \message{macros,}
5068 % @macro.
5070 % To do this right we need a feature of e-TeX, \scantokens,
5071 % which we arrange to emulate with a temporary file in ordinary TeX.
5072 \ifx\eTeXversion\undefined
5073 \newwrite\macscribble
5074 \def\scanmacro#1{%
5075 \begingroup \newlinechar`\^^M
5076 % Undo catcode changes of \startcontents and \doprintindex
5077 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5078 % Append \endinput to make sure that TeX does not see the ending newline.
5079 \toks0={#1\endinput}%
5080 \immediate\openout\macscribble=\jobname.tmp
5081 \immediate\write\macscribble{\the\toks0}%
5082 \immediate\closeout\macscribble
5083 \let\xeatspaces\eatspaces
5084 \input \jobname.tmp
5085 \endgroup
5087 \else
5088 \def\scanmacro#1{%
5089 \begingroup \newlinechar`\^^M
5090 % Undo catcode changes of \startcontents and \doprintindex
5091 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5092 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5095 \newcount\paramno % Count of parameters
5096 \newtoks\macname % Macro name
5097 \newif\ifrecursive % Is it recursive?
5098 \def\macrolist{} % List of all defined macros in the form
5099 % \do\macro1\do\macro2...
5101 % Utility routines.
5102 % Thisdoes \let #1 = #2, except with \csnames.
5103 \def\cslet#1#2{%
5104 \expandafter\expandafter
5105 \expandafter\let
5106 \expandafter\expandafter
5107 \csname#1\endcsname
5108 \csname#2\endcsname}
5110 % Trim leading and trailing spaces off a string.
5111 % Concepts from aro-bend problem 15 (see CTAN).
5112 {\catcode`\@=11
5113 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5114 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5115 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5116 \def\unbrace#1{#1}
5117 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5120 % Trim a single trailing ^^M off a string.
5121 {\catcode`\^^M=12\catcode`\Q=3%
5122 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5123 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5124 \gdef\eatcrb#1Q#2Q{#1}%
5127 % Macro bodies are absorbed as an argument in a context where
5128 % all characters are catcode 10, 11 or 12, except \ which is active
5129 % (as in normal texinfo). It is necessary to change the definition of \.
5131 % It's necessary to have hard CRs when the macro is executed. This is
5132 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5133 % body, and then making it the \newlinechar in \scanmacro.
5135 \def\macrobodyctxt{%
5136 \catcode`\~=12
5137 \catcode`\^=12
5138 \catcode`\_=12
5139 \catcode`\|=12
5140 \catcode`\<=12
5141 \catcode`\>=12
5142 \catcode`\+=12
5143 \catcode`\{=12
5144 \catcode`\}=12
5145 \catcode`\@=12
5146 \catcode`\^^M=12
5147 \usembodybackslash}
5149 \def\macroargctxt{%
5150 \catcode`\~=12
5151 \catcode`\^=12
5152 \catcode`\_=12
5153 \catcode`\|=12
5154 \catcode`\<=12
5155 \catcode`\>=12
5156 \catcode`\+=12
5157 \catcode`\@=12
5158 \catcode`\\=12}
5160 % \mbodybackslash is the definition of \ in @macro bodies.
5161 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5162 % where N is the macro parameter number.
5163 % We define \csname macarg.\endcsname to be \realbackslash, so
5164 % \\ in macro replacement text gets you a backslash.
5166 {\catcode`@=0 @catcode`@\=@active
5167 @gdef@usembodybackslash{@let\=@mbodybackslash}
5168 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5170 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5172 \def\macro{\recursivefalse\parsearg\macroxxx}
5173 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5175 \def\macroxxx#1{%
5176 \getargs{#1}% now \macname is the macname and \argl the arglist
5177 \ifx\argl\empty % no arguments
5178 \paramno=0%
5179 \else
5180 \expandafter\parsemargdef \argl;%
5182 \if1\csname ismacro.\the\macname\endcsname
5183 \message{Warning: redefining \the\macname}%
5184 \else
5185 \expandafter\ifx\csname \the\macname\endcsname \relax
5186 \else \errmessage{The name \the\macname\space is reserved}\fi
5187 \global\cslet{macsave.\the\macname}{\the\macname}%
5188 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5189 % Add the macroname to \macrolist
5190 \toks0 = \expandafter{\macrolist\do}%
5191 \xdef\macrolist{\the\toks0
5192 \expandafter\noexpand\csname\the\macname\endcsname}%
5194 \begingroup \macrobodyctxt
5195 \ifrecursive \expandafter\parsermacbody
5196 \else \expandafter\parsemacbody
5197 \fi}
5199 \def\unmacro{\parsearg\unmacroxxx}
5200 \def\unmacroxxx#1{%
5201 \if1\csname ismacro.#1\endcsname
5202 \global\cslet{#1}{macsave.#1}%
5203 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5204 % Remove the macro name from \macrolist
5205 \begingroup
5206 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5207 \def\do##1{%
5208 \def\tempb{##1}%
5209 \ifx\tempa\tempb
5210 % remove this
5211 \else
5212 \toks0 = \expandafter{\newmacrolist\do}%
5213 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5214 \fi}%
5215 \def\newmacrolist{}%
5216 % Execute macro list to define \newmacrolist
5217 \macrolist
5218 \global\let\macrolist\newmacrolist
5219 \endgroup
5220 \else
5221 \errmessage{Macro #1 not defined}%
5225 % This makes use of the obscure feature that if the last token of a
5226 % <parameter list> is #, then the preceding argument is delimited by
5227 % an opening brace, and that opening brace is not consumed.
5228 \def\getargs#1{\getargsxxx#1{}}
5229 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5230 \def\getmacname #1 #2\relax{\macname={#1}}
5231 \def\getmacargs#1{\def\argl{#1}}
5233 % Parse the optional {params} list. Set up \paramno and \paramlist
5234 % so \defmacro knows what to do. Define \macarg.blah for each blah
5235 % in the params list, to be ##N where N is the position in that list.
5236 % That gets used by \mbodybackslash (above).
5238 % We need to get `macro parameter char #' into several definitions.
5239 % The technique used is stolen from LaTeX: let \hash be something
5240 % unexpandable, insert that wherever you need a #, and then redefine
5241 % it to # just before using the token list produced.
5243 % The same technique is used to protect \eatspaces till just before
5244 % the macro is used.
5246 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5247 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5248 \def\parsemargdefxxx#1,{%
5249 \if#1;\let\next=\relax
5250 \else \let\next=\parsemargdefxxx
5251 \advance\paramno by 1%
5252 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5253 {\xeatspaces{\hash\the\paramno}}%
5254 \edef\paramlist{\paramlist\hash\the\paramno,}%
5255 \fi\next}
5257 % These two commands read recursive and nonrecursive macro bodies.
5258 % (They're different since rec and nonrec macros end differently.)
5260 \long\def\parsemacbody#1@end macro%
5261 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5262 \long\def\parsermacbody#1@end rmacro%
5263 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5265 % This defines the macro itself. There are six cases: recursive and
5266 % nonrecursive macros of zero, one, and many arguments.
5267 % Much magic with \expandafter here.
5268 % \xdef is used so that macro definitions will survive the file
5269 % they're defined in; @include reads the file inside a group.
5270 \def\defmacro{%
5271 \let\hash=##% convert placeholders to macro parameter chars
5272 \ifrecursive
5273 \ifcase\paramno
5275 \expandafter\xdef\csname\the\macname\endcsname{%
5276 \noexpand\scanmacro{\temp}}%
5277 \or % 1
5278 \expandafter\xdef\csname\the\macname\endcsname{%
5279 \bgroup\noexpand\macroargctxt
5280 \noexpand\braceorline
5281 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5282 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5283 \egroup\noexpand\scanmacro{\temp}}%
5284 \else % many
5285 \expandafter\xdef\csname\the\macname\endcsname{%
5286 \bgroup\noexpand\macroargctxt
5287 \noexpand\csname\the\macname xx\endcsname}%
5288 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5289 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5290 \expandafter\expandafter
5291 \expandafter\xdef
5292 \expandafter\expandafter
5293 \csname\the\macname xxx\endcsname
5294 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5296 \else
5297 \ifcase\paramno
5299 \expandafter\xdef\csname\the\macname\endcsname{%
5300 \noexpand\norecurse{\the\macname}%
5301 \noexpand\scanmacro{\temp}\egroup}%
5302 \or % 1
5303 \expandafter\xdef\csname\the\macname\endcsname{%
5304 \bgroup\noexpand\macroargctxt
5305 \noexpand\braceorline
5306 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5307 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5308 \egroup
5309 \noexpand\norecurse{\the\macname}%
5310 \noexpand\scanmacro{\temp}\egroup}%
5311 \else % many
5312 \expandafter\xdef\csname\the\macname\endcsname{%
5313 \bgroup\noexpand\macroargctxt
5314 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5315 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5316 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5317 \expandafter\expandafter
5318 \expandafter\xdef
5319 \expandafter\expandafter
5320 \csname\the\macname xxx\endcsname
5321 \paramlist{%
5322 \egroup
5323 \noexpand\norecurse{\the\macname}%
5324 \noexpand\scanmacro{\temp}\egroup}%
5326 \fi}
5328 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5330 % \braceorline decides whether the next nonwhitespace character is a
5331 % {. If so it reads up to the closing }, if not, it reads the whole
5332 % line. Whatever was read is then fed to the next control sequence
5333 % as an argument (by \parsebrace or \parsearg)
5334 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5335 \def\braceorlinexxx{%
5336 \ifx\nchar\bgroup\else
5337 \expandafter\parsearg
5338 \fi \next}
5340 % We mant to disable all macros during \shipout so that they are not
5341 % expanded by \write.
5342 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5343 \edef\next{\macrolist}\expandafter\endgroup\next}
5346 % @alias.
5347 % We need some trickery to remove the optional spaces around the equal
5348 % sign. Just make them active and then expand them all to nothing.
5349 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5350 \def\aliasxxx #1{\aliasyyy#1\relax}
5351 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5352 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5353 \expandafter\noexpand\csname#2\endcsname}%
5354 \expandafter\endgroup\next}
5357 \message{cross references,}
5358 % @xref etc.
5360 \newwrite\auxfile
5362 \newif\ifhavexrefs % True if xref values are known.
5363 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5365 % @inforef is relatively simple.
5366 \def\inforef #1{\inforefzzz #1,,,,**}
5367 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5368 node \samp{\ignorespaces#1{}}}
5370 % @node's job is to define \lastnode.
5371 \def\node{\ENVcheck\parsearg\nodezzz}
5372 \def\nodezzz#1{\nodexxx [#1,]}
5373 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5374 \let\nwnode=\node
5375 \let\lastnode=\relax
5377 % The sectioning commands (@chapter, etc.) call these.
5378 \def\donoderef{%
5379 \ifx\lastnode\relax\else
5380 \expandafter\expandafter\expandafter\setref{\lastnode}%
5381 {Ysectionnumberandtype}%
5382 \global\let\lastnode=\relax
5385 \def\unnumbnoderef{%
5386 \ifx\lastnode\relax\else
5387 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5388 \global\let\lastnode=\relax
5391 \def\appendixnoderef{%
5392 \ifx\lastnode\relax\else
5393 \expandafter\expandafter\expandafter\setref{\lastnode}%
5394 {Yappendixletterandtype}%
5395 \global\let\lastnode=\relax
5400 % @anchor{NAME} -- define xref target at arbitrary point.
5402 \newcount\savesfregister
5403 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5404 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5405 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5407 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5408 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5409 % to set \indexdummies so commands such as @code in a section title
5410 % aren't expanded. It would be nicer not to expand the titles in the
5411 % first place, but there's so many layers that that is hard to do.
5413 \def\setref#1#2{{%
5414 \indexdummies
5415 \pdfmkdest{#1}%
5416 \dosetq{#1-title}{Ytitle}%
5417 \dosetq{#1-pg}{Ypagenumber}%
5418 \dosetq{#1-snt}{#2}%
5421 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5422 % the node name, #2 the name of the Info cross-reference, #3 the printed
5423 % node name, #4 the name of the Info file, #5 the name of the printed
5424 % manual. All but the node name can be omitted.
5426 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5427 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5428 \def\ref#1{\xrefX[#1,,,,,,,]}
5429 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5430 \unsepspaces
5431 \def\printedmanual{\ignorespaces #5}%
5432 \def\printednodename{\ignorespaces #3}%
5433 \setbox1=\hbox{\printedmanual}%
5434 \setbox0=\hbox{\printednodename}%
5435 \ifdim \wd0 = 0pt
5436 % No printed node name was explicitly given.
5437 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5438 % Use the node name inside the square brackets.
5439 \def\printednodename{\ignorespaces #1}%
5440 \else
5441 % Use the actual chapter/section title appear inside
5442 % the square brackets. Use the real section title if we have it.
5443 \ifdim \wd1 > 0pt
5444 % It is in another manual, so we don't have it.
5445 \def\printednodename{\ignorespaces #1}%
5446 \else
5447 \ifhavexrefs
5448 % We know the real title if we have the xref values.
5449 \def\printednodename{\refx{#1-title}{}}%
5450 \else
5451 % Otherwise just copy the Info node name.
5452 \def\printednodename{\ignorespaces #1}%
5453 \fi%
5458 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5459 % insert empty discretionaries after hyphens, which means that it will
5460 % not find a line break at a hyphen in a node names. Since some manuals
5461 % are best written with fairly long node names, containing hyphens, this
5462 % is a loss. Therefore, we give the text of the node name again, so it
5463 % is as if TeX is seeing it for the first time.
5464 \ifpdf
5465 \leavevmode
5466 \getfilename{#4}%
5467 \ifnum\filenamelength>0
5468 \startlink attr{/Border [0 0 0]}%
5469 goto file{\the\filename.pdf} name{#1@}%
5470 \else
5471 \startlink attr{/Border [0 0 0]}%
5472 goto name{#1@}%
5474 \linkcolor
5477 \ifdim \wd1 > 0pt
5478 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5479 \else
5480 % _ (for example) has to be the character _ for the purposes of the
5481 % control sequence corresponding to the node, but it has to expand
5482 % into the usual \leavevmode...\vrule stuff for purposes of
5483 % printing. So we \turnoffactive for the \refx-snt, back on for the
5484 % printing, back off for the \refx-pg.
5485 {\normalturnoffactive
5486 % Only output a following space if the -snt ref is nonempty; for
5487 % @unnumbered and @anchor, it won't be.
5488 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5489 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5491 % [mynode],
5492 [\printednodename],\space
5493 % page 3
5494 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5496 \endlink
5497 \endgroup}
5499 % \dosetq is the interface for calls from other macros
5501 % Use \normalturnoffactive so that punctuation chars such as underscore
5502 % and backslash work in node names. (\turnoffactive doesn't do \.)
5503 \def\dosetq#1#2{%
5504 {\let\folio=0%
5505 \normalturnoffactive
5506 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5507 \iflinks
5508 \next
5513 % \internalsetq {foo}{page} expands into
5514 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5515 % When the aux file is read, ' is the escape character
5517 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5519 % Things to be expanded by \internalsetq
5521 \def\Ypagenumber{\folio}
5523 \def\Ytitle{\thissection}
5525 \def\Ynothing{}
5527 \def\Ysectionnumberandtype{%
5528 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5529 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5530 \else \ifnum \subsubsecno=0 %
5531 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5532 \else %
5533 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5534 \fi \fi \fi }
5536 \def\Yappendixletterandtype{%
5537 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5538 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5539 \else \ifnum \subsubsecno=0 %
5540 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5541 \else %
5542 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5543 \fi \fi \fi }
5545 \gdef\xreftie{'tie}
5547 % Use TeX 3.0's \inputlineno to get the line number, for better error
5548 % messages, but if we're using an old version of TeX, don't do anything.
5550 \ifx\inputlineno\thisisundefined
5551 \let\linenumber = \empty % Non-3.0.
5552 \else
5553 \def\linenumber{\the\inputlineno:\space}
5556 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5557 % If its value is nonempty, SUFFIX is output afterward.
5559 \def\refx#1#2{%
5560 \expandafter\ifx\csname X#1\endcsname\relax
5561 % If not defined, say something at least.
5562 \angleleft un\-de\-fined\angleright
5563 \iflinks
5564 \ifhavexrefs
5565 \message{\linenumber Undefined cross reference `#1'.}%
5566 \else
5567 \ifwarnedxrefs\else
5568 \global\warnedxrefstrue
5569 \message{Cross reference values unknown; you must run TeX again.}%
5573 \else
5574 % It's defined, so just use it.
5575 \csname X#1\endcsname
5577 #2% Output the suffix in any case.
5580 % This is the macro invoked by entries in the aux file.
5582 \def\xrdef#1{\begingroup
5583 % Reenable \ as an escape while reading the second argument.
5584 \catcode`\\ = 0
5585 \afterassignment\endgroup
5586 \expandafter\gdef\csname X#1\endcsname
5589 % Read the last existing aux file, if any. No error if none exists.
5590 \def\readauxfile{\begingroup
5591 \catcode`\^^@=\other
5592 \catcode`\^^A=\other
5593 \catcode`\^^B=\other
5594 \catcode`\^^C=\other
5595 \catcode`\^^D=\other
5596 \catcode`\^^E=\other
5597 \catcode`\^^F=\other
5598 \catcode`\^^G=\other
5599 \catcode`\^^H=\other
5600 \catcode`\^^K=\other
5601 \catcode`\^^L=\other
5602 \catcode`\^^N=\other
5603 \catcode`\^^P=\other
5604 \catcode`\^^Q=\other
5605 \catcode`\^^R=\other
5606 \catcode`\^^S=\other
5607 \catcode`\^^T=\other
5608 \catcode`\^^U=\other
5609 \catcode`\^^V=\other
5610 \catcode`\^^W=\other
5611 \catcode`\^^X=\other
5612 \catcode`\^^Z=\other
5613 \catcode`\^^[=\other
5614 \catcode`\^^\=\other
5615 \catcode`\^^]=\other
5616 \catcode`\^^^=\other
5617 \catcode`\^^_=\other
5618 \catcode`\@=\other
5619 \catcode`\^=\other
5620 % It was suggested to define this as 7, which would allow ^^e4 etc.
5621 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5622 % supported in the main text, it doesn't seem desirable. Furthermore,
5623 % that is not enough: for node names that actually contain a ^
5624 % character, we would end up writing a line like this: 'xrdef {'hat
5625 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5626 % argument, and \hat is not an expandable control sequence. It could
5627 % all be worked out, but why? Either we support ^^ or we don't.
5629 % The other change necessary for this was to define \auxhat:
5630 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5631 % and then to call \auxhat in \setq.
5633 \catcode`\~=\other
5634 \catcode`\[=\other
5635 \catcode`\]=\other
5636 \catcode`\"=\other
5637 \catcode`\_=\other
5638 \catcode`\|=\other
5639 \catcode`\<=\other
5640 \catcode`\>=\other
5641 \catcode`\$=\other
5642 \catcode`\#=\other
5643 \catcode`\&=\other
5644 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5645 % Make the characters 128-255 be printing characters
5647 \count 1=128
5648 \def\loop{%
5649 \catcode\count 1=\other
5650 \advance\count 1 by 1
5651 \ifnum \count 1<256 \loop \fi
5654 % The aux file uses ' as the escape (for now).
5655 % Turn off \ as an escape so we do not lose on
5656 % entries which were dumped with control sequences in their names.
5657 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5658 % Reference to such entries still does not work the way one would wish,
5659 % but at least they do not bomb out when the aux file is read in.
5660 \catcode`\{=1
5661 \catcode`\}=2
5662 \catcode`\%=\other
5663 \catcode`\'=0
5664 \catcode`\\=\other
5666 \openin 1 \jobname.aux
5667 \ifeof 1 \else
5668 \closein 1
5669 \input \jobname.aux
5670 \global\havexrefstrue
5671 \global\warnedobstrue
5673 % Open the new aux file. TeX will close it automatically at exit.
5674 \openout\auxfile=\jobname.aux
5675 \endgroup}
5678 % Footnotes.
5680 \newcount \footnoteno
5682 % The trailing space in the following definition for supereject is
5683 % vital for proper filling; pages come out unaligned when you do a
5684 % pagealignmacro call if that space before the closing brace is
5685 % removed. (Generally, numeric constants should always be followed by a
5686 % space to prevent strange expansion errors.)
5687 \def\supereject{\par\penalty -20000\footnoteno =0 }
5689 % @footnotestyle is meaningful for info output only.
5690 \let\footnotestyle=\comment
5692 \let\ptexfootnote=\footnote
5694 {\catcode `\@=11
5696 % Auto-number footnotes. Otherwise like plain.
5697 \gdef\footnote{%
5698 \global\advance\footnoteno by \@ne
5699 \edef\thisfootno{$^{\the\footnoteno}$}%
5701 % In case the footnote comes at the end of a sentence, preserve the
5702 % extra spacing after we do the footnote number.
5703 \let\@sf\empty
5704 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5706 % Remove inadvertent blank space before typesetting the footnote number.
5707 \unskip
5708 \thisfootno\@sf
5709 \footnotezzz
5712 % Don't bother with the trickery in plain.tex to not require the
5713 % footnote text as a parameter. Our footnotes don't need to be so general.
5715 % Oh yes, they do; otherwise, @ifset and anything else that uses
5716 % \parseargline fail inside footnotes because the tokens are fixed when
5717 % the footnote is read. --karl, 16nov96.
5719 \long\gdef\footnotezzz{\insert\footins\bgroup
5720 % We want to typeset this text as a normal paragraph, even if the
5721 % footnote reference occurs in (for example) a display environment.
5722 % So reset some parameters.
5723 \interlinepenalty\interfootnotelinepenalty
5724 \splittopskip\ht\strutbox % top baseline for broken footnotes
5725 \splitmaxdepth\dp\strutbox
5726 \floatingpenalty\@MM
5727 \leftskip\z@skip
5728 \rightskip\z@skip
5729 \spaceskip\z@skip
5730 \xspaceskip\z@skip
5731 \parindent\defaultparindent
5733 \smallfonts \rm
5735 % Hang the footnote text off the number.
5736 \hang
5737 \textindent{\thisfootno}%
5739 % Don't crash into the line above the footnote text. Since this
5740 % expands into a box, it must come within the paragraph, lest it
5741 % provide a place where TeX can split the footnote.
5742 \footstrut
5743 \futurelet\next\fo@t
5745 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5746 \else\let\next\f@t\fi \next}
5747 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
5748 \def\f@t#1{#1\@foot}
5749 \def\@foot{\strut\par\egroup}
5751 }%end \catcode `\@=11
5753 % Set the baselineskip to #1, and the lineskip and strut size
5754 % correspondingly. There is no deep meaning behind these magic numbers
5755 % used as factors; they just match (closely enough) what Knuth defined.
5757 \def\lineskipfactor{.08333}
5758 \def\strutheightpercent{.70833}
5759 \def\strutdepthpercent {.29167}
5761 \def\setleading#1{%
5762 \normalbaselineskip = #1\relax
5763 \normallineskip = \lineskipfactor\normalbaselineskip
5764 \normalbaselines
5765 \setbox\strutbox =\hbox{%
5766 \vrule width0pt height\strutheightpercent\baselineskip
5767 depth \strutdepthpercent \baselineskip
5771 % @| inserts a changebar to the left of the current line. It should
5772 % surround any changed text. This approach does *not* work if the
5773 % change spans more than two lines of output. To handle that, we would
5774 % have adopt a much more difficult approach (putting marks into the main
5775 % vertical list for the beginning and end of each change).
5777 \def\|{%
5778 % \vadjust can only be used in horizontal mode.
5779 \leavevmode
5781 % Append this vertical mode material after the current line in the output.
5782 \vadjust{%
5783 % We want to insert a rule with the height and depth of the current
5784 % leading; that is exactly what \strutbox is supposed to record.
5785 \vskip-\baselineskip
5787 % \vadjust-items are inserted at the left edge of the type. So
5788 % the \llap here moves out into the left-hand margin.
5789 \llap{%
5791 % For a thicker or thinner bar, change the `1pt'.
5792 \vrule height\baselineskip width1pt
5794 % This is the space between the bar and the text.
5795 \hskip 12pt
5800 % For a final copy, take out the rectangles
5801 % that mark overfull boxes (in case you have decided
5802 % that the text looks ok even though it passes the margin).
5804 \def\finalout{\overfullrule=0pt}
5806 % @image. We use the macros from epsf.tex to support this.
5807 % If epsf.tex is not installed and @image is used, we complain.
5809 % Check for and read epsf.tex up front. If we read it only at @image
5810 % time, we might be inside a group, and then its definitions would get
5811 % undone and the next image would fail.
5812 \openin 1 = epsf.tex
5813 \ifeof 1 \else
5814 \closein 1
5815 % Do not bother showing banner with post-v2.7 epsf.tex (available in
5816 % doc/epsf.tex until it shows up on ctan).
5817 \def\epsfannounce{\toks0 = }%
5818 \input epsf.tex
5821 % We will only complain once about lack of epsf.tex.
5822 \newif\ifwarnednoepsf
5823 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5824 work. It is also included in the Texinfo distribution, or you can get
5825 it from ftp://tug.org/tex/epsf.tex.}
5827 \def\image#1{%
5828 \ifx\epsfbox\undefined
5829 \ifwarnednoepsf \else
5830 \errhelp = \noepsfhelp
5831 \errmessage{epsf.tex not found, images will be ignored}%
5832 \global\warnednoepsftrue
5834 \else
5835 \imagexxx #1,,,\finish
5839 % Arguments to @image:
5840 % #1 is (mandatory) image filename; we tack on .eps extension.
5841 % #2 is (optional) width, #3 is (optional) height.
5842 % #4 is just the usual extra ignored arg for parsing this stuff.
5843 \def\imagexxx#1,#2,#3,#4\finish{%
5844 \ifpdf
5845 \centerline{\dopdfimage{#1}{#2}{#3}}%
5846 \else
5847 % \epsfbox itself resets \epsf?size at each figure.
5848 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5849 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5850 \begingroup
5851 \catcode`\^^M = 5 % in case we're inside an example
5852 \normalturnoffactive % allow _ et al. in names
5853 % If the image is by itself, center it.
5854 \ifvmode
5855 \nobreak\bigskip
5856 % Usually we'll have text after the image which will insert
5857 % \parskip glue, so insert it here too to equalize the space
5858 % above and below.
5859 \nobreak\vskip\parskip
5860 \nobreak
5861 \centerline{\epsfbox{#1.eps}}%
5862 \bigbreak
5863 \else
5864 % In the middle of a paragraph, no extra space.
5865 \epsfbox{#1.eps}%
5867 \endgroup
5872 \message{localization,}
5873 % and i18n.
5875 % @documentlanguage is usually given very early, just after
5876 % @setfilename. If done too late, it may not override everything
5877 % properly. Single argument is the language abbreviation.
5878 % It would be nice if we could set up a hyphenation file here.
5880 \def\documentlanguage{\parsearg\dodocumentlanguage}
5881 \def\dodocumentlanguage#1{%
5882 \tex % read txi-??.tex file in plain TeX.
5883 % Read the file if it exists.
5884 \openin 1 txi-#1.tex
5885 \ifeof1
5886 \errhelp = \nolanghelp
5887 \errmessage{Cannot read language file txi-#1.tex}%
5888 \let\temp = \relax
5889 \else
5890 \def\temp{\input txi-#1.tex }%
5892 \temp
5893 \endgroup
5895 \newhelp\nolanghelp{The given language definition file cannot be found or
5896 is empty. Maybe you need to install it? In the current directory
5897 should work if nowhere else does.}
5900 % @documentencoding should change something in TeX eventually, most
5901 % likely, but for now just recognize it.
5902 \let\documentencoding = \comment
5905 % Page size parameters.
5907 \newdimen\defaultparindent \defaultparindent = 15pt
5909 \chapheadingskip = 15pt plus 4pt minus 2pt
5910 \secheadingskip = 12pt plus 3pt minus 2pt
5911 \subsecheadingskip = 9pt plus 2pt minus 2pt
5913 % Prevent underfull vbox error messages.
5914 \vbadness = 10000
5916 % Don't be so finicky about underfull hboxes, either.
5917 \hbadness = 2000
5919 % Following George Bush, just get rid of widows and orphans.
5920 \widowpenalty=10000
5921 \clubpenalty=10000
5923 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
5924 % using an old version of TeX, don't do anything. We want the amount of
5925 % stretch added to depend on the line length, hence the dependence on
5926 % \hsize. We call this whenever the paper size is set.
5928 \def\setemergencystretch{%
5929 \ifx\emergencystretch\thisisundefined
5930 % Allow us to assign to \emergencystretch anyway.
5931 \def\emergencystretch{\dimen0}%
5932 \else
5933 \emergencystretch = .15\hsize
5937 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
5938 % 4) hoffset; 5) binding offset; 6) topskip. Then whoever calls us can
5939 % set \parskip and call \setleading for \baselineskip.
5941 \def\internalpagesizes#1#2#3#4#5#6{%
5942 \voffset = #3\relax
5943 \topskip = #6\relax
5944 \splittopskip = \topskip
5946 \vsize = #1\relax
5947 \advance\vsize by \topskip
5948 \outervsize = \vsize
5949 \advance\outervsize by 2\topandbottommargin
5950 \pageheight = \vsize
5952 \hsize = #2\relax
5953 \outerhsize = \hsize
5954 \advance\outerhsize by 0.5in
5955 \pagewidth = \hsize
5957 \normaloffset = #4\relax
5958 \bindingoffset = #5\relax
5960 \parindent = \defaultparindent
5961 \setemergencystretch
5964 % Use `small' versions.
5966 \def\smallenvironments{%
5967 \let\smalldisplay = \smalldisplayx
5968 \let\smallexample = \smalllispx
5969 \let\smallformat = \smallformatx
5970 \let\smalllisp = \smalllispx
5973 % @letterpaper (the default).
5974 \def\letterpaper{{\globaldefs = 1
5975 \parskip = 3pt plus 2pt minus 1pt
5976 \setleading{13.2pt}%
5978 % If page is nothing but text, make it come out even.
5979 \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}%
5982 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
5983 \def\smallbook{{\globaldefs = 1
5984 \parskip = 2pt plus 1pt
5985 \setleading{12pt}%
5987 \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}%
5989 \lispnarrowing = 0.3in
5990 \tolerance = 700
5991 \hfuzz = 1pt
5992 \contentsrightmargin = 0pt
5993 \deftypemargin = 0pt
5994 \defbodyindent = .5cm
5995 \smallenvironments
5998 % Use @afourpaper to print on European A4 paper.
5999 \def\afourpaper{{\globaldefs = 1
6000 \setleading{12pt}%
6001 \parskip = 3pt plus 2pt minus 1pt
6003 \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}%
6005 \tolerance = 700
6006 \hfuzz = 1pt
6009 % Use @afivepaper to print on European A5 paper.
6010 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6011 % He also recommends making @example and @lisp be small.
6012 \def\afivepaper{{\globaldefs = 1
6013 \setleading{12.5pt}%
6014 \parskip = 2pt plus 1pt minus 0.1pt
6016 \internalpagesizes{166mm}{120mm}{\voffset}{-8mm}{\bindingoffset}{8pt}%
6018 \lispnarrowing = 0.2in
6019 \tolerance = 800
6020 \hfuzz = 1.2pt
6021 \contentsrightmargin = 0mm
6022 \deftypemargin = 0pt
6023 \defbodyindent = 2mm
6024 \tableindent = 12mm
6026 \smallenvironments
6029 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
6030 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
6031 \def\afourlatex{{\globaldefs = 1
6032 \setleading{13.6pt}%
6034 \afourpaper
6035 \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}%
6037 \globaldefs = 0
6040 % Use @afourwide to print on European A4 paper in wide format.
6041 \def\afourwide{%
6042 \afourpaper
6043 \internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}%
6045 \globaldefs = 0
6048 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6049 % Perhaps we should allow setting the margins, \topskip, \parskip,
6050 % and/or leading, also. Or perhaps we should compute them somehow.
6052 \def\pagesizes{\parsearg\pagesizesxxx}
6053 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6054 \def\pagesizesyyy#1,#2,#3\finish{{%
6055 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6056 \globaldefs = 1
6058 \parskip = 3pt plus 2pt minus 1pt
6059 \setleading{13.2pt}%
6061 \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}%
6064 % Set default to letter.
6066 \letterpaper
6069 \message{and turning on texinfo input format.}
6071 % Define macros to output various characters with catcode for normal text.
6072 \catcode`\"=\other
6073 \catcode`\~=\other
6074 \catcode`\^=\other
6075 \catcode`\_=\other
6076 \catcode`\|=\other
6077 \catcode`\<=\other
6078 \catcode`\>=\other
6079 \catcode`\+=\other
6080 \catcode`\$=\other
6081 \def\normaldoublequote{"}
6082 \def\normaltilde{~}
6083 \def\normalcaret{^}
6084 \def\normalunderscore{_}
6085 \def\normalverticalbar{|}
6086 \def\normalless{<}
6087 \def\normalgreater{>}
6088 \def\normalplus{+}
6089 \def\normaldollar{$}
6091 % This macro is used to make a character print one way in ttfont
6092 % where it can probably just be output, and another way in other fonts,
6093 % where something hairier probably needs to be done.
6095 % #1 is what to print if we are indeed using \tt; #2 is what to print
6096 % otherwise. Since all the Computer Modern typewriter fonts have zero
6097 % interword stretch (and shrink), and it is reasonable to expect all
6098 % typewriter fonts to have this, we can check that font parameter.
6100 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6102 % Same as above, but check for italic font. Actually this also catches
6103 % non-italic slanted fonts since it is impossible to distinguish them from
6104 % italic fonts. But since this is only used by $ and it uses \sl anyway
6105 % this is not a problem.
6106 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6108 % Turn off all special characters except @
6109 % (and those which the user can use as if they were ordinary).
6110 % Most of these we simply print from the \tt font, but for some, we can
6111 % use math or other variants that look better in normal text.
6113 \catcode`\"=\active
6114 \def\activedoublequote{{\tt\char34}}
6115 \let"=\activedoublequote
6116 \catcode`\~=\active
6117 \def~{{\tt\char126}}
6118 \chardef\hat=`\^
6119 \catcode`\^=\active
6120 \def^{{\tt \hat}}
6122 \catcode`\_=\active
6123 \def_{\ifusingtt\normalunderscore\_}
6124 % Subroutine for the previous macro.
6125 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
6127 \catcode`\|=\active
6128 \def|{{\tt\char124}}
6129 \chardef \less=`\<
6130 \catcode`\<=\active
6131 \def<{{\tt \less}}
6132 \chardef \gtr=`\>
6133 \catcode`\>=\active
6134 \def>{{\tt \gtr}}
6135 \catcode`\+=\active
6136 \def+{{\tt \char 43}}
6137 \catcode`\$=\active
6138 \def${\ifusingit{{\sl\$}}\normaldollar}
6139 %\catcode 27=\active
6140 %\def^^[{$\diamondsuit$}
6142 % Set up an active definition for =, but don't enable it most of the time.
6143 {\catcode`\==\active
6144 \global\def={{\tt \char 61}}}
6146 \catcode`+=\active
6147 \catcode`\_=\active
6149 % If a .fmt file is being used, characters that might appear in a file
6150 % name cannot be active until we have parsed the command line.
6151 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6152 % \otherifyactive is called near the end of this file.
6153 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6155 \catcode`\@=0
6157 % \rawbackslashxx output one backslash character in current font
6158 \global\chardef\rawbackslashxx=`\\
6159 %{\catcode`\\=\other
6160 %@gdef@rawbackslashxx{\}}
6162 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6163 {\catcode`\\=\active
6164 @gdef@rawbackslash{@let\=@rawbackslashxx }}
6166 % \normalbackslash outputs one backslash in fixed width font.
6167 \def\normalbackslash{{\tt\rawbackslashxx}}
6169 % \catcode 17=0 % Define control-q
6170 \catcode`\\=\active
6172 % Used sometimes to turn off (effectively) the active characters
6173 % even after parsing them.
6174 @def@turnoffactive{@let"=@normaldoublequote
6175 @let\=@realbackslash
6176 @let~=@normaltilde
6177 @let^=@normalcaret
6178 @let_=@normalunderscore
6179 @let|=@normalverticalbar
6180 @let<=@normalless
6181 @let>=@normalgreater
6182 @let+=@normalplus
6183 @let$=@normaldollar}
6185 @def@normalturnoffactive{@let"=@normaldoublequote
6186 @let\=@normalbackslash
6187 @let~=@normaltilde
6188 @let^=@normalcaret
6189 @let_=@normalunderscore
6190 @let|=@normalverticalbar
6191 @let<=@normalless
6192 @let>=@normalgreater
6193 @let+=@normalplus
6194 @let$=@normaldollar}
6196 % Make _ and + \other characters, temporarily.
6197 % This is canceled by @fixbackslash.
6198 @otherifyactive
6200 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6201 % That is what \eatinput is for; after that, the `\' should revert to printing
6202 % a backslash.
6204 @gdef@eatinput input texinfo{@fixbackslash}
6205 @global@let\ = @eatinput
6207 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6208 % the first `\{ in the file would cause an error. This macro tries to fix
6209 % that, assuming it is called before the first `\' could plausibly occur.
6210 % Also back turn on active characters that might appear in the input
6211 % file name, in case not using a pre-dumped format.
6213 @gdef@fixbackslash{%
6214 @ifx\@eatinput @let\ = @normalbackslash @fi
6215 @catcode`+=@active
6216 @catcode`@_=@active
6219 % Say @foo, not \foo, in error messages.
6220 @escapechar = `@@
6222 % These look ok in all fonts, so just make them not special.
6223 @catcode`@& = @other
6224 @catcode`@# = @other
6225 @catcode`@% = @other
6227 @c Set initial fonts.
6228 @textfonts
6232 @c Local variables:
6233 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6234 @c page-delimiter: "^\\\\message"
6235 @c time-stamp-start: "def\\\\texinfoversion{"
6236 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6237 @c time-stamp-end: "}"
6238 @c End: