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