Update.
[glibc.git] / manual / texinfo.tex
blobcd88ce747f2d593d1a91a37a9340285f8110de61
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-05-24.09}
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 % add check for \lastpenalty to plain's definitions. If the last thing
174 % we did was a \nobreak, we don't want to insert more space.
176 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
177 \removelastskip\penalty-50\smallskip\fi\fi}
178 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
179 \removelastskip\penalty-100\medskip\fi\fi}
180 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
181 \removelastskip\penalty-200\bigskip\fi\fi}
183 % For @cropmarks command.
184 % Do @cropmarks to get crop marks.
186 \newif\ifcropmarks
187 \let\cropmarks = \cropmarkstrue
189 % Dimensions to add cropmarks at corners.
190 % Added by P. A. MacKay, 12 Nov. 1986
192 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
193 \newdimen\cornerlong \cornerlong=1pc
194 \newdimen\cornerthick \cornerthick=.3pt
195 \newdimen\topandbottommargin \topandbottommargin=.75in
197 % Main output routine.
198 \chardef\PAGE = 255
199 \output = {\onepageout{\pagecontents\PAGE}}
201 \newbox\headlinebox
202 \newbox\footlinebox
204 % \onepageout takes a vbox as an argument. Note that \pagecontents
205 % does insertions, but you have to call it yourself.
206 \def\onepageout#1{%
207 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
209 \ifodd\pageno \advance\hoffset by \bindingoffset
210 \else \advance\hoffset by -\bindingoffset\fi
212 % Do this outside of the \shipout so @code etc. will be expanded in
213 % the headline as they should be, not taken literally (outputting ''code).
214 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
215 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
218 % Have to do this stuff outside the \shipout because we want it to
219 % take effect in \write's, yet the group defined by the \vbox ends
220 % before the \shipout runs.
222 \escapechar = `\\ % use backslash in output files.
223 \indexdummies % don't expand commands in the output.
224 \normalturnoffactive % \ in index entries must not stay \, e.g., if
225 % the page break happens to be in the middle of an example.
226 \shipout\vbox{%
227 % Do this early so pdf references go to the beginning of the page.
228 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
230 \ifcropmarks \vbox to \outervsize\bgroup
231 \hsize = \outerhsize
232 \vskip-\topandbottommargin
233 \vtop to0pt{%
234 \line{\ewtop\hfil\ewtop}%
235 \nointerlineskip
236 \line{%
237 \vbox{\moveleft\cornerthick\nstop}%
238 \hfill
239 \vbox{\moveright\cornerthick\nstop}%
241 \vss}%
242 \vskip\topandbottommargin
243 \line\bgroup
244 \hfil % center the page within the outer (page) hsize.
245 \ifodd\pageno\hskip\bindingoffset\fi
246 \vbox\bgroup
249 \unvbox\headlinebox
250 \pagebody{#1}%
251 \ifdim\ht\footlinebox > 0pt
252 % Only leave this space if the footline is nonempty.
253 % (We lessened \vsize for it in \oddfootingxxx.)
254 % The \baselineskip=24pt in plain's \makefootline has no effect.
255 \vskip 2\baselineskip
256 \unvbox\footlinebox
259 \ifcropmarks
260 \egroup % end of \vbox\bgroup
261 \hfil\egroup % end of (centering) \line\bgroup
262 \vskip\topandbottommargin plus1fill minus1fill
263 \boxmaxdepth = \cornerthick
264 \vbox to0pt{\vss
265 \line{%
266 \vbox{\moveleft\cornerthick\nsbot}%
267 \hfill
268 \vbox{\moveright\cornerthick\nsbot}%
270 \nointerlineskip
271 \line{\ewbot\hfil\ewbot}%
273 \egroup % \vbox from first cropmarks clause
275 }% end of \shipout\vbox
276 }% end of group with \turnoffactive
277 \advancepageno
278 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
281 \newinsert\margin \dimen\margin=\maxdimen
283 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
284 {\catcode`\@ =11
285 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
286 % marginal hacks, juha@viisa.uucp (Juha Takala)
287 \ifvoid\margin\else % marginal info is present
288 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
289 \dimen@=\dp#1 \unvbox#1
290 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
291 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
294 % Here are the rules for the cropmarks. Note that they are
295 % offset so that the space between them is truly \outerhsize or \outervsize
296 % (P. A. MacKay, 12 November, 1986)
298 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
299 \def\nstop{\vbox
300 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
301 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
302 \def\nsbot{\vbox
303 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
305 % Parse an argument, then pass it to #1. The argument is the rest of
306 % the input line (except we remove a trailing comment). #1 should be a
307 % macro which expects an ordinary undelimited TeX argument.
309 \def\parsearg#1{%
310 \let\next = #1%
311 \begingroup
312 \obeylines
313 \futurelet\temp\parseargx
316 % If the next token is an obeyed space (from an @example environment or
317 % the like), remove it and recurse. Otherwise, we're done.
318 \def\parseargx{%
319 % \obeyedspace is defined far below, after the definition of \sepspaces.
320 \ifx\obeyedspace\temp
321 \expandafter\parseargdiscardspace
322 \else
323 \expandafter\parseargline
327 % Remove a single space (as the delimiter token to the macro call).
328 {\obeyspaces %
329 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
331 {\obeylines %
332 \gdef\parseargline#1^^M{%
333 \endgroup % End of the group started in \parsearg.
335 % First remove any @c comment, then any @comment.
336 % Result of each macro is put in \toks0.
337 \argremovec #1\c\relax %
338 \expandafter\argremovecomment \the\toks0 \comment\relax %
340 % Call the caller's macro, saved as \next in \parsearg.
341 \expandafter\next\expandafter{\the\toks0}%
345 % Since all \c{,omment} does is throw away the argument, we can let TeX
346 % do that for us. The \relax here is matched by the \relax in the call
347 % in \parseargline; it could be more or less anything, its purpose is
348 % just to delimit the argument to the \c.
349 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
350 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
352 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
353 % @end itemize @c foo
354 % will have two active spaces as part of the argument with the
355 % `itemize'. Here we remove all active spaces from #1, and assign the
356 % result to \toks0.
358 % This loses if there are any *other* active characters besides spaces
359 % in the argument -- _ ^ +, for example -- since they get expanded.
360 % Fortunately, Texinfo does not define any such commands. (If it ever
361 % does, the catcode of the characters in questionwill have to be changed
362 % here.) But this means we cannot call \removeactivespaces as part of
363 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
364 % that \parsearg gets might well have any character at all in it.
366 \def\removeactivespaces#1{%
367 \begingroup
368 \ignoreactivespaces
369 \edef\temp{#1}%
370 \global\toks0 = \expandafter{\temp}%
371 \endgroup
374 % Change the active space to expand to nothing.
376 \begingroup
377 \obeyspaces
378 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
379 \endgroup
382 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
384 %% These are used to keep @begin/@end levels from running away
385 %% Call \inENV within environments (after a \begingroup)
386 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
387 \def\ENVcheck{%
388 \ifENV\errmessage{Still within an environment; press RETURN to continue}
389 \endgroup\fi} % This is not perfect, but it should reduce lossage
391 % @begin foo is the same as @foo, for now.
392 \newhelp\EMsimple{Press RETURN to continue.}
394 \outer\def\begin{\parsearg\beginxxx}
396 \def\beginxxx #1{%
397 \expandafter\ifx\csname #1\endcsname\relax
398 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
399 \csname #1\endcsname\fi}
401 % @end foo executes the definition of \Efoo.
403 \def\end{\parsearg\endxxx}
404 \def\endxxx #1{%
405 \removeactivespaces{#1}%
406 \edef\endthing{\the\toks0}%
408 \expandafter\ifx\csname E\endthing\endcsname\relax
409 \expandafter\ifx\csname \endthing\endcsname\relax
410 % There's no \foo, i.e., no ``environment'' foo.
411 \errhelp = \EMsimple
412 \errmessage{Undefined command `@end \endthing'}%
413 \else
414 \unmatchedenderror\endthing
416 \else
417 % Everything's ok; the right environment has been started.
418 \csname E\endthing\endcsname
422 % There is an environment #1, but it hasn't been started. Give an error.
424 \def\unmatchedenderror#1{%
425 \errhelp = \EMsimple
426 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
429 % Define the control sequence \E#1 to give an unmatched @end error.
431 \def\defineunmatchedend#1{%
432 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
436 % Single-spacing is done by various environments (specifically, in
437 % \nonfillstart and \quotations).
438 \newskip\singlespaceskip \singlespaceskip = 12.5pt
439 \def\singlespace{%
440 % Why was this kern here? It messes up equalizing space above and below
441 % environments. --karl, 6may93
442 %{\advance \baselineskip by -\singlespaceskip
443 %\kern \baselineskip}%
444 \setleading \singlespaceskip
447 %% Simple single-character @ commands
449 % @@ prints an @
450 % Kludge this until the fonts are right (grr).
451 \def\@{{\tt\char64}}
453 % This is turned off because it was never documented
454 % and you can use @w{...} around a quote to suppress ligatures.
455 %% Define @` and @' to be the same as ` and '
456 %% but suppressing ligatures.
457 %\def\`{{`}}
458 %\def\'{{'}}
460 % Used to generate quoted braces.
461 \def\mylbrace {{\tt\char123}}
462 \def\myrbrace {{\tt\char125}}
463 \let\{=\mylbrace
464 \let\}=\myrbrace
465 \begingroup
466 % Definitions to produce actual \{ & \} command in an index.
467 \catcode`\{ = 12 \catcode`\} = 12
468 \catcode`\[ = 1 \catcode`\] = 2
469 \catcode`\@ = 0 \catcode`\\ = 12
470 @gdef@lbracecmd[\{]%
471 @gdef@rbracecmd[\}]%
472 @endgroup
474 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
475 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
476 \let\, = \c
477 \let\dotaccent = \.
478 \def\ringaccent#1{{\accent23 #1}}
479 \let\tieaccent = \t
480 \let\ubaraccent = \b
481 \let\udotaccent = \d
483 % Other special characters: @questiondown @exclamdown
484 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
485 \def\questiondown{?`}
486 \def\exclamdown{!`}
488 % Dotless i and dotless j, used for accents.
489 \def\imacro{i}
490 \def\jmacro{j}
491 \def\dotless#1{%
492 \def\temp{#1}%
493 \ifx\temp\imacro \ptexi
494 \else\ifx\temp\jmacro \j
495 \else \errmessage{@dotless can be used only with i or j}%
496 \fi\fi
499 % Be sure we're in horizontal mode when doing a tie, since we make space
500 % equivalent to this in @example-like environments. Otherwise, a space
501 % at the beginning of a line will start with \penalty -- and
502 % since \penalty is valid in vertical mode, we'd end up putting the
503 % penalty on the vertical list instead of in the new paragraph.
504 {\catcode`@ = 11
505 % Avoid using \@M directly, because that causes trouble
506 % if the definition is written into an index file.
507 \global\let\tiepenalty = \@M
508 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
511 % @: forces normal size whitespace following.
512 \def\:{\spacefactor=1000 }
514 % @* forces a line break.
515 \def\*{\hfil\break\hbox{}\ignorespaces}
517 % @. is an end-of-sentence period.
518 \def\.{.\spacefactor=3000 }
520 % @! is an end-of-sentence bang.
521 \def\!{!\spacefactor=3000 }
523 % @? is an end-of-sentence query.
524 \def\?{?\spacefactor=3000 }
526 % @w prevents a word break. Without the \leavevmode, @w at the
527 % beginning of a paragraph, when TeX is still in vertical mode, would
528 % produce a whole line of output instead of starting the paragraph.
529 \def\w#1{\leavevmode\hbox{#1}}
531 % @group ... @end group forces ... to be all on one page, by enclosing
532 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
533 % to keep its height that of a normal line. According to the rules for
534 % \topskip (p.114 of the TeXbook), the glue inserted is
535 % max (\topskip - \ht (first item), 0). If that height is large,
536 % therefore, no glue is inserted, and the space between the headline and
537 % the text is small, which looks bad.
539 \def\group{\begingroup
540 \ifnum\catcode13=\active \else
541 \errhelp = \groupinvalidhelp
542 \errmessage{@group invalid in context where filling is enabled}%
545 % The \vtop we start below produces a box with normal height and large
546 % depth; thus, TeX puts \baselineskip glue before it, and (when the
547 % next line of text is done) \lineskip glue after it. (See p.82 of
548 % the TeXbook.) Thus, space below is not quite equal to space
549 % above. But it's pretty close.
550 \def\Egroup{%
551 \egroup % End the \vtop.
552 \endgroup % End the \group.
555 \vtop\bgroup
556 % We have to put a strut on the last line in case the @group is in
557 % the midst of an example, rather than completely enclosing it.
558 % Otherwise, the interline space between the last line of the group
559 % and the first line afterwards is too small. But we can't put the
560 % strut in \Egroup, since there it would be on a line by itself.
561 % Hence this just inserts a strut at the beginning of each line.
562 \everypar = {\strut}%
564 % Since we have a strut on every line, we don't need any of TeX's
565 % normal interline spacing.
566 \offinterlineskip
568 % OK, but now we have to do something about blank
569 % lines in the input in @example-like environments, which normally
570 % just turn into \lisppar, which will insert no space now that we've
571 % turned off the interline space. Simplest is to make them be an
572 % empty paragraph.
573 \ifx\par\lisppar
574 \edef\par{\leavevmode \par}%
576 % Reset ^^M's definition to new definition of \par.
577 \obeylines
580 % Do @comment since we are called inside an environment such as
581 % @example, where each end-of-line in the input causes an
582 % end-of-line in the output. We don't want the end-of-line after
583 % the `@group' to put extra space in the output. Since @group
584 % should appear on a line by itself (according to the Texinfo
585 % manual), we don't worry about eating any user text.
586 \comment
589 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
590 % message, so this ends up printing `@group can only ...'.
592 \newhelp\groupinvalidhelp{%
593 group can only be used in environments such as @example,^^J%
594 where each line of input produces a line of output.}
596 % @need space-in-mils
597 % forces a page break if there is not space-in-mils remaining.
599 \newdimen\mil \mil=0.001in
601 \def\need{\parsearg\needx}
603 % Old definition--didn't work.
604 %\def\needx #1{\par %
605 %% This method tries to make TeX break the page naturally
606 %% if the depth of the box does not fit.
607 %{\baselineskip=0pt%
608 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
609 %\prevdepth=-1000pt
612 \def\needx#1{%
613 % Ensure vertical mode, so we don't make a big box in the middle of a
614 % paragraph.
615 \par
617 % If the @need value is less than one line space, it's useless.
618 \dimen0 = #1\mil
619 \dimen2 = \ht\strutbox
620 \advance\dimen2 by \dp\strutbox
621 \ifdim\dimen0 > \dimen2
623 % Do a \strut just to make the height of this box be normal, so the
624 % normal leading is inserted relative to the preceding line.
625 % And a page break here is fine.
626 \vtop to #1\mil{\strut\vfil}%
628 % TeX does not even consider page breaks if a penalty added to the
629 % main vertical list is 10000 or more. But in order to see if the
630 % empty box we just added fits on the page, we must make it consider
631 % page breaks. On the other hand, we don't want to actually break the
632 % page after the empty box. So we use a penalty of 9999.
634 % There is an extremely small chance that TeX will actually break the
635 % page at this \penalty, if there are no other feasible breakpoints in
636 % sight. (If the user is using lots of big @group commands, which
637 % almost-but-not-quite fill up a page, TeX will have a hard time doing
638 % good page breaking, for example.) However, I could not construct an
639 % example where a page broke at this \penalty; if it happens in a real
640 % document, then we can reconsider our strategy.
641 \penalty9999
643 % Back up by the size of the box, whether we did a page break or not.
644 \kern -#1\mil
646 % Do not allow a page break right after this kern.
647 \nobreak
651 % @br forces paragraph break
653 \let\br = \par
655 % @dots{} output an ellipsis using the current font.
656 % We do .5em per period so that it has the same spacing in a typewriter
657 % font as three actual period characters.
659 \def\dots{%
660 \leavevmode
661 \hbox to 1.5em{%
662 \hskip 0pt plus 0.25fil minus 0.25fil
663 .\hss.\hss.%
664 \hskip 0pt plus 0.5fil minus 0.5fil
668 % @enddots{} is an end-of-sentence ellipsis.
670 \def\enddots{%
671 \leavevmode
672 \hbox to 2em{%
673 \hskip 0pt plus 0.25fil minus 0.25fil
674 .\hss.\hss.\hss.%
675 \hskip 0pt plus 0.5fil minus 0.5fil
677 \spacefactor=3000
681 % @page forces the start of a new page
683 \def\page{\par\vfill\supereject}
685 % @exdent text....
686 % outputs text on separate line in roman font, starting at standard page margin
688 % This records the amount of indent in the innermost environment.
689 % That's how much \exdent should take out.
690 \newskip\exdentamount
692 % This defn is used inside fill environments such as @defun.
693 \def\exdent{\parsearg\exdentyyy}
694 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
696 % This defn is used inside nofill environments such as @example.
697 \def\nofillexdent{\parsearg\nofillexdentyyy}
698 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
699 \leftline{\hskip\leftskip{\rm#1}}}}
701 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
702 % paragraph. For more general purposes, use the \margin insertion
703 % class. WHICH is `l' or `r'.
705 \newskip\inmarginspacing \inmarginspacing=1cm
706 \def\strutdepth{\dp\strutbox}
708 \def\doinmargin#1#2{\strut\vadjust{%
709 \nobreak
710 \kern-\strutdepth
711 \vtop to \strutdepth{%
712 \baselineskip=\strutdepth
713 \vss
714 % if you have multiple lines of stuff to put here, you'll need to
715 % make the vbox yourself of the appropriate size.
716 \ifx#1l%
717 \llap{\ignorespaces #2\hskip\inmarginspacing}%
718 \else
719 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
721 \null
724 \def\inleftmargin{\doinmargin l}
725 \def\inrightmargin{\doinmargin r}
727 % @inmargin{TEXT [, RIGHT-TEXT]}
728 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
729 % else use TEXT for both).
731 \def\inmargin#1{\parseinmargin #1,,\finish}
732 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
733 \setbox0 = \hbox{\ignorespaces #2}%
734 \ifdim\wd0 > 0pt
735 \def\lefttext{#1}% have both texts
736 \def\righttext{#2}%
737 \else
738 \def\lefttext{#1}% have only one text
739 \def\righttext{#1}%
742 \ifodd\pageno
743 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
744 \else
745 \def\temp{\inleftmargin\lefttext}%
747 \temp
750 % @include file insert text of that file as input.
751 % Allow normal characters that we make active in the argument (a file name).
752 \def\include{\begingroup
753 \catcode`\\=12
754 \catcode`~=12
755 \catcode`^=12
756 \catcode`_=12
757 \catcode`|=12
758 \catcode`<=12
759 \catcode`>=12
760 \catcode`+=12
761 \parsearg\includezzz}
762 % Restore active chars for included file.
763 \def\includezzz#1{\endgroup\begingroup
764 % Read the included file in a group so nested @include's work.
765 \def\thisfile{#1}%
766 \input\thisfile
767 \endgroup}
769 \def\thisfile{}
771 % @center line outputs that line, centered
773 \def\center{\parsearg\centerzzz}
774 \def\centerzzz #1{{\advance\hsize by -\leftskip
775 \advance\hsize by -\rightskip
776 \centerline{#1}}}
778 % @sp n outputs n lines of vertical space
780 \def\sp{\parsearg\spxxx}
781 \def\spxxx #1{\vskip #1\baselineskip}
783 % @comment ...line which is ignored...
784 % @c is the same as @comment
785 % @ignore ... @end ignore is another way to write a comment
787 \def\comment{\begingroup \catcode`\^^M=\other%
788 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
789 \commentxxx}
790 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
792 \let\c=\comment
794 % @paragraphindent NCHARS
795 % We'll use ems for NCHARS, close enough.
796 % We cannot implement @paragraphindent asis, though.
798 \def\asisword{asis} % no translation, these are keywords
799 \def\noneword{none}
801 \def\paragraphindent{\parsearg\doparagraphindent}
802 \def\doparagraphindent#1{%
803 \def\temp{#1}%
804 \ifx\temp\asisword
805 \else
806 \ifx\temp\noneword
807 \defaultparindent = 0pt
808 \else
809 \defaultparindent = #1em
812 \parindent = \defaultparindent
815 % @exampleindent NCHARS
816 % We'll use ems for NCHARS like @paragraphindent.
817 % It seems @exampleindent asis isn't necessary, but
818 % I preserve it to make it similar to @paragraphindent.
819 \def\exampleindent{\parsearg\doexampleindent}
820 \def\doexampleindent#1{%
821 \def\temp{#1}%
822 \ifx\temp\asisword
823 \else
824 \ifx\temp\noneword
825 \lispnarrowing = 0pt
826 \else
827 \lispnarrowing = #1em
832 % @asis just yields its argument. Used with @table, for example.
834 \def\asis#1{#1}
836 % @math means output in math mode.
837 % We don't use $'s directly in the definition of \math because control
838 % sequences like \math are expanded when the toc file is written. Then,
839 % we read the toc file back, the $'s will be normal characters (as they
840 % should be, according to the definition of Texinfo). So we must use a
841 % control sequence to switch into and out of math mode.
843 % This isn't quite enough for @math to work properly in indices, but it
844 % seems unlikely it will ever be needed there.
846 \let\implicitmath = $
847 \def\math#1{\implicitmath #1\implicitmath}
849 % @bullet and @minus need the same treatment as @math, just above.
850 \def\bullet{\implicitmath\ptexbullet\implicitmath}
851 \def\minus{\implicitmath-\implicitmath}
853 % @refill is a no-op.
854 \let\refill=\relax
856 % If working on a large document in chapters, it is convenient to
857 % be able to disable indexing, cross-referencing, and contents, for test runs.
858 % This is done with @novalidate (before @setfilename).
860 \newif\iflinks \linkstrue % by default we want the aux files.
861 \let\novalidate = \linksfalse
863 % @setfilename is done at the beginning of every texinfo file.
864 % So open here the files we need to have open while reading the input.
865 % This makes it possible to make a .fmt file for texinfo.
866 \def\setfilename{%
867 \iflinks
868 \readauxfile
869 \fi % \openindices needs to do some work in any case.
870 \openindices
871 \fixbackslash % Turn off hack to swallow `\input texinfo'.
872 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
874 % If texinfo.cnf is present on the system, read it.
875 % Useful for site-wide @afourpaper, etc.
876 % Just to be on the safe side, close the input stream before the \input.
877 \openin 1 texinfo.cnf
878 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
879 \closein1
880 \temp
882 \comment % Ignore the actual filename.
885 % Called from \setfilename.
887 \def\openindices{%
888 \newindex{cp}%
889 \newcodeindex{fn}%
890 \newcodeindex{vr}%
891 \newcodeindex{tp}%
892 \newcodeindex{ky}%
893 \newcodeindex{pg}%
896 % @bye.
897 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
900 \message{pdf,}
901 % adobe `portable' document format
902 \newcount\tempnum
903 \newcount\lnkcount
904 \newtoks\filename
905 \newcount\filenamelength
906 \newcount\pgn
907 \newtoks\toksA
908 \newtoks\toksB
909 \newtoks\toksC
910 \newtoks\toksD
911 \newbox\boxA
912 \newcount\countA
913 \newif\ifpdf
914 \newif\ifpdfmakepagedest
916 \ifx\pdfoutput\undefined
917 \pdffalse
918 \let\pdfmkdest = \gobble
919 \let\pdfurl = \gobble
920 \let\endlink = \relax
921 \let\linkcolor = \relax
922 \let\pdfmakeoutlines = \relax
923 \else
924 \pdftrue
925 \pdfoutput = 1
926 \input pdfcolor
927 \def\dopdfimage#1#2#3{%
928 \def\imagewidth{#2}%
929 \def\imageheight{#3}%
930 \ifnum\pdftexversion < 14
931 \pdfimage
932 \else
933 \pdfximage
935 \ifx\empty\imagewidth\else width \imagewidth \fi
936 \ifx\empty\imageheight\else height \imageheight \fi
937 \ifnum\pdftexversion<13
938 #1.pdf%
939 \else
940 {#1.pdf}%
942 \ifnum\pdftexversion < 14 \else
943 \pdfrefximage \pdflastximage
944 \fi}
945 \def\pdfmkdest#1{\pdfdest name{#1} xyz}
946 \def\pdfmkpgn#1{#1@}
947 \let\linkcolor = \Blue % was Cyan, but that seems light?
948 \def\endlink{\Black\pdfendlink}
949 % Adding outlines to PDF; macros for calculating structure of outlines
950 % come from Petr Olsak
951 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
952 \else \csname#1\endcsname \fi}
953 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
954 \advance\tempnum by1
955 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
956 \def\pdfmakeoutlines{{%
957 \openin 1 \jobname.toc
958 \ifeof 1\else\bgroup
959 \closein 1
960 \indexnofonts
961 \def\tt{}
962 \let\_ = \normalunderscore
963 % Thanh's hack / proper braces in bookmarks
964 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
965 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
967 \def\chapentry ##1##2##3{}
968 \def\unnumbchapentry ##1##2{}
969 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
970 \def\unnumbsecentry ##1##2{}
971 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
972 \def\unnumbsubsecentry ##1##2{}
973 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
974 \def\unnumbsubsubsecentry ##1##2{}
975 \input \jobname.toc
976 \def\chapentry ##1##2##3{%
977 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
978 \def\unnumbchapentry ##1##2{%
979 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
980 \def\secentry ##1##2##3##4{%
981 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
982 \def\unnumbsecentry ##1##2{%
983 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
984 \def\subsecentry ##1##2##3##4##5{%
985 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
986 \def\unnumbsubsecentry ##1##2{%
987 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
988 \def\subsubsecentry ##1##2##3##4##5##6{%
989 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
990 \def\unnumbsubsubsecentry ##1##2{%
991 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
992 \input \jobname.toc
993 \egroup\fi
995 \def\makelinks #1,{%
996 \def\params{#1}\def\E{END}%
997 \ifx\params\E
998 \let\nextmakelinks=\relax
999 \else
1000 \let\nextmakelinks=\makelinks
1001 \ifnum\lnkcount>0,\fi
1002 \picknum{#1}%
1003 \startlink attr{/Border [0 0 0]}
1004 goto name{\pdfmkpgn{\the\pgn}}%
1005 \linkcolor #1%
1006 \advance\lnkcount by 1%
1007 \endlink
1009 \nextmakelinks
1011 \def\picknum#1{\expandafter\pn#1}
1012 \def\pn#1{%
1013 \def\p{#1}%
1014 \ifx\p\lbrace
1015 \let\nextpn=\ppn
1016 \else
1017 \let\nextpn=\ppnn
1018 \def\first{#1}
1020 \nextpn
1022 \def\ppn#1{\pgn=#1\gobble}
1023 \def\ppnn{\pgn=\first}
1024 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1025 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1026 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1027 \ifx\PP\D\let\nextsp\relax
1028 \else\let\nextsp\skipspaces
1029 \ifx\p\space\else\addtokens{\filename}{\PP}%
1030 \advance\filenamelength by 1
1033 \nextsp}
1034 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1035 \ifnum\pdftexversion < 14
1036 \let \startlink \pdfannotlink
1037 \else
1038 \let \startlink \pdfstartlink
1040 \def\pdfurl#1{%
1041 \begingroup
1042 \normalturnoffactive\def\@{@}%
1043 \let\value=\expandablevalue
1044 \leavevmode\Red
1045 \startlink attr{/Border [0 0 0]}%
1046 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1047 % #1
1048 \endgroup}
1049 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1050 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1051 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1052 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1053 \def\maketoks{%
1054 \expandafter\poptoks\the\toksA|ENDTOKS|
1055 \ifx\first0\adn0
1056 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1057 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1058 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1059 \else
1060 \ifnum0=\countA\else\makelink\fi
1061 \ifx\first.\let\next=\done\else
1062 \let\next=\maketoks
1063 \addtokens{\toksB}{\the\toksD}
1064 \ifx\first,\addtokens{\toksB}{\space}\fi
1066 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1067 \next}
1068 \def\makelink{\addtokens{\toksB}%
1069 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1070 \def\pdflink#1{%
1071 \startlink attr{/Border [0 0 0]} goto name{\mkpgn{#1}}
1072 \linkcolor #1\endlink}
1073 \def\mkpgn#1{#1@}
1074 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1075 \fi % \ifx\pdfoutput
1078 \message{fonts,}
1079 % Font-change commands.
1081 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1082 % So we set up a \sf analogous to plain's \rm, etc.
1083 \newfam\sffam
1084 \def\sf{\fam=\sffam \tensf}
1085 \let\li = \sf % Sometimes we call it \li, not \sf.
1087 % We don't need math for this one.
1088 \def\ttsl{\tenttsl}
1090 % Use Computer Modern fonts at \magstephalf (11pt).
1091 \newcount\mainmagstep
1092 \mainmagstep=\magstephalf
1094 % Set the font macro #1 to the font named #2, adding on the
1095 % specified font prefix (normally `cm').
1096 % #3 is the font's design size, #4 is a scale factor
1097 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1099 % Use cm as the default font prefix.
1100 % To specify the font prefix, you must define \fontprefix
1101 % before you read in texinfo.tex.
1102 \ifx\fontprefix\undefined
1103 \def\fontprefix{cm}
1105 % Support font families that don't use the same naming scheme as CM.
1106 \def\rmshape{r}
1107 \def\rmbshape{bx} %where the normal face is bold
1108 \def\bfshape{b}
1109 \def\bxshape{bx}
1110 \def\ttshape{tt}
1111 \def\ttbshape{tt}
1112 \def\ttslshape{sltt}
1113 \def\itshape{ti}
1114 \def\itbshape{bxti}
1115 \def\slshape{sl}
1116 \def\slbshape{bxsl}
1117 \def\sfshape{ss}
1118 \def\sfbshape{ss}
1119 \def\scshape{csc}
1120 \def\scbshape{csc}
1122 \ifx\bigger\relax
1123 \let\mainmagstep=\magstep1
1124 \setfont\textrm\rmshape{12}{1000}
1125 \setfont\texttt\ttshape{12}{1000}
1126 \else
1127 \setfont\textrm\rmshape{10}{\mainmagstep}
1128 \setfont\texttt\ttshape{10}{\mainmagstep}
1130 % Instead of cmb10, you many want to use cmbx10.
1131 % cmbx10 is a prettier font on its own, but cmb10
1132 % looks better when embedded in a line with cmr10.
1133 \setfont\textbf\bfshape{10}{\mainmagstep}
1134 \setfont\textit\itshape{10}{\mainmagstep}
1135 \setfont\textsl\slshape{10}{\mainmagstep}
1136 \setfont\textsf\sfshape{10}{\mainmagstep}
1137 \setfont\textsc\scshape{10}{\mainmagstep}
1138 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1139 \font\texti=cmmi10 scaled \mainmagstep
1140 \font\textsy=cmsy10 scaled \mainmagstep
1142 % A few fonts for @defun, etc.
1143 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1144 \setfont\deftt\ttshape{10}{\magstep1}
1145 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1147 % Fonts for indices, footnotes, small examples (9pt).
1148 \setfont\smallrm\rmshape{9}{1000}
1149 \setfont\smalltt\ttshape{9}{1000}
1150 \setfont\smallbf\bfshape{10}{900}
1151 \setfont\smallit\itshape{9}{1000}
1152 \setfont\smallsl\slshape{9}{1000}
1153 \setfont\smallsf\sfshape{9}{1000}
1154 \setfont\smallsc\scshape{10}{900}
1155 \setfont\smallttsl\ttslshape{10}{900}
1156 \font\smalli=cmmi9
1157 \font\smallsy=cmsy9
1159 % Fonts for small examples (8pt).
1160 \setfont\smallerrm\rmshape{8}{1000}
1161 \setfont\smallertt\ttshape{8}{1000}
1162 \setfont\smallerbf\bfshape{10}{800}
1163 \setfont\smallerit\itshape{8}{1000}
1164 \setfont\smallersl\slshape{8}{1000}
1165 \setfont\smallersf\sfshape{8}{1000}
1166 \setfont\smallersc\scshape{10}{800}
1167 \setfont\smallerttsl\ttslshape{10}{800}
1168 \font\smalleri=cmmi8
1169 \font\smallersy=cmsy8
1171 % Fonts for title page:
1172 \setfont\titlerm\rmbshape{12}{\magstep3}
1173 \setfont\titleit\itbshape{10}{\magstep4}
1174 \setfont\titlesl\slbshape{10}{\magstep4}
1175 \setfont\titlett\ttbshape{12}{\magstep3}
1176 \setfont\titlettsl\ttslshape{10}{\magstep4}
1177 \setfont\titlesf\sfbshape{17}{\magstep1}
1178 \let\titlebf=\titlerm
1179 \setfont\titlesc\scbshape{10}{\magstep4}
1180 \font\titlei=cmmi12 scaled \magstep3
1181 \font\titlesy=cmsy10 scaled \magstep4
1182 \def\authorrm{\secrm}
1184 % Chapter (and unnumbered) fonts (17.28pt).
1185 \setfont\chaprm\rmbshape{12}{\magstep2}
1186 \setfont\chapit\itbshape{10}{\magstep3}
1187 \setfont\chapsl\slbshape{10}{\magstep3}
1188 \setfont\chaptt\ttbshape{12}{\magstep2}
1189 \setfont\chapttsl\ttslshape{10}{\magstep3}
1190 \setfont\chapsf\sfbshape{17}{1000}
1191 \let\chapbf=\chaprm
1192 \setfont\chapsc\scbshape{10}{\magstep3}
1193 \font\chapi=cmmi12 scaled \magstep2
1194 \font\chapsy=cmsy10 scaled \magstep3
1196 % Section fonts (14.4pt).
1197 \setfont\secrm\rmbshape{12}{\magstep1}
1198 \setfont\secit\itbshape{10}{\magstep2}
1199 \setfont\secsl\slbshape{10}{\magstep2}
1200 \setfont\sectt\ttbshape{12}{\magstep1}
1201 \setfont\secttsl\ttslshape{10}{\magstep2}
1202 \setfont\secsf\sfbshape{12}{\magstep1}
1203 \let\secbf\secrm
1204 \setfont\secsc\scbshape{10}{\magstep2}
1205 \font\seci=cmmi12 scaled \magstep1
1206 \font\secsy=cmsy10 scaled \magstep2
1208 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1209 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1210 % \setfont\ssecsl\slshape{10}{\magstep1}
1211 % \setfont\ssectt\ttshape{10}{\magstep1}
1212 % \setfont\ssecsf\sfshape{10}{\magstep1}
1214 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1215 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1216 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1217 %\setfont\ssectt\ttshape{10}{1315}
1218 %\setfont\ssecsf\sfshape{10}{1315}
1220 %\let\ssecbf=\ssecrm
1222 % Subsection fonts (13.15pt).
1223 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1224 \setfont\ssecit\itbshape{10}{1315}
1225 \setfont\ssecsl\slbshape{10}{1315}
1226 \setfont\ssectt\ttbshape{12}{\magstephalf}
1227 \setfont\ssecttsl\ttslshape{10}{1315}
1228 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1229 \let\ssecbf\ssecrm
1230 \setfont\ssecsc\scbshape{10}{\magstep1}
1231 \font\sseci=cmmi12 scaled \magstephalf
1232 \font\ssecsy=cmsy10 scaled 1315
1233 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1234 % but that is not a standard magnification.
1236 % In order for the font changes to affect most math symbols and letters,
1237 % we have to define the \textfont of the standard families. Since
1238 % texinfo doesn't allow for producing subscripts and superscripts, we
1239 % don't bother to reset \scriptfont and \scriptscriptfont (which would
1240 % also require loading a lot more fonts).
1242 \def\resetmathfonts{%
1243 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1244 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1245 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1249 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1250 % of just \STYLE. We do this so that font changes will continue to work
1251 % in math mode, where it is the current \fam that is relevant in most
1252 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1253 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1254 % redefine \bf itself.
1255 \def\textfonts{%
1256 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1257 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1258 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1259 \resetmathfonts}
1260 \def\titlefonts{%
1261 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1262 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1263 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1264 \let\tenttsl=\titlettsl
1265 \resetmathfonts \setleading{25pt}}
1266 \def\titlefont#1{{\titlefonts\rm #1}}
1267 \def\chapfonts{%
1268 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1269 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1270 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1271 \resetmathfonts \setleading{19pt}}
1272 \def\secfonts{%
1273 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1274 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1275 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1276 \resetmathfonts \setleading{16pt}}
1277 \def\subsecfonts{%
1278 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1279 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1280 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1281 \resetmathfonts \setleading{15pt}}
1282 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1283 \def\smallfonts{%
1284 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1285 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1286 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1287 \let\tenttsl=\smallttsl
1288 \resetmathfonts \setleading{10.5pt}}
1289 \def\smallerfonts{%
1290 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1291 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1292 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1293 \let\tenttsl=\smallerttsl
1294 \resetmathfonts \setleading{9.5pt}}
1295 \let\smallexamplefonts = \smallerfonts
1297 % Set up the default fonts, so we can use them for creating boxes.
1299 \textfonts
1301 % Define these so they can be easily changed for other fonts.
1302 \def\angleleft{$\langle$}
1303 \def\angleright{$\rangle$}
1305 % Count depth in font-changes, for error checks
1306 \newcount\fontdepth \fontdepth=0
1308 % Fonts for short table of contents.
1309 \setfont\shortcontrm\rmshape{12}{1000}
1310 \setfont\shortcontbf\bxshape{12}{1000}
1311 \setfont\shortcontsl\slshape{12}{1000}
1313 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1314 %% serif) and @ii for TeX italic
1316 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1317 % unless the following character is such as not to need one.
1318 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1319 \def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx}
1320 \def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx}
1322 \let\i=\smartitalic
1323 \let\var=\smartslanted
1324 \let\dfn=\smartslanted
1325 \let\emph=\smartitalic
1326 \let\cite=\smartslanted
1328 \def\b#1{{\bf #1}}
1329 \let\strong=\b
1331 % We can't just use \exhyphenpenalty, because that only has effect at
1332 % the end of a paragraph. Restore normal hyphenation at the end of the
1333 % group within which \nohyphenation is presumably called.
1335 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1336 \def\restorehyphenation{\hyphenchar\font = `- }
1338 \def\t#1{%
1339 {\tt \rawbackslash \frenchspacing #1}%
1340 \null
1342 \let\ttfont=\t
1343 \def\samp#1{`\tclose{#1}'\null}
1344 \setfont\keyrm\rmshape{8}{1000}
1345 \font\keysy=cmsy9
1346 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1347 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1348 \vbox{\hrule\kern-0.4pt
1349 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1350 \kern-0.4pt\hrule}%
1351 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1352 % The old definition, with no lozenge:
1353 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1354 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1356 % @file, @option are the same as @samp.
1357 \let\file=\samp
1358 \let\option=\samp
1360 % @code is a modification of @t,
1361 % which makes spaces the same size as normal in the surrounding text.
1362 \def\tclose#1{%
1364 % Change normal interword space to be same as for the current font.
1365 \spaceskip = \fontdimen2\font
1367 % Switch to typewriter.
1370 % But `\ ' produces the large typewriter interword space.
1371 \def\ {{\spaceskip = 0pt{} }}%
1373 % Turn off hyphenation.
1374 \nohyphenation
1376 \rawbackslash
1377 \frenchspacing
1380 \null
1383 % We *must* turn on hyphenation at `-' and `_' in \code.
1384 % Otherwise, it is too hard to avoid overfull hboxes
1385 % in the Emacs manual, the Library manual, etc.
1387 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1388 % both hyphenation at - and hyphenation within words.
1389 % We must therefore turn them both off (\tclose does that)
1390 % and arrange explicitly to hyphenate at a dash.
1391 % -- rms.
1393 \catcode`\-=\active
1394 \catcode`\_=\active
1396 \global\def\code{\begingroup
1397 \catcode`\-=\active \let-\codedash
1398 \catcode`\_=\active \let_\codeunder
1399 \codex
1402 % If we end up with any active - characters when handling the index,
1403 % just treat them as a normal -.
1404 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1407 \def\realdash{-}
1408 \def\codedash{-\discretionary{}{}{}}
1409 \def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}}
1410 \def\codex #1{\tclose{#1}\endgroup}
1412 %\let\exp=\tclose %Was temporary
1414 % @kbd is like @code, except that if the argument is just one @key command,
1415 % then @kbd has no effect.
1417 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1418 % `example' (@kbd uses ttsl only inside of @example and friends),
1419 % or `code' (@kbd uses normal tty font always).
1420 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1421 \def\kbdinputstylexxx#1{%
1422 \def\arg{#1}%
1423 \ifx\arg\worddistinct
1424 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1425 \else\ifx\arg\wordexample
1426 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1427 \else\ifx\arg\wordcode
1428 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1429 \fi\fi\fi
1431 \def\worddistinct{distinct}
1432 \def\wordexample{example}
1433 \def\wordcode{code}
1435 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1436 % the catcodes are wrong for parsearg to work.)
1437 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1439 \def\xkey{\key}
1440 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1441 \ifx\one\xkey\ifx\threex\three \key{#2}%
1442 \else{\tclose{\kbdfont\look}}\fi
1443 \else{\tclose{\kbdfont\look}}\fi}
1445 % For @url, @env, @command quotes seem unnecessary, so use \code.
1446 \let\url=\code
1447 \let\env=\code
1448 \let\command=\code
1450 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1451 % second argument specifying the text to display and an optional third
1452 % arg as text to display instead of (rather than in addition to) the url
1453 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1454 % a hypertex \special here.
1456 \def\uref#1{\douref #1,,,\finish}
1457 \def\douref#1,#2,#3,#4\finish{\begingroup
1458 \unsepspaces
1459 \pdfurl{#1}%
1460 \setbox0 = \hbox{\ignorespaces #3}%
1461 \ifdim\wd0 > 0pt
1462 \unhbox0 % third arg given, show only that
1463 \else
1464 \setbox0 = \hbox{\ignorespaces #2}%
1465 \ifdim\wd0 > 0pt
1466 \ifpdf
1467 \unhbox0 % PDF: 2nd arg given, show only it
1468 \else
1469 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1471 \else
1472 \code{#1}% only url given, so show it
1475 \endlink
1476 \endgroup}
1478 % rms does not like angle brackets --karl, 17may97.
1479 % So now @email is just like @uref, unless we are pdf.
1481 %\def\email#1{\angleleft{\tt #1}\angleright}
1482 \ifpdf
1483 \def\email#1{\doemail#1,,\finish}
1484 \def\doemail#1,#2,#3\finish{\begingroup
1485 \unsepspaces
1486 \pdfurl{mailto:#1}%
1487 \setbox0 = \hbox{\ignorespaces #2}%
1488 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1489 \endlink
1490 \endgroup}
1491 \else
1492 \let\email=\uref
1495 % Check if we are currently using a typewriter font. Since all the
1496 % Computer Modern typewriter fonts have zero interword stretch (and
1497 % shrink), and it is reasonable to expect all typewriter fonts to have
1498 % this property, we can check that font parameter.
1500 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1502 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1503 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1505 \def\dmn#1{\thinspace #1}
1507 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1509 % @l was never documented to mean ``switch to the Lisp font'',
1510 % and it is not used as such in any manual I can find. We need it for
1511 % Polish suppressed-l. --karl, 22sep96.
1512 %\def\l#1{{\li #1}\null}
1514 % Explicit font changes: @r, @sc, undocumented @ii.
1515 \def\r#1{{\rm #1}} % roman font
1516 \def\sc#1{{\smallcaps#1}} % smallcaps font
1517 \def\ii#1{{\it #1}} % italic font
1519 % @acronym downcases the argument and prints in smallcaps.
1520 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1522 % @pounds{} is a sterling sign.
1523 \def\pounds{{\it\$}}
1526 \message{page headings,}
1528 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1529 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1531 % First the title page. Must do @settitle before @titlepage.
1532 \newif\ifseenauthor
1533 \newif\iffinishedtitlepage
1535 % Do an implicit @contents or @shortcontents after @end titlepage if the
1536 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1538 \newif\ifsetcontentsaftertitlepage
1539 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1540 \newif\ifsetshortcontentsaftertitlepage
1541 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1543 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1544 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1545 \endgroup\page\hbox{}\page}
1547 \def\titlepage{\begingroup \parindent=0pt \textfonts
1548 \let\subtitlerm=\tenrm
1549 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1551 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1553 % Leave some space at the very top of the page.
1554 \vglue\titlepagetopglue
1556 % Now you can print the title using @title.
1557 \def\title{\parsearg\titlezzz}%
1558 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1559 % print a rule at the page bottom also.
1560 \finishedtitlepagefalse
1561 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1562 % No rule at page bottom unless we print one at the top with @title.
1563 \finishedtitlepagetrue
1565 % Now you can put text using @subtitle.
1566 \def\subtitle{\parsearg\subtitlezzz}%
1567 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1569 % @author should come last, but may come many times.
1570 \def\author{\parsearg\authorzzz}%
1571 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1572 {\authorfont \leftline{##1}}}%
1574 % Most title ``pages'' are actually two pages long, with space
1575 % at the top of the second. We don't want the ragged left on the second.
1576 \let\oldpage = \page
1577 \def\page{%
1578 \iffinishedtitlepage\else
1579 \finishtitlepage
1581 \oldpage
1582 \let\page = \oldpage
1583 \hbox{}}%
1584 % \def\page{\oldpage \hbox{}}
1587 \def\Etitlepage{%
1588 \iffinishedtitlepage\else
1589 \finishtitlepage
1591 % It is important to do the page break before ending the group,
1592 % because the headline and footline are only empty inside the group.
1593 % If we use the new definition of \page, we always get a blank page
1594 % after the title page, which we certainly don't want.
1595 \oldpage
1596 \endgroup
1598 % If they want short, they certainly want long too.
1599 \ifsetshortcontentsaftertitlepage
1600 \shortcontents
1601 \contents
1602 \global\let\shortcontents = \relax
1603 \global\let\contents = \relax
1606 \ifsetcontentsaftertitlepage
1607 \contents
1608 \global\let\contents = \relax
1609 \global\let\shortcontents = \relax
1612 \ifpdf \pdfmakepagedesttrue \fi
1614 \HEADINGSon
1617 \def\finishtitlepage{%
1618 \vskip4pt \hrule height 2pt width \hsize
1619 \vskip\titlepagebottomglue
1620 \finishedtitlepagetrue
1623 %%% Set up page headings and footings.
1625 \let\thispage=\folio
1627 \newtoks\evenheadline % headline on even pages
1628 \newtoks\oddheadline % headline on odd pages
1629 \newtoks\evenfootline % footline on even pages
1630 \newtoks\oddfootline % footline on odd pages
1632 % Now make Tex use those variables
1633 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1634 \else \the\evenheadline \fi}}
1635 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1636 \else \the\evenfootline \fi}\HEADINGShook}
1637 \let\HEADINGShook=\relax
1639 % Commands to set those variables.
1640 % For example, this is what @headings on does
1641 % @evenheading @thistitle|@thispage|@thischapter
1642 % @oddheading @thischapter|@thispage|@thistitle
1643 % @evenfooting @thisfile||
1644 % @oddfooting ||@thisfile
1646 \def\evenheading{\parsearg\evenheadingxxx}
1647 \def\oddheading{\parsearg\oddheadingxxx}
1648 \def\everyheading{\parsearg\everyheadingxxx}
1650 \def\evenfooting{\parsearg\evenfootingxxx}
1651 \def\oddfooting{\parsearg\oddfootingxxx}
1652 \def\everyfooting{\parsearg\everyfootingxxx}
1654 {\catcode`\@=0 %
1656 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1657 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1658 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1660 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1661 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1662 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1664 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1666 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1667 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1668 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1670 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1671 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1672 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1674 % Leave some space for the footline. Hopefully ok to assume
1675 % @evenfooting will not be used by itself.
1676 \global\advance\pageheight by -\baselineskip
1677 \global\advance\vsize by -\baselineskip
1680 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1682 }% unbind the catcode of @.
1684 % @headings double turns headings on for double-sided printing.
1685 % @headings single turns headings on for single-sided printing.
1686 % @headings off turns them off.
1687 % @headings on same as @headings double, retained for compatibility.
1688 % @headings after turns on double-sided headings after this page.
1689 % @headings doubleafter turns on double-sided headings after this page.
1690 % @headings singleafter turns on single-sided headings after this page.
1691 % By default, they are off at the start of a document,
1692 % and turned `on' after @end titlepage.
1694 \def\headings #1 {\csname HEADINGS#1\endcsname}
1696 \def\HEADINGSoff{
1697 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1698 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1699 \HEADINGSoff
1700 % When we turn headings on, set the page number to 1.
1701 % For double-sided printing, put current file name in lower left corner,
1702 % chapter name on inside top of right hand pages, document
1703 % title on inside top of left hand pages, and page numbers on outside top
1704 % edge of all pages.
1705 \def\HEADINGSdouble{
1706 \global\pageno=1
1707 \global\evenfootline={\hfil}
1708 \global\oddfootline={\hfil}
1709 \global\evenheadline={\line{\folio\hfil\thistitle}}
1710 \global\oddheadline={\line{\thischapter\hfil\folio}}
1711 \global\let\contentsalignmacro = \chapoddpage
1713 \let\contentsalignmacro = \chappager
1715 % For single-sided printing, chapter title goes across top left of page,
1716 % page number on top right.
1717 \def\HEADINGSsingle{
1718 \global\pageno=1
1719 \global\evenfootline={\hfil}
1720 \global\oddfootline={\hfil}
1721 \global\evenheadline={\line{\thischapter\hfil\folio}}
1722 \global\oddheadline={\line{\thischapter\hfil\folio}}
1723 \global\let\contentsalignmacro = \chappager
1725 \def\HEADINGSon{\HEADINGSdouble}
1727 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1728 \let\HEADINGSdoubleafter=\HEADINGSafter
1729 \def\HEADINGSdoublex{%
1730 \global\evenfootline={\hfil}
1731 \global\oddfootline={\hfil}
1732 \global\evenheadline={\line{\folio\hfil\thistitle}}
1733 \global\oddheadline={\line{\thischapter\hfil\folio}}
1734 \global\let\contentsalignmacro = \chapoddpage
1737 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1738 \def\HEADINGSsinglex{%
1739 \global\evenfootline={\hfil}
1740 \global\oddfootline={\hfil}
1741 \global\evenheadline={\line{\thischapter\hfil\folio}}
1742 \global\oddheadline={\line{\thischapter\hfil\folio}}
1743 \global\let\contentsalignmacro = \chappager
1746 % Subroutines used in generating headings
1747 % This produces Day Month Year style of output.
1748 % Only define if not already defined, in case a txi-??.tex file has set
1749 % up a different format (e.g., txi-cs.tex does this).
1750 \ifx\today\undefined
1751 \def\today{%
1752 \number\day\space
1753 \ifcase\month
1754 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1755 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1756 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1758 \space\number\year}
1761 % @settitle line... specifies the title of the document, for headings.
1762 % It generates no output of its own.
1763 \def\thistitle{\putwordNoTitle}
1764 \def\settitle{\parsearg\settitlezzz}
1765 \def\settitlezzz #1{\gdef\thistitle{#1}}
1768 \message{tables,}
1769 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1771 % default indentation of table text
1772 \newdimen\tableindent \tableindent=.8in
1773 % default indentation of @itemize and @enumerate text
1774 \newdimen\itemindent \itemindent=.3in
1775 % margin between end of table item and start of table text.
1776 \newdimen\itemmargin \itemmargin=.1in
1778 % used internally for \itemindent minus \itemmargin
1779 \newdimen\itemmax
1781 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1782 % these defs.
1783 % They also define \itemindex
1784 % to index the item name in whatever manner is desired (perhaps none).
1786 \newif\ifitemxneedsnegativevskip
1788 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1790 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1791 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1793 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1794 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1796 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1797 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1799 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1800 \itemzzz {#1}}
1802 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1803 \itemzzz {#1}}
1805 \def\itemzzz #1{\begingroup %
1806 \advance\hsize by -\rightskip
1807 \advance\hsize by -\tableindent
1808 \setbox0=\hbox{\itemfont{#1}}%
1809 \itemindex{#1}%
1810 \nobreak % This prevents a break before @itemx.
1812 % If the item text does not fit in the space we have, put it on a line
1813 % by itself, and do not allow a page break either before or after that
1814 % line. We do not start a paragraph here because then if the next
1815 % command is, e.g., @kindex, the whatsit would get put into the
1816 % horizontal list on a line by itself, resulting in extra blank space.
1817 \ifdim \wd0>\itemmax
1819 % Make this a paragraph so we get the \parskip glue and wrapping,
1820 % but leave it ragged-right.
1821 \begingroup
1822 \advance\leftskip by-\tableindent
1823 \advance\hsize by\tableindent
1824 \advance\rightskip by0pt plus1fil
1825 \leavevmode\unhbox0\par
1826 \endgroup
1828 % We're going to be starting a paragraph, but we don't want the
1829 % \parskip glue -- logically it's part of the @item we just started.
1830 \nobreak \vskip-\parskip
1832 % Stop a page break at the \parskip glue coming up. Unfortunately
1833 % we can't prevent a possible page break at the following
1834 % \baselineskip glue.
1835 \nobreak
1836 \endgroup
1837 \itemxneedsnegativevskipfalse
1838 \else
1839 % The item text fits into the space. Start a paragraph, so that the
1840 % following text (if any) will end up on the same line.
1841 \noindent
1842 % Do this with kerns and \unhbox so that if there is a footnote in
1843 % the item text, it can migrate to the main vertical list and
1844 % eventually be printed.
1845 \nobreak\kern-\tableindent
1846 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1847 \unhbox0
1848 \nobreak\kern\dimen0
1849 \endgroup
1850 \itemxneedsnegativevskiptrue
1854 \def\item{\errmessage{@item while not in a table}}
1855 \def\itemx{\errmessage{@itemx while not in a table}}
1856 \def\kitem{\errmessage{@kitem while not in a table}}
1857 \def\kitemx{\errmessage{@kitemx while not in a table}}
1858 \def\xitem{\errmessage{@xitem while not in a table}}
1859 \def\xitemx{\errmessage{@xitemx while not in a table}}
1861 % Contains a kludge to get @end[description] to work.
1862 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1864 % @table, @ftable, @vtable.
1865 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1866 {\obeylines\obeyspaces%
1867 \gdef\tablex #1^^M{%
1868 \tabley\dontindex#1 \endtabley}}
1870 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1871 {\obeylines\obeyspaces%
1872 \gdef\ftablex #1^^M{%
1873 \tabley\fnitemindex#1 \endtabley
1874 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1875 \let\Etable=\relax}}
1877 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1878 {\obeylines\obeyspaces%
1879 \gdef\vtablex #1^^M{%
1880 \tabley\vritemindex#1 \endtabley
1881 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1882 \let\Etable=\relax}}
1884 \def\dontindex #1{}
1885 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1886 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1888 {\obeyspaces %
1889 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1890 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1892 \def\tablez #1#2#3#4#5#6{%
1893 \aboveenvbreak %
1894 \begingroup %
1895 \def\Edescription{\Etable}% Necessary kludge.
1896 \let\itemindex=#1%
1897 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1898 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1899 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1900 \def\itemfont{#2}%
1901 \itemmax=\tableindent %
1902 \advance \itemmax by -\itemmargin %
1903 \advance \leftskip by \tableindent %
1904 \exdentamount=\tableindent
1905 \parindent = 0pt
1906 \parskip = \smallskipamount
1907 \ifdim \parskip=0pt \parskip=2pt \fi%
1908 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1909 \let\item = \internalBitem %
1910 \let\itemx = \internalBitemx %
1911 \let\kitem = \internalBkitem %
1912 \let\kitemx = \internalBkitemx %
1913 \let\xitem = \internalBxitem %
1914 \let\xitemx = \internalBxitemx %
1917 % This is the counter used by @enumerate, which is really @itemize
1919 \newcount \itemno
1921 \def\itemize{\parsearg\itemizezzz}
1923 \def\itemizezzz #1{%
1924 \begingroup % ended by the @end itemize
1925 \itemizey {#1}{\Eitemize}
1928 \def\itemizey #1#2{%
1929 \aboveenvbreak %
1930 \itemmax=\itemindent %
1931 \advance \itemmax by -\itemmargin %
1932 \advance \leftskip by \itemindent %
1933 \exdentamount=\itemindent
1934 \parindent = 0pt %
1935 \parskip = \smallskipamount %
1936 \ifdim \parskip=0pt \parskip=2pt \fi%
1937 \def#2{\endgraf\afterenvbreak\endgroup}%
1938 \def\itemcontents{#1}%
1939 \let\item=\itemizeitem}
1941 % Set sfcode to normal for the chars that usually have another value.
1942 % These are `.?!:;,'
1943 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1944 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1946 % \splitoff TOKENS\endmark defines \first to be the first token in
1947 % TOKENS, and \rest to be the remainder.
1949 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1951 % Allow an optional argument of an uppercase letter, lowercase letter,
1952 % or number, to specify the first label in the enumerated list. No
1953 % argument is the same as `1'.
1955 \def\enumerate{\parsearg\enumeratezzz}
1956 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1957 \def\enumeratey #1 #2\endenumeratey{%
1958 \begingroup % ended by the @end enumerate
1960 % If we were given no argument, pretend we were given `1'.
1961 \def\thearg{#1}%
1962 \ifx\thearg\empty \def\thearg{1}\fi
1964 % Detect if the argument is a single token. If so, it might be a
1965 % letter. Otherwise, the only valid thing it can be is a number.
1966 % (We will always have one token, because of the test we just made.
1967 % This is a good thing, since \splitoff doesn't work given nothing at
1968 % all -- the first parameter is undelimited.)
1969 \expandafter\splitoff\thearg\endmark
1970 \ifx\rest\empty
1971 % Only one token in the argument. It could still be anything.
1972 % A ``lowercase letter'' is one whose \lccode is nonzero.
1973 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1974 % not equal to itself.
1975 % Otherwise, we assume it's a number.
1977 % We need the \relax at the end of the \ifnum lines to stop TeX from
1978 % continuing to look for a <number>.
1980 \ifnum\lccode\expandafter`\thearg=0\relax
1981 \numericenumerate % a number (we hope)
1982 \else
1983 % It's a letter.
1984 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1985 \lowercaseenumerate % lowercase letter
1986 \else
1987 \uppercaseenumerate % uppercase letter
1990 \else
1991 % Multiple tokens in the argument. We hope it's a number.
1992 \numericenumerate
1996 % An @enumerate whose labels are integers. The starting integer is
1997 % given in \thearg.
1999 \def\numericenumerate{%
2000 \itemno = \thearg
2001 \startenumeration{\the\itemno}%
2004 % The starting (lowercase) letter is in \thearg.
2005 \def\lowercaseenumerate{%
2006 \itemno = \expandafter`\thearg
2007 \startenumeration{%
2008 % Be sure we're not beyond the end of the alphabet.
2009 \ifnum\itemno=0
2010 \errmessage{No more lowercase letters in @enumerate; get a bigger
2011 alphabet}%
2013 \char\lccode\itemno
2017 % The starting (uppercase) letter is in \thearg.
2018 \def\uppercaseenumerate{%
2019 \itemno = \expandafter`\thearg
2020 \startenumeration{%
2021 % Be sure we're not beyond the end of the alphabet.
2022 \ifnum\itemno=0
2023 \errmessage{No more uppercase letters in @enumerate; get a bigger
2024 alphabet}
2026 \char\uccode\itemno
2030 % Call itemizey, adding a period to the first argument and supplying the
2031 % common last two arguments. Also subtract one from the initial value in
2032 % \itemno, since @item increments \itemno.
2034 \def\startenumeration#1{%
2035 \advance\itemno by -1
2036 \itemizey{#1.}\Eenumerate\flushcr
2039 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2040 % to @enumerate.
2042 \def\alphaenumerate{\enumerate{a}}
2043 \def\capsenumerate{\enumerate{A}}
2044 \def\Ealphaenumerate{\Eenumerate}
2045 \def\Ecapsenumerate{\Eenumerate}
2047 % Definition of @item while inside @itemize.
2049 \def\itemizeitem{%
2050 \advance\itemno by 1
2051 {\let\par=\endgraf \smallbreak}%
2052 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2053 {\parskip=0in \hskip 0pt
2054 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2055 \vadjust{\penalty 1200}}%
2056 \flushcr}
2058 % @multitable macros
2059 % Amy Hendrickson, 8/18/94, 3/6/96
2061 % @multitable ... @end multitable will make as many columns as desired.
2062 % Contents of each column will wrap at width given in preamble. Width
2063 % can be specified either with sample text given in a template line,
2064 % or in percent of \hsize, the current width of text on page.
2066 % Table can continue over pages but will only break between lines.
2068 % To make preamble:
2070 % Either define widths of columns in terms of percent of \hsize:
2071 % @multitable @columnfractions .25 .3 .45
2072 % @item ...
2074 % Numbers following @columnfractions are the percent of the total
2075 % current hsize to be used for each column. You may use as many
2076 % columns as desired.
2079 % Or use a template:
2080 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2081 % @item ...
2082 % using the widest term desired in each column.
2084 % For those who want to use more than one line's worth of words in
2085 % the preamble, break the line within one argument and it
2086 % will parse correctly, i.e.,
2088 % @multitable {Column 1 template} {Column 2 template} {Column 3
2089 % template}
2090 % Not:
2091 % @multitable {Column 1 template} {Column 2 template}
2092 % {Column 3 template}
2094 % Each new table line starts with @item, each subsequent new column
2095 % starts with @tab. Empty columns may be produced by supplying @tab's
2096 % with nothing between them for as many times as empty columns are needed,
2097 % ie, @tab@tab@tab will produce two empty columns.
2099 % @item, @tab, @multitable or @end multitable do not need to be on their
2100 % own lines, but it will not hurt if they are.
2102 % Sample multitable:
2104 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2105 % @item first col stuff @tab second col stuff @tab third col
2106 % @item
2107 % first col stuff
2108 % @tab
2109 % second col stuff
2110 % @tab
2111 % third col
2112 % @item first col stuff @tab second col stuff
2113 % @tab Many paragraphs of text may be used in any column.
2115 % They will wrap at the width determined by the template.
2116 % @item@tab@tab This will be in third column.
2117 % @end multitable
2119 % Default dimensions may be reset by user.
2120 % @multitableparskip is vertical space between paragraphs in table.
2121 % @multitableparindent is paragraph indent in table.
2122 % @multitablecolmargin is horizontal space to be left between columns.
2123 % @multitablelinespace is space to leave between table items, baseline
2124 % to baseline.
2125 % 0pt means it depends on current normal line spacing.
2127 \newskip\multitableparskip
2128 \newskip\multitableparindent
2129 \newdimen\multitablecolspace
2130 \newskip\multitablelinespace
2131 \multitableparskip=0pt
2132 \multitableparindent=6pt
2133 \multitablecolspace=12pt
2134 \multitablelinespace=0pt
2136 % Macros used to set up halign preamble:
2138 \let\endsetuptable\relax
2139 \def\xendsetuptable{\endsetuptable}
2140 \let\columnfractions\relax
2141 \def\xcolumnfractions{\columnfractions}
2142 \newif\ifsetpercent
2144 % #1 is the part of the @columnfraction before the decimal point, which
2145 % is presumably either 0 or the empty string (but we don't check, we
2146 % just throw it away). #2 is the decimal part, which we use as the
2147 % percent of \hsize for this column.
2148 \def\pickupwholefraction#1.#2 {%
2149 \global\advance\colcount by 1
2150 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2151 \setuptable
2154 \newcount\colcount
2155 \def\setuptable#1{%
2156 \def\firstarg{#1}%
2157 \ifx\firstarg\xendsetuptable
2158 \let\go = \relax
2159 \else
2160 \ifx\firstarg\xcolumnfractions
2161 \global\setpercenttrue
2162 \else
2163 \ifsetpercent
2164 \let\go\pickupwholefraction
2165 \else
2166 \global\advance\colcount by 1
2167 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2168 % typically that is always in the input, anyway.
2169 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2172 \ifx\go\pickupwholefraction
2173 % Put the argument back for the \pickupwholefraction call, so
2174 % we'll always have a period there to be parsed.
2175 \def\go{\pickupwholefraction#1}%
2176 \else
2177 \let\go = \setuptable
2178 \fi%
2183 % This used to have \hskip1sp. But then the space in a template line is
2184 % not enough. That is bad. So let's go back to just & until we
2185 % encounter the problem it was intended to solve again.
2186 % --karl, nathan@acm.org, 20apr99.
2187 \def\tab{&}
2189 % @multitable ... @end multitable definitions:
2191 \def\multitable{\parsearg\dotable}
2192 \def\dotable#1{\bgroup
2193 \vskip\parskip
2194 \let\item\crcr
2195 \tolerance=9500
2196 \hbadness=9500
2197 \setmultitablespacing
2198 \parskip=\multitableparskip
2199 \parindent=\multitableparindent
2200 \overfullrule=0pt
2201 \global\colcount=0
2202 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2204 % To parse everything between @multitable and @item:
2205 \setuptable#1 \endsetuptable
2207 % \everycr will reset column counter, \colcount, at the end of
2208 % each line. Every column entry will cause \colcount to advance by one.
2209 % The table preamble
2210 % looks at the current \colcount to find the correct column width.
2211 \everycr{\noalign{%
2213 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2214 % Maybe so, but it also creates really weird page breaks when the table
2215 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2216 % manifests itself, so it can be fixed for real --karl.
2217 \global\colcount=0\relax}}%
2219 % This preamble sets up a generic column definition, which will
2220 % be used as many times as user calls for columns.
2221 % \vtop will set a single line and will also let text wrap and
2222 % continue for many paragraphs if desired.
2223 \halign\bgroup&\global\advance\colcount by 1\relax
2224 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2226 % In order to keep entries from bumping into each other
2227 % we will add a \leftskip of \multitablecolspace to all columns after
2228 % the first one.
2230 % If a template has been used, we will add \multitablecolspace
2231 % to the width of each template entry.
2233 % If the user has set preamble in terms of percent of \hsize we will
2234 % use that dimension as the width of the column, and the \leftskip
2235 % will keep entries from bumping into each other. Table will start at
2236 % left margin and final column will justify at right margin.
2238 % Make sure we don't inherit \rightskip from the outer environment.
2239 \rightskip=0pt
2240 \ifnum\colcount=1
2241 % The first column will be indented with the surrounding text.
2242 \advance\hsize by\leftskip
2243 \else
2244 \ifsetpercent \else
2245 % If user has not set preamble in terms of percent of \hsize
2246 % we will advance \hsize by \multitablecolspace.
2247 \advance\hsize by \multitablecolspace
2249 % In either case we will make \leftskip=\multitablecolspace:
2250 \leftskip=\multitablecolspace
2252 % Ignoring space at the beginning and end avoids an occasional spurious
2253 % blank line, when TeX decides to break the line at the space before the
2254 % box from the multistrut, so the strut ends up on a line by itself.
2255 % For example:
2256 % @multitable @columnfractions .11 .89
2257 % @item @code{#}
2258 % @tab Legal holiday which is valid in major parts of the whole country.
2259 % Is automatically provided with highlighting sequences respectively marking
2260 % characters.
2261 \noindent\ignorespaces##\unskip\multistrut}\cr
2264 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2265 % If so, do nothing. If not, give it an appropriate dimension based on
2266 % current baselineskip.
2267 \ifdim\multitablelinespace=0pt
2268 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2269 \global\advance\multitablelinespace by-\ht0
2270 %% strut to put in table in case some entry doesn't have descenders,
2271 %% to keep lines equally spaced
2272 \let\multistrut = \strut
2273 \else
2274 %% FIXME: what is \box0 supposed to be?
2275 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2276 width0pt\relax} \fi
2277 %% Test to see if parskip is larger than space between lines of
2278 %% table. If not, do nothing.
2279 %% If so, set to same dimension as multitablelinespace.
2280 \ifdim\multitableparskip>\multitablelinespace
2281 \global\multitableparskip=\multitablelinespace
2282 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2283 %% than skip between lines in the table.
2284 \fi%
2285 \ifdim\multitableparskip=0pt
2286 \global\multitableparskip=\multitablelinespace
2287 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2288 %% than skip between lines in the table.
2289 \fi}
2292 \message{conditionals,}
2293 % Prevent errors for section commands.
2294 % Used in @ignore and in failing conditionals.
2295 \def\ignoresections{%
2296 \let\chapter=\relax
2297 \let\unnumbered=\relax
2298 \let\top=\relax
2299 \let\unnumberedsec=\relax
2300 \let\unnumberedsection=\relax
2301 \let\unnumberedsubsec=\relax
2302 \let\unnumberedsubsection=\relax
2303 \let\unnumberedsubsubsec=\relax
2304 \let\unnumberedsubsubsection=\relax
2305 \let\section=\relax
2306 \let\subsec=\relax
2307 \let\subsubsec=\relax
2308 \let\subsection=\relax
2309 \let\subsubsection=\relax
2310 \let\appendix=\relax
2311 \let\appendixsec=\relax
2312 \let\appendixsection=\relax
2313 \let\appendixsubsec=\relax
2314 \let\appendixsubsection=\relax
2315 \let\appendixsubsubsec=\relax
2316 \let\appendixsubsubsection=\relax
2317 \let\contents=\relax
2318 \let\smallbook=\relax
2319 \let\titlepage=\relax
2322 % Used in nested conditionals, where we have to parse the Texinfo source
2323 % and so want to turn off most commands, in case they are used
2324 % incorrectly.
2326 \def\ignoremorecommands{%
2327 \let\defcodeindex = \relax
2328 \let\defcv = \relax
2329 \let\deffn = \relax
2330 \let\deffnx = \relax
2331 \let\defindex = \relax
2332 \let\defivar = \relax
2333 \let\defmac = \relax
2334 \let\defmethod = \relax
2335 \let\defop = \relax
2336 \let\defopt = \relax
2337 \let\defspec = \relax
2338 \let\deftp = \relax
2339 \let\deftypefn = \relax
2340 \let\deftypefun = \relax
2341 \let\deftypeivar = \relax
2342 \let\deftypeop = \relax
2343 \let\deftypevar = \relax
2344 \let\deftypevr = \relax
2345 \let\defun = \relax
2346 \let\defvar = \relax
2347 \let\defvr = \relax
2348 \let\ref = \relax
2349 \let\xref = \relax
2350 \let\printindex = \relax
2351 \let\pxref = \relax
2352 \let\settitle = \relax
2353 \let\setchapternewpage = \relax
2354 \let\setchapterstyle = \relax
2355 \let\everyheading = \relax
2356 \let\evenheading = \relax
2357 \let\oddheading = \relax
2358 \let\everyfooting = \relax
2359 \let\evenfooting = \relax
2360 \let\oddfooting = \relax
2361 \let\headings = \relax
2362 \let\include = \relax
2363 \let\lowersections = \relax
2364 \let\down = \relax
2365 \let\raisesections = \relax
2366 \let\up = \relax
2367 \let\set = \relax
2368 \let\clear = \relax
2369 \let\item = \relax
2372 % Ignore @ignore ... @end ignore.
2374 \def\ignore{\doignore{ignore}}
2376 % Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text.
2378 \def\ifinfo{\doignore{ifinfo}}
2379 \def\ifhtml{\doignore{ifhtml}}
2380 \def\ifnottex{\doignore{ifnottex}}
2381 \def\html{\doignore{html}}
2382 \def\menu{\doignore{menu}}
2383 \def\direntry{\doignore{direntry}}
2385 % @dircategory CATEGORY -- specify a category of the dir file
2386 % which this file should belong to. Ignore this in TeX.
2387 \let\dircategory = \comment
2389 % Ignore text until a line `@end #1'.
2391 \def\doignore#1{\begingroup
2392 % Don't complain about control sequences we have declared \outer.
2393 \ignoresections
2395 % Define a command to swallow text until we reach `@end #1'.
2396 % This @ is a catcode 12 token (that is the normal catcode of @ in
2397 % this texinfo.tex file). We change the catcode of @ below to match.
2398 \long\def\doignoretext##1@end #1{\enddoignore}%
2400 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2401 \catcode32 = 10
2403 % Ignore braces, too, so mismatched braces don't cause trouble.
2404 \catcode`\{ = 9
2405 \catcode`\} = 9
2407 % We must not have @c interpreted as a control sequence.
2408 \catcode`\@ = 12
2410 % Make the letter c a comment character so that the rest of the line
2411 % will be ignored. This way, the document can have (for example)
2412 % @c @end ifinfo
2413 % and the @end ifinfo will be properly ignored.
2414 % (We've just changed @ to catcode 12.)
2415 \catcode`\c = 14
2417 % And now expand that command.
2418 \doignoretext
2421 % What we do to finish off ignored text.
2423 \def\enddoignore{\endgroup\ignorespaces}%
2425 \newif\ifwarnedobs\warnedobsfalse
2426 \def\obstexwarn{%
2427 \ifwarnedobs\relax\else
2428 % We need to warn folks that they may have trouble with TeX 3.0.
2429 % This uses \immediate\write16 rather than \message to get newlines.
2430 \immediate\write16{}
2431 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2432 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2433 \immediate\write16{If you are running another version of TeX, relax.}
2434 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2435 \immediate\write16{ Then upgrade your TeX installation if you can.}
2436 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2437 \immediate\write16{If you are stuck with version 3.0, run the}
2438 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2439 \immediate\write16{ to use a workaround.}
2440 \immediate\write16{}
2441 \global\warnedobstrue
2445 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2446 % workaround (which requires the file ``dummy.tfm'' to be installed),
2447 % uncomment the following line:
2448 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2450 % Ignore text, except that we keep track of conditional commands for
2451 % purposes of nesting, up to an `@end #1' command.
2453 \def\nestedignore#1{%
2454 \obstexwarn
2455 % We must actually expand the ignored text to look for the @end
2456 % command, so that nested ignore constructs work. Thus, we put the
2457 % text into a \vbox and then do nothing with the result. To minimize
2458 % the change of memory overflow, we follow the approach outlined on
2459 % page 401 of the TeXbook: make the current font be a dummy font.
2461 \setbox0 = \vbox\bgroup
2462 % Don't complain about control sequences we have declared \outer.
2463 \ignoresections
2465 % Define `@end #1' to end the box, which will in turn undefine the
2466 % @end command again.
2467 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2469 % We are going to be parsing Texinfo commands. Most cause no
2470 % trouble when they are used incorrectly, but some commands do
2471 % complicated argument parsing or otherwise get confused, so we
2472 % undefine them.
2474 % We can't do anything about stray @-signs, unfortunately;
2475 % they'll produce `undefined control sequence' errors.
2476 \ignoremorecommands
2478 % Set the current font to be \nullfont, a TeX primitive, and define
2479 % all the font commands to also use \nullfont. We don't use
2480 % dummy.tfm, as suggested in the TeXbook, because not all sites
2481 % might have that installed. Therefore, math mode will still
2482 % produce output, but that should be an extremely small amount of
2483 % stuff compared to the main input.
2485 \nullfont
2486 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2487 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2488 \let\tensf=\nullfont
2489 % Similarly for index fonts.
2490 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2491 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2492 \let\smallsf=\nullfont
2493 % Similarly for smallexample fonts.
2494 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2495 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2496 \let\smallersf=\nullfont
2498 % Don't complain when characters are missing from the fonts.
2499 \tracinglostchars = 0
2501 % Don't bother to do space factor calculations.
2502 \frenchspacing
2504 % Don't report underfull hboxes.
2505 \hbadness = 10000
2507 % Do minimal line-breaking.
2508 \pretolerance = 10000
2510 % Do not execute instructions in @tex
2511 \def\tex{\doignore{tex}}%
2512 % Do not execute macro definitions.
2513 % `c' is a comment character, so the word `macro' will get cut off.
2514 \def\macro{\doignore{ma}}%
2517 % @set VAR sets the variable VAR to an empty value.
2518 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2520 % Since we want to separate VAR from REST-OF-LINE (which might be
2521 % empty), we can't just use \parsearg; we have to insert a space of our
2522 % own to delimit the rest of the line, and then take it out again if we
2523 % didn't need it. Make sure the catcode of space is correct to avoid
2524 % losing inside @example, for instance.
2526 \def\set{\begingroup\catcode` =10
2527 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2528 \parsearg\setxxx}
2529 \def\setxxx#1{\setyyy#1 \endsetyyy}
2530 \def\setyyy#1 #2\endsetyyy{%
2531 \def\temp{#2}%
2532 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2533 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2535 \endgroup
2537 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2538 % \next or other control sequences that we've defined might get us into
2539 % an infinite loop. Consider `@set foo @cite{bar}'.
2540 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2542 % @clear VAR clears (i.e., unsets) the variable VAR.
2544 \def\clear{\parsearg\clearxxx}
2545 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2547 % @value{foo} gets the text saved in variable foo.
2549 \catcode`\_ = \active
2551 % We might end up with active _ or - characters in the argument if
2552 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2553 % such active characters to their normal equivalents.
2554 \gdef\value{\begingroup
2555 \catcode`\-=12 \catcode`\_=12
2556 \indexbreaks \let_\normalunderscore
2557 \valuexxx}
2559 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2561 % We have this subroutine so that we can handle at least some @value's
2562 % properly in indexes (we \let\value to this in \indexdummies). Ones
2563 % whose names contain - or _ still won't work, but we can't do anything
2564 % about that. The command has to be fully expandable, since the result
2565 % winds up in the index file. This means that if the variable's value
2566 % contains other Texinfo commands, it's almost certain it will fail
2567 % (although perhaps we could fix that with sufficient work to do a
2568 % one-level expansion on the result, instead of complete).
2570 \def\expandablevalue#1{%
2571 \expandafter\ifx\csname SET#1\endcsname\relax
2572 {[No value for ``#1'']}%
2573 \else
2574 \csname SET#1\endcsname
2578 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2579 % with @set.
2581 \def\ifset{\parsearg\ifsetxxx}
2582 \def\ifsetxxx #1{%
2583 \expandafter\ifx\csname SET#1\endcsname\relax
2584 \expandafter\ifsetfail
2585 \else
2586 \expandafter\ifsetsucceed
2589 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2590 \def\ifsetfail{\nestedignore{ifset}}
2591 \defineunmatchedend{ifset}
2593 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2594 % defined with @set, or has been undefined with @clear.
2596 \def\ifclear{\parsearg\ifclearxxx}
2597 \def\ifclearxxx #1{%
2598 \expandafter\ifx\csname SET#1\endcsname\relax
2599 \expandafter\ifclearsucceed
2600 \else
2601 \expandafter\ifclearfail
2604 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2605 \def\ifclearfail{\nestedignore{ifclear}}
2606 \defineunmatchedend{ifclear}
2608 % @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
2609 % following, through the first @end iftex (etc.). Make `@end iftex'
2610 % (etc.) valid only after an @iftex.
2612 \def\iftex{\conditionalsucceed{iftex}}
2613 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2614 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2615 \defineunmatchedend{iftex}
2616 \defineunmatchedend{ifnothtml}
2617 \defineunmatchedend{ifnotinfo}
2619 % We can't just want to start a group at @iftex (for example) and end it
2620 % at @end iftex, since then @set commands inside the conditional have no
2621 % effect (they'd get reverted at the end of the group). So we must
2622 % define \Eiftex to redefine itself to be its previous value. (We can't
2623 % just define it to fail again with an ``unmatched end'' error, since
2624 % the @ifset might be nested.)
2626 \def\conditionalsucceed#1{%
2627 \edef\temp{%
2628 % Remember the current value of \E#1.
2629 \let\nece{prevE#1} = \nece{E#1}%
2631 % At the `@end #1', redefine \E#1 to be its previous value.
2632 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2634 \temp
2637 % We need to expand lots of \csname's, but we don't want to expand the
2638 % control sequences after we've constructed them.
2640 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2642 % @defininfoenclose.
2643 \let\definfoenclose=\comment
2646 \message{indexing,}
2647 % Index generation facilities
2649 % Define \newwrite to be identical to plain tex's \newwrite
2650 % except not \outer, so it can be used within \newindex.
2651 {\catcode`\@=11
2652 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2654 % \newindex {foo} defines an index named foo.
2655 % It automatically defines \fooindex such that
2656 % \fooindex ...rest of line... puts an entry in the index foo.
2657 % It also defines \fooindfile to be the number of the output channel for
2658 % the file that accumulates this index. The file's extension is foo.
2659 % The name of an index should be no more than 2 characters long
2660 % for the sake of vms.
2662 \def\newindex#1{%
2663 \iflinks
2664 \expandafter\newwrite \csname#1indfile\endcsname
2665 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2667 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2668 \noexpand\doindex{#1}}
2671 % @defindex foo == \newindex{foo}
2673 \def\defindex{\parsearg\newindex}
2675 % Define @defcodeindex, like @defindex except put all entries in @code.
2677 \def\defcodeindex{\parsearg\newcodeindex}
2679 \def\newcodeindex#1{%
2680 \iflinks
2681 \expandafter\newwrite \csname#1indfile\endcsname
2682 \openout \csname#1indfile\endcsname \jobname.#1
2684 \expandafter\xdef\csname#1index\endcsname{%
2685 \noexpand\docodeindex{#1}}%
2689 % @synindex foo bar makes index foo feed into index bar.
2690 % Do this instead of @defindex foo if you don't want it as a separate index.
2692 % @syncodeindex foo bar similar, but put all entries made for index foo
2693 % inside @code.
2695 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2696 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2698 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2699 % #3 the target index (bar).
2700 \def\dosynindex#1#2#3{%
2701 % Only do \closeout if we haven't already done it, else we'll end up
2702 % closing the target index.
2703 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2704 % The \closeout helps reduce unnecessary open files; the limit on the
2705 % Acorn RISC OS is a mere 16 files.
2706 \expandafter\closeout\csname#2indfile\endcsname
2707 \expandafter\let\csname\donesynindex#2\endcsname = 1
2709 % redefine \fooindfile:
2710 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2711 \expandafter\let\csname#2indfile\endcsname=\temp
2712 % redefine \fooindex:
2713 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2716 % Define \doindex, the driver for all \fooindex macros.
2717 % Argument #1 is generated by the calling \fooindex macro,
2718 % and it is "foo", the name of the index.
2720 % \doindex just uses \parsearg; it calls \doind for the actual work.
2721 % This is because \doind is more useful to call from other macros.
2723 % There is also \dosubind {index}{topic}{subtopic}
2724 % which makes an entry in a two-level index such as the operation index.
2726 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2727 \def\singleindexer #1{\doind{\indexname}{#1}}
2729 % like the previous two, but they put @code around the argument.
2730 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2731 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2733 \def\indexdummies{%
2734 \def\ { }%
2735 % Take care of the plain tex accent commands.
2736 \def\"{\realbackslash "}%
2737 \def\`{\realbackslash `}%
2738 \def\'{\realbackslash '}%
2739 \def\^{\realbackslash ^}%
2740 \def\~{\realbackslash ~}%
2741 \def\={\realbackslash =}%
2742 \def\b{\realbackslash b}%
2743 \def\c{\realbackslash c}%
2744 \def\d{\realbackslash d}%
2745 \def\u{\realbackslash u}%
2746 \def\v{\realbackslash v}%
2747 \def\H{\realbackslash H}%
2748 % Take care of the plain tex special European modified letters.
2749 \def\oe{\realbackslash oe}%
2750 \def\ae{\realbackslash ae}%
2751 \def\aa{\realbackslash aa}%
2752 \def\OE{\realbackslash OE}%
2753 \def\AE{\realbackslash AE}%
2754 \def\AA{\realbackslash AA}%
2755 \def\o{\realbackslash o}%
2756 \def\O{\realbackslash O}%
2757 \def\l{\realbackslash l}%
2758 \def\L{\realbackslash L}%
2759 \def\ss{\realbackslash ss}%
2760 % Take care of texinfo commands likely to appear in an index entry.
2761 % (Must be a way to avoid doing expansion at all, and thus not have to
2762 % laboriously list every single command here.)
2763 \def\@{@}% will be @@ when we switch to @ as escape char.
2764 % Need these in case \tex is in effect and \{ is a \delimiter again.
2765 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2766 % braces and backslashes are used only as delimiters.
2767 \let\{ = \mylbrace
2768 \let\} = \myrbrace
2769 \def\_{{\realbackslash _}}%
2770 \def\w{\realbackslash w }%
2771 \def\bf{\realbackslash bf }%
2772 %\def\rm{\realbackslash rm }%
2773 \def\sl{\realbackslash sl }%
2774 \def\sf{\realbackslash sf}%
2775 \def\tt{\realbackslash tt}%
2776 \def\gtr{\realbackslash gtr}%
2777 \def\less{\realbackslash less}%
2778 \def\hat{\realbackslash hat}%
2779 \def\TeX{\realbackslash TeX}%
2780 \def\dots{\realbackslash dots }%
2781 \def\result{\realbackslash result}%
2782 \def\equiv{\realbackslash equiv}%
2783 \def\expansion{\realbackslash expansion}%
2784 \def\print{\realbackslash print}%
2785 \def\error{\realbackslash error}%
2786 \def\point{\realbackslash point}%
2787 \def\copyright{\realbackslash copyright}%
2788 \def\tclose##1{\realbackslash tclose {##1}}%
2789 \def\code##1{\realbackslash code {##1}}%
2790 \def\uref##1{\realbackslash uref {##1}}%
2791 \def\url##1{\realbackslash url {##1}}%
2792 \def\env##1{\realbackslash env {##1}}%
2793 \def\command##1{\realbackslash command {##1}}%
2794 \def\option##1{\realbackslash option {##1}}%
2795 \def\dotless##1{\realbackslash dotless {##1}}%
2796 \def\samp##1{\realbackslash samp {##1}}%
2797 \def\,##1{\realbackslash ,{##1}}%
2798 \def\t##1{\realbackslash t {##1}}%
2799 \def\r##1{\realbackslash r {##1}}%
2800 \def\i##1{\realbackslash i {##1}}%
2801 \def\b##1{\realbackslash b {##1}}%
2802 \def\sc##1{\realbackslash sc {##1}}%
2803 \def\cite##1{\realbackslash cite {##1}}%
2804 \def\key##1{\realbackslash key {##1}}%
2805 \def\file##1{\realbackslash file {##1}}%
2806 \def\var##1{\realbackslash var {##1}}%
2807 \def\kbd##1{\realbackslash kbd {##1}}%
2808 \def\dfn##1{\realbackslash dfn {##1}}%
2809 \def\emph##1{\realbackslash emph {##1}}%
2810 \def\acronym##1{\realbackslash acronym {##1}}%
2812 % Handle some cases of @value -- where the variable name does not
2813 % contain - or _, and the value does not contain any
2814 % (non-fully-expandable) commands.
2815 \let\value = \expandablevalue
2817 \unsepspaces
2818 % Turn off macro expansion
2819 \turnoffmacros
2822 % If an index command is used in an @example environment, any spaces
2823 % therein should become regular spaces in the raw index file, not the
2824 % expansion of \tie (\\leavevmode \penalty \@M \ ).
2825 {\obeyspaces
2826 \gdef\unsepspaces{\obeyspaces\let =\space}}
2828 % \indexnofonts no-ops all font-change commands.
2829 % This is used when outputting the strings to sort the index by.
2830 \def\indexdummyfont#1{#1}
2831 \def\indexdummytex{TeX}
2832 \def\indexdummydots{...}
2834 \def\indexnofonts{%
2835 % Just ignore accents.
2836 \let\,=\indexdummyfont
2837 \let\"=\indexdummyfont
2838 \let\`=\indexdummyfont
2839 \let\'=\indexdummyfont
2840 \let\^=\indexdummyfont
2841 \let\~=\indexdummyfont
2842 \let\==\indexdummyfont
2843 \let\b=\indexdummyfont
2844 \let\c=\indexdummyfont
2845 \let\d=\indexdummyfont
2846 \let\u=\indexdummyfont
2847 \let\v=\indexdummyfont
2848 \let\H=\indexdummyfont
2849 \let\dotless=\indexdummyfont
2850 % Take care of the plain tex special European modified letters.
2851 \def\oe{oe}%
2852 \def\ae{ae}%
2853 \def\aa{aa}%
2854 \def\OE{OE}%
2855 \def\AE{AE}%
2856 \def\AA{AA}%
2857 \def\o{o}%
2858 \def\O{O}%
2859 \def\l{l}%
2860 \def\L{L}%
2861 \def\ss{ss}%
2862 \let\w=\indexdummyfont
2863 \let\t=\indexdummyfont
2864 \let\r=\indexdummyfont
2865 \let\i=\indexdummyfont
2866 \let\b=\indexdummyfont
2867 \let\emph=\indexdummyfont
2868 \let\strong=\indexdummyfont
2869 \let\cite=\indexdummyfont
2870 \let\sc=\indexdummyfont
2871 %Don't no-op \tt, since it isn't a user-level command
2872 % and is used in the definitions of the active chars like <, >, |...
2873 %\let\tt=\indexdummyfont
2874 \let\tclose=\indexdummyfont
2875 \let\code=\indexdummyfont
2876 \let\url=\indexdummyfont
2877 \let\uref=\indexdummyfont
2878 \let\env=\indexdummyfont
2879 \let\acronym=\indexdummyfont
2880 \let\command=\indexdummyfont
2881 \let\option=\indexdummyfont
2882 \let\file=\indexdummyfont
2883 \let\samp=\indexdummyfont
2884 \let\kbd=\indexdummyfont
2885 \let\key=\indexdummyfont
2886 \let\var=\indexdummyfont
2887 \let\TeX=\indexdummytex
2888 \let\dots=\indexdummydots
2889 \def\@{@}%
2892 % To define \realbackslash, we must make \ not be an escape.
2893 % We must first make another character (@) an escape
2894 % so we do not become unable to do a definition.
2896 {\catcode`\@=0 \catcode`\\=\other
2897 @gdef@realbackslash{\}}
2899 \let\indexbackslash=0 %overridden during \printindex.
2900 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2902 % For \ifx comparisons.
2903 \def\emptymacro{\empty}
2905 % Most index entries go through here, but \dosubind is the general case.
2907 \def\doind#1#2{\dosubind{#1}{#2}\empty}
2909 % Workhorse for all \fooindexes.
2910 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2911 % \empty if called from \doind, as we usually are. The main exception
2912 % is with defuns, which call us directly.
2914 \def\dosubind#1#2#3{%
2915 % Put the index entry in the margin if desired.
2916 \ifx\SETmarginindex\relax\else
2917 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2920 \count255=\lastpenalty
2922 \indexdummies % Must do this here, since \bf, etc expand at this stage
2923 \escapechar=`\\
2925 \let\folio = 0% We will expand all macros now EXCEPT \folio.
2926 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2927 % so it will be output as is; and it will print as backslash.
2929 \def\thirdarg{#3}%
2931 % If third arg is present, precede it with space in sort key.
2932 \ifx\thirdarg\emptymacro
2933 \let\subentry = \empty
2934 \else
2935 \def\subentry{ #3}%
2938 % First process the index entry with all font commands turned
2939 % off to get the string to sort by.
2940 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
2942 % Now the real index entry with the fonts.
2943 \toks0 = {#2}%
2945 % If the third (subentry) arg is present, add it to the index
2946 % line to write.
2947 \ifx\thirdarg\emptymacro \else
2948 \toks0 = \expandafter{\the\toks0{#3}}%
2951 % Set up the complete index entry, with both the sort key and
2952 % the original text, including any font commands. We write
2953 % three arguments to \entry to the .?? file (four in the
2954 % subentry case), texindex reduces to two when writing the .??s
2955 % sorted result.
2956 \edef\temp{%
2957 \write\csname#1indfile\endcsname{%
2958 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2961 % If a skip is the last thing on the list now, preserve it
2962 % by backing up by \lastskip, doing the \write, then inserting
2963 % the skip again. Otherwise, the whatsit generated by the
2964 % \write will make \lastskip zero. The result is that sequences
2965 % like this:
2966 % @end defun
2967 % @tindex whatever
2968 % @defun ...
2969 % will have extra space inserted, because the \medbreak in the
2970 % start of the @defun won't see the skip inserted by the @end of
2971 % the previous defun.
2973 % But don't do any of this if we're not in vertical mode. We
2974 % don't want to do a \vskip and prematurely end a paragraph.
2976 % Avoid page breaks due to these extra skips, too.
2978 \iflinks
2979 \ifvmode
2980 \skip0 = \lastskip
2981 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
2984 \temp % do the write
2987 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
2991 \penalty\count255
2995 % The index entry written in the file actually looks like
2996 % \entry {sortstring}{page}{topic}
2997 % or
2998 % \entry {sortstring}{page}{topic}{subtopic}
2999 % The texindex program reads in these files and writes files
3000 % containing these kinds of lines:
3001 % \initial {c}
3002 % before the first topic whose initial is c
3003 % \entry {topic}{pagelist}
3004 % for a topic that is used without subtopics
3005 % \primary {topic}
3006 % for the beginning of a topic that is used with subtopics
3007 % \secondary {subtopic}{pagelist}
3008 % for each subtopic.
3010 % Define the user-accessible indexing commands
3011 % @findex, @vindex, @kindex, @cindex.
3013 \def\findex {\fnindex}
3014 \def\kindex {\kyindex}
3015 \def\cindex {\cpindex}
3016 \def\vindex {\vrindex}
3017 \def\tindex {\tpindex}
3018 \def\pindex {\pgindex}
3020 \def\cindexsub {\begingroup\obeylines\cindexsub}
3021 {\obeylines %
3022 \gdef\cindexsub "#1" #2^^M{\endgroup %
3023 \dosubind{cp}{#2}{#1}}}
3025 % Define the macros used in formatting output of the sorted index material.
3027 % @printindex causes a particular index (the ??s file) to get printed.
3028 % It does not print any chapter heading (usually an @unnumbered).
3030 \def\printindex{\parsearg\doprintindex}
3031 \def\doprintindex#1{\begingroup
3032 \dobreak \chapheadingskip{10000}%
3034 \smallfonts \rm
3035 \tolerance = 9500
3036 \indexbreaks
3038 % See if the index file exists and is nonempty.
3039 % Change catcode of @ here so that if the index file contains
3040 % \initial {@}
3041 % as its first line, TeX doesn't complain about mismatched braces
3042 % (because it thinks @} is a control sequence).
3043 \catcode`\@ = 11
3044 \openin 1 \jobname.#1s
3045 \ifeof 1
3046 % \enddoublecolumns gets confused if there is no text in the index,
3047 % and it loses the chapter title and the aux file entries for the
3048 % index. The easiest way to prevent this problem is to make sure
3049 % there is some text.
3050 \putwordIndexNonexistent
3051 \else
3053 % If the index file exists but is empty, then \openin leaves \ifeof
3054 % false. We have to make TeX try to read something from the file, so
3055 % it can discover if there is anything in it.
3056 \read 1 to \temp
3057 \ifeof 1
3058 \putwordIndexIsEmpty
3059 \else
3060 % Index files are almost Texinfo source, but we use \ as the escape
3061 % character. It would be better to use @, but that's too big a change
3062 % to make right now.
3063 \def\indexbackslash{\rawbackslashxx}%
3064 \catcode`\\ = 0
3065 \escapechar = `\\
3066 \begindoublecolumns
3067 \input \jobname.#1s
3068 \enddoublecolumns
3071 \closein 1
3072 \endgroup}
3074 % These macros are used by the sorted index file itself.
3075 % Change them to control the appearance of the index.
3077 \def\initial#1{{%
3078 % Some minor font changes for the special characters.
3079 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3081 % Remove any glue we may have, we'll be inserting our own.
3082 \removelastskip
3084 % We like breaks before the index initials, so insert a bonus.
3085 \penalty -300
3087 % Typeset the initial. Making this add up to a whole number of
3088 % baselineskips increases the chance of the dots lining up from column
3089 % to column. It still won't often be perfect, because of the stretch
3090 % we need before each entry, but it's better.
3092 % No shrink because it confuses \balancecolumns.
3093 \vskip 1.67\baselineskip plus .5\baselineskip
3094 \leftline{\secbf #1}%
3095 \vskip .33\baselineskip plus .1\baselineskip
3097 % Do our best not to break after the initial.
3098 \nobreak
3101 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3102 % flush to the right margin. It is used for index and table of contents
3103 % entries. The paragraph is indented by \leftskip.
3105 \def\entry#1#2{\begingroup
3107 % Start a new paragraph if necessary, so our assignments below can't
3108 % affect previous text.
3109 \par
3111 % Do not fill out the last line with white space.
3112 \parfillskip = 0in
3114 % No extra space above this paragraph.
3115 \parskip = 0in
3117 % Do not prefer a separate line ending with a hyphen to fewer lines.
3118 \finalhyphendemerits = 0
3120 % \hangindent is only relevant when the entry text and page number
3121 % don't both fit on one line. In that case, bob suggests starting the
3122 % dots pretty far over on the line. Unfortunately, a large
3123 % indentation looks wrong when the entry text itself is broken across
3124 % lines. So we use a small indentation and put up with long leaders.
3126 % \hangafter is reset to 1 (which is the value we want) at the start
3127 % of each paragraph, so we need not do anything with that.
3128 \hangindent = 2em
3130 % When the entry text needs to be broken, just fill out the first line
3131 % with blank space.
3132 \rightskip = 0pt plus1fil
3134 % A bit of stretch before each entry for the benefit of balancing columns.
3135 \vskip 0pt plus1pt
3137 % Start a ``paragraph'' for the index entry so the line breaking
3138 % parameters we've set above will have an effect.
3139 \noindent
3141 % Insert the text of the index entry. TeX will do line-breaking on it.
3143 % The following is kludged to not output a line of dots in the index if
3144 % there are no page numbers. The next person who breaks this will be
3145 % cursed by a Unix daemon.
3146 \def\tempa{{\rm }}%
3147 \def\tempb{#2}%
3148 \edef\tempc{\tempa}%
3149 \edef\tempd{\tempb}%
3150 \ifx\tempc\tempd\ \else%
3152 % If we must, put the page number on a line of its own, and fill out
3153 % this line with blank space. (The \hfil is overwhelmed with the
3154 % fill leaders glue in \indexdotfill if the page number does fit.)
3155 \hfil\penalty50
3156 \null\nobreak\indexdotfill % Have leaders before the page number.
3158 % The `\ ' here is removed by the implicit \unskip that TeX does as
3159 % part of (the primitive) \par. Without it, a spurious underfull
3160 % \hbox ensues.
3161 \ifpdf
3162 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3163 \else
3164 \ #2% The page number ends the paragraph.
3166 \fi%
3167 \par
3168 \endgroup}
3170 % Like \dotfill except takes at least 1 em.
3171 \def\indexdotfill{\cleaders
3172 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3174 \def\primary #1{\line{#1\hfil}}
3176 \newskip\secondaryindent \secondaryindent=0.5cm
3177 \def\secondary#1#2{{%
3178 \parfillskip=0in
3179 \parskip=0in
3180 \hangindent=1in
3181 \hangafter=1
3182 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3183 \ifpdf
3184 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3185 \else
3188 \par
3191 % Define two-column mode, which we use to typeset indexes.
3192 % Adapted from the TeXbook, page 416, which is to say,
3193 % the manmac.tex format used to print the TeXbook itself.
3194 \catcode`\@=11
3196 \newbox\partialpage
3197 \newdimen\doublecolumnhsize
3199 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3200 % Grab any single-column material above us.
3201 \output = {%
3203 % Here is a possibility not foreseen in manmac: if we accumulate a
3204 % whole lot of material, we might end up calling this \output
3205 % routine twice in a row (see the doublecol-lose test, which is
3206 % essentially a couple of indexes with @setchapternewpage off). In
3207 % that case we just ship out what is in \partialpage with the normal
3208 % output routine. Generally, \partialpage will be empty when this
3209 % runs and this will be a no-op. See the indexspread.tex test case.
3210 \ifvoid\partialpage \else
3211 \onepageout{\pagecontents\partialpage}%
3214 \global\setbox\partialpage = \vbox{%
3215 % Unvbox the main output page.
3216 \unvbox\PAGE
3217 \kern-\topskip \kern\baselineskip
3220 \eject % run that output routine to set \partialpage
3222 % Use the double-column output routine for subsequent pages.
3223 \output = {\doublecolumnout}%
3225 % Change the page size parameters. We could do this once outside this
3226 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3227 % format, but then we repeat the same computation. Repeating a couple
3228 % of assignments once per index is clearly meaningless for the
3229 % execution time, so we may as well do it in one place.
3231 % First we halve the line length, less a little for the gutter between
3232 % the columns. We compute the gutter based on the line length, so it
3233 % changes automatically with the paper format. The magic constant
3234 % below is chosen so that the gutter has the same value (well, +-<1pt)
3235 % as it did when we hard-coded it.
3237 % We put the result in a separate register, \doublecolumhsize, so we
3238 % can restore it in \pagesofar, after \hsize itself has (potentially)
3239 % been clobbered.
3241 \doublecolumnhsize = \hsize
3242 \advance\doublecolumnhsize by -.04154\hsize
3243 \divide\doublecolumnhsize by 2
3244 \hsize = \doublecolumnhsize
3246 % Double the \vsize as well. (We don't need a separate register here,
3247 % since nobody clobbers \vsize.)
3248 \vsize = 2\vsize
3251 % The double-column output routine for all double-column pages except
3252 % the last.
3254 \def\doublecolumnout{%
3255 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3256 % Get the available space for the double columns -- the normal
3257 % (undoubled) page height minus any material left over from the
3258 % previous page.
3259 \dimen@ = \vsize
3260 \divide\dimen@ by 2
3261 \advance\dimen@ by -\ht\partialpage
3263 % box0 will be the left-hand column, box2 the right.
3264 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3265 \onepageout\pagesofar
3266 \unvbox255
3267 \penalty\outputpenalty
3270 % Re-output the contents of the output page -- any previous material,
3271 % followed by the two boxes we just split, in box0 and box2.
3272 \def\pagesofar{%
3273 \unvbox\partialpage
3275 \hsize = \doublecolumnhsize
3276 \wd0=\hsize \wd2=\hsize
3277 \hbox to\pagewidth{\box0\hfil\box2}%
3280 % All done with double columns.
3281 \def\enddoublecolumns{%
3282 \output = {%
3283 % Split the last of the double-column material. Leave it on the
3284 % current page, no automatic page break.
3285 \balancecolumns
3287 % If we end up splitting too much material for the current page,
3288 % though, there will be another page break right after this \output
3289 % invocation ends. Having called \balancecolumns once, we do not
3290 % want to call it again. Therefore, reset \output to its normal
3291 % definition right away. (We hope \balancecolumns will never be
3292 % called on to balance too much material, but if it is, this makes
3293 % the output somewhat more palatable.)
3294 \global\output = {\onepageout{\pagecontents\PAGE}}%
3296 \eject
3297 \endgroup % started in \begindoublecolumns
3299 % \pagegoal was set to the doubled \vsize above, since we restarted
3300 % the current page. We're now back to normal single-column
3301 % typesetting, so reset \pagegoal to the normal \vsize (after the
3302 % \endgroup where \vsize got restored).
3303 \pagegoal = \vsize
3306 % Called at the end of the double column material.
3307 \def\balancecolumns{%
3308 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3309 \dimen@ = \ht0
3310 \advance\dimen@ by \topskip
3311 \advance\dimen@ by-\baselineskip
3312 \divide\dimen@ by 2 % target to split to
3313 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3314 \splittopskip = \topskip
3315 % Loop until we get a decent breakpoint.
3317 \vbadness = 10000
3318 \loop
3319 \global\setbox3 = \copy0
3320 \global\setbox1 = \vsplit3 to \dimen@
3321 \ifdim\ht3>\dimen@
3322 \global\advance\dimen@ by 1pt
3323 \repeat
3325 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3326 \setbox0=\vbox to\dimen@{\unvbox1}%
3327 \setbox2=\vbox to\dimen@{\unvbox3}%
3329 \pagesofar
3331 \catcode`\@ = \other
3334 \message{sectioning,}
3335 % Chapters, sections, etc.
3337 \newcount\chapno
3338 \newcount\secno \secno=0
3339 \newcount\subsecno \subsecno=0
3340 \newcount\subsubsecno \subsubsecno=0
3342 % This counter is funny since it counts through charcodes of letters A, B, ...
3343 \newcount\appendixno \appendixno = `\@
3344 % \def\appendixletter{\char\the\appendixno}
3345 % We do the following for the sake of pdftex, which needs the actual
3346 % letter in the expansion, not just typeset.
3347 \def\appendixletter{%
3348 \ifnum\appendixno=`A A%
3349 \else\ifnum\appendixno=`B B%
3350 \else\ifnum\appendixno=`C C%
3351 \else\ifnum\appendixno=`D D%
3352 \else\ifnum\appendixno=`E E%
3353 \else\ifnum\appendixno=`F F%
3354 \else\ifnum\appendixno=`G G%
3355 \else\ifnum\appendixno=`H H%
3356 \else\ifnum\appendixno=`I I%
3357 \else\ifnum\appendixno=`J J%
3358 \else\ifnum\appendixno=`K K%
3359 \else\ifnum\appendixno=`L L%
3360 \else\ifnum\appendixno=`M M%
3361 \else\ifnum\appendixno=`N N%
3362 \else\ifnum\appendixno=`O O%
3363 \else\ifnum\appendixno=`P P%
3364 \else\ifnum\appendixno=`Q Q%
3365 \else\ifnum\appendixno=`R R%
3366 \else\ifnum\appendixno=`S S%
3367 \else\ifnum\appendixno=`T T%
3368 \else\ifnum\appendixno=`U U%
3369 \else\ifnum\appendixno=`V V%
3370 \else\ifnum\appendixno=`W W%
3371 \else\ifnum\appendixno=`X X%
3372 \else\ifnum\appendixno=`Y Y%
3373 \else\ifnum\appendixno=`Z Z%
3374 % The \the is necessary, despite appearances, because \appendixletter is
3375 % expanded while writing the .toc file. \char\appendixno is not
3376 % expandable, thus it is written literally, thus all appendixes come out
3377 % with the same letter (or @) in the toc without it.
3378 \else\char\the\appendixno
3379 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3380 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3382 % Each @chapter defines this as the name of the chapter.
3383 % page headings and footings can use it. @section does likewise.
3384 \def\thischapter{}
3385 \def\thissection{}
3387 \newcount\absseclevel % used to calculate proper heading level
3388 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3390 % @raisesections: treat @section as chapter, @subsection as section, etc.
3391 \def\raisesections{\global\advance\secbase by -1}
3392 \let\up=\raisesections % original BFox name
3394 % @lowersections: treat @chapter as section, @section as subsection, etc.
3395 \def\lowersections{\global\advance\secbase by 1}
3396 \let\down=\lowersections % original BFox name
3398 % Choose a numbered-heading macro
3399 % #1 is heading level if unmodified by @raisesections or @lowersections
3400 % #2 is text for heading
3401 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3402 \ifcase\absseclevel
3403 \chapterzzz{#2}
3405 \seczzz{#2}
3407 \numberedsubseczzz{#2}
3409 \numberedsubsubseczzz{#2}
3410 \else
3411 \ifnum \absseclevel<0
3412 \chapterzzz{#2}
3413 \else
3414 \numberedsubsubseczzz{#2}
3419 % like \numhead, but chooses appendix heading levels
3420 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3421 \ifcase\absseclevel
3422 \appendixzzz{#2}
3424 \appendixsectionzzz{#2}
3426 \appendixsubseczzz{#2}
3428 \appendixsubsubseczzz{#2}
3429 \else
3430 \ifnum \absseclevel<0
3431 \appendixzzz{#2}
3432 \else
3433 \appendixsubsubseczzz{#2}
3438 % like \numhead, but chooses numberless heading levels
3439 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3440 \ifcase\absseclevel
3441 \unnumberedzzz{#2}
3443 \unnumberedseczzz{#2}
3445 \unnumberedsubseczzz{#2}
3447 \unnumberedsubsubseczzz{#2}
3448 \else
3449 \ifnum \absseclevel<0
3450 \unnumberedzzz{#2}
3451 \else
3452 \unnumberedsubsubseczzz{#2}
3457 % @chapter, @appendix, @unnumbered.
3458 \def\thischaptername{No Chapter Title}
3459 \outer\def\chapter{\parsearg\chapteryyy}
3460 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3461 \def\chapterzzz #1{%
3462 \secno=0 \subsecno=0 \subsubsecno=0
3463 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3464 \chapmacro {#1}{\the\chapno}%
3465 \gdef\thissection{#1}%
3466 \gdef\thischaptername{#1}%
3467 % We don't substitute the actual chapter name into \thischapter
3468 % because we don't want its macros evaluated now.
3469 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3470 \toks0 = {#1}%
3471 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3472 {\the\chapno}}}%
3473 \temp
3474 \donoderef
3475 \global\let\section = \numberedsec
3476 \global\let\subsection = \numberedsubsec
3477 \global\let\subsubsection = \numberedsubsubsec
3480 \outer\def\appendix{\parsearg\appendixyyy}
3481 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3482 \def\appendixzzz #1{%
3483 \secno=0 \subsecno=0 \subsubsecno=0
3484 \global\advance \appendixno by 1
3485 \message{\putwordAppendix\space \appendixletter}%
3486 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3487 \gdef\thissection{#1}%
3488 \gdef\thischaptername{#1}%
3489 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3490 \toks0 = {#1}%
3491 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3492 {\putwordAppendix{} \appendixletter}}}%
3493 \temp
3494 \appendixnoderef
3495 \global\let\section = \appendixsec
3496 \global\let\subsection = \appendixsubsec
3497 \global\let\subsubsection = \appendixsubsubsec
3500 % @centerchap is like @unnumbered, but the heading is centered.
3501 \outer\def\centerchap{\parsearg\centerchapyyy}
3502 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3504 % @top is like @unnumbered.
3505 \outer\def\top{\parsearg\unnumberedyyy}
3507 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3508 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3509 \def\unnumberedzzz #1{%
3510 \secno=0 \subsecno=0 \subsubsecno=0
3512 % This used to be simply \message{#1}, but TeX fully expands the
3513 % argument to \message. Therefore, if #1 contained @-commands, TeX
3514 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3515 % expanded @cite (which turns out to cause errors because \cite is meant
3516 % to be executed, not expanded).
3518 % Anyway, we don't want the fully-expanded definition of @cite to appear
3519 % as a result of the \message, we just want `@cite' itself. We use
3520 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3521 % simply yielding the contents of <toks register>. (We also do this for
3522 % the toc entries.)
3523 \toks0 = {#1}\message{(\the\toks0)}%
3525 \unnumbchapmacro {#1}%
3526 \gdef\thischapter{#1}\gdef\thissection{#1}%
3527 \toks0 = {#1}%
3528 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3529 \temp
3530 \unnumbnoderef
3531 \global\let\section = \unnumberedsec
3532 \global\let\subsection = \unnumberedsubsec
3533 \global\let\subsubsection = \unnumberedsubsubsec
3536 % Sections.
3537 \outer\def\numberedsec{\parsearg\secyyy}
3538 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3539 \def\seczzz #1{%
3540 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3541 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3542 \toks0 = {#1}%
3543 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3544 {\the\chapno}{\the\secno}}}%
3545 \temp
3546 \donoderef
3547 \nobreak
3550 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3551 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3552 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3553 \def\appendixsectionzzz #1{%
3554 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3555 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3556 \toks0 = {#1}%
3557 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3558 {\appendixletter}{\the\secno}}}%
3559 \temp
3560 \appendixnoderef
3561 \nobreak
3564 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3565 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3566 \def\unnumberedseczzz #1{%
3567 \plainsecheading {#1}\gdef\thissection{#1}%
3568 \toks0 = {#1}%
3569 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}%
3570 \temp
3571 \unnumbnoderef
3572 \nobreak
3575 % Subsections.
3576 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3577 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3578 \def\numberedsubseczzz #1{%
3579 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3580 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3581 \toks0 = {#1}%
3582 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3583 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3584 \temp
3585 \donoderef
3586 \nobreak
3589 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3590 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3591 \def\appendixsubseczzz #1{%
3592 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3593 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3594 \toks0 = {#1}%
3595 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3596 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3597 \temp
3598 \appendixnoderef
3599 \nobreak
3602 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3603 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3604 \def\unnumberedsubseczzz #1{%
3605 \plainsubsecheading {#1}\gdef\thissection{#1}%
3606 \toks0 = {#1}%
3607 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3608 {\the\toks0}}}%
3609 \temp
3610 \unnumbnoderef
3611 \nobreak
3614 % Subsubsections.
3615 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3616 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3617 \def\numberedsubsubseczzz #1{%
3618 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3619 \subsubsecheading {#1}
3620 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3621 \toks0 = {#1}%
3622 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3623 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3624 \temp
3625 \donoderef
3626 \nobreak
3629 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3630 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3631 \def\appendixsubsubseczzz #1{%
3632 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3633 \subsubsecheading {#1}
3634 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3635 \toks0 = {#1}%
3636 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3637 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3638 \temp
3639 \appendixnoderef
3640 \nobreak
3643 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3644 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3645 \def\unnumberedsubsubseczzz #1{%
3646 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3647 \toks0 = {#1}%
3648 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3649 {\the\toks0}}}%
3650 \temp
3651 \unnumbnoderef
3652 \nobreak
3655 % These are variants which are not "outer", so they can appear in @ifinfo.
3656 % Actually, they should now be obsolete; ordinary section commands should work.
3657 \def\infotop{\parsearg\unnumberedzzz}
3658 \def\infounnumbered{\parsearg\unnumberedzzz}
3659 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3660 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3661 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3663 \def\infoappendix{\parsearg\appendixzzz}
3664 \def\infoappendixsec{\parsearg\appendixseczzz}
3665 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3666 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3668 \def\infochapter{\parsearg\chapterzzz}
3669 \def\infosection{\parsearg\sectionzzz}
3670 \def\infosubsection{\parsearg\subsectionzzz}
3671 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3673 % These macros control what the section commands do, according
3674 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3675 % Define them by default for a numbered chapter.
3676 \global\let\section = \numberedsec
3677 \global\let\subsection = \numberedsubsec
3678 \global\let\subsubsection = \numberedsubsubsec
3680 % Define @majorheading, @heading and @subheading
3682 % NOTE on use of \vbox for chapter headings, section headings, and such:
3683 % 1) We use \vbox rather than the earlier \line to permit
3684 % overlong headings to fold.
3685 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3686 % heading is obnoxious; this forbids it.
3687 % 3) Likewise, headings look best if no \parindent is used, and
3688 % if justification is not attempted. Hence \raggedright.
3691 \def\majorheading{\parsearg\majorheadingzzz}
3692 \def\majorheadingzzz #1{%
3693 {\advance\chapheadingskip by 10pt \chapbreak }%
3694 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3695 \parindent=0pt\raggedright
3696 \rm #1\hfill}}\bigskip \par\penalty 200}
3698 \def\chapheading{\parsearg\chapheadingzzz}
3699 \def\chapheadingzzz #1{\chapbreak %
3700 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3701 \parindent=0pt\raggedright
3702 \rm #1\hfill}}\bigskip \par\penalty 200}
3704 % @heading, @subheading, @subsubheading.
3705 \def\heading{\parsearg\plainsecheading}
3706 \def\subheading{\parsearg\plainsubsecheading}
3707 \def\subsubheading{\parsearg\plainsubsubsecheading}
3709 % These macros generate a chapter, section, etc. heading only
3710 % (including whitespace, linebreaking, etc. around it),
3711 % given all the information in convenient, parsed form.
3713 %%% Args are the skip and penalty (usually negative)
3714 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3716 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3718 %%% Define plain chapter starts, and page on/off switching for it
3719 % Parameter controlling skip before chapter headings (if needed)
3721 \newskip\chapheadingskip
3723 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3724 \def\chappager{\par\vfill\supereject}
3725 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3727 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3729 \def\CHAPPAGoff{%
3730 \global\let\contentsalignmacro = \chappager
3731 \global\let\pchapsepmacro=\chapbreak
3732 \global\let\pagealignmacro=\chappager}
3734 \def\CHAPPAGon{%
3735 \global\let\contentsalignmacro = \chappager
3736 \global\let\pchapsepmacro=\chappager
3737 \global\let\pagealignmacro=\chappager
3738 \global\def\HEADINGSon{\HEADINGSsingle}}
3740 \def\CHAPPAGodd{
3741 \global\let\contentsalignmacro = \chapoddpage
3742 \global\let\pchapsepmacro=\chapoddpage
3743 \global\let\pagealignmacro=\chapoddpage
3744 \global\def\HEADINGSon{\HEADINGSdouble}}
3746 \CHAPPAGon
3748 \def\CHAPFplain{
3749 \global\let\chapmacro=\chfplain
3750 \global\let\unnumbchapmacro=\unnchfplain
3751 \global\let\centerchapmacro=\centerchfplain}
3753 % Plain chapter opening.
3754 % #1 is the text, #2 the chapter number or empty if unnumbered.
3755 \def\chfplain#1#2{%
3756 \pchapsepmacro
3758 \chapfonts \rm
3759 \def\chapnum{#2}%
3760 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3761 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3762 \hangindent = \wd0 \centerparametersmaybe
3763 \unhbox0 #1\par}%
3765 \nobreak\bigskip % no page break after a chapter title
3766 \nobreak
3769 % Plain opening for unnumbered.
3770 \def\unnchfplain#1{\chfplain{#1}{}}
3772 % @centerchap -- centered and unnumbered.
3773 \let\centerparametersmaybe = \relax
3774 \def\centerchfplain#1{{%
3775 \def\centerparametersmaybe{%
3776 \advance\rightskip by 3\rightskip
3777 \leftskip = \rightskip
3778 \parfillskip = 0pt
3780 \chfplain{#1}{}%
3783 \CHAPFplain % The default
3785 \def\unnchfopen #1{%
3786 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3787 \parindent=0pt\raggedright
3788 \rm #1\hfill}}\bigskip \par\nobreak
3791 \def\chfopen #1#2{\chapoddpage {\chapfonts
3792 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3793 \par\penalty 5000 %
3796 \def\centerchfopen #1{%
3797 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3798 \parindent=0pt
3799 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3802 \def\CHAPFopen{
3803 \global\let\chapmacro=\chfopen
3804 \global\let\unnumbchapmacro=\unnchfopen
3805 \global\let\centerchapmacro=\centerchfopen}
3808 % Section titles.
3809 \newskip\secheadingskip
3810 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3811 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3812 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3814 % Subsection titles.
3815 \newskip \subsecheadingskip
3816 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3817 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3818 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3820 % Subsubsection titles.
3821 \let\subsubsecheadingskip = \subsecheadingskip
3822 \let\subsubsecheadingbreak = \subsecheadingbreak
3823 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3824 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3827 % Print any size section title.
3829 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3830 % number (maybe empty), #3 the text.
3831 \def\sectionheading#1#2#3{%
3833 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3834 \csname #1headingbreak\endcsname
3837 % Switch to the right set of fonts.
3838 \csname #1fonts\endcsname \rm
3840 % Only insert the separating space if we have a section number.
3841 \def\secnum{#2}%
3842 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3844 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3845 \hangindent = \wd0 % zero if no section number
3846 \unhbox0 #3}%
3848 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3852 \message{toc,}
3853 % Table of contents.
3854 \newwrite\tocfile
3856 % Write an entry to the toc file, opening it if necessary.
3857 % Called from @chapter, etc. We supply {\folio} at the end of the
3858 % argument, which will end up as the last argument to the \...entry macro.
3860 % We open the .toc file here instead of at @setfilename or any other
3861 % given time so that @contents can be put in the document anywhere.
3863 \newif\iftocfileopened
3864 \def\writetocentry#1{%
3865 \iftocfileopened\else
3866 \immediate\openout\tocfile = \jobname.toc
3867 \global\tocfileopenedtrue
3869 \iflinks \write\tocfile{#1{\folio}}\fi
3872 \newskip\contentsrightmargin \contentsrightmargin=1in
3873 \newcount\savepageno
3874 \newcount\lastnegativepageno \lastnegativepageno = -1
3876 % Finish up the main text and prepare to read what we've written
3877 % to \tocfile.
3879 \def\startcontents#1{%
3880 % If @setchapternewpage on, and @headings double, the contents should
3881 % start on an odd page, unlike chapters. Thus, we maintain
3882 % \contentsalignmacro in parallel with \pagealignmacro.
3883 % From: Torbjorn Granlund <tege@matematik.su.se>
3884 \contentsalignmacro
3885 \immediate\closeout\tocfile
3887 % Don't need to put `Contents' or `Short Contents' in the headline.
3888 % It is abundantly clear what they are.
3889 \unnumbchapmacro{#1}\def\thischapter{}%
3890 \savepageno = \pageno
3891 \begingroup % Set up to handle contents files properly.
3892 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3893 % We can't do this, because then an actual ^ in a section
3894 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3895 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3896 \raggedbottom % Worry more about breakpoints than the bottom.
3897 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3899 % Roman numerals for page numbers.
3900 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3904 % Normal (long) toc.
3905 \def\contents{%
3906 \startcontents{\putwordTOC}%
3907 \openin 1 \jobname.toc
3908 \ifeof 1 \else
3909 \closein 1
3910 \input \jobname.toc
3912 \vfill \eject
3913 \contentsalignmacro % in case @setchapternewpage odd is in effect
3914 \pdfmakeoutlines
3915 \endgroup
3916 \lastnegativepageno = \pageno
3917 \pageno = \savepageno
3920 % And just the chapters.
3921 \def\summarycontents{%
3922 \startcontents{\putwordShortTOC}%
3924 \let\chapentry = \shortchapentry
3925 \let\unnumbchapentry = \shortunnumberedentry
3926 % We want a true roman here for the page numbers.
3927 \secfonts
3928 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3930 \hyphenpenalty = 10000
3931 \advance\baselineskip by 1pt % Open it up a little.
3932 \def\secentry ##1##2##3##4{}
3933 \def\unnumbsecentry ##1##2{}
3934 \def\subsecentry ##1##2##3##4##5{}
3935 \def\unnumbsubsecentry ##1##2{}
3936 \def\subsubsecentry ##1##2##3##4##5##6{}
3937 \def\unnumbsubsubsecentry ##1##2{}
3938 \openin 1 \jobname.toc
3939 \ifeof 1 \else
3940 \closein 1
3941 \input \jobname.toc
3943 \vfill \eject
3944 \contentsalignmacro % in case @setchapternewpage odd is in effect
3945 \endgroup
3946 \lastnegativepageno = \pageno
3947 \pageno = \savepageno
3949 \let\shortcontents = \summarycontents
3951 \ifpdf
3952 \pdfcatalog{/PageMode /UseOutlines}%
3955 % These macros generate individual entries in the table of contents.
3956 % The first argument is the chapter or section name.
3957 % The last argument is the page number.
3958 % The arguments in between are the chapter number, section number, ...
3960 % Chapter-level things, for both the long and short contents.
3961 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3963 % See comments in \dochapentry re vbox and related settings
3964 \def\shortchapentry#1#2#3{%
3965 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
3968 % Typeset the label for a chapter or appendix for the short contents.
3969 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3970 % We could simplify the code here by writing out an \appendixentry
3971 % command in the toc file for appendices, instead of using \chapentry
3972 % for both, but it doesn't seem worth it.
3974 \newdimen\shortappendixwidth
3976 \def\shortchaplabel#1{%
3977 % Compute width of word "Appendix", may change with language.
3978 \setbox0 = \hbox{\shortcontrm \putwordAppendix}%
3979 \shortappendixwidth = \wd0
3981 % We typeset #1 in a box of constant width, regardless of the text of
3982 % #1, so the chapter titles will come out aligned.
3983 \setbox0 = \hbox{#1}%
3984 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3986 % This space should be plenty, since a single number is .5em, and the
3987 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3988 % (This space doesn't include the extra space that gets added after
3989 % the label; that gets put in by \shortchapentry above.)
3990 \advance\dimen0 by 1.1em
3991 \hbox to \dimen0{#1\hfil}%
3994 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3995 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
3997 % Sections.
3998 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
3999 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
4001 % Subsections.
4002 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4003 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
4005 % And subsubsections.
4006 \def\subsubsecentry#1#2#3#4#5#6{%
4007 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4008 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
4010 % This parameter controls the indentation of the various levels.
4011 \newdimen\tocindent \tocindent = 3pc
4013 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4014 % page number.
4016 % If the toc has to be broken over pages, we want it to be at chapters
4017 % if at all possible; hence the \penalty.
4018 \def\dochapentry#1#2{%
4019 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4020 \begingroup
4021 \chapentryfonts
4022 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4023 \endgroup
4024 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4027 \def\dosecentry#1#2{\begingroup
4028 \secentryfonts \leftskip=\tocindent
4029 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4030 \endgroup}
4032 \def\dosubsecentry#1#2{\begingroup
4033 \subsecentryfonts \leftskip=2\tocindent
4034 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4035 \endgroup}
4037 \def\dosubsubsecentry#1#2{\begingroup
4038 \subsubsecentryfonts \leftskip=3\tocindent
4039 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4040 \endgroup}
4042 % Final typesetting of a toc entry; we use the same \entry macro as for
4043 % the index entries, but we want to suppress hyphenation here. (We
4044 % can't do that in the \entry macro, since index entries might consist
4045 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4046 \def\tocentry#1#2{\begingroup
4047 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4048 % Do not use \turnoffactive in these arguments. Since the toc is
4049 % typeset in cmr, so characters such as _ would come out wrong; we
4050 % have to do the usual translation tricks.
4051 \entry{#1}{#2}%
4052 \endgroup}
4054 % Space between chapter (or whatever) number and the title.
4055 \def\labelspace{\hskip1em \relax}
4057 \def\dopageno#1{{\rm #1}}
4058 \def\doshortpageno#1{{\rm #1}}
4060 \def\chapentryfonts{\secfonts \rm}
4061 \def\secentryfonts{\textfonts}
4062 \let\subsecentryfonts = \textfonts
4063 \let\subsubsecentryfonts = \textfonts
4066 \message{environments,}
4067 % @foo ... @end foo.
4069 % Since these characters are used in examples, it should be an even number of
4070 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4071 % Furthermore, these definitions must come after we define our fonts.
4072 \newbox\dblarrowbox \newbox\longdblarrowbox
4073 \newbox\pushcharbox \newbox\bullbox
4074 \newbox\equivbox \newbox\errorbox
4076 %{\tentt
4077 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
4078 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
4079 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
4080 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
4081 % Adapted from the manmac format (p.420 of TeXbook)
4082 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
4083 % depth .1ex\hfil}
4086 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4087 \def\point{$\star$}
4088 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4089 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4090 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4091 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4093 % Adapted from the TeXbook's \boxit.
4094 {\tentt \global\dimen0 = 3em}% Width of the box.
4095 \dimen2 = .55pt % Thickness of rules
4096 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4097 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4099 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4100 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4101 \advance\hsize by -2\dimen2 % Rules.
4102 \vbox{
4103 \hrule height\dimen2
4104 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4105 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4106 \kern3pt\vrule width\dimen2}% Space to right.
4107 \hrule height\dimen2}
4108 \hfil}
4110 % The @error{} command.
4111 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4113 % @tex ... @end tex escapes into raw Tex temporarily.
4114 % One exception: @ is still an escape character, so that @end tex works.
4115 % But \@ or @@ will get a plain tex @ character.
4117 \def\tex{\begingroup
4118 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4119 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4120 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4121 \catcode `\%=14
4122 \catcode 43=12 % plus
4123 \catcode`\"=12
4124 \catcode`\==12
4125 \catcode`\|=12
4126 \catcode`\<=12
4127 \catcode`\>=12
4128 \escapechar=`\\
4130 \let\b=\ptexb
4131 \let\bullet=\ptexbullet
4132 \let\c=\ptexc
4133 \let\,=\ptexcomma
4134 \let\.=\ptexdot
4135 \let\dots=\ptexdots
4136 \let\equiv=\ptexequiv
4137 \let\!=\ptexexclam
4138 \let\i=\ptexi
4139 \let\{=\ptexlbrace
4140 \let\+=\tabalign
4141 \let\}=\ptexrbrace
4142 \let\*=\ptexstar
4143 \let\t=\ptext
4145 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4146 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4147 \def\@{@}%
4148 \let\Etex=\endgroup}
4150 % Define @lisp ... @endlisp.
4151 % @lisp does a \begingroup so it can rebind things,
4152 % including the definition of @endlisp (which normally is erroneous).
4154 % Amount to narrow the margins by for @lisp.
4155 \newskip\lispnarrowing \lispnarrowing=0.4in
4157 % This is the definition that ^^M gets inside @lisp, @example, and other
4158 % such environments. \null is better than a space, since it doesn't
4159 % have any width.
4160 \def\lisppar{\null\endgraf}
4162 % Make each space character in the input produce a normal interword
4163 % space in the output. Don't allow a line break at this space, as this
4164 % is used only in environments like @example, where each line of input
4165 % should produce a line of output anyway.
4167 {\obeyspaces %
4168 \gdef\sepspaces{\obeyspaces\let =\tie}}
4170 % Define \obeyedspace to be our active space, whatever it is. This is
4171 % for use in \parsearg.
4172 {\sepspaces%
4173 \global\let\obeyedspace= }
4175 % This space is always present above and below environments.
4176 \newskip\envskipamount \envskipamount = 0pt
4178 % Make spacing and below environment symmetrical. We use \parskip here
4179 % to help in doing that, since in @example-like environments \parskip
4180 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4181 % start of the next paragraph will insert \parskip
4183 \def\aboveenvbreak{{%
4184 \ifnum\lastpenalty < 10000
4185 \advance\envskipamount by \parskip
4186 \endgraf
4187 \ifdim\lastskip<\envskipamount
4188 \removelastskip
4189 \penalty-50
4190 \vskip\envskipamount
4195 \let\afterenvbreak = \aboveenvbreak
4197 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4198 \let\nonarrowing=\relax
4200 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4201 % environment contents.
4202 \font\circle=lcircle10
4203 \newdimen\circthick
4204 \newdimen\cartouter\newdimen\cartinner
4205 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4206 \circthick=\fontdimen8\circle
4208 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4209 \def\ctr{{\hskip 6pt\circle\char'010}}
4210 \def\cbl{{\circle\char'012\hskip -6pt}}
4211 \def\cbr{{\hskip 6pt\circle\char'011}}
4212 \def\carttop{\hbox to \cartouter{\hskip\lskip
4213 \ctl\leaders\hrule height\circthick\hfil\ctr
4214 \hskip\rskip}}
4215 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4216 \cbl\leaders\hrule height\circthick\hfil\cbr
4217 \hskip\rskip}}
4219 \newskip\lskip\newskip\rskip
4221 \long\def\cartouche{%
4222 \begingroup
4223 \lskip=\leftskip \rskip=\rightskip
4224 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4225 \cartinner=\hsize \advance\cartinner by-\lskip
4226 \advance\cartinner by-\rskip
4227 \cartouter=\hsize
4228 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4229 % side, and for 6pt waste from
4230 % each corner char, and rule thickness
4231 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4232 % Flag to tell @lisp, etc., not to narrow margin.
4233 \let\nonarrowing=\comment
4234 \vbox\bgroup
4235 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4236 \carttop
4237 \hbox\bgroup
4238 \hskip\lskip
4239 \vrule\kern3pt
4240 \vbox\bgroup
4241 \hsize=\cartinner
4242 \kern3pt
4243 \begingroup
4244 \baselineskip=\normbskip
4245 \lineskip=\normlskip
4246 \parskip=\normpskip
4247 \vskip -\parskip
4248 \def\Ecartouche{%
4249 \endgroup
4250 \kern3pt
4251 \egroup
4252 \kern3pt\vrule
4253 \hskip\rskip
4254 \egroup
4255 \cartbot
4256 \egroup
4257 \endgroup
4261 % This macro is called at the beginning of all the @example variants,
4262 % inside a group.
4263 \def\nonfillstart{%
4264 \aboveenvbreak
4265 \inENV % This group ends at the end of the body
4266 \hfuzz = 12pt % Don't be fussy
4267 \sepspaces % Make spaces be word-separators rather than space tokens.
4268 \singlespace
4269 \let\par = \lisppar % don't ignore blank lines
4270 \obeylines % each line of input is a line of output
4271 \parskip = 0pt
4272 \parindent = 0pt
4273 \emergencystretch = 0pt % don't try to avoid overfull boxes
4274 % @cartouche defines \nonarrowing to inhibit narrowing
4275 % at next level down.
4276 \ifx\nonarrowing\relax
4277 \advance \leftskip by \lispnarrowing
4278 \exdentamount=\lispnarrowing
4279 \let\exdent=\nofillexdent
4280 \let\nonarrowing=\relax
4284 % Define the \E... control sequence only if we are inside the particular
4285 % environment, so the error checking in \end will work.
4287 % To end an @example-like environment, we first end the paragraph (via
4288 % \afterenvbreak's vertical glue), and then the group. That way we keep
4289 % the zero \parskip that the environments set -- \parskip glue will be
4290 % inserted at the beginning of the next paragraph in the document, after
4291 % the environment.
4293 \def\nonfillfinish{\afterenvbreak\endgroup}
4295 % @lisp: indented, narrowed, typewriter font.
4296 \def\lisp{\begingroup
4297 \nonfillstart
4298 \let\Elisp = \nonfillfinish
4300 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4301 \gobble % eat return
4304 % @example: Same as @lisp.
4305 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4307 % @small... is usually equivalent to the non-small (@smallbook
4308 % redefines). We must call \example (or whatever) last in the
4309 % definition, since it reads the return following the @example (or
4310 % whatever) command.
4312 % This actually allows (for example) @end display inside an
4313 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4315 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4316 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4317 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4318 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4320 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4321 % Originally contributed by Pavel@xerox.
4322 \def\smalllispx{\begingroup
4323 \def\Esmalllisp{\nonfillfinish\endgroup}%
4324 \def\Esmallexample{\nonfillfinish\endgroup}%
4325 \smallexamplefonts
4326 \lisp
4329 % @display: same as @lisp except keep current font.
4331 \def\display{\begingroup
4332 \nonfillstart
4333 \let\Edisplay = \nonfillfinish
4334 \gobble
4337 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4339 \def\smalldisplayx{\begingroup
4340 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4341 \smallexamplefonts \rm
4342 \display
4345 % @format: same as @display except don't narrow margins.
4347 \def\format{\begingroup
4348 \let\nonarrowing = t
4349 \nonfillstart
4350 \let\Eformat = \nonfillfinish
4351 \gobble
4354 % @smallformat (when @smallbook): @format plus smaller fonts.
4356 \def\smallformatx{\begingroup
4357 \def\Esmallformat{\nonfillfinish\endgroup}%
4358 \smallexamplefonts \rm
4359 \format
4362 % @flushleft (same as @format).
4364 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4366 % @flushright.
4368 \def\flushright{\begingroup
4369 \let\nonarrowing = t
4370 \nonfillstart
4371 \let\Eflushright = \nonfillfinish
4372 \advance\leftskip by 0pt plus 1fill
4373 \gobble
4377 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4378 % and narrows the margins.
4380 \def\quotation{%
4381 \begingroup\inENV %This group ends at the end of the @quotation body
4382 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4383 \singlespace
4384 \parindent=0pt
4385 % We have retained a nonzero parskip for the environment, since we're
4386 % doing normal filling. So to avoid extra space below the environment...
4387 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4389 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4390 \ifx\nonarrowing\relax
4391 \advance\leftskip by \lispnarrowing
4392 \advance\rightskip by \lispnarrowing
4393 \exdentamount = \lispnarrowing
4394 \let\nonarrowing = \relax
4399 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4400 % If we want to allow any <char> as delimiter,
4401 % we need the curly braces so that makeinfo sees the @verb command, eg:
4402 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4404 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4406 % [Knuth] p. 344; only we need to do '@' too
4407 \def\dospecials{%
4408 \do\ \do\\\do\@\do\{\do\}\do\$\do\&%
4409 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~}
4411 % [Knuth] p. 380
4412 \def\uncatcodespecials{%
4413 \def\do##1{\catcode`##1=12}\dospecials}
4415 % [Knuth] pp. 380,381,391
4416 % Disable Spanish ligatures ?` and !` of \tt font
4417 \begingroup
4418 \catcode`\`=\active\gdef`{\relax\lq}
4419 \endgroup
4421 % Setup for the @verb command.
4423 % Eight spaces for a tab
4424 \begingroup
4425 \catcode`\^^I=\active
4426 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4427 \endgroup
4429 \def\setupverb{%
4430 \tt % easiest (and conventionally used) font for verbatim
4431 \def\par{\leavevmode\endgraf}%
4432 \catcode`\`=\active
4433 \tabeightspaces
4434 % Respect line breaks,
4435 % print special symbols as themselves, and
4436 % make each space count
4437 % must do in this order:
4438 \obeylines \uncatcodespecials \sepspaces
4441 % Setup for the @verbatim environment
4443 % Real tab expansion
4444 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4446 \def\starttabbox{\setbox0=\hbox\bgroup}
4447 \begingroup
4448 \catcode`\^^I=\active
4449 \gdef\tabexpand{%
4450 \catcode`\^^I=\active
4451 \def^^I{\leavevmode\egroup
4452 \dimen0=\wd0 % the width so far, or since the previous tab
4453 \divide\dimen0 by\tabw
4454 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4455 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4456 \wd0=\dimen0 \box0 \starttabbox
4459 \endgroup
4460 \def\setupverbatim{%
4461 % Easiest (and conventionally used) font for verbatim
4463 \def\par{\leavevmode\egroup\box0\endgraf}%
4464 \catcode`\`=\active
4465 \tabexpand
4466 % Respect line breaks,
4467 % print special symbols as themselves, and
4468 % make each space count
4469 % must do in this order:
4470 \obeylines \uncatcodespecials \sepspaces
4471 \everypar{\starttabbox}%
4474 % Do the @verb magic: verbatim text is quoted by unique
4475 % delimiter characters. Before first delimiter expect a
4476 % right brace, after last delimiter expect closing brace:
4478 % \def\doverb'{'<char>#1<char>'}'{#1}
4480 % [Knuth] p. 382; only eat outer {}
4481 \begingroup
4482 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4483 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4484 \endgroup
4486 \def\verb{\begingroup\setupverb\doverb}
4489 % Do the @verbatim magic: define the macro \doverbatim so that
4490 % the (first) argument ends when '@end verbatim' is reached, ie:
4492 % \def\doverbatim#1@end verbatim{#1}
4494 % For Texinfo it's a lot easier than for LaTeX,
4495 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4496 % we need not redefine '\', '{' and '}'
4498 % Inspired by LaTeX's verbatim command set [latex.ltx]
4499 %% Include LaTeX hack for completeness -- never know
4500 %% \begingroup
4501 %% \catcode`|=0 \catcode`[=1
4502 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4503 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4504 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4505 %% |endgroup
4506 \begingroup
4507 \catcode`\ =\active
4508 \gdef\doverbatim#1@end verbatim{#1\end{verbatim}}
4509 \endgroup
4511 \def\verbatim{%
4512 \def\Everbatim{\nonfillfinish\endgroup}%
4513 \begingroup
4514 \nonfillstart
4515 \advance\leftskip by -\defbodyindent
4516 \begingroup\setupverbatim\doverbatim
4519 % @verbatiminclude FILE - insert text of file in verbatim environment.
4521 % Allow normal characters that we make active in the argument (a file name).
4522 \def\verbatiminclude{%
4523 \begingroup
4524 \catcode`\\=12
4525 \catcode`~=12
4526 \catcode`^=12
4527 \catcode`_=12
4528 \catcode`|=12
4529 \catcode`<=12
4530 \catcode`>=12
4531 \catcode`+=12
4532 \parsearg\doverbatiminclude
4534 \def\setupverbatiminclude{%
4535 \begingroup
4536 \nonfillstart
4537 \advance\leftskip by -\defbodyindent
4538 \begingroup\setupverbatim
4541 \def\doverbatiminclude#1{%
4542 % Restore active chars for included file.
4543 \endgroup
4544 \begingroup
4545 \def\thisfile{#1}%
4546 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4547 \endgroup\nonfillfinish\endgroup
4551 \message{defuns,}
4552 % @defun etc.
4554 % Allow user to change definition object font (\df) internally
4555 \def\setdeffont #1 {\csname DEF#1\endcsname}
4557 \newskip\defbodyindent \defbodyindent=.4in
4558 \newskip\defargsindent \defargsindent=50pt
4559 \newskip\deftypemargin \deftypemargin=12pt
4560 \newskip\deflastargmargin \deflastargmargin=18pt
4562 \newcount\parencount
4563 % define \functionparens, which makes ( and ) and & do special things.
4564 % \functionparens affects the group it is contained in.
4565 \def\activeparens{%
4566 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4567 \catcode`\[=\active \catcode`\]=\active}
4569 % Make control sequences which act like normal parenthesis chars.
4570 \let\lparen = ( \let\rparen = )
4572 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4574 % Be sure that we always have a definition for `(', etc. For example,
4575 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4576 % so TeX would otherwise complain about undefined control sequence.
4577 \global\let(=\lparen \global\let)=\rparen
4578 \global\let[=\lbrack \global\let]=\rbrack
4580 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4581 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4582 % This is used to turn on special parens
4583 % but make & act ordinary (given that it's active).
4584 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4586 % Definitions of (, ) and & used in args for functions.
4587 % This is the definition of ( outside of all parentheses.
4588 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4589 \global\advance\parencount by 1
4592 % This is the definition of ( when already inside a level of parens.
4593 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4595 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4596 % also in that case restore the outer-level definition of (.
4597 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4598 \global\advance \parencount by -1 }
4599 % If we encounter &foo, then turn on ()-hacking afterwards
4600 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
4602 \gdef\normalparens{\boldbrax\let&=\ampnr}
4603 } % End of definition inside \activeparens
4604 %% These parens (in \boldbrax) actually are a little bolder than the
4605 %% contained text. This is especially needed for [ and ]
4606 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4607 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4608 \let\ampnr = \&
4609 \def\lbrb{{\bf\char`\[}}
4610 \def\rbrb{{\bf\char`\]}}
4612 % Active &'s sneak into the index arguments, so make sure it's defined.
4614 \catcode`& = 13
4615 \global\let& = \ampnr
4618 % First, defname, which formats the header line itself.
4619 % #1 should be the function name.
4620 % #2 should be the type of definition, such as "Function".
4622 \def\defname #1#2{%
4623 % Get the values of \leftskip and \rightskip as they were
4624 % outside the @def...
4625 \dimen2=\leftskip
4626 \advance\dimen2 by -\defbodyindent
4627 \noindent
4628 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4629 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4630 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4631 \parshape 2 0in \dimen0 \defargsindent \dimen1
4632 % Now output arg 2 ("Function" or some such)
4633 % ending at \deftypemargin from the right margin,
4634 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4635 {% Adjust \hsize to exclude the ambient margins,
4636 % so that \rightline will obey them.
4637 \advance \hsize by -\dimen2
4638 \rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4639 % Make all lines underfull and no complaints:
4640 \tolerance=10000 \hbadness=10000
4641 \advance\leftskip by -\defbodyindent
4642 \exdentamount=\defbodyindent
4643 {\df #1}\enskip % Generate function name
4646 % Actually process the body of a definition
4647 % #1 should be the terminating control sequence, such as \Edefun.
4648 % #2 should be the "another name" control sequence, such as \defunx.
4649 % #3 should be the control sequence that actually processes the header,
4650 % such as \defunheader.
4652 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4653 \medbreak %
4654 % Define the end token that this defining construct specifies
4655 % so that it will exit this group.
4656 \def#1{\endgraf\endgroup\medbreak}%
4657 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4658 \parindent=0in
4659 \advance\leftskip by \defbodyindent
4660 \exdentamount=\defbodyindent
4661 \begingroup %
4662 \catcode 61=\active % 61 is `='
4663 \obeylines\activeparens\spacesplit#3}
4665 % #1 is the \E... control sequence to end the definition (which we define).
4666 % #2 is the \...x control sequence for consecutive fns (which we define).
4667 % #3 is the control sequence to call to resume processing.
4668 % #4, delimited by the space, is the class name.
4670 \def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4671 \medbreak %
4672 % Define the end token that this defining construct specifies
4673 % so that it will exit this group.
4674 \def#1{\endgraf\endgroup\medbreak}%
4675 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4676 \parindent=0in
4677 \advance\leftskip by \defbodyindent
4678 \exdentamount=\defbodyindent
4679 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4681 % Used for @deftypemethod and @deftypeivar.
4682 % #1 is the \E... control sequence to end the definition (which we define).
4683 % #2 is the \...x control sequence for consecutive fns (which we define).
4684 % #3 is the control sequence to call to resume processing.
4685 % #4, delimited by a space, is the class name.
4686 % #5 is the method's return type.
4688 \def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4689 \medbreak
4690 \def#1{\endgraf\endgroup\medbreak}%
4691 \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4692 \parindent=0in
4693 \advance\leftskip by \defbodyindent
4694 \exdentamount=\defbodyindent
4695 \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4697 % Used for @deftypeop. The change from \deftypemethparsebody is an
4698 % extra argument at the beginning which is the `category', instead of it
4699 % being the hardwired string `Method' or `Instance Variable'. We have
4700 % to account for this both in the \...x definition and in parsing the
4701 % input at hand. Thus also need a control sequence (passed as #5) for
4702 % the \E... definition to assign the category name to.
4704 \def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4705 \medbreak
4706 \def#1{\endgraf\endgroup\medbreak}%
4707 \def#2##1 ##2 ##3 {%
4708 \def#4{##1}%
4709 \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4710 \parindent=0in
4711 \advance\leftskip by \defbodyindent
4712 \exdentamount=\defbodyindent
4713 \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4715 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4716 \medbreak %
4717 % Define the end token that this defining construct specifies
4718 % so that it will exit this group.
4719 \def#1{\endgraf\endgroup\medbreak}%
4720 \def#2##1 ##2 {\def#4{##1}%
4721 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4722 \parindent=0in
4723 \advance\leftskip by \defbodyindent
4724 \exdentamount=\defbodyindent
4725 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4727 % These parsing functions are similar to the preceding ones
4728 % except that they do not make parens into active characters.
4729 % These are used for "variables" since they have no arguments.
4731 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4732 \medbreak %
4733 % Define the end token that this defining construct specifies
4734 % so that it will exit this group.
4735 \def#1{\endgraf\endgroup\medbreak}%
4736 \def#2{\begingroup\obeylines\spacesplit#3}%
4737 \parindent=0in
4738 \advance\leftskip by \defbodyindent
4739 \exdentamount=\defbodyindent
4740 \begingroup %
4741 \catcode 61=\active %
4742 \obeylines\spacesplit#3}
4744 % This is used for \def{tp,vr}parsebody. It could probably be used for
4745 % some of the others, too, with some judicious conditionals.
4747 \def\parsebodycommon#1#2#3{%
4748 \begingroup\inENV %
4749 \medbreak %
4750 % Define the end token that this defining construct specifies
4751 % so that it will exit this group.
4752 \def#1{\endgraf\endgroup\medbreak}%
4753 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4754 \parindent=0in
4755 \advance\leftskip by \defbodyindent
4756 \exdentamount=\defbodyindent
4757 \begingroup\obeylines
4760 \def\defvrparsebody#1#2#3#4 {%
4761 \parsebodycommon{#1}{#2}{#3}%
4762 \spacesplit{#3{#4}}%
4765 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4766 % type is just `struct', because we lose the braces in `{struct
4767 % termios}' when \spacesplit reads its undelimited argument. Sigh.
4768 % \let\deftpparsebody=\defvrparsebody
4770 % So, to get around this, we put \empty in with the type name. That
4771 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4772 % won't strip off the braces.
4774 \def\deftpparsebody #1#2#3#4 {%
4775 \parsebodycommon{#1}{#2}{#3}%
4776 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4779 % Fine, but then we have to eventually remove the \empty *and* the
4780 % braces (if any). That's what this does.
4782 \def\removeemptybraces\empty#1\relax{#1}
4784 % After \spacesplit has done its work, this is called -- #1 is the final
4785 % thing to call, #2 the type name (which starts with \empty), and #3
4786 % (which might be empty) the arguments.
4788 \def\parsetpheaderline#1#2#3{%
4789 #1{\removeemptybraces#2\relax}{#3}%
4792 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4793 \medbreak %
4794 % Define the end token that this defining construct specifies
4795 % so that it will exit this group.
4796 \def#1{\endgraf\endgroup\medbreak}%
4797 \def#2##1 ##2 {\def#4{##1}%
4798 \begingroup\obeylines\spacesplit{#3{##2}}}%
4799 \parindent=0in
4800 \advance\leftskip by \defbodyindent
4801 \exdentamount=\defbodyindent
4802 \begingroup\obeylines\spacesplit{#3{#5}}}
4804 % Split up #2 at the first space token.
4805 % call #1 with two arguments:
4806 % the first is all of #2 before the space token,
4807 % the second is all of #2 after that space token.
4808 % If #2 contains no space token, all of it is passed as the first arg
4809 % and the second is passed as empty.
4811 {\obeylines
4812 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4813 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4814 \ifx\relax #3%
4815 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4817 % So much for the things common to all kinds of definitions.
4819 % Define @defun.
4821 % First, define the processing that is wanted for arguments of \defun
4822 % Use this to expand the args and terminate the paragraph they make up
4824 \def\defunargs#1{\functionparens \sl
4825 % Expand, preventing hyphenation at `-' chars.
4826 % Note that groups don't affect changes in \hyphenchar.
4827 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4828 {\tensl\hyphenchar\font=0}%
4830 {\tensl\hyphenchar\font=45}%
4831 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4832 \interlinepenalty=10000
4833 \advance\rightskip by 0pt plus 1fil
4834 \endgraf\nobreak\vskip -\parskip\nobreak
4837 \def\deftypefunargs #1{%
4838 % Expand, preventing hyphenation at `-' chars.
4839 % Note that groups don't affect changes in \hyphenchar.
4840 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4841 \boldbraxnoamp
4842 \tclose{#1}% avoid \code because of side effects on active chars
4843 \interlinepenalty=10000
4844 \advance\rightskip by 0pt plus 1fil
4845 \endgraf\nobreak\vskip -\parskip\nobreak
4848 % Do complete processing of one @defun or @defunx line already parsed.
4850 % @deffn Command forward-char nchars
4852 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4854 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4855 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4856 \catcode 61=\other % Turn off change made in \defparsebody
4859 % @defun == @deffn Function
4861 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4863 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4864 \begingroup\defname {#1}{\putwordDeffunc}%
4865 \defunargs {#2}\endgroup %
4866 \catcode 61=\other % Turn off change made in \defparsebody
4869 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4871 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4873 % #1 is the data type. #2 is the name and args.
4874 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4875 % #1 is the data type, #2 the name, #3 the args.
4876 \def\deftypefunheaderx #1#2 #3\relax{%
4877 \doind {fn}{\code{#2}}% Make entry in function index
4878 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}%
4879 \deftypefunargs {#3}\endgroup %
4880 \catcode 61=\other % Turn off change made in \defparsebody
4883 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4885 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4887 % \defheaderxcond#1\relax$$$
4888 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4889 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4891 % #1 is the classification. #2 is the data type. #3 is the name and args.
4892 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4893 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4894 \def\deftypefnheaderx #1#2#3 #4\relax{%
4895 \doind {fn}{\code{#3}}% Make entry in function index
4896 \begingroup
4897 \normalparens % notably, turn off `&' magic, which prevents
4898 % at least some C++ text from working
4899 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
4900 \deftypefunargs {#4}\endgroup %
4901 \catcode 61=\other % Turn off change made in \defparsebody
4904 % @defmac == @deffn Macro
4906 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4908 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4909 \begingroup\defname {#1}{\putwordDefmac}%
4910 \defunargs {#2}\endgroup %
4911 \catcode 61=\other % Turn off change made in \defparsebody
4914 % @defspec == @deffn Special Form
4916 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4918 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4919 \begingroup\defname {#1}{\putwordDefspec}%
4920 \defunargs {#2}\endgroup %
4921 \catcode 61=\other % Turn off change made in \defparsebody
4924 % @defop CATEGORY CLASS OPERATION ARG...
4926 \def\defop #1 {\def\defoptype{#1}%
4927 \defopparsebody\Edefop\defopx\defopheader\defoptype}
4929 \def\defopheader#1#2#3{%
4930 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4931 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4932 \defunargs {#3}\endgroup %
4935 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4937 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
4938 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
4939 \deftypeopcategory}
4941 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4942 \def\deftypeopheader#1#2#3#4{%
4943 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4944 \begingroup
4945 \defname{\defheaderxcond#2\relax$$$#3}
4946 {\deftypeopcategory\ \putwordon\ \code{#1}}%
4947 \deftypefunargs{#4}%
4948 \endgroup
4951 % @deftypemethod CLASS TYPE METHOD ARG...
4953 \def\deftypemethod{%
4954 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4956 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4957 \def\deftypemethodheader#1#2#3#4{%
4958 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4959 \begingroup
4960 \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}%
4961 \deftypefunargs{#4}%
4962 \endgroup
4965 % @deftypeivar CLASS TYPE VARNAME
4967 \def\deftypeivar{%
4968 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
4970 % #1 is the class name, #2 the data type, #3 the variable name.
4971 \def\deftypeivarheader#1#2#3{%
4972 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
4973 \begingroup
4974 \defname{\defheaderxcond#2\relax$$$#3}
4975 {\putwordInstanceVariableof\ \code{#1}}%
4976 \defvarargs{#3}%
4977 \endgroup
4980 % @defmethod == @defop Method
4982 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
4984 % #1 is the class name, #2 the method name, #3 the args.
4985 \def\defmethodheader#1#2#3{%
4986 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
4987 \begingroup
4988 \defname{#2}{\putwordMethodon\ \code{#1}}%
4989 \defunargs{#3}%
4990 \endgroup
4993 % @defcv {Class Option} foo-class foo-flag
4995 \def\defcv #1 {\def\defcvtype{#1}%
4996 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
4998 \def\defcvarheader #1#2#3{%
4999 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5000 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5001 \defvarargs {#3}\endgroup %
5004 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5006 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5008 \def\defivarheader#1#2#3{%
5009 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5010 \begingroup
5011 \defname{#2}{\putwordInstanceVariableof\ #1}%
5012 \defvarargs{#3}%
5013 \endgroup
5016 % @defvar
5017 % First, define the processing that is wanted for arguments of @defvar.
5018 % This is actually simple: just print them in roman.
5019 % This must expand the args and terminate the paragraph they make up
5020 \def\defvarargs #1{\normalparens #1%
5021 \interlinepenalty=10000
5022 \endgraf\nobreak\vskip -\parskip\nobreak}
5024 % @defvr Counter foo-count
5026 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5028 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5029 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5031 % @defvar == @defvr Variable
5033 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5035 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5036 \begingroup\defname {#1}{\putwordDefvar}%
5037 \defvarargs {#2}\endgroup %
5040 % @defopt == @defvr {User Option}
5042 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5044 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5045 \begingroup\defname {#1}{\putwordDefopt}%
5046 \defvarargs {#2}\endgroup %
5049 % @deftypevar int foobar
5051 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5053 % #1 is the data type. #2 is the name, perhaps followed by text that
5054 % is actually part of the data type, which should not be put into the index.
5055 \def\deftypevarheader #1#2{%
5056 \dovarind#2 \relax% Make entry in variables index
5057 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}%
5058 \interlinepenalty=10000
5059 \endgraf\nobreak\vskip -\parskip\nobreak
5060 \endgroup}
5061 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5063 % @deftypevr {Global Flag} int enable
5065 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5067 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5068 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
5069 \interlinepenalty=10000
5070 \endgraf\nobreak\vskip -\parskip\nobreak
5071 \endgroup}
5073 % Now define @deftp
5074 % Args are printed in bold, a slight difference from @defvar.
5076 \def\deftpargs #1{\bf \defvarargs{#1}}
5078 % @deftp Class window height width ...
5080 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5082 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5083 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5085 % These definitions are used if you use @defunx (etc.)
5086 % anywhere other than immediately after a @defun or @defunx.
5088 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5089 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5090 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5091 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5092 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5093 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5094 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5095 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5096 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5097 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5098 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5099 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5100 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5101 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5102 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5103 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5104 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5105 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5106 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5109 \message{macros,}
5110 % @macro.
5112 % To do this right we need a feature of e-TeX, \scantokens,
5113 % which we arrange to emulate with a temporary file in ordinary TeX.
5114 \ifx\eTeXversion\undefined
5115 \newwrite\macscribble
5116 \def\scanmacro#1{%
5117 \begingroup \newlinechar`\^^M
5118 % Undo catcode changes of \startcontents and \doprintindex
5119 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5120 % Append \endinput to make sure that TeX does not see the ending newline.
5121 \toks0={#1\endinput}%
5122 \immediate\openout\macscribble=\jobname.tmp
5123 \immediate\write\macscribble{\the\toks0}%
5124 \immediate\closeout\macscribble
5125 \let\xeatspaces\eatspaces
5126 \input \jobname.tmp
5127 \endgroup
5129 \else
5130 \def\scanmacro#1{%
5131 \begingroup \newlinechar`\^^M
5132 % Undo catcode changes of \startcontents and \doprintindex
5133 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5134 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5137 \newcount\paramno % Count of parameters
5138 \newtoks\macname % Macro name
5139 \newif\ifrecursive % Is it recursive?
5140 \def\macrolist{} % List of all defined macros in the form
5141 % \do\macro1\do\macro2...
5143 % Utility routines.
5144 % Thisdoes \let #1 = #2, except with \csnames.
5145 \def\cslet#1#2{%
5146 \expandafter\expandafter
5147 \expandafter\let
5148 \expandafter\expandafter
5149 \csname#1\endcsname
5150 \csname#2\endcsname}
5152 % Trim leading and trailing spaces off a string.
5153 % Concepts from aro-bend problem 15 (see CTAN).
5154 {\catcode`\@=11
5155 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5156 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5157 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5158 \def\unbrace#1{#1}
5159 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5162 % Trim a single trailing ^^M off a string.
5163 {\catcode`\^^M=12\catcode`\Q=3%
5164 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5165 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5166 \gdef\eatcrb#1Q#2Q{#1}%
5169 % Macro bodies are absorbed as an argument in a context where
5170 % all characters are catcode 10, 11 or 12, except \ which is active
5171 % (as in normal texinfo). It is necessary to change the definition of \.
5173 % It's necessary to have hard CRs when the macro is executed. This is
5174 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5175 % body, and then making it the \newlinechar in \scanmacro.
5177 \def\macrobodyctxt{%
5178 \catcode`\~=12
5179 \catcode`\^=12
5180 \catcode`\_=12
5181 \catcode`\|=12
5182 \catcode`\<=12
5183 \catcode`\>=12
5184 \catcode`\+=12
5185 \catcode`\{=12
5186 \catcode`\}=12
5187 \catcode`\@=12
5188 \catcode`\^^M=12
5189 \usembodybackslash}
5191 \def\macroargctxt{%
5192 \catcode`\~=12
5193 \catcode`\^=12
5194 \catcode`\_=12
5195 \catcode`\|=12
5196 \catcode`\<=12
5197 \catcode`\>=12
5198 \catcode`\+=12
5199 \catcode`\@=12
5200 \catcode`\\=12}
5202 % \mbodybackslash is the definition of \ in @macro bodies.
5203 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5204 % where N is the macro parameter number.
5205 % We define \csname macarg.\endcsname to be \realbackslash, so
5206 % \\ in macro replacement text gets you a backslash.
5208 {\catcode`@=0 @catcode`@\=@active
5209 @gdef@usembodybackslash{@let\=@mbodybackslash}
5210 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5212 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5214 \def\macro{\recursivefalse\parsearg\macroxxx}
5215 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5217 \def\macroxxx#1{%
5218 \getargs{#1}% now \macname is the macname and \argl the arglist
5219 \ifx\argl\empty % no arguments
5220 \paramno=0%
5221 \else
5222 \expandafter\parsemargdef \argl;%
5224 \if1\csname ismacro.\the\macname\endcsname
5225 \message{Warning: redefining \the\macname}%
5226 \else
5227 \expandafter\ifx\csname \the\macname\endcsname \relax
5228 \else \errmessage{The name \the\macname\space is reserved}\fi
5229 \global\cslet{macsave.\the\macname}{\the\macname}%
5230 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5231 % Add the macroname to \macrolist
5232 \toks0 = \expandafter{\macrolist\do}%
5233 \xdef\macrolist{\the\toks0
5234 \expandafter\noexpand\csname\the\macname\endcsname}%
5236 \begingroup \macrobodyctxt
5237 \ifrecursive \expandafter\parsermacbody
5238 \else \expandafter\parsemacbody
5239 \fi}
5241 \def\unmacro{\parsearg\unmacroxxx}
5242 \def\unmacroxxx#1{%
5243 \if1\csname ismacro.#1\endcsname
5244 \global\cslet{#1}{macsave.#1}%
5245 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5246 % Remove the macro name from \macrolist
5247 \begingroup
5248 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5249 \def\do##1{%
5250 \def\tempb{##1}%
5251 \ifx\tempa\tempb
5252 % remove this
5253 \else
5254 \toks0 = \expandafter{\newmacrolist\do}%
5255 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5256 \fi}%
5257 \def\newmacrolist{}%
5258 % Execute macro list to define \newmacrolist
5259 \macrolist
5260 \global\let\macrolist\newmacrolist
5261 \endgroup
5262 \else
5263 \errmessage{Macro #1 not defined}%
5267 % This makes use of the obscure feature that if the last token of a
5268 % <parameter list> is #, then the preceding argument is delimited by
5269 % an opening brace, and that opening brace is not consumed.
5270 \def\getargs#1{\getargsxxx#1{}}
5271 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5272 \def\getmacname #1 #2\relax{\macname={#1}}
5273 \def\getmacargs#1{\def\argl{#1}}
5275 % Parse the optional {params} list. Set up \paramno and \paramlist
5276 % so \defmacro knows what to do. Define \macarg.blah for each blah
5277 % in the params list, to be ##N where N is the position in that list.
5278 % That gets used by \mbodybackslash (above).
5280 % We need to get `macro parameter char #' into several definitions.
5281 % The technique used is stolen from LaTeX: let \hash be something
5282 % unexpandable, insert that wherever you need a #, and then redefine
5283 % it to # just before using the token list produced.
5285 % The same technique is used to protect \eatspaces till just before
5286 % the macro is used.
5288 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5289 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5290 \def\parsemargdefxxx#1,{%
5291 \if#1;\let\next=\relax
5292 \else \let\next=\parsemargdefxxx
5293 \advance\paramno by 1%
5294 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5295 {\xeatspaces{\hash\the\paramno}}%
5296 \edef\paramlist{\paramlist\hash\the\paramno,}%
5297 \fi\next}
5299 % These two commands read recursive and nonrecursive macro bodies.
5300 % (They're different since rec and nonrec macros end differently.)
5302 \long\def\parsemacbody#1@end macro%
5303 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5304 \long\def\parsermacbody#1@end rmacro%
5305 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5307 % This defines the macro itself. There are six cases: recursive and
5308 % nonrecursive macros of zero, one, and many arguments.
5309 % Much magic with \expandafter here.
5310 % \xdef is used so that macro definitions will survive the file
5311 % they're defined in; @include reads the file inside a group.
5312 \def\defmacro{%
5313 \let\hash=##% convert placeholders to macro parameter chars
5314 \ifrecursive
5315 \ifcase\paramno
5317 \expandafter\xdef\csname\the\macname\endcsname{%
5318 \noexpand\scanmacro{\temp}}%
5319 \or % 1
5320 \expandafter\xdef\csname\the\macname\endcsname{%
5321 \bgroup\noexpand\macroargctxt
5322 \noexpand\braceorline
5323 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5324 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5325 \egroup\noexpand\scanmacro{\temp}}%
5326 \else % many
5327 \expandafter\xdef\csname\the\macname\endcsname{%
5328 \bgroup\noexpand\macroargctxt
5329 \noexpand\csname\the\macname xx\endcsname}%
5330 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5331 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5332 \expandafter\expandafter
5333 \expandafter\xdef
5334 \expandafter\expandafter
5335 \csname\the\macname xxx\endcsname
5336 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5338 \else
5339 \ifcase\paramno
5341 \expandafter\xdef\csname\the\macname\endcsname{%
5342 \noexpand\norecurse{\the\macname}%
5343 \noexpand\scanmacro{\temp}\egroup}%
5344 \or % 1
5345 \expandafter\xdef\csname\the\macname\endcsname{%
5346 \bgroup\noexpand\macroargctxt
5347 \noexpand\braceorline
5348 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5349 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5350 \egroup
5351 \noexpand\norecurse{\the\macname}%
5352 \noexpand\scanmacro{\temp}\egroup}%
5353 \else % many
5354 \expandafter\xdef\csname\the\macname\endcsname{%
5355 \bgroup\noexpand\macroargctxt
5356 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5357 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5358 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5359 \expandafter\expandafter
5360 \expandafter\xdef
5361 \expandafter\expandafter
5362 \csname\the\macname xxx\endcsname
5363 \paramlist{%
5364 \egroup
5365 \noexpand\norecurse{\the\macname}%
5366 \noexpand\scanmacro{\temp}\egroup}%
5368 \fi}
5370 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5372 % \braceorline decides whether the next nonwhitespace character is a
5373 % {. If so it reads up to the closing }, if not, it reads the whole
5374 % line. Whatever was read is then fed to the next control sequence
5375 % as an argument (by \parsebrace or \parsearg)
5376 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5377 \def\braceorlinexxx{%
5378 \ifx\nchar\bgroup\else
5379 \expandafter\parsearg
5380 \fi \next}
5382 % We mant to disable all macros during \shipout so that they are not
5383 % expanded by \write.
5384 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5385 \edef\next{\macrolist}\expandafter\endgroup\next}
5388 % @alias.
5389 % We need some trickery to remove the optional spaces around the equal
5390 % sign. Just make them active and then expand them all to nothing.
5391 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5392 \def\aliasxxx #1{\aliasyyy#1\relax}
5393 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5394 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5395 \expandafter\noexpand\csname#2\endcsname}%
5396 \expandafter\endgroup\next}
5399 \message{cross references,}
5400 % @xref etc.
5402 \newwrite\auxfile
5404 \newif\ifhavexrefs % True if xref values are known.
5405 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5407 % @inforef is relatively simple.
5408 \def\inforef #1{\inforefzzz #1,,,,**}
5409 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5410 node \samp{\ignorespaces#1{}}}
5412 % @node's job is to define \lastnode.
5413 \def\node{\ENVcheck\parsearg\nodezzz}
5414 \def\nodezzz#1{\nodexxx [#1,]}
5415 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5416 \let\nwnode=\node
5417 \let\lastnode=\relax
5419 % The sectioning commands (@chapter, etc.) call these.
5420 \def\donoderef{%
5421 \ifx\lastnode\relax\else
5422 \expandafter\expandafter\expandafter\setref{\lastnode}%
5423 {Ysectionnumberandtype}%
5424 \global\let\lastnode=\relax
5427 \def\unnumbnoderef{%
5428 \ifx\lastnode\relax\else
5429 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5430 \global\let\lastnode=\relax
5433 \def\appendixnoderef{%
5434 \ifx\lastnode\relax\else
5435 \expandafter\expandafter\expandafter\setref{\lastnode}%
5436 {Yappendixletterandtype}%
5437 \global\let\lastnode=\relax
5442 % @anchor{NAME} -- define xref target at arbitrary point.
5444 \newcount\savesfregister
5445 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5446 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5447 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5449 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5450 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5451 % to set \indexdummies so commands such as @code in a section title
5452 % aren't expanded. It would be nicer not to expand the titles in the
5453 % first place, but there's so many layers that that is hard to do.
5455 \def\setref#1#2{{%
5456 \indexdummies
5457 \pdfmkdest{#1}%
5458 \dosetq{#1-title}{Ytitle}%
5459 \dosetq{#1-pg}{Ypagenumber}%
5460 \dosetq{#1-snt}{#2}%
5463 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5464 % the node name, #2 the name of the Info cross-reference, #3 the printed
5465 % node name, #4 the name of the Info file, #5 the name of the printed
5466 % manual. All but the node name can be omitted.
5468 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5469 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5470 \def\ref#1{\xrefX[#1,,,,,,,]}
5471 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5472 \unsepspaces
5473 \def\printedmanual{\ignorespaces #5}%
5474 \def\printednodename{\ignorespaces #3}%
5475 \setbox1=\hbox{\printedmanual}%
5476 \setbox0=\hbox{\printednodename}%
5477 \ifdim \wd0 = 0pt
5478 % No printed node name was explicitly given.
5479 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5480 % Use the node name inside the square brackets.
5481 \def\printednodename{\ignorespaces #1}%
5482 \else
5483 % Use the actual chapter/section title appear inside
5484 % the square brackets. Use the real section title if we have it.
5485 \ifdim \wd1 > 0pt
5486 % It is in another manual, so we don't have it.
5487 \def\printednodename{\ignorespaces #1}%
5488 \else
5489 \ifhavexrefs
5490 % We know the real title if we have the xref values.
5491 \def\printednodename{\refx{#1-title}{}}%
5492 \else
5493 % Otherwise just copy the Info node name.
5494 \def\printednodename{\ignorespaces #1}%
5495 \fi%
5500 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5501 % insert empty discretionaries after hyphens, which means that it will
5502 % not find a line break at a hyphen in a node names. Since some manuals
5503 % are best written with fairly long node names, containing hyphens, this
5504 % is a loss. Therefore, we give the text of the node name again, so it
5505 % is as if TeX is seeing it for the first time.
5506 \ifpdf
5507 \leavevmode
5508 \getfilename{#4}%
5509 \ifnum\filenamelength>0
5510 \startlink attr{/Border [0 0 0]}%
5511 goto file{\the\filename.pdf} name{#1@}%
5512 \else
5513 \startlink attr{/Border [0 0 0]}%
5514 goto name{#1@}%
5516 \linkcolor
5519 \ifdim \wd1 > 0pt
5520 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5521 \else
5522 % _ (for example) has to be the character _ for the purposes of the
5523 % control sequence corresponding to the node, but it has to expand
5524 % into the usual \leavevmode...\vrule stuff for purposes of
5525 % printing. So we \turnoffactive for the \refx-snt, back on for the
5526 % printing, back off for the \refx-pg.
5527 {\normalturnoffactive
5528 % Only output a following space if the -snt ref is nonempty; for
5529 % @unnumbered and @anchor, it won't be.
5530 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5531 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5533 % [mynode],
5534 [\printednodename],\space
5535 % page 3
5536 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5538 \endlink
5539 \endgroup}
5541 % \dosetq is the interface for calls from other macros
5543 % Use \normalturnoffactive so that punctuation chars such as underscore
5544 % and backslash work in node names. (\turnoffactive doesn't do \.)
5545 \def\dosetq#1#2{%
5546 {\let\folio=0%
5547 \normalturnoffactive
5548 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5549 \iflinks
5550 \next
5555 % \internalsetq {foo}{page} expands into
5556 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5557 % When the aux file is read, ' is the escape character
5559 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5561 % Things to be expanded by \internalsetq
5563 \def\Ypagenumber{\folio}
5565 \def\Ytitle{\thissection}
5567 \def\Ynothing{}
5569 \def\Ysectionnumberandtype{%
5570 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5571 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5572 \else \ifnum \subsubsecno=0 %
5573 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5574 \else %
5575 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5576 \fi \fi \fi }
5578 \def\Yappendixletterandtype{%
5579 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5580 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5581 \else \ifnum \subsubsecno=0 %
5582 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5583 \else %
5584 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5585 \fi \fi \fi }
5587 \gdef\xreftie{'tie}
5589 % Use TeX 3.0's \inputlineno to get the line number, for better error
5590 % messages, but if we're using an old version of TeX, don't do anything.
5592 \ifx\inputlineno\thisisundefined
5593 \let\linenumber = \empty % Non-3.0.
5594 \else
5595 \def\linenumber{\the\inputlineno:\space}
5598 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5599 % If its value is nonempty, SUFFIX is output afterward.
5601 \def\refx#1#2{%
5602 \expandafter\ifx\csname X#1\endcsname\relax
5603 % If not defined, say something at least.
5604 \angleleft un\-de\-fined\angleright
5605 \iflinks
5606 \ifhavexrefs
5607 \message{\linenumber Undefined cross reference `#1'.}%
5608 \else
5609 \ifwarnedxrefs\else
5610 \global\warnedxrefstrue
5611 \message{Cross reference values unknown; you must run TeX again.}%
5615 \else
5616 % It's defined, so just use it.
5617 \csname X#1\endcsname
5619 #2% Output the suffix in any case.
5622 % This is the macro invoked by entries in the aux file.
5624 \def\xrdef#1{\begingroup
5625 % Reenable \ as an escape while reading the second argument.
5626 \catcode`\\ = 0
5627 \afterassignment\endgroup
5628 \expandafter\gdef\csname X#1\endcsname
5631 % Read the last existing aux file, if any. No error if none exists.
5632 \def\readauxfile{\begingroup
5633 \catcode`\^^@=\other
5634 \catcode`\^^A=\other
5635 \catcode`\^^B=\other
5636 \catcode`\^^C=\other
5637 \catcode`\^^D=\other
5638 \catcode`\^^E=\other
5639 \catcode`\^^F=\other
5640 \catcode`\^^G=\other
5641 \catcode`\^^H=\other
5642 \catcode`\^^K=\other
5643 \catcode`\^^L=\other
5644 \catcode`\^^N=\other
5645 \catcode`\^^P=\other
5646 \catcode`\^^Q=\other
5647 \catcode`\^^R=\other
5648 \catcode`\^^S=\other
5649 \catcode`\^^T=\other
5650 \catcode`\^^U=\other
5651 \catcode`\^^V=\other
5652 \catcode`\^^W=\other
5653 \catcode`\^^X=\other
5654 \catcode`\^^Z=\other
5655 \catcode`\^^[=\other
5656 \catcode`\^^\=\other
5657 \catcode`\^^]=\other
5658 \catcode`\^^^=\other
5659 \catcode`\^^_=\other
5660 \catcode`\@=\other
5661 \catcode`\^=\other
5662 % It was suggested to define this as 7, which would allow ^^e4 etc.
5663 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5664 % supported in the main text, it doesn't seem desirable. Furthermore,
5665 % that is not enough: for node names that actually contain a ^
5666 % character, we would end up writing a line like this: 'xrdef {'hat
5667 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5668 % argument, and \hat is not an expandable control sequence. It could
5669 % all be worked out, but why? Either we support ^^ or we don't.
5671 % The other change necessary for this was to define \auxhat:
5672 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5673 % and then to call \auxhat in \setq.
5675 \catcode`\~=\other
5676 \catcode`\[=\other
5677 \catcode`\]=\other
5678 \catcode`\"=\other
5679 \catcode`\_=\other
5680 \catcode`\|=\other
5681 \catcode`\<=\other
5682 \catcode`\>=\other
5683 \catcode`\$=\other
5684 \catcode`\#=\other
5685 \catcode`\&=\other
5686 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5687 % Make the characters 128-255 be printing characters
5689 \count 1=128
5690 \def\loop{%
5691 \catcode\count 1=\other
5692 \advance\count 1 by 1
5693 \ifnum \count 1<256 \loop \fi
5696 % The aux file uses ' as the escape (for now).
5697 % Turn off \ as an escape so we do not lose on
5698 % entries which were dumped with control sequences in their names.
5699 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5700 % Reference to such entries still does not work the way one would wish,
5701 % but at least they do not bomb out when the aux file is read in.
5702 \catcode`\{=1
5703 \catcode`\}=2
5704 \catcode`\%=\other
5705 \catcode`\'=0
5706 \catcode`\\=\other
5708 \openin 1 \jobname.aux
5709 \ifeof 1 \else
5710 \closein 1
5711 \input \jobname.aux
5712 \global\havexrefstrue
5713 \global\warnedobstrue
5715 % Open the new aux file. TeX will close it automatically at exit.
5716 \openout\auxfile=\jobname.aux
5717 \endgroup}
5720 % Footnotes.
5722 \newcount \footnoteno
5724 % The trailing space in the following definition for supereject is
5725 % vital for proper filling; pages come out unaligned when you do a
5726 % pagealignmacro call if that space before the closing brace is
5727 % removed. (Generally, numeric constants should always be followed by a
5728 % space to prevent strange expansion errors.)
5729 \def\supereject{\par\penalty -20000\footnoteno =0 }
5731 % @footnotestyle is meaningful for info output only.
5732 \let\footnotestyle=\comment
5734 \let\ptexfootnote=\footnote
5736 {\catcode `\@=11
5738 % Auto-number footnotes. Otherwise like plain.
5739 \gdef\footnote{%
5740 \global\advance\footnoteno by \@ne
5741 \edef\thisfootno{$^{\the\footnoteno}$}%
5743 % In case the footnote comes at the end of a sentence, preserve the
5744 % extra spacing after we do the footnote number.
5745 \let\@sf\empty
5746 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5748 % Remove inadvertent blank space before typesetting the footnote number.
5749 \unskip
5750 \thisfootno\@sf
5751 \footnotezzz
5754 % Don't bother with the trickery in plain.tex to not require the
5755 % footnote text as a parameter. Our footnotes don't need to be so general.
5757 % Oh yes, they do; otherwise, @ifset and anything else that uses
5758 % \parseargline fail inside footnotes because the tokens are fixed when
5759 % the footnote is read. --karl, 16nov96.
5761 \long\gdef\footnotezzz{\insert\footins\bgroup
5762 % We want to typeset this text as a normal paragraph, even if the
5763 % footnote reference occurs in (for example) a display environment.
5764 % So reset some parameters.
5765 \interlinepenalty\interfootnotelinepenalty
5766 \splittopskip\ht\strutbox % top baseline for broken footnotes
5767 \splitmaxdepth\dp\strutbox
5768 \floatingpenalty\@MM
5769 \leftskip\z@skip
5770 \rightskip\z@skip
5771 \spaceskip\z@skip
5772 \xspaceskip\z@skip
5773 \parindent\defaultparindent
5775 \smallfonts \rm
5777 % Hang the footnote text off the number.
5778 \hang
5779 \textindent{\thisfootno}%
5781 % Don't crash into the line above the footnote text. Since this
5782 % expands into a box, it must come within the paragraph, lest it
5783 % provide a place where TeX can split the footnote.
5784 \footstrut
5785 \futurelet\next\fo@t
5787 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5788 \else\let\next\f@t\fi \next}
5789 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
5790 \def\f@t#1{#1\@foot}
5791 \def\@foot{\strut\par\egroup}
5793 }%end \catcode `\@=11
5795 % Set the baselineskip to #1, and the lineskip and strut size
5796 % correspondingly. There is no deep meaning behind these magic numbers
5797 % used as factors; they just match (closely enough) what Knuth defined.
5799 \def\lineskipfactor{.08333}
5800 \def\strutheightpercent{.70833}
5801 \def\strutdepthpercent {.29167}
5803 \def\setleading#1{%
5804 \normalbaselineskip = #1\relax
5805 \normallineskip = \lineskipfactor\normalbaselineskip
5806 \normalbaselines
5807 \setbox\strutbox =\hbox{%
5808 \vrule width0pt height\strutheightpercent\baselineskip
5809 depth \strutdepthpercent \baselineskip
5813 % @| inserts a changebar to the left of the current line. It should
5814 % surround any changed text. This approach does *not* work if the
5815 % change spans more than two lines of output. To handle that, we would
5816 % have adopt a much more difficult approach (putting marks into the main
5817 % vertical list for the beginning and end of each change).
5819 \def\|{%
5820 % \vadjust can only be used in horizontal mode.
5821 \leavevmode
5823 % Append this vertical mode material after the current line in the output.
5824 \vadjust{%
5825 % We want to insert a rule with the height and depth of the current
5826 % leading; that is exactly what \strutbox is supposed to record.
5827 \vskip-\baselineskip
5829 % \vadjust-items are inserted at the left edge of the type. So
5830 % the \llap here moves out into the left-hand margin.
5831 \llap{%
5833 % For a thicker or thinner bar, change the `1pt'.
5834 \vrule height\baselineskip width1pt
5836 % This is the space between the bar and the text.
5837 \hskip 12pt
5842 % For a final copy, take out the rectangles
5843 % that mark overfull boxes (in case you have decided
5844 % that the text looks ok even though it passes the margin).
5846 \def\finalout{\overfullrule=0pt}
5848 % @image. We use the macros from epsf.tex to support this.
5849 % If epsf.tex is not installed and @image is used, we complain.
5851 % Check for and read epsf.tex up front. If we read it only at @image
5852 % time, we might be inside a group, and then its definitions would get
5853 % undone and the next image would fail.
5854 \openin 1 = epsf.tex
5855 \ifeof 1 \else
5856 \closein 1
5857 % Do not bother showing banner with post-v2.7 epsf.tex (available in
5858 % doc/epsf.tex until it shows up on ctan).
5859 \def\epsfannounce{\toks0 = }%
5860 \input epsf.tex
5863 % We will only complain once about lack of epsf.tex.
5864 \newif\ifwarnednoepsf
5865 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5866 work. It is also included in the Texinfo distribution, or you can get
5867 it from ftp://tug.org/tex/epsf.tex.}
5869 \def\image#1{%
5870 \ifx\epsfbox\undefined
5871 \ifwarnednoepsf \else
5872 \errhelp = \noepsfhelp
5873 \errmessage{epsf.tex not found, images will be ignored}%
5874 \global\warnednoepsftrue
5876 \else
5877 \imagexxx #1,,,\finish
5881 % Arguments to @image:
5882 % #1 is (mandatory) image filename; we tack on .eps extension.
5883 % #2 is (optional) width, #3 is (optional) height.
5884 % #4 is just the usual extra ignored arg for parsing this stuff.
5885 \def\imagexxx#1,#2,#3,#4\finish{%
5886 \ifpdf
5887 \centerline{\dopdfimage{#1}{#2}{#3}}%
5888 \else
5889 % \epsfbox itself resets \epsf?size at each figure.
5890 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5891 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5892 \begingroup
5893 \catcode`\^^M = 5 % in case we're inside an example
5894 \normalturnoffactive % allow _ et al. in names
5895 % If the image is by itself, center it.
5896 \ifvmode
5897 \nobreak\bigskip
5898 % Usually we'll have text after the image which will insert
5899 % \parskip glue, so insert it here too to equalize the space
5900 % above and below.
5901 \nobreak\vskip\parskip
5902 \nobreak
5903 \centerline{\epsfbox{#1.eps}}%
5904 \bigbreak
5905 \else
5906 % In the middle of a paragraph, no extra space.
5907 \epsfbox{#1.eps}%
5909 \endgroup
5914 \message{localization,}
5915 % and i18n.
5917 % @documentlanguage is usually given very early, just after
5918 % @setfilename. If done too late, it may not override everything
5919 % properly. Single argument is the language abbreviation.
5920 % It would be nice if we could set up a hyphenation file here.
5922 \def\documentlanguage{\parsearg\dodocumentlanguage}
5923 \def\dodocumentlanguage#1{%
5924 \tex % read txi-??.tex file in plain TeX.
5925 % Read the file if it exists.
5926 \openin 1 txi-#1.tex
5927 \ifeof1
5928 \errhelp = \nolanghelp
5929 \errmessage{Cannot read language file txi-#1.tex}%
5930 \let\temp = \relax
5931 \else
5932 \def\temp{\input txi-#1.tex }%
5934 \temp
5935 \endgroup
5937 \newhelp\nolanghelp{The given language definition file cannot be found or
5938 is empty. Maybe you need to install it? In the current directory
5939 should work if nowhere else does.}
5942 % @documentencoding should change something in TeX eventually, most
5943 % likely, but for now just recognize it.
5944 \let\documentencoding = \comment
5947 % Page size parameters.
5949 \newdimen\defaultparindent \defaultparindent = 15pt
5951 \chapheadingskip = 15pt plus 4pt minus 2pt
5952 \secheadingskip = 12pt plus 3pt minus 2pt
5953 \subsecheadingskip = 9pt plus 2pt minus 2pt
5955 % Prevent underfull vbox error messages.
5956 \vbadness = 10000
5958 % Don't be so finicky about underfull hboxes, either.
5959 \hbadness = 2000
5961 % Following George Bush, just get rid of widows and orphans.
5962 \widowpenalty=10000
5963 \clubpenalty=10000
5965 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
5966 % using an old version of TeX, don't do anything. We want the amount of
5967 % stretch added to depend on the line length, hence the dependence on
5968 % \hsize. We call this whenever the paper size is set.
5970 \def\setemergencystretch{%
5971 \ifx\emergencystretch\thisisundefined
5972 % Allow us to assign to \emergencystretch anyway.
5973 \def\emergencystretch{\dimen0}%
5974 \else
5975 \emergencystretch = .15\hsize
5979 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
5980 % 4) hoffset; 5) binding offset; 6) topskip. Then whoever calls us can
5981 % set \parskip and call \setleading for \baselineskip.
5983 \def\internalpagesizes#1#2#3#4#5#6{%
5984 \voffset = #3\relax
5985 \topskip = #6\relax
5986 \splittopskip = \topskip
5988 \vsize = #1\relax
5989 \advance\vsize by \topskip
5990 \outervsize = \vsize
5991 \advance\outervsize by 2\topandbottommargin
5992 \pageheight = \vsize
5994 \hsize = #2\relax
5995 \outerhsize = \hsize
5996 \advance\outerhsize by 0.5in
5997 \pagewidth = \hsize
5999 \normaloffset = #4\relax
6000 \bindingoffset = #5\relax
6002 \parindent = \defaultparindent
6003 \setemergencystretch
6006 % Use `small' versions.
6008 \def\smallenvironments{%
6009 \let\smalldisplay = \smalldisplayx
6010 \let\smallexample = \smalllispx
6011 \let\smallformat = \smallformatx
6012 \let\smalllisp = \smalllispx
6015 % @letterpaper (the default).
6016 \def\letterpaper{{\globaldefs = 1
6017 \parskip = 3pt plus 2pt minus 1pt
6018 \setleading{13.2pt}%
6020 % If page is nothing but text, make it come out even.
6021 \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}%
6024 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6025 \def\smallbook{{\globaldefs = 1
6026 \parskip = 2pt plus 1pt
6027 \setleading{12pt}%
6029 \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}%
6031 \lispnarrowing = 0.3in
6032 \tolerance = 700
6033 \hfuzz = 1pt
6034 \contentsrightmargin = 0pt
6035 \deftypemargin = 0pt
6036 \defbodyindent = .5cm
6037 \smallenvironments
6040 % Use @afourpaper to print on European A4 paper.
6041 \def\afourpaper{{\globaldefs = 1
6042 \setleading{12pt}%
6043 \parskip = 3pt plus 2pt minus 1pt
6045 \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}%
6047 \tolerance = 700
6048 \hfuzz = 1pt
6051 % Use @afivepaper to print on European A5 paper.
6052 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6053 % He also recommends making @example and @lisp be small.
6054 \def\afivepaper{{\globaldefs = 1
6055 \setleading{12.5pt}%
6056 \parskip = 2pt plus 1pt minus 0.1pt
6058 \internalpagesizes{166mm}{120mm}{\voffset}{-8mm}{\bindingoffset}{8pt}%
6060 \lispnarrowing = 0.2in
6061 \tolerance = 800
6062 \hfuzz = 1.2pt
6063 \contentsrightmargin = 0mm
6064 \deftypemargin = 0pt
6065 \defbodyindent = 2mm
6066 \tableindent = 12mm
6068 \smallenvironments
6071 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
6072 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
6073 \def\afourlatex{{\globaldefs = 1
6074 \setleading{13.6pt}%
6076 \afourpaper
6077 \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}%
6079 \globaldefs = 0
6082 % Use @afourwide to print on European A4 paper in wide format.
6083 \def\afourwide{%
6084 \afourpaper
6085 \internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}%
6087 \globaldefs = 0
6090 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6091 % Perhaps we should allow setting the margins, \topskip, \parskip,
6092 % and/or leading, also. Or perhaps we should compute them somehow.
6094 \def\pagesizes{\parsearg\pagesizesxxx}
6095 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6096 \def\pagesizesyyy#1,#2,#3\finish{{%
6097 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6098 \globaldefs = 1
6100 \parskip = 3pt plus 2pt minus 1pt
6101 \setleading{13.2pt}%
6103 \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}%
6106 % Set default to letter.
6108 \letterpaper
6111 \message{and turning on texinfo input format.}
6113 % Define macros to output various characters with catcode for normal text.
6114 \catcode`\"=\other
6115 \catcode`\~=\other
6116 \catcode`\^=\other
6117 \catcode`\_=\other
6118 \catcode`\|=\other
6119 \catcode`\<=\other
6120 \catcode`\>=\other
6121 \catcode`\+=\other
6122 \catcode`\$=\other
6123 \def\normaldoublequote{"}
6124 \def\normaltilde{~}
6125 \def\normalcaret{^}
6126 \def\normalunderscore{_}
6127 \def\normalverticalbar{|}
6128 \def\normalless{<}
6129 \def\normalgreater{>}
6130 \def\normalplus{+}
6131 \def\normaldollar{$}
6133 % This macro is used to make a character print one way in ttfont
6134 % where it can probably just be output, and another way in other fonts,
6135 % where something hairier probably needs to be done.
6137 % #1 is what to print if we are indeed using \tt; #2 is what to print
6138 % otherwise. Since all the Computer Modern typewriter fonts have zero
6139 % interword stretch (and shrink), and it is reasonable to expect all
6140 % typewriter fonts to have this, we can check that font parameter.
6142 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6144 % Same as above, but check for italic font. Actually this also catches
6145 % non-italic slanted fonts since it is impossible to distinguish them from
6146 % italic fonts. But since this is only used by $ and it uses \sl anyway
6147 % this is not a problem.
6148 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6150 % Turn off all special characters except @
6151 % (and those which the user can use as if they were ordinary).
6152 % Most of these we simply print from the \tt font, but for some, we can
6153 % use math or other variants that look better in normal text.
6155 \catcode`\"=\active
6156 \def\activedoublequote{{\tt\char34}}
6157 \let"=\activedoublequote
6158 \catcode`\~=\active
6159 \def~{{\tt\char126}}
6160 \chardef\hat=`\^
6161 \catcode`\^=\active
6162 \def^{{\tt \hat}}
6164 \catcode`\_=\active
6165 \def_{\ifusingtt\normalunderscore\_}
6166 % Subroutine for the previous macro.
6167 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
6169 \catcode`\|=\active
6170 \def|{{\tt\char124}}
6171 \chardef \less=`\<
6172 \catcode`\<=\active
6173 \def<{{\tt \less}}
6174 \chardef \gtr=`\>
6175 \catcode`\>=\active
6176 \def>{{\tt \gtr}}
6177 \catcode`\+=\active
6178 \def+{{\tt \char 43}}
6179 \catcode`\$=\active
6180 \def${\ifusingit{{\sl\$}}\normaldollar}
6181 %\catcode 27=\active
6182 %\def^^[{$\diamondsuit$}
6184 % Set up an active definition for =, but don't enable it most of the time.
6185 {\catcode`\==\active
6186 \global\def={{\tt \char 61}}}
6188 \catcode`+=\active
6189 \catcode`\_=\active
6191 % If a .fmt file is being used, characters that might appear in a file
6192 % name cannot be active until we have parsed the command line.
6193 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6194 % \otherifyactive is called near the end of this file.
6195 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6197 \catcode`\@=0
6199 % \rawbackslashxx output one backslash character in current font
6200 \global\chardef\rawbackslashxx=`\\
6201 %{\catcode`\\=\other
6202 %@gdef@rawbackslashxx{\}}
6204 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6205 {\catcode`\\=\active
6206 @gdef@rawbackslash{@let\=@rawbackslashxx }}
6208 % \normalbackslash outputs one backslash in fixed width font.
6209 \def\normalbackslash{{\tt\rawbackslashxx}}
6211 % \catcode 17=0 % Define control-q
6212 \catcode`\\=\active
6214 % Used sometimes to turn off (effectively) the active characters
6215 % even after parsing them.
6216 @def@turnoffactive{@let"=@normaldoublequote
6217 @let\=@realbackslash
6218 @let~=@normaltilde
6219 @let^=@normalcaret
6220 @let_=@normalunderscore
6221 @let|=@normalverticalbar
6222 @let<=@normalless
6223 @let>=@normalgreater
6224 @let+=@normalplus
6225 @let$=@normaldollar}
6227 @def@normalturnoffactive{@let"=@normaldoublequote
6228 @let\=@normalbackslash
6229 @let~=@normaltilde
6230 @let^=@normalcaret
6231 @let_=@normalunderscore
6232 @let|=@normalverticalbar
6233 @let<=@normalless
6234 @let>=@normalgreater
6235 @let+=@normalplus
6236 @let$=@normaldollar}
6238 % Make _ and + \other characters, temporarily.
6239 % This is canceled by @fixbackslash.
6240 @otherifyactive
6242 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6243 % That is what \eatinput is for; after that, the `\' should revert to printing
6244 % a backslash.
6246 @gdef@eatinput input texinfo{@fixbackslash}
6247 @global@let\ = @eatinput
6249 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6250 % the first `\{ in the file would cause an error. This macro tries to fix
6251 % that, assuming it is called before the first `\' could plausibly occur.
6252 % Also back turn on active characters that might appear in the input
6253 % file name, in case not using a pre-dumped format.
6255 @gdef@fixbackslash{%
6256 @ifx\@eatinput @let\ = @normalbackslash @fi
6257 @catcode`+=@active
6258 @catcode`@_=@active
6261 % Say @foo, not \foo, in error messages.
6262 @escapechar = `@@
6264 % These look ok in all fonts, so just make them not special.
6265 @catcode`@& = @other
6266 @catcode`@# = @other
6267 @catcode`@% = @other
6269 @c Set initial fonts.
6270 @textfonts
6274 @c Local variables:
6275 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6276 @c page-delimiter: "^\\\\message"
6277 @c time-stamp-start: "def\\\\texinfoversion{"
6278 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6279 @c time-stamp-end: "}"
6280 @c End: