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