]> git.saurik.com Git - bison.git/blame - config/texinfo.tex
* src/system.h: Provide default declarations for stpcpy, strndup,
[bison.git] / config / texinfo.tex
CommitLineData
d074a105
AD
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-06-21.10}
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{%
593group can only be used in environments such as @example,^^J%
594where 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 % If they want short, they certainly want long too.
1618 \ifsetshortcontentsaftertitlepage
1619 \shortcontents
1620 \contents
1621 \global\let\shortcontents = \relax
1622 \global\let\contents = \relax
1623 \fi
1624 %
1625 \ifsetcontentsaftertitlepage
1626 \contents
1627 \global\let\contents = \relax
1628 \global\let\shortcontents = \relax
1629 \fi
1630 %
1631 \ifpdf \pdfmakepagedesttrue \fi
1632 %
1633 \HEADINGSon
1634}
1635
1636\def\finishtitlepage{%
1637 \vskip4pt \hrule height 2pt width \hsize
1638 \vskip\titlepagebottomglue
1639 \finishedtitlepagetrue
1640}
1641
1642%%% Set up page headings and footings.
1643
1644\let\thispage=\folio
1645
1646\newtoks\evenheadline % headline on even pages
1647\newtoks\oddheadline % headline on odd pages
1648\newtoks\evenfootline % footline on even pages
1649\newtoks\oddfootline % footline on odd pages
1650
1651% Now make Tex use those variables
1652\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1653 \else \the\evenheadline \fi}}
1654\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1655 \else \the\evenfootline \fi}\HEADINGShook}
1656\let\HEADINGShook=\relax
1657
1658% Commands to set those variables.
1659% For example, this is what @headings on does
1660% @evenheading @thistitle|@thispage|@thischapter
1661% @oddheading @thischapter|@thispage|@thistitle
1662% @evenfooting @thisfile||
1663% @oddfooting ||@thisfile
1664
1665\def\evenheading{\parsearg\evenheadingxxx}
1666\def\oddheading{\parsearg\oddheadingxxx}
1667\def\everyheading{\parsearg\everyheadingxxx}
1668
1669\def\evenfooting{\parsearg\evenfootingxxx}
1670\def\oddfooting{\parsearg\oddfootingxxx}
1671\def\everyfooting{\parsearg\everyfootingxxx}
1672
1673{\catcode`\@=0 %
1674
1675\gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1676\gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1677\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1678
1679\gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1680\gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1681\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1682
1683\gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1684
1685\gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1686\gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1687\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1688
1689\gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1690\gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1691 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1692 %
1693 % Leave some space for the footline. Hopefully ok to assume
1694 % @evenfooting will not be used by itself.
1695 \global\advance\pageheight by -\baselineskip
1696 \global\advance\vsize by -\baselineskip
1697}
1698
1699\gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1700%
1701}% unbind the catcode of @.
1702
1703% @headings double turns headings on for double-sided printing.
1704% @headings single turns headings on for single-sided printing.
1705% @headings off turns them off.
1706% @headings on same as @headings double, retained for compatibility.
1707% @headings after turns on double-sided headings after this page.
1708% @headings doubleafter turns on double-sided headings after this page.
1709% @headings singleafter turns on single-sided headings after this page.
1710% By default, they are off at the start of a document,
1711% and turned `on' after @end titlepage.
1712
1713\def\headings #1 {\csname HEADINGS#1\endcsname}
1714
1715\def\HEADINGSoff{
1716\global\evenheadline={\hfil} \global\evenfootline={\hfil}
1717\global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1718\HEADINGSoff
1719% When we turn headings on, set the page number to 1.
1720% For double-sided printing, put current file name in lower left corner,
1721% chapter name on inside top of right hand pages, document
1722% title on inside top of left hand pages, and page numbers on outside top
1723% edge of all pages.
1724\def\HEADINGSdouble{
1725\global\pageno=1
1726\global\evenfootline={\hfil}
1727\global\oddfootline={\hfil}
1728\global\evenheadline={\line{\folio\hfil\thistitle}}
1729\global\oddheadline={\line{\thischapter\hfil\folio}}
1730\global\let\contentsalignmacro = \chapoddpage
1731}
1732\let\contentsalignmacro = \chappager
1733
1734% For single-sided printing, chapter title goes across top left of page,
1735% page number on top right.
1736\def\HEADINGSsingle{
1737\global\pageno=1
1738\global\evenfootline={\hfil}
1739\global\oddfootline={\hfil}
1740\global\evenheadline={\line{\thischapter\hfil\folio}}
1741\global\oddheadline={\line{\thischapter\hfil\folio}}
1742\global\let\contentsalignmacro = \chappager
1743}
1744\def\HEADINGSon{\HEADINGSdouble}
1745
1746\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1747\let\HEADINGSdoubleafter=\HEADINGSafter
1748\def\HEADINGSdoublex{%
1749\global\evenfootline={\hfil}
1750\global\oddfootline={\hfil}
1751\global\evenheadline={\line{\folio\hfil\thistitle}}
1752\global\oddheadline={\line{\thischapter\hfil\folio}}
1753\global\let\contentsalignmacro = \chapoddpage
1754}
1755
1756\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1757\def\HEADINGSsinglex{%
1758\global\evenfootline={\hfil}
1759\global\oddfootline={\hfil}
1760\global\evenheadline={\line{\thischapter\hfil\folio}}
1761\global\oddheadline={\line{\thischapter\hfil\folio}}
1762\global\let\contentsalignmacro = \chappager
1763}
1764
1765% Subroutines used in generating headings
1766% This produces Day Month Year style of output.
1767% Only define if not already defined, in case a txi-??.tex file has set
1768% up a different format (e.g., txi-cs.tex does this).
1769\ifx\today\undefined
1770\def\today{%
1771 \number\day\space
1772 \ifcase\month
1773 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1774 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1775 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1776 \fi
1777 \space\number\year}
1778\fi
1779
1780% @settitle line... specifies the title of the document, for headings.
1781% It generates no output of its own.
1782\def\thistitle{\putwordNoTitle}
1783\def\settitle{\parsearg\settitlezzz}
1784\def\settitlezzz #1{\gdef\thistitle{#1}}
1785
1786
1787\message{tables,}
1788% Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1789
1790% default indentation of table text
1791\newdimen\tableindent \tableindent=.8in
1792% default indentation of @itemize and @enumerate text
1793\newdimen\itemindent \itemindent=.3in
1794% margin between end of table item and start of table text.
1795\newdimen\itemmargin \itemmargin=.1in
1796
1797% used internally for \itemindent minus \itemmargin
1798\newdimen\itemmax
1799
1800% Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1801% these defs.
1802% They also define \itemindex
1803% to index the item name in whatever manner is desired (perhaps none).
1804
1805\newif\ifitemxneedsnegativevskip
1806
1807\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1808
1809\def\internalBitem{\smallbreak \parsearg\itemzzz}
1810\def\internalBitemx{\itemxpar \parsearg\itemzzz}
1811
1812\def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1813\def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1814
1815\def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1816\def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1817
1818\def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1819 \itemzzz {#1}}
1820
1821\def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1822 \itemzzz {#1}}
1823
1824\def\itemzzz #1{\begingroup %
1825 \advance\hsize by -\rightskip
1826 \advance\hsize by -\tableindent
1827 \setbox0=\hbox{\itemfont{#1}}%
1828 \itemindex{#1}%
1829 \nobreak % This prevents a break before @itemx.
1830 %
1831 % If the item text does not fit in the space we have, put it on a line
1832 % by itself, and do not allow a page break either before or after that
1833 % line. We do not start a paragraph here because then if the next
1834 % command is, e.g., @kindex, the whatsit would get put into the
1835 % horizontal list on a line by itself, resulting in extra blank space.
1836 \ifdim \wd0>\itemmax
1837 %
1838 % Make this a paragraph so we get the \parskip glue and wrapping,
1839 % but leave it ragged-right.
1840 \begingroup
1841 \advance\leftskip by-\tableindent
1842 \advance\hsize by\tableindent
1843 \advance\rightskip by0pt plus1fil
1844 \leavevmode\unhbox0\par
1845 \endgroup
1846 %
1847 % We're going to be starting a paragraph, but we don't want the
1848 % \parskip glue -- logically it's part of the @item we just started.
1849 \nobreak \vskip-\parskip
1850 %
1851 % Stop a page break at the \parskip glue coming up. Unfortunately
1852 % we can't prevent a possible page break at the following
1853 % \baselineskip glue.
1854 \nobreak
1855 \endgroup
1856 \itemxneedsnegativevskipfalse
1857 \else
1858 % The item text fits into the space. Start a paragraph, so that the
1859 % following text (if any) will end up on the same line.
1860 \noindent
1861 % Do this with kerns and \unhbox so that if there is a footnote in
1862 % the item text, it can migrate to the main vertical list and
1863 % eventually be printed.
1864 \nobreak\kern-\tableindent
1865 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1866 \unhbox0
1867 \nobreak\kern\dimen0
1868 \endgroup
1869 \itemxneedsnegativevskiptrue
1870 \fi
1871}
1872
1873\def\item{\errmessage{@item while not in a table}}
1874\def\itemx{\errmessage{@itemx while not in a table}}
1875\def\kitem{\errmessage{@kitem while not in a table}}
1876\def\kitemx{\errmessage{@kitemx while not in a table}}
1877\def\xitem{\errmessage{@xitem while not in a table}}
1878\def\xitemx{\errmessage{@xitemx while not in a table}}
1879
1880% Contains a kludge to get @end[description] to work.
1881\def\description{\tablez{\dontindex}{1}{}{}{}{}}
1882
1883% @table, @ftable, @vtable.
1884\def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1885{\obeylines\obeyspaces%
1886\gdef\tablex #1^^M{%
1887\tabley\dontindex#1 \endtabley}}
1888
1889\def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1890{\obeylines\obeyspaces%
1891\gdef\ftablex #1^^M{%
1892\tabley\fnitemindex#1 \endtabley
1893\def\Eftable{\endgraf\afterenvbreak\endgroup}%
1894\let\Etable=\relax}}
1895
1896\def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1897{\obeylines\obeyspaces%
1898\gdef\vtablex #1^^M{%
1899\tabley\vritemindex#1 \endtabley
1900\def\Evtable{\endgraf\afterenvbreak\endgroup}%
1901\let\Etable=\relax}}
1902
1903\def\dontindex #1{}
1904\def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1905\def\vritemindex #1{\doind {vr}{\code{#1}}}%
1906
1907{\obeyspaces %
1908\gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1909\tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1910
1911\def\tablez #1#2#3#4#5#6{%
1912\aboveenvbreak %
1913\begingroup %
1914\def\Edescription{\Etable}% Necessary kludge.
1915\let\itemindex=#1%
1916\ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1917\ifnum 0#4>0 \tableindent=#4\mil \fi %
1918\ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1919\def\itemfont{#2}%
1920\itemmax=\tableindent %
1921\advance \itemmax by -\itemmargin %
1922\advance \leftskip by \tableindent %
1923\exdentamount=\tableindent
1924\parindent = 0pt
1925\parskip = \smallskipamount
1926\ifdim \parskip=0pt \parskip=2pt \fi%
1927\def\Etable{\endgraf\afterenvbreak\endgroup}%
1928\let\item = \internalBitem %
1929\let\itemx = \internalBitemx %
1930\let\kitem = \internalBkitem %
1931\let\kitemx = \internalBkitemx %
1932\let\xitem = \internalBxitem %
1933\let\xitemx = \internalBxitemx %
1934}
1935
1936% This is the counter used by @enumerate, which is really @itemize
1937
1938\newcount \itemno
1939
1940\def\itemize{\parsearg\itemizezzz}
1941
1942\def\itemizezzz #1{%
1943 \begingroup % ended by the @end itemize
1944 \itemizey {#1}{\Eitemize}
1945}
1946
1947\def\itemizey #1#2{%
1948\aboveenvbreak %
1949\itemmax=\itemindent %
1950\advance \itemmax by -\itemmargin %
1951\advance \leftskip by \itemindent %
1952\exdentamount=\itemindent
1953\parindent = 0pt %
1954\parskip = \smallskipamount %
1955\ifdim \parskip=0pt \parskip=2pt \fi%
1956\def#2{\endgraf\afterenvbreak\endgroup}%
1957\def\itemcontents{#1}%
1958\let\item=\itemizeitem}
1959
1960% Set sfcode to normal for the chars that usually have another value.
1961% These are `.?!:;,'
1962\def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1963 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1964
1965% \splitoff TOKENS\endmark defines \first to be the first token in
1966% TOKENS, and \rest to be the remainder.
1967%
1968\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1969
1970% Allow an optional argument of an uppercase letter, lowercase letter,
1971% or number, to specify the first label in the enumerated list. No
1972% argument is the same as `1'.
1973%
1974\def\enumerate{\parsearg\enumeratezzz}
1975\def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1976\def\enumeratey #1 #2\endenumeratey{%
1977 \begingroup % ended by the @end enumerate
1978 %
1979 % If we were given no argument, pretend we were given `1'.
1980 \def\thearg{#1}%
1981 \ifx\thearg\empty \def\thearg{1}\fi
1982 %
1983 % Detect if the argument is a single token. If so, it might be a
1984 % letter. Otherwise, the only valid thing it can be is a number.
1985 % (We will always have one token, because of the test we just made.
1986 % This is a good thing, since \splitoff doesn't work given nothing at
1987 % all -- the first parameter is undelimited.)
1988 \expandafter\splitoff\thearg\endmark
1989 \ifx\rest\empty
1990 % Only one token in the argument. It could still be anything.
1991 % A ``lowercase letter'' is one whose \lccode is nonzero.
1992 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1993 % not equal to itself.
1994 % Otherwise, we assume it's a number.
1995 %
1996 % We need the \relax at the end of the \ifnum lines to stop TeX from
1997 % continuing to look for a <number>.
1998 %
1999 \ifnum\lccode\expandafter`\thearg=0\relax
2000 \numericenumerate % a number (we hope)
2001 \else
2002 % It's a letter.
2003 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2004 \lowercaseenumerate % lowercase letter
2005 \else
2006 \uppercaseenumerate % uppercase letter
2007 \fi
2008 \fi
2009 \else
2010 % Multiple tokens in the argument. We hope it's a number.
2011 \numericenumerate
2012 \fi
2013}
2014
2015% An @enumerate whose labels are integers. The starting integer is
2016% given in \thearg.
2017%
2018\def\numericenumerate{%
2019 \itemno = \thearg
2020 \startenumeration{\the\itemno}%
2021}
2022
2023% The starting (lowercase) letter is in \thearg.
2024\def\lowercaseenumerate{%
2025 \itemno = \expandafter`\thearg
2026 \startenumeration{%
2027 % Be sure we're not beyond the end of the alphabet.
2028 \ifnum\itemno=0
2029 \errmessage{No more lowercase letters in @enumerate; get a bigger
2030 alphabet}%
2031 \fi
2032 \char\lccode\itemno
2033 }%
2034}
2035
2036% The starting (uppercase) letter is in \thearg.
2037\def\uppercaseenumerate{%
2038 \itemno = \expandafter`\thearg
2039 \startenumeration{%
2040 % Be sure we're not beyond the end of the alphabet.
2041 \ifnum\itemno=0
2042 \errmessage{No more uppercase letters in @enumerate; get a bigger
2043 alphabet}
2044 \fi
2045 \char\uccode\itemno
2046 }%
2047}
2048
2049% Call itemizey, adding a period to the first argument and supplying the
2050% common last two arguments. Also subtract one from the initial value in
2051% \itemno, since @item increments \itemno.
2052%
2053\def\startenumeration#1{%
2054 \advance\itemno by -1
2055 \itemizey{#1.}\Eenumerate\flushcr
2056}
2057
2058% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2059% to @enumerate.
2060%
2061\def\alphaenumerate{\enumerate{a}}
2062\def\capsenumerate{\enumerate{A}}
2063\def\Ealphaenumerate{\Eenumerate}
2064\def\Ecapsenumerate{\Eenumerate}
2065
2066% Definition of @item while inside @itemize.
2067
2068\def\itemizeitem{%
2069\advance\itemno by 1
2070{\let\par=\endgraf \smallbreak}%
2071\ifhmode \errmessage{In hmode at itemizeitem}\fi
2072{\parskip=0in \hskip 0pt
2073\hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2074\vadjust{\penalty 1200}}%
2075\flushcr}
2076
2077% @multitable macros
2078% Amy Hendrickson, 8/18/94, 3/6/96
2079%
2080% @multitable ... @end multitable will make as many columns as desired.
2081% Contents of each column will wrap at width given in preamble. Width
2082% can be specified either with sample text given in a template line,
2083% or in percent of \hsize, the current width of text on page.
2084
2085% Table can continue over pages but will only break between lines.
2086
2087% To make preamble:
2088%
2089% Either define widths of columns in terms of percent of \hsize:
2090% @multitable @columnfractions .25 .3 .45
2091% @item ...
2092%
2093% Numbers following @columnfractions are the percent of the total
2094% current hsize to be used for each column. You may use as many
2095% columns as desired.
2096
2097
2098% Or use a template:
2099% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2100% @item ...
2101% using the widest term desired in each column.
2102%
2103% For those who want to use more than one line's worth of words in
2104% the preamble, break the line within one argument and it
2105% will parse correctly, i.e.,
2106%
2107% @multitable {Column 1 template} {Column 2 template} {Column 3
2108% template}
2109% Not:
2110% @multitable {Column 1 template} {Column 2 template}
2111% {Column 3 template}
2112
2113% Each new table line starts with @item, each subsequent new column
2114% starts with @tab. Empty columns may be produced by supplying @tab's
2115% with nothing between them for as many times as empty columns are needed,
2116% ie, @tab@tab@tab will produce two empty columns.
2117
2118% @item, @tab, @multitable or @end multitable do not need to be on their
2119% own lines, but it will not hurt if they are.
2120
2121% Sample multitable:
2122
2123% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2124% @item first col stuff @tab second col stuff @tab third col
2125% @item
2126% first col stuff
2127% @tab
2128% second col stuff
2129% @tab
2130% third col
2131% @item first col stuff @tab second col stuff
2132% @tab Many paragraphs of text may be used in any column.
2133%
2134% They will wrap at the width determined by the template.
2135% @item@tab@tab This will be in third column.
2136% @end multitable
2137
2138% Default dimensions may be reset by user.
2139% @multitableparskip is vertical space between paragraphs in table.
2140% @multitableparindent is paragraph indent in table.
2141% @multitablecolmargin is horizontal space to be left between columns.
2142% @multitablelinespace is space to leave between table items, baseline
2143% to baseline.
2144% 0pt means it depends on current normal line spacing.
2145%
2146\newskip\multitableparskip
2147\newskip\multitableparindent
2148\newdimen\multitablecolspace
2149\newskip\multitablelinespace
2150\multitableparskip=0pt
2151\multitableparindent=6pt
2152\multitablecolspace=12pt
2153\multitablelinespace=0pt
2154
2155% Macros used to set up halign preamble:
2156%
2157\let\endsetuptable\relax
2158\def\xendsetuptable{\endsetuptable}
2159\let\columnfractions\relax
2160\def\xcolumnfractions{\columnfractions}
2161\newif\ifsetpercent
2162
2163% #1 is the part of the @columnfraction before the decimal point, which
2164% is presumably either 0 or the empty string (but we don't check, we
2165% just throw it away). #2 is the decimal part, which we use as the
2166% percent of \hsize for this column.
2167\def\pickupwholefraction#1.#2 {%
2168 \global\advance\colcount by 1
2169 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2170 \setuptable
2171}
2172
2173\newcount\colcount
2174\def\setuptable#1{%
2175 \def\firstarg{#1}%
2176 \ifx\firstarg\xendsetuptable
2177 \let\go = \relax
2178 \else
2179 \ifx\firstarg\xcolumnfractions
2180 \global\setpercenttrue
2181 \else
2182 \ifsetpercent
2183 \let\go\pickupwholefraction
2184 \else
2185 \global\advance\colcount by 1
2186 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2187 % typically that is always in the input, anyway.
2188 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2189 \fi
2190 \fi
2191 \ifx\go\pickupwholefraction
2192 % Put the argument back for the \pickupwholefraction call, so
2193 % we'll always have a period there to be parsed.
2194 \def\go{\pickupwholefraction#1}%
2195 \else
2196 \let\go = \setuptable
2197 \fi%
2198 \fi
2199 \go
2200}
2201
2202% This used to have \hskip1sp. But then the space in a template line is
2203% not enough. That is bad. So let's go back to just & until we
2204% encounter the problem it was intended to solve again.
2205% --karl, nathan@acm.org, 20apr99.
2206\def\tab{&}
2207
2208% @multitable ... @end multitable definitions:
2209%
2210\def\multitable{\parsearg\dotable}
2211\def\dotable#1{\bgroup
2212 \vskip\parskip
2213 \let\item\crcr
2214 \tolerance=9500
2215 \hbadness=9500
2216 \setmultitablespacing
2217 \parskip=\multitableparskip
2218 \parindent=\multitableparindent
2219 \overfullrule=0pt
2220 \global\colcount=0
2221 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2222 %
2223 % To parse everything between @multitable and @item:
2224 \setuptable#1 \endsetuptable
2225 %
2226 % \everycr will reset column counter, \colcount, at the end of
2227 % each line. Every column entry will cause \colcount to advance by one.
2228 % The table preamble
2229 % looks at the current \colcount to find the correct column width.
2230 \everycr{\noalign{%
2231 %
2232 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2233 % Maybe so, but it also creates really weird page breaks when the table
2234 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2235 % manifests itself, so it can be fixed for real --karl.
2236 \global\colcount=0\relax}}%
2237 %
2238 % This preamble sets up a generic column definition, which will
2239 % be used as many times as user calls for columns.
2240 % \vtop will set a single line and will also let text wrap and
2241 % continue for many paragraphs if desired.
2242 \halign\bgroup&\global\advance\colcount by 1\relax
2243 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2244 %
2245 % In order to keep entries from bumping into each other
2246 % we will add a \leftskip of \multitablecolspace to all columns after
2247 % the first one.
2248 %
2249 % If a template has been used, we will add \multitablecolspace
2250 % to the width of each template entry.
2251 %
2252 % If the user has set preamble in terms of percent of \hsize we will
2253 % use that dimension as the width of the column, and the \leftskip
2254 % will keep entries from bumping into each other. Table will start at
2255 % left margin and final column will justify at right margin.
2256 %
2257 % Make sure we don't inherit \rightskip from the outer environment.
2258 \rightskip=0pt
2259 \ifnum\colcount=1
2260 % The first column will be indented with the surrounding text.
2261 \advance\hsize by\leftskip
2262 \else
2263 \ifsetpercent \else
2264 % If user has not set preamble in terms of percent of \hsize
2265 % we will advance \hsize by \multitablecolspace.
2266 \advance\hsize by \multitablecolspace
2267 \fi
2268 % In either case we will make \leftskip=\multitablecolspace:
2269 \leftskip=\multitablecolspace
2270 \fi
2271 % Ignoring space at the beginning and end avoids an occasional spurious
2272 % blank line, when TeX decides to break the line at the space before the
2273 % box from the multistrut, so the strut ends up on a line by itself.
2274 % For example:
2275 % @multitable @columnfractions .11 .89
2276 % @item @code{#}
2277 % @tab Legal holiday which is valid in major parts of the whole country.
2278 % Is automatically provided with highlighting sequences respectively marking
2279 % characters.
2280 \noindent\ignorespaces##\unskip\multistrut}\cr
2281}
2282
2283\def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2284% If so, do nothing. If not, give it an appropriate dimension based on
2285% current baselineskip.
2286\ifdim\multitablelinespace=0pt
2287\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2288\global\advance\multitablelinespace by-\ht0
2289%% strut to put in table in case some entry doesn't have descenders,
2290%% to keep lines equally spaced
2291\let\multistrut = \strut
2292\else
2293%% FIXME: what is \box0 supposed to be?
2294\gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2295width0pt\relax} \fi
2296%% Test to see if parskip is larger than space between lines of
2297%% table. If not, do nothing.
2298%% If so, set to same dimension as multitablelinespace.
2299\ifdim\multitableparskip>\multitablelinespace
2300\global\multitableparskip=\multitablelinespace
2301\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2302 %% than skip between lines in the table.
2303\fi%
2304\ifdim\multitableparskip=0pt
2305\global\multitableparskip=\multitablelinespace
2306\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2307 %% than skip between lines in the table.
2308\fi}
2309
2310
2311\message{conditionals,}
2312% Prevent errors for section commands.
2313% Used in @ignore and in failing conditionals.
2314\def\ignoresections{%
2315 \let\chapter=\relax
2316 \let\unnumbered=\relax
2317 \let\top=\relax
2318 \let\unnumberedsec=\relax
2319 \let\unnumberedsection=\relax
2320 \let\unnumberedsubsec=\relax
2321 \let\unnumberedsubsection=\relax
2322 \let\unnumberedsubsubsec=\relax
2323 \let\unnumberedsubsubsection=\relax
2324 \let\section=\relax
2325 \let\subsec=\relax
2326 \let\subsubsec=\relax
2327 \let\subsection=\relax
2328 \let\subsubsection=\relax
2329 \let\appendix=\relax
2330 \let\appendixsec=\relax
2331 \let\appendixsection=\relax
2332 \let\appendixsubsec=\relax
2333 \let\appendixsubsection=\relax
2334 \let\appendixsubsubsec=\relax
2335 \let\appendixsubsubsection=\relax
2336 \let\contents=\relax
2337 \let\smallbook=\relax
2338 \let\titlepage=\relax
2339}
2340
2341% Used in nested conditionals, where we have to parse the Texinfo source
2342% and so want to turn off most commands, in case they are used
2343% incorrectly.
2344%
2345\def\ignoremorecommands{%
2346 \let\defcodeindex = \relax
2347 \let\defcv = \relax
2348 \let\deffn = \relax
2349 \let\deffnx = \relax
2350 \let\defindex = \relax
2351 \let\defivar = \relax
2352 \let\defmac = \relax
2353 \let\defmethod = \relax
2354 \let\defop = \relax
2355 \let\defopt = \relax
2356 \let\defspec = \relax
2357 \let\deftp = \relax
2358 \let\deftypefn = \relax
2359 \let\deftypefun = \relax
2360 \let\deftypeivar = \relax
2361 \let\deftypeop = \relax
2362 \let\deftypevar = \relax
2363 \let\deftypevr = \relax
2364 \let\defun = \relax
2365 \let\defvar = \relax
2366 \let\defvr = \relax
2367 \let\ref = \relax
2368 \let\xref = \relax
2369 \let\printindex = \relax
2370 \let\pxref = \relax
2371 \let\settitle = \relax
2372 \let\setchapternewpage = \relax
2373 \let\setchapterstyle = \relax
2374 \let\everyheading = \relax
2375 \let\evenheading = \relax
2376 \let\oddheading = \relax
2377 \let\everyfooting = \relax
2378 \let\evenfooting = \relax
2379 \let\oddfooting = \relax
2380 \let\headings = \relax
2381 \let\include = \relax
2382 \let\lowersections = \relax
2383 \let\down = \relax
2384 \let\raisesections = \relax
2385 \let\up = \relax
2386 \let\set = \relax
2387 \let\clear = \relax
2388 \let\item = \relax
2389}
2390
2391% Ignore @ignore ... @end ignore.
2392%
2393\def\ignore{\doignore{ignore}}
2394
2395% Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text.
2396%
2397\def\ifinfo{\doignore{ifinfo}}
2398\def\ifhtml{\doignore{ifhtml}}
2399\def\ifnottex{\doignore{ifnottex}}
2400\def\html{\doignore{html}}
2401\def\menu{\doignore{menu}}
2402\def\direntry{\doignore{direntry}}
2403
2404% @dircategory CATEGORY -- specify a category of the dir file
2405% which this file should belong to. Ignore this in TeX.
2406\let\dircategory = \comment
2407
2408% Ignore text until a line `@end #1'.
2409%
2410\def\doignore#1{\begingroup
2411 % Don't complain about control sequences we have declared \outer.
2412 \ignoresections
2413 %
2414 % Define a command to swallow text until we reach `@end #1'.
2415 % This @ is a catcode 12 token (that is the normal catcode of @ in
2416 % this texinfo.tex file). We change the catcode of @ below to match.
2417 \long\def\doignoretext##1@end #1{\enddoignore}%
2418 %
2419 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2420 \catcode32 = 10
2421 %
2422 % Ignore braces, too, so mismatched braces don't cause trouble.
2423 \catcode`\{ = 9
2424 \catcode`\} = 9
2425 %
2426 % We must not have @c interpreted as a control sequence.
2427 \catcode`\@ = 12
2428 %
2429 % Make the letter c a comment character so that the rest of the line
2430 % will be ignored. This way, the document can have (for example)
2431 % @c @end ifinfo
2432 % and the @end ifinfo will be properly ignored.
2433 % (We've just changed @ to catcode 12.)
2434 \catcode`\c = 14
2435 %
2436 % And now expand that command.
2437 \doignoretext
2438}
2439
2440% What we do to finish off ignored text.
2441%
2442\def\enddoignore{\endgroup\ignorespaces}%
2443
2444\newif\ifwarnedobs\warnedobsfalse
2445\def\obstexwarn{%
2446 \ifwarnedobs\relax\else
2447 % We need to warn folks that they may have trouble with TeX 3.0.
2448 % This uses \immediate\write16 rather than \message to get newlines.
2449 \immediate\write16{}
2450 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2451 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2452 \immediate\write16{If you are running another version of TeX, relax.}
2453 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2454 \immediate\write16{ Then upgrade your TeX installation if you can.}
2455 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2456 \immediate\write16{If you are stuck with version 3.0, run the}
2457 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2458 \immediate\write16{ to use a workaround.}
2459 \immediate\write16{}
2460 \global\warnedobstrue
2461 \fi
2462}
2463
2464% **In TeX 3.0, setting text in \nullfont hangs tex. For a
2465% workaround (which requires the file ``dummy.tfm'' to be installed),
2466% uncomment the following line:
2467%%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2468
2469% Ignore text, except that we keep track of conditional commands for
2470% purposes of nesting, up to an `@end #1' command.
2471%
2472\def\nestedignore#1{%
2473 \obstexwarn
2474 % We must actually expand the ignored text to look for the @end
2475 % command, so that nested ignore constructs work. Thus, we put the
2476 % text into a \vbox and then do nothing with the result. To minimize
2477 % the change of memory overflow, we follow the approach outlined on
2478 % page 401 of the TeXbook: make the current font be a dummy font.
2479 %
2480 \setbox0 = \vbox\bgroup
2481 % Don't complain about control sequences we have declared \outer.
2482 \ignoresections
2483 %
2484 % Define `@end #1' to end the box, which will in turn undefine the
2485 % @end command again.
2486 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2487 %
2488 % We are going to be parsing Texinfo commands. Most cause no
2489 % trouble when they are used incorrectly, but some commands do
2490 % complicated argument parsing or otherwise get confused, so we
2491 % undefine them.
2492 %
2493 % We can't do anything about stray @-signs, unfortunately;
2494 % they'll produce `undefined control sequence' errors.
2495 \ignoremorecommands
2496 %
2497 % Set the current font to be \nullfont, a TeX primitive, and define
2498 % all the font commands to also use \nullfont. We don't use
2499 % dummy.tfm, as suggested in the TeXbook, because not all sites
2500 % might have that installed. Therefore, math mode will still
2501 % produce output, but that should be an extremely small amount of
2502 % stuff compared to the main input.
2503 %
2504 \nullfont
2505 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2506 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2507 \let\tensf=\nullfont
2508 % Similarly for index fonts.
2509 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2510 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2511 \let\smallsf=\nullfont
2512 % Similarly for smallexample fonts.
2513 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2514 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2515 \let\smallersf=\nullfont
2516 %
2517 % Don't complain when characters are missing from the fonts.
2518 \tracinglostchars = 0
2519 %
2520 % Don't bother to do space factor calculations.
2521 \frenchspacing
2522 %
2523 % Don't report underfull hboxes.
2524 \hbadness = 10000
2525 %
2526 % Do minimal line-breaking.
2527 \pretolerance = 10000
2528 %
2529 % Do not execute instructions in @tex
2530 \def\tex{\doignore{tex}}%
2531 % Do not execute macro definitions.
2532 % `c' is a comment character, so the word `macro' will get cut off.
2533 \def\macro{\doignore{ma}}%
2534}
2535
2536% @set VAR sets the variable VAR to an empty value.
2537% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2538%
2539% Since we want to separate VAR from REST-OF-LINE (which might be
2540% empty), we can't just use \parsearg; we have to insert a space of our
2541% own to delimit the rest of the line, and then take it out again if we
2542% didn't need it. Make sure the catcode of space is correct to avoid
2543% losing inside @example, for instance.
2544%
2545\def\set{\begingroup\catcode` =10
2546 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2547 \parsearg\setxxx}
2548\def\setxxx#1{\setyyy#1 \endsetyyy}
2549\def\setyyy#1 #2\endsetyyy{%
2550 \def\temp{#2}%
2551 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2552 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2553 \fi
2554 \endgroup
2555}
2556% Can't use \xdef to pre-expand #2 and save some time, since \temp or
2557% \next or other control sequences that we've defined might get us into
2558% an infinite loop. Consider `@set foo @cite{bar}'.
2559\def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2560
2561% @clear VAR clears (i.e., unsets) the variable VAR.
2562%
2563\def\clear{\parsearg\clearxxx}
2564\def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2565
2566% @value{foo} gets the text saved in variable foo.
2567{
2568 \catcode`\_ = \active
2569 %
2570 % We might end up with active _ or - characters in the argument if
2571 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2572 % such active characters to their normal equivalents.
2573 \gdef\value{\begingroup
2574 \catcode`\-=12 \catcode`\_=12
2575 \indexbreaks \let_\normalunderscore
2576 \valuexxx}
2577}
2578\def\valuexxx#1{\expandablevalue{#1}\endgroup}
2579
2580% We have this subroutine so that we can handle at least some @value's
2581% properly in indexes (we \let\value to this in \indexdummies). Ones
2582% whose names contain - or _ still won't work, but we can't do anything
2583% about that. The command has to be fully expandable, since the result
2584% winds up in the index file. This means that if the variable's value
2585% contains other Texinfo commands, it's almost certain it will fail
2586% (although perhaps we could fix that with sufficient work to do a
2587% one-level expansion on the result, instead of complete).
2588%
2589\def\expandablevalue#1{%
2590 \expandafter\ifx\csname SET#1\endcsname\relax
2591 {[No value for ``#1'']}%
2592 \else
2593 \csname SET#1\endcsname
2594 \fi
2595}
2596
2597% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2598% with @set.
2599%
2600\def\ifset{\parsearg\ifsetxxx}
2601\def\ifsetxxx #1{%
2602 \expandafter\ifx\csname SET#1\endcsname\relax
2603 \expandafter\ifsetfail
2604 \else
2605 \expandafter\ifsetsucceed
2606 \fi
2607}
2608\def\ifsetsucceed{\conditionalsucceed{ifset}}
2609\def\ifsetfail{\nestedignore{ifset}}
2610\defineunmatchedend{ifset}
2611
2612% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2613% defined with @set, or has been undefined with @clear.
2614%
2615\def\ifclear{\parsearg\ifclearxxx}
2616\def\ifclearxxx #1{%
2617 \expandafter\ifx\csname SET#1\endcsname\relax
2618 \expandafter\ifclearsucceed
2619 \else
2620 \expandafter\ifclearfail
2621 \fi
2622}
2623\def\ifclearsucceed{\conditionalsucceed{ifclear}}
2624\def\ifclearfail{\nestedignore{ifclear}}
2625\defineunmatchedend{ifclear}
2626
2627% @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
2628% following, through the first @end iftex (etc.). Make `@end iftex'
2629% (etc.) valid only after an @iftex.
2630%
2631\def\iftex{\conditionalsucceed{iftex}}
2632\def\ifnothtml{\conditionalsucceed{ifnothtml}}
2633\def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2634\defineunmatchedend{iftex}
2635\defineunmatchedend{ifnothtml}
2636\defineunmatchedend{ifnotinfo}
2637
2638% We can't just want to start a group at @iftex (for example) and end it
2639% at @end iftex, since then @set commands inside the conditional have no
2640% effect (they'd get reverted at the end of the group). So we must
2641% define \Eiftex to redefine itself to be its previous value. (We can't
2642% just define it to fail again with an ``unmatched end'' error, since
2643% the @ifset might be nested.)
2644%
2645\def\conditionalsucceed#1{%
2646 \edef\temp{%
2647 % Remember the current value of \E#1.
2648 \let\nece{prevE#1} = \nece{E#1}%
2649 %
2650 % At the `@end #1', redefine \E#1 to be its previous value.
2651 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2652 }%
2653 \temp
2654}
2655
2656% We need to expand lots of \csname's, but we don't want to expand the
2657% control sequences after we've constructed them.
2658%
2659\def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2660
2661% @defininfoenclose.
2662\let\definfoenclose=\comment
2663
2664
2665\message{indexing,}
2666% Index generation facilities
2667
2668% Define \newwrite to be identical to plain tex's \newwrite
2669% except not \outer, so it can be used within \newindex.
2670{\catcode`\@=11
2671\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2672
2673% \newindex {foo} defines an index named foo.
2674% It automatically defines \fooindex such that
2675% \fooindex ...rest of line... puts an entry in the index foo.
2676% It also defines \fooindfile to be the number of the output channel for
2677% the file that accumulates this index. The file's extension is foo.
2678% The name of an index should be no more than 2 characters long
2679% for the sake of vms.
2680%
2681\def\newindex#1{%
2682 \iflinks
2683 \expandafter\newwrite \csname#1indfile\endcsname
2684 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2685 \fi
2686 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2687 \noexpand\doindex{#1}}
2688}
2689
2690% @defindex foo == \newindex{foo}
2691%
2692\def\defindex{\parsearg\newindex}
2693
2694% Define @defcodeindex, like @defindex except put all entries in @code.
2695%
2696\def\defcodeindex{\parsearg\newcodeindex}
2697%
2698\def\newcodeindex#1{%
2699 \iflinks
2700 \expandafter\newwrite \csname#1indfile\endcsname
2701 \openout \csname#1indfile\endcsname \jobname.#1
2702 \fi
2703 \expandafter\xdef\csname#1index\endcsname{%
2704 \noexpand\docodeindex{#1}}%
2705}
2706
2707
2708% @synindex foo bar makes index foo feed into index bar.
2709% Do this instead of @defindex foo if you don't want it as a separate index.
2710%
2711% @syncodeindex foo bar similar, but put all entries made for index foo
2712% inside @code.
2713%
2714\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2715\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2716
2717% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2718% #3 the target index (bar).
2719\def\dosynindex#1#2#3{%
2720 % Only do \closeout if we haven't already done it, else we'll end up
2721 % closing the target index.
2722 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2723 % The \closeout helps reduce unnecessary open files; the limit on the
2724 % Acorn RISC OS is a mere 16 files.
2725 \expandafter\closeout\csname#2indfile\endcsname
2726 \expandafter\let\csname\donesynindex#2\endcsname = 1
2727 \fi
2728 % redefine \fooindfile:
2729 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2730 \expandafter\let\csname#2indfile\endcsname=\temp
2731 % redefine \fooindex:
2732 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2733}
2734
2735% Define \doindex, the driver for all \fooindex macros.
2736% Argument #1 is generated by the calling \fooindex macro,
2737% and it is "foo", the name of the index.
2738
2739% \doindex just uses \parsearg; it calls \doind for the actual work.
2740% This is because \doind is more useful to call from other macros.
2741
2742% There is also \dosubind {index}{topic}{subtopic}
2743% which makes an entry in a two-level index such as the operation index.
2744
2745\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2746\def\singleindexer #1{\doind{\indexname}{#1}}
2747
2748% like the previous two, but they put @code around the argument.
2749\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2750\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2751
2752\def\indexdummies{%
2753\def\ { }%
2754% Take care of the plain tex accent commands.
2755\def\"{\realbackslash "}%
2756\def\`{\realbackslash `}%
2757\def\'{\realbackslash '}%
2758\def\^{\realbackslash ^}%
2759\def\~{\realbackslash ~}%
2760\def\={\realbackslash =}%
2761\def\b{\realbackslash b}%
2762\def\c{\realbackslash c}%
2763\def\d{\realbackslash d}%
2764\def\u{\realbackslash u}%
2765\def\v{\realbackslash v}%
2766\def\H{\realbackslash H}%
2767% Take care of the plain tex special European modified letters.
2768\def\oe{\realbackslash oe}%
2769\def\ae{\realbackslash ae}%
2770\def\aa{\realbackslash aa}%
2771\def\OE{\realbackslash OE}%
2772\def\AE{\realbackslash AE}%
2773\def\AA{\realbackslash AA}%
2774\def\o{\realbackslash o}%
2775\def\O{\realbackslash O}%
2776\def\l{\realbackslash l}%
2777\def\L{\realbackslash L}%
2778\def\ss{\realbackslash ss}%
2779% Take care of texinfo commands likely to appear in an index entry.
2780% (Must be a way to avoid doing expansion at all, and thus not have to
2781% laboriously list every single command here.)
2782\def\@{@}% will be @@ when we switch to @ as escape char.
2783% Need these in case \tex is in effect and \{ is a \delimiter again.
2784% But can't use \lbracecmd and \rbracecmd because texindex assumes
2785% braces and backslashes are used only as delimiters.
2786\let\{ = \mylbrace
2787\let\} = \myrbrace
2788\def\_{{\realbackslash _}}%
2789\def\w{\realbackslash w }%
2790\def\bf{\realbackslash bf }%
2791%\def\rm{\realbackslash rm }%
2792\def\sl{\realbackslash sl }%
2793\def\sf{\realbackslash sf}%
2794\def\tt{\realbackslash tt}%
2795\def\gtr{\realbackslash gtr}%
2796\def\less{\realbackslash less}%
2797\def\hat{\realbackslash hat}%
2798\def\TeX{\realbackslash TeX}%
2799\def\dots{\realbackslash dots }%
2800\def\result{\realbackslash result}%
2801\def\equiv{\realbackslash equiv}%
2802\def\expansion{\realbackslash expansion}%
2803\def\print{\realbackslash print}%
2804\def\error{\realbackslash error}%
2805\def\point{\realbackslash point}%
2806\def\copyright{\realbackslash copyright}%
2807\def\tclose##1{\realbackslash tclose {##1}}%
2808\def\code##1{\realbackslash code {##1}}%
2809\def\uref##1{\realbackslash uref {##1}}%
2810\def\url##1{\realbackslash url {##1}}%
2811\def\env##1{\realbackslash env {##1}}%
2812\def\command##1{\realbackslash command {##1}}%
2813\def\option##1{\realbackslash option {##1}}%
2814\def\dotless##1{\realbackslash dotless {##1}}%
2815\def\samp##1{\realbackslash samp {##1}}%
2816\def\,##1{\realbackslash ,{##1}}%
2817\def\t##1{\realbackslash t {##1}}%
2818\def\r##1{\realbackslash r {##1}}%
2819\def\i##1{\realbackslash i {##1}}%
2820\def\b##1{\realbackslash b {##1}}%
2821\def\sc##1{\realbackslash sc {##1}}%
2822\def\cite##1{\realbackslash cite {##1}}%
2823\def\key##1{\realbackslash key {##1}}%
2824\def\file##1{\realbackslash file {##1}}%
2825\def\var##1{\realbackslash var {##1}}%
2826\def\kbd##1{\realbackslash kbd {##1}}%
2827\def\dfn##1{\realbackslash dfn {##1}}%
2828\def\emph##1{\realbackslash emph {##1}}%
2829\def\acronym##1{\realbackslash acronym {##1}}%
2830%
2831% Handle some cases of @value -- where the variable name does not
2832% contain - or _, and the value does not contain any
2833% (non-fully-expandable) commands.
2834\let\value = \expandablevalue
2835%
2836\unsepspaces
2837% Turn off macro expansion
2838\turnoffmacros
2839}
2840
2841% If an index command is used in an @example environment, any spaces
2842% therein should become regular spaces in the raw index file, not the
2843% expansion of \tie (\\leavevmode \penalty \@M \ ).
2844{\obeyspaces
2845 \gdef\unsepspaces{\obeyspaces\let =\space}}
2846
2847% \indexnofonts no-ops all font-change commands.
2848% This is used when outputting the strings to sort the index by.
2849\def\indexdummyfont#1{#1}
2850\def\indexdummytex{TeX}
2851\def\indexdummydots{...}
2852
2853\def\indexnofonts{%
2854% Just ignore accents.
2855\let\,=\indexdummyfont
2856\let\"=\indexdummyfont
2857\let\`=\indexdummyfont
2858\let\'=\indexdummyfont
2859\let\^=\indexdummyfont
2860\let\~=\indexdummyfont
2861\let\==\indexdummyfont
2862\let\b=\indexdummyfont
2863\let\c=\indexdummyfont
2864\let\d=\indexdummyfont
2865\let\u=\indexdummyfont
2866\let\v=\indexdummyfont
2867\let\H=\indexdummyfont
2868\let\dotless=\indexdummyfont
2869% Take care of the plain tex special European modified letters.
2870\def\oe{oe}%
2871\def\ae{ae}%
2872\def\aa{aa}%
2873\def\OE{OE}%
2874\def\AE{AE}%
2875\def\AA{AA}%
2876\def\o{o}%
2877\def\O{O}%
2878\def\l{l}%
2879\def\L{L}%
2880\def\ss{ss}%
2881\let\w=\indexdummyfont
2882\let\t=\indexdummyfont
2883\let\r=\indexdummyfont
2884\let\i=\indexdummyfont
2885\let\b=\indexdummyfont
2886\let\emph=\indexdummyfont
2887\let\strong=\indexdummyfont
2888\let\cite=\indexdummyfont
2889\let\sc=\indexdummyfont
2890%Don't no-op \tt, since it isn't a user-level command
2891% and is used in the definitions of the active chars like <, >, |...
2892%\let\tt=\indexdummyfont
2893\let\tclose=\indexdummyfont
2894\let\code=\indexdummyfont
2895\let\url=\indexdummyfont
2896\let\uref=\indexdummyfont
2897\let\env=\indexdummyfont
2898\let\acronym=\indexdummyfont
2899\let\command=\indexdummyfont
2900\let\option=\indexdummyfont
2901\let\file=\indexdummyfont
2902\let\samp=\indexdummyfont
2903\let\kbd=\indexdummyfont
2904\let\key=\indexdummyfont
2905\let\var=\indexdummyfont
2906\let\TeX=\indexdummytex
2907\let\dots=\indexdummydots
2908\def\@{@}%
2909}
2910
2911% To define \realbackslash, we must make \ not be an escape.
2912% We must first make another character (@) an escape
2913% so we do not become unable to do a definition.
2914
2915{\catcode`\@=0 \catcode`\\=\other
2916 @gdef@realbackslash{\}}
2917
2918\let\indexbackslash=0 %overridden during \printindex.
2919\let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2920
2921% For \ifx comparisons.
2922\def\emptymacro{\empty}
2923
2924% Most index entries go through here, but \dosubind is the general case.
2925%
2926\def\doind#1#2{\dosubind{#1}{#2}\empty}
2927
2928% Workhorse for all \fooindexes.
2929% #1 is name of index, #2 is stuff to put there, #3 is subentry --
2930% \empty if called from \doind, as we usually are. The main exception
2931% is with defuns, which call us directly.
2932%
2933\def\dosubind#1#2#3{%
2934 % Put the index entry in the margin if desired.
2935 \ifx\SETmarginindex\relax\else
2936 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2937 \fi
2938 {%
2939 \count255=\lastpenalty
2940 {%
2941 \indexdummies % Must do this here, since \bf, etc expand at this stage
2942 \escapechar=`\\
2943 {%
2944 \let\folio = 0% We will expand all macros now EXCEPT \folio.
2945 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2946 % so it will be output as is; and it will print as backslash.
2947 %
2948 \def\thirdarg{#3}%
2949 %
2950 % If third arg is present, precede it with space in sort key.
2951 \ifx\thirdarg\emptymacro
2952 \let\subentry = \empty
2953 \else
2954 \def\subentry{ #3}%
2955 \fi
2956 %
2957 % First process the index entry with all font commands turned
2958 % off to get the string to sort by.
2959 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
2960 %
2961 % Now the real index entry with the fonts.
2962 \toks0 = {#2}%
2963 %
2964 % If the third (subentry) arg is present, add it to the index
2965 % line to write.
2966 \ifx\thirdarg\emptymacro \else
2967 \toks0 = \expandafter{\the\toks0{#3}}%
2968 \fi
2969 %
2970 % Set up the complete index entry, with both the sort key and
2971 % the original text, including any font commands. We write
2972 % three arguments to \entry to the .?? file (four in the
2973 % subentry case), texindex reduces to two when writing the .??s
2974 % sorted result.
2975 \edef\temp{%
2976 \write\csname#1indfile\endcsname{%
2977 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2978 }%
2979 %
2980 % If a skip is the last thing on the list now, preserve it
2981 % by backing up by \lastskip, doing the \write, then inserting
2982 % the skip again. Otherwise, the whatsit generated by the
2983 % \write will make \lastskip zero. The result is that sequences
2984 % like this:
2985 % @end defun
2986 % @tindex whatever
2987 % @defun ...
2988 % will have extra space inserted, because the \medbreak in the
2989 % start of the @defun won't see the skip inserted by the @end of
2990 % the previous defun.
2991 %
2992 % But don't do any of this if we're not in vertical mode. We
2993 % don't want to do a \vskip and prematurely end a paragraph.
2994 %
2995 % Avoid page breaks due to these extra skips, too.
2996 %
2997 \iflinks
2998 \ifvmode
2999 \skip0 = \lastskip
3000 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
3001 \fi
3002 %
3003 \temp % do the write
3004 %
3005 %
3006 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3007 \fi
3008 }%
3009 }%
3010 \penalty\count255
3011 }%
3012}
3013
3014% The index entry written in the file actually looks like
3015% \entry {sortstring}{page}{topic}
3016% or
3017% \entry {sortstring}{page}{topic}{subtopic}
3018% The texindex program reads in these files and writes files
3019% containing these kinds of lines:
3020% \initial {c}
3021% before the first topic whose initial is c
3022% \entry {topic}{pagelist}
3023% for a topic that is used without subtopics
3024% \primary {topic}
3025% for the beginning of a topic that is used with subtopics
3026% \secondary {subtopic}{pagelist}
3027% for each subtopic.
3028
3029% Define the user-accessible indexing commands
3030% @findex, @vindex, @kindex, @cindex.
3031
3032\def\findex {\fnindex}
3033\def\kindex {\kyindex}
3034\def\cindex {\cpindex}
3035\def\vindex {\vrindex}
3036\def\tindex {\tpindex}
3037\def\pindex {\pgindex}
3038
3039\def\cindexsub {\begingroup\obeylines\cindexsub}
3040{\obeylines %
3041\gdef\cindexsub "#1" #2^^M{\endgroup %
3042\dosubind{cp}{#2}{#1}}}
3043
3044% Define the macros used in formatting output of the sorted index material.
3045
3046% @printindex causes a particular index (the ??s file) to get printed.
3047% It does not print any chapter heading (usually an @unnumbered).
3048%
3049\def\printindex{\parsearg\doprintindex}
3050\def\doprintindex#1{\begingroup
3051 \dobreak \chapheadingskip{10000}%
3052 %
3053 \smallfonts \rm
3054 \tolerance = 9500
3055 \indexbreaks
3056 %
3057 % See if the index file exists and is nonempty.
3058 % Change catcode of @ here so that if the index file contains
3059 % \initial {@}
3060 % as its first line, TeX doesn't complain about mismatched braces
3061 % (because it thinks @} is a control sequence).
3062 \catcode`\@ = 11
3063 \openin 1 \jobname.#1s
3064 \ifeof 1
3065 % \enddoublecolumns gets confused if there is no text in the index,
3066 % and it loses the chapter title and the aux file entries for the
3067 % index. The easiest way to prevent this problem is to make sure
3068 % there is some text.
3069 \putwordIndexNonexistent
3070 \else
3071 %
3072 % If the index file exists but is empty, then \openin leaves \ifeof
3073 % false. We have to make TeX try to read something from the file, so
3074 % it can discover if there is anything in it.
3075 \read 1 to \temp
3076 \ifeof 1
3077 \putwordIndexIsEmpty
3078 \else
3079 % Index files are almost Texinfo source, but we use \ as the escape
3080 % character. It would be better to use @, but that's too big a change
3081 % to make right now.
3082 \def\indexbackslash{\rawbackslashxx}%
3083 \catcode`\\ = 0
3084 \escapechar = `\\
3085 \begindoublecolumns
3086 \input \jobname.#1s
3087 \enddoublecolumns
3088 \fi
3089 \fi
3090 \closein 1
3091\endgroup}
3092
3093% These macros are used by the sorted index file itself.
3094% Change them to control the appearance of the index.
3095
3096\def\initial#1{{%
3097 % Some minor font changes for the special characters.
3098 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3099 %
3100 % Remove any glue we may have, we'll be inserting our own.
3101 \removelastskip
3102 %
3103 % We like breaks before the index initials, so insert a bonus.
3104 \penalty -300
3105 %
3106 % Typeset the initial. Making this add up to a whole number of
3107 % baselineskips increases the chance of the dots lining up from column
3108 % to column. It still won't often be perfect, because of the stretch
3109 % we need before each entry, but it's better.
3110 %
3111 % No shrink because it confuses \balancecolumns.
3112 \vskip 1.67\baselineskip plus .5\baselineskip
3113 \leftline{\secbf #1}%
3114 \vskip .33\baselineskip plus .1\baselineskip
3115 %
3116 % Do our best not to break after the initial.
3117 \nobreak
3118}}
3119
3120% This typesets a paragraph consisting of #1, dot leaders, and then #2
3121% flush to the right margin. It is used for index and table of contents
3122% entries. The paragraph is indented by \leftskip.
3123%
3124\def\entry#1#2{\begingroup
3125 %
3126 % Start a new paragraph if necessary, so our assignments below can't
3127 % affect previous text.
3128 \par
3129 %
3130 % Do not fill out the last line with white space.
3131 \parfillskip = 0in
3132 %
3133 % No extra space above this paragraph.
3134 \parskip = 0in
3135 %
3136 % Do not prefer a separate line ending with a hyphen to fewer lines.
3137 \finalhyphendemerits = 0
3138 %
3139 % \hangindent is only relevant when the entry text and page number
3140 % don't both fit on one line. In that case, bob suggests starting the
3141 % dots pretty far over on the line. Unfortunately, a large
3142 % indentation looks wrong when the entry text itself is broken across
3143 % lines. So we use a small indentation and put up with long leaders.
3144 %
3145 % \hangafter is reset to 1 (which is the value we want) at the start
3146 % of each paragraph, so we need not do anything with that.
3147 \hangindent = 2em
3148 %
3149 % When the entry text needs to be broken, just fill out the first line
3150 % with blank space.
3151 \rightskip = 0pt plus1fil
3152 %
3153 % A bit of stretch before each entry for the benefit of balancing columns.
3154 \vskip 0pt plus1pt
3155 %
3156 % Start a ``paragraph'' for the index entry so the line breaking
3157 % parameters we've set above will have an effect.
3158 \noindent
3159 %
3160 % Insert the text of the index entry. TeX will do line-breaking on it.
3161 #1%
3162 % The following is kludged to not output a line of dots in the index if
3163 % there are no page numbers. The next person who breaks this will be
3164 % cursed by a Unix daemon.
3165 \def\tempa{{\rm }}%
3166 \def\tempb{#2}%
3167 \edef\tempc{\tempa}%
3168 \edef\tempd{\tempb}%
3169 \ifx\tempc\tempd\ \else%
3170 %
3171 % If we must, put the page number on a line of its own, and fill out
3172 % this line with blank space. (The \hfil is overwhelmed with the
3173 % fill leaders glue in \indexdotfill if the page number does fit.)
3174 \hfil\penalty50
3175 \null\nobreak\indexdotfill % Have leaders before the page number.
3176 %
3177 % The `\ ' here is removed by the implicit \unskip that TeX does as
3178 % part of (the primitive) \par. Without it, a spurious underfull
3179 % \hbox ensues.
3180 \ifpdf
3181 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3182 \else
3183 \ #2% The page number ends the paragraph.
3184 \fi
3185 \fi%
3186 \par
3187\endgroup}
3188
3189% Like \dotfill except takes at least 1 em.
3190\def\indexdotfill{\cleaders
3191 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3192
3193\def\primary #1{\line{#1\hfil}}
3194
3195\newskip\secondaryindent \secondaryindent=0.5cm
3196\def\secondary#1#2{{%
3197 \parfillskip=0in
3198 \parskip=0in
3199 \hangindent=1in
3200 \hangafter=1
3201 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3202 \ifpdf
3203 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3204 \else
3205 #2
3206 \fi
3207 \par
3208}}
3209
3210% Define two-column mode, which we use to typeset indexes.
3211% Adapted from the TeXbook, page 416, which is to say,
3212% the manmac.tex format used to print the TeXbook itself.
3213\catcode`\@=11
3214
3215\newbox\partialpage
3216\newdimen\doublecolumnhsize
3217
3218\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3219 % Grab any single-column material above us.
3220 \output = {%
3221 %
3222 % Here is a possibility not foreseen in manmac: if we accumulate a
3223 % whole lot of material, we might end up calling this \output
3224 % routine twice in a row (see the doublecol-lose test, which is
3225 % essentially a couple of indexes with @setchapternewpage off). In
3226 % that case we just ship out what is in \partialpage with the normal
3227 % output routine. Generally, \partialpage will be empty when this
3228 % runs and this will be a no-op. See the indexspread.tex test case.
3229 \ifvoid\partialpage \else
3230 \onepageout{\pagecontents\partialpage}%
3231 \fi
3232 %
3233 \global\setbox\partialpage = \vbox{%
3234 % Unvbox the main output page.
3235 \unvbox\PAGE
3236 \kern-\topskip \kern\baselineskip
3237 }%
3238 }%
3239 \eject % run that output routine to set \partialpage
3240 %
3241 % Use the double-column output routine for subsequent pages.
3242 \output = {\doublecolumnout}%
3243 %
3244 % Change the page size parameters. We could do this once outside this
3245 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3246 % format, but then we repeat the same computation. Repeating a couple
3247 % of assignments once per index is clearly meaningless for the
3248 % execution time, so we may as well do it in one place.
3249 %
3250 % First we halve the line length, less a little for the gutter between
3251 % the columns. We compute the gutter based on the line length, so it
3252 % changes automatically with the paper format. The magic constant
3253 % below is chosen so that the gutter has the same value (well, +-<1pt)
3254 % as it did when we hard-coded it.
3255 %
3256 % We put the result in a separate register, \doublecolumhsize, so we
3257 % can restore it in \pagesofar, after \hsize itself has (potentially)
3258 % been clobbered.
3259 %
3260 \doublecolumnhsize = \hsize
3261 \advance\doublecolumnhsize by -.04154\hsize
3262 \divide\doublecolumnhsize by 2
3263 \hsize = \doublecolumnhsize
3264 %
3265 % Double the \vsize as well. (We don't need a separate register here,
3266 % since nobody clobbers \vsize.)
3267 \vsize = 2\vsize
3268}
3269
3270% The double-column output routine for all double-column pages except
3271% the last.
3272%
3273\def\doublecolumnout{%
3274 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3275 % Get the available space for the double columns -- the normal
3276 % (undoubled) page height minus any material left over from the
3277 % previous page.
3278 \dimen@ = \vsize
3279 \divide\dimen@ by 2
3280 \advance\dimen@ by -\ht\partialpage
3281 %
3282 % box0 will be the left-hand column, box2 the right.
3283 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3284 \onepageout\pagesofar
3285 \unvbox255
3286 \penalty\outputpenalty
3287}
3288%
3289% Re-output the contents of the output page -- any previous material,
3290% followed by the two boxes we just split, in box0 and box2.
3291\def\pagesofar{%
3292 \unvbox\partialpage
3293 %
3294 \hsize = \doublecolumnhsize
3295 \wd0=\hsize \wd2=\hsize
3296 \hbox to\pagewidth{\box0\hfil\box2}%
3297}
3298%
3299% All done with double columns.
3300\def\enddoublecolumns{%
3301 \output = {%
3302 % Split the last of the double-column material. Leave it on the
3303 % current page, no automatic page break.
3304 \balancecolumns
3305 %
3306 % If we end up splitting too much material for the current page,
3307 % though, there will be another page break right after this \output
3308 % invocation ends. Having called \balancecolumns once, we do not
3309 % want to call it again. Therefore, reset \output to its normal
3310 % definition right away. (We hope \balancecolumns will never be
3311 % called on to balance too much material, but if it is, this makes
3312 % the output somewhat more palatable.)
3313 \global\output = {\onepageout{\pagecontents\PAGE}}%
3314 }%
3315 \eject
3316 \endgroup % started in \begindoublecolumns
3317 %
3318 % \pagegoal was set to the doubled \vsize above, since we restarted
3319 % the current page. We're now back to normal single-column
3320 % typesetting, so reset \pagegoal to the normal \vsize (after the
3321 % \endgroup where \vsize got restored).
3322 \pagegoal = \vsize
3323}
3324%
3325% Called at the end of the double column material.
3326\def\balancecolumns{%
3327 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3328 \dimen@ = \ht0
3329 \advance\dimen@ by \topskip
3330 \advance\dimen@ by-\baselineskip
3331 \divide\dimen@ by 2 % target to split to
3332 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3333 \splittopskip = \topskip
3334 % Loop until we get a decent breakpoint.
3335 {%
3336 \vbadness = 10000
3337 \loop
3338 \global\setbox3 = \copy0
3339 \global\setbox1 = \vsplit3 to \dimen@
3340 \ifdim\ht3>\dimen@
3341 \global\advance\dimen@ by 1pt
3342 \repeat
3343 }%
3344 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3345 \setbox0=\vbox to\dimen@{\unvbox1}%
3346 \setbox2=\vbox to\dimen@{\unvbox3}%
3347 %
3348 \pagesofar
3349}
3350\catcode`\@ = \other
3351
3352
3353\message{sectioning,}
3354% Chapters, sections, etc.
3355
3356\newcount\chapno
3357\newcount\secno \secno=0
3358\newcount\subsecno \subsecno=0
3359\newcount\subsubsecno \subsubsecno=0
3360
3361% This counter is funny since it counts through charcodes of letters A, B, ...
3362\newcount\appendixno \appendixno = `\@
3363% \def\appendixletter{\char\the\appendixno}
3364% We do the following for the sake of pdftex, which needs the actual
3365% letter in the expansion, not just typeset.
3366\def\appendixletter{%
3367 \ifnum\appendixno=`A A%
3368 \else\ifnum\appendixno=`B B%
3369 \else\ifnum\appendixno=`C C%
3370 \else\ifnum\appendixno=`D D%
3371 \else\ifnum\appendixno=`E E%
3372 \else\ifnum\appendixno=`F F%
3373 \else\ifnum\appendixno=`G G%
3374 \else\ifnum\appendixno=`H H%
3375 \else\ifnum\appendixno=`I I%
3376 \else\ifnum\appendixno=`J J%
3377 \else\ifnum\appendixno=`K K%
3378 \else\ifnum\appendixno=`L L%
3379 \else\ifnum\appendixno=`M M%
3380 \else\ifnum\appendixno=`N N%
3381 \else\ifnum\appendixno=`O O%
3382 \else\ifnum\appendixno=`P P%
3383 \else\ifnum\appendixno=`Q Q%
3384 \else\ifnum\appendixno=`R R%
3385 \else\ifnum\appendixno=`S S%
3386 \else\ifnum\appendixno=`T T%
3387 \else\ifnum\appendixno=`U U%
3388 \else\ifnum\appendixno=`V V%
3389 \else\ifnum\appendixno=`W W%
3390 \else\ifnum\appendixno=`X X%
3391 \else\ifnum\appendixno=`Y Y%
3392 \else\ifnum\appendixno=`Z Z%
3393 % The \the is necessary, despite appearances, because \appendixletter is
3394 % expanded while writing the .toc file. \char\appendixno is not
3395 % expandable, thus it is written literally, thus all appendixes come out
3396 % with the same letter (or @) in the toc without it.
3397 \else\char\the\appendixno
3398 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3399 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3400
3401% Each @chapter defines this as the name of the chapter.
3402% page headings and footings can use it. @section does likewise.
3403\def\thischapter{}
3404\def\thissection{}
3405
3406\newcount\absseclevel % used to calculate proper heading level
3407\newcount\secbase\secbase=0 % @raise/lowersections modify this count
3408
3409% @raisesections: treat @section as chapter, @subsection as section, etc.
3410\def\raisesections{\global\advance\secbase by -1}
3411\let\up=\raisesections % original BFox name
3412
3413% @lowersections: treat @chapter as section, @section as subsection, etc.
3414\def\lowersections{\global\advance\secbase by 1}
3415\let\down=\lowersections % original BFox name
3416
3417% Choose a numbered-heading macro
3418% #1 is heading level if unmodified by @raisesections or @lowersections
3419% #2 is text for heading
3420\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3421\ifcase\absseclevel
3422 \chapterzzz{#2}
3423\or
3424 \seczzz{#2}
3425\or
3426 \numberedsubseczzz{#2}
3427\or
3428 \numberedsubsubseczzz{#2}
3429\else
3430 \ifnum \absseclevel<0
3431 \chapterzzz{#2}
3432 \else
3433 \numberedsubsubseczzz{#2}
3434 \fi
3435\fi
3436}
3437
3438% like \numhead, but chooses appendix heading levels
3439\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3440\ifcase\absseclevel
3441 \appendixzzz{#2}
3442\or
3443 \appendixsectionzzz{#2}
3444\or
3445 \appendixsubseczzz{#2}
3446\or
3447 \appendixsubsubseczzz{#2}
3448\else
3449 \ifnum \absseclevel<0
3450 \appendixzzz{#2}
3451 \else
3452 \appendixsubsubseczzz{#2}
3453 \fi
3454\fi
3455}
3456
3457% like \numhead, but chooses numberless heading levels
3458\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3459\ifcase\absseclevel
3460 \unnumberedzzz{#2}
3461\or
3462 \unnumberedseczzz{#2}
3463\or
3464 \unnumberedsubseczzz{#2}
3465\or
3466 \unnumberedsubsubseczzz{#2}
3467\else
3468 \ifnum \absseclevel<0
3469 \unnumberedzzz{#2}
3470 \else
3471 \unnumberedsubsubseczzz{#2}
3472 \fi
3473\fi
3474}
3475
3476% @chapter, @appendix, @unnumbered.
3477\def\thischaptername{No Chapter Title}
3478\outer\def\chapter{\parsearg\chapteryyy}
3479\def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3480\def\chapterzzz #1{%
3481\secno=0 \subsecno=0 \subsubsecno=0
3482\global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3483\chapmacro {#1}{\the\chapno}%
3484\gdef\thissection{#1}%
3485\gdef\thischaptername{#1}%
3486% We don't substitute the actual chapter name into \thischapter
3487% because we don't want its macros evaluated now.
3488\xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3489\toks0 = {#1}%
3490\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3491 {\the\chapno}}}%
3492\temp
3493\donoderef
3494\global\let\section = \numberedsec
3495\global\let\subsection = \numberedsubsec
3496\global\let\subsubsection = \numberedsubsubsec
3497}
3498
3499\outer\def\appendix{\parsearg\appendixyyy}
3500\def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3501\def\appendixzzz #1{%
3502\secno=0 \subsecno=0 \subsubsecno=0
3503\global\advance \appendixno by 1
3504\message{\putwordAppendix\space \appendixletter}%
3505\chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3506\gdef\thissection{#1}%
3507\gdef\thischaptername{#1}%
3508\xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3509\toks0 = {#1}%
3510\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3511 {\putwordAppendix{} \appendixletter}}}%
3512\temp
3513\appendixnoderef
3514\global\let\section = \appendixsec
3515\global\let\subsection = \appendixsubsec
3516\global\let\subsubsection = \appendixsubsubsec
3517}
3518
3519% @centerchap is like @unnumbered, but the heading is centered.
3520\outer\def\centerchap{\parsearg\centerchapyyy}
3521\def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3522
3523% @top is like @unnumbered.
3524\outer\def\top{\parsearg\unnumberedyyy}
3525
3526\outer\def\unnumbered{\parsearg\unnumberedyyy}
3527\def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3528\def\unnumberedzzz #1{%
3529\secno=0 \subsecno=0 \subsubsecno=0
3530%
3531% This used to be simply \message{#1}, but TeX fully expands the
3532% argument to \message. Therefore, if #1 contained @-commands, TeX
3533% expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3534% expanded @cite (which turns out to cause errors because \cite is meant
3535% to be executed, not expanded).
3536%
3537% Anyway, we don't want the fully-expanded definition of @cite to appear
3538% as a result of the \message, we just want `@cite' itself. We use
3539% \the<toks register> to achieve this: TeX expands \the<toks> only once,
3540% simply yielding the contents of <toks register>. (We also do this for
3541% the toc entries.)
3542\toks0 = {#1}\message{(\the\toks0)}%
3543%
3544\unnumbchapmacro {#1}%
3545\gdef\thischapter{#1}\gdef\thissection{#1}%
3546\toks0 = {#1}%
3547\edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3548\temp
3549\unnumbnoderef
3550\global\let\section = \unnumberedsec
3551\global\let\subsection = \unnumberedsubsec
3552\global\let\subsubsection = \unnumberedsubsubsec
3553}
3554
3555% Sections.
3556\outer\def\numberedsec{\parsearg\secyyy}
3557\def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3558\def\seczzz #1{%
3559\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3560\gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3561\toks0 = {#1}%
3562\edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3563 {\the\chapno}{\the\secno}}}%
3564\temp
3565\donoderef
3566\nobreak
3567}
3568
3569\outer\def\appendixsection{\parsearg\appendixsecyyy}
3570\outer\def\appendixsec{\parsearg\appendixsecyyy}
3571\def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3572\def\appendixsectionzzz #1{%
3573\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3574\gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3575\toks0 = {#1}%
3576\edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3577 {\appendixletter}{\the\secno}}}%
3578\temp
3579\appendixnoderef
3580\nobreak
3581}
3582
3583\outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3584\def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3585\def\unnumberedseczzz #1{%
3586\plainsecheading {#1}\gdef\thissection{#1}%
3587\toks0 = {#1}%
3588\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}%
3589\temp
3590\unnumbnoderef
3591\nobreak
3592}
3593
3594% Subsections.
3595\outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3596\def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3597\def\numberedsubseczzz #1{%
3598\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3599\subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3600\toks0 = {#1}%
3601\edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3602 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3603\temp
3604\donoderef
3605\nobreak
3606}
3607
3608\outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3609\def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3610\def\appendixsubseczzz #1{%
3611\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3612\subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3613\toks0 = {#1}%
3614\edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3615 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3616\temp
3617\appendixnoderef
3618\nobreak
3619}
3620
3621\outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3622\def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3623\def\unnumberedsubseczzz #1{%
3624\plainsubsecheading {#1}\gdef\thissection{#1}%
3625\toks0 = {#1}%
3626\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3627 {\the\toks0}}}%
3628\temp
3629\unnumbnoderef
3630\nobreak
3631}
3632
3633% Subsubsections.
3634\outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3635\def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3636\def\numberedsubsubseczzz #1{%
3637\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3638\subsubsecheading {#1}
3639 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3640\toks0 = {#1}%
3641\edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3642 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3643\temp
3644\donoderef
3645\nobreak
3646}
3647
3648\outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3649\def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3650\def\appendixsubsubseczzz #1{%
3651\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3652\subsubsecheading {#1}
3653 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3654\toks0 = {#1}%
3655\edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3656 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3657\temp
3658\appendixnoderef
3659\nobreak
3660}
3661
3662\outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3663\def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3664\def\unnumberedsubsubseczzz #1{%
3665\plainsubsubsecheading {#1}\gdef\thissection{#1}%
3666\toks0 = {#1}%
3667\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3668 {\the\toks0}}}%
3669\temp
3670\unnumbnoderef
3671\nobreak
3672}
3673
3674% These are variants which are not "outer", so they can appear in @ifinfo.
3675% Actually, they should now be obsolete; ordinary section commands should work.
3676\def\infotop{\parsearg\unnumberedzzz}
3677\def\infounnumbered{\parsearg\unnumberedzzz}
3678\def\infounnumberedsec{\parsearg\unnumberedseczzz}
3679\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3680\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3681
3682\def\infoappendix{\parsearg\appendixzzz}
3683\def\infoappendixsec{\parsearg\appendixseczzz}
3684\def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3685\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3686
3687\def\infochapter{\parsearg\chapterzzz}
3688\def\infosection{\parsearg\sectionzzz}
3689\def\infosubsection{\parsearg\subsectionzzz}
3690\def\infosubsubsection{\parsearg\subsubsectionzzz}
3691
3692% These macros control what the section commands do, according
3693% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3694% Define them by default for a numbered chapter.
3695\global\let\section = \numberedsec
3696\global\let\subsection = \numberedsubsec
3697\global\let\subsubsection = \numberedsubsubsec
3698
3699% Define @majorheading, @heading and @subheading
3700
3701% NOTE on use of \vbox for chapter headings, section headings, and such:
3702% 1) We use \vbox rather than the earlier \line to permit
3703% overlong headings to fold.
3704% 2) \hyphenpenalty is set to 10000 because hyphenation in a
3705% heading is obnoxious; this forbids it.
3706% 3) Likewise, headings look best if no \parindent is used, and
3707% if justification is not attempted. Hence \raggedright.
3708
3709
3710\def\majorheading{\parsearg\majorheadingzzz}
3711\def\majorheadingzzz #1{%
3712{\advance\chapheadingskip by 10pt \chapbreak }%
3713{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3714 \parindent=0pt\raggedright
3715 \rm #1\hfill}}\bigskip \par\penalty 200}
3716
3717\def\chapheading{\parsearg\chapheadingzzz}
3718\def\chapheadingzzz #1{\chapbreak %
3719{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3720 \parindent=0pt\raggedright
3721 \rm #1\hfill}}\bigskip \par\penalty 200}
3722
3723% @heading, @subheading, @subsubheading.
3724\def\heading{\parsearg\plainsecheading}
3725\def\subheading{\parsearg\plainsubsecheading}
3726\def\subsubheading{\parsearg\plainsubsubsecheading}
3727
3728% These macros generate a chapter, section, etc. heading only
3729% (including whitespace, linebreaking, etc. around it),
3730% given all the information in convenient, parsed form.
3731
3732%%% Args are the skip and penalty (usually negative)
3733\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3734
3735\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3736
3737%%% Define plain chapter starts, and page on/off switching for it
3738% Parameter controlling skip before chapter headings (if needed)
3739
3740\newskip\chapheadingskip
3741
3742\def\chapbreak{\dobreak \chapheadingskip {-4000}}
3743\def\chappager{\par\vfill\supereject}
3744\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3745
3746\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3747
3748\def\CHAPPAGoff{%
3749\global\let\contentsalignmacro = \chappager
3750\global\let\pchapsepmacro=\chapbreak
3751\global\let\pagealignmacro=\chappager}
3752
3753\def\CHAPPAGon{%
3754\global\let\contentsalignmacro = \chappager
3755\global\let\pchapsepmacro=\chappager
3756\global\let\pagealignmacro=\chappager
3757\global\def\HEADINGSon{\HEADINGSsingle}}
3758
3759\def\CHAPPAGodd{
3760\global\let\contentsalignmacro = \chapoddpage
3761\global\let\pchapsepmacro=\chapoddpage
3762\global\let\pagealignmacro=\chapoddpage
3763\global\def\HEADINGSon{\HEADINGSdouble}}
3764
3765\CHAPPAGon
3766
3767\def\CHAPFplain{
3768\global\let\chapmacro=\chfplain
3769\global\let\unnumbchapmacro=\unnchfplain
3770\global\let\centerchapmacro=\centerchfplain}
3771
3772% Plain chapter opening.
3773% #1 is the text, #2 the chapter number or empty if unnumbered.
3774\def\chfplain#1#2{%
3775 \pchapsepmacro
3776 {%
3777 \chapfonts \rm
3778 \def\chapnum{#2}%
3779 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3780 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3781 \hangindent = \wd0 \centerparametersmaybe
3782 \unhbox0 #1\par}%
3783 }%
3784 \nobreak\bigskip % no page break after a chapter title
3785 \nobreak
3786}
3787
3788% Plain opening for unnumbered.
3789\def\unnchfplain#1{\chfplain{#1}{}}
3790
3791% @centerchap -- centered and unnumbered.
3792\let\centerparametersmaybe = \relax
3793\def\centerchfplain#1{{%
3794 \def\centerparametersmaybe{%
3795 \advance\rightskip by 3\rightskip
3796 \leftskip = \rightskip
3797 \parfillskip = 0pt
3798 }%
3799 \chfplain{#1}{}%
3800}}
3801
3802\CHAPFplain % The default
3803
3804\def\unnchfopen #1{%
3805\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3806 \parindent=0pt\raggedright
3807 \rm #1\hfill}}\bigskip \par\nobreak
3808}
3809
3810\def\chfopen #1#2{\chapoddpage {\chapfonts
3811\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3812\par\penalty 5000 %
3813}
3814
3815\def\centerchfopen #1{%
3816\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3817 \parindent=0pt
3818 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3819}
3820
3821\def\CHAPFopen{
3822\global\let\chapmacro=\chfopen
3823\global\let\unnumbchapmacro=\unnchfopen
3824\global\let\centerchapmacro=\centerchfopen}
3825
3826
3827% Section titles.
3828\newskip\secheadingskip
3829\def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3830\def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3831\def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3832
3833% Subsection titles.
3834\newskip \subsecheadingskip
3835\def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3836\def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3837\def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3838
3839% Subsubsection titles.
3840\let\subsubsecheadingskip = \subsecheadingskip
3841\let\subsubsecheadingbreak = \subsecheadingbreak
3842\def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3843\def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3844
3845
3846% Print any size section title.
3847%
3848% #1 is the section type (sec/subsec/subsubsec), #2 is the section
3849% number (maybe empty), #3 the text.
3850\def\sectionheading#1#2#3{%
3851 {%
3852 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3853 \csname #1headingbreak\endcsname
3854 }%
3855 {%
3856 % Switch to the right set of fonts.
3857 \csname #1fonts\endcsname \rm
3858 %
3859 % Only insert the separating space if we have a section number.
3860 \def\secnum{#2}%
3861 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3862 %
3863 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3864 \hangindent = \wd0 % zero if no section number
3865 \unhbox0 #3}%
3866 }%
3867 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3868}
3869
3870
3871\message{toc,}
3872% Table of contents.
3873\newwrite\tocfile
3874
3875% Write an entry to the toc file, opening it if necessary.
3876% Called from @chapter, etc. We supply {\folio} at the end of the
3877% argument, which will end up as the last argument to the \...entry macro.
3878%
3879% We open the .toc file here instead of at @setfilename or any other
3880% given time so that @contents can be put in the document anywhere.
3881%
3882\newif\iftocfileopened
3883\def\writetocentry#1{%
3884 \iftocfileopened\else
3885 \immediate\openout\tocfile = \jobname.toc
3886 \global\tocfileopenedtrue
3887 \fi
3888 \iflinks \write\tocfile{#1{\folio}}\fi
3889}
3890
3891\newskip\contentsrightmargin \contentsrightmargin=1in
3892\newcount\savepageno
3893\newcount\lastnegativepageno \lastnegativepageno = -1
3894
3895% Finish up the main text and prepare to read what we've written
3896% to \tocfile.
3897%
3898\def\startcontents#1{%
3899 % If @setchapternewpage on, and @headings double, the contents should
3900 % start on an odd page, unlike chapters. Thus, we maintain
3901 % \contentsalignmacro in parallel with \pagealignmacro.
3902 % From: Torbjorn Granlund <tege@matematik.su.se>
3903 \contentsalignmacro
3904 \immediate\closeout\tocfile
3905 %
3906 % Don't need to put `Contents' or `Short Contents' in the headline.
3907 % It is abundantly clear what they are.
3908 \unnumbchapmacro{#1}\def\thischapter{}%
3909 \savepageno = \pageno
3910 \begingroup % Set up to handle contents files properly.
3911 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3912 % We can't do this, because then an actual ^ in a section
3913 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3914 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3915 \raggedbottom % Worry more about breakpoints than the bottom.
3916 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3917 %
3918 % Roman numerals for page numbers.
3919 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3920}
3921
3922
3923% Normal (long) toc.
3924\def\contents{%
3925 \startcontents{\putwordTOC}%
3926 \openin 1 \jobname.toc
3927 \ifeof 1 \else
3928 \closein 1
3929 \input \jobname.toc
3930 \fi
3931 \vfill \eject
3932 \contentsalignmacro % in case @setchapternewpage odd is in effect
3933 \pdfmakeoutlines
3934 \endgroup
3935 \lastnegativepageno = \pageno
3936 \pageno = \savepageno
3937}
3938
3939% And just the chapters.
3940\def\summarycontents{%
3941 \startcontents{\putwordShortTOC}%
3942 %
3943 \let\chapentry = \shortchapentry
3944 \let\unnumbchapentry = \shortunnumberedentry
3945 % We want a true roman here for the page numbers.
3946 \secfonts
3947 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3948 \rm
3949 \hyphenpenalty = 10000
3950 \advance\baselineskip by 1pt % Open it up a little.
3951 \def\secentry ##1##2##3##4{}
3952 \def\unnumbsecentry ##1##2{}
3953 \def\subsecentry ##1##2##3##4##5{}
3954 \def\unnumbsubsecentry ##1##2{}
3955 \def\subsubsecentry ##1##2##3##4##5##6{}
3956 \def\unnumbsubsubsecentry ##1##2{}
3957 \openin 1 \jobname.toc
3958 \ifeof 1 \else
3959 \closein 1
3960 \input \jobname.toc
3961 \fi
3962 \vfill \eject
3963 \contentsalignmacro % in case @setchapternewpage odd is in effect
3964 \endgroup
3965 \lastnegativepageno = \pageno
3966 \pageno = \savepageno
3967}
3968\let\shortcontents = \summarycontents
3969
3970\ifpdf
3971 \pdfcatalog{/PageMode /UseOutlines}%
3972\fi
3973
3974% These macros generate individual entries in the table of contents.
3975% The first argument is the chapter or section name.
3976% The last argument is the page number.
3977% The arguments in between are the chapter number, section number, ...
3978
3979% Chapter-level things, for both the long and short contents.
3980\def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3981
3982% See comments in \dochapentry re vbox and related settings
3983\def\shortchapentry#1#2#3{%
3984 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
3985}
3986
3987% Typeset the label for a chapter or appendix for the short contents.
3988% The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3989% We could simplify the code here by writing out an \appendixentry
3990% command in the toc file for appendices, instead of using \chapentry
3991% for both, but it doesn't seem worth it.
3992%
3993\newdimen\shortappendixwidth
3994%
3995\def\shortchaplabel#1{%
3996 % Compute width of word "Appendix", may change with language.
3997 \setbox0 = \hbox{\shortcontrm \putwordAppendix}%
3998 \shortappendixwidth = \wd0
3999 %
4000 % We typeset #1 in a box of constant width, regardless of the text of
4001 % #1, so the chapter titles will come out aligned.
4002 \setbox0 = \hbox{#1}%
4003 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
4004 %
4005 % This space should be plenty, since a single number is .5em, and the
4006 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4007 % (This space doesn't include the extra space that gets added after
4008 % the label; that gets put in by \shortchapentry above.)
4009 \advance\dimen0 by 1.1em
4010 \hbox to \dimen0{#1\hfil}%
4011}
4012
4013\def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
4014\def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
4015
4016% Sections.
4017\def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4018\def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
4019
4020% Subsections.
4021\def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4022\def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
4023
4024% And subsubsections.
4025\def\subsubsecentry#1#2#3#4#5#6{%
4026 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4027\def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
4028
4029% This parameter controls the indentation of the various levels.
4030\newdimen\tocindent \tocindent = 3pc
4031
4032% Now for the actual typesetting. In all these, #1 is the text and #2 is the
4033% page number.
4034%
4035% If the toc has to be broken over pages, we want it to be at chapters
4036% if at all possible; hence the \penalty.
4037\def\dochapentry#1#2{%
4038 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4039 \begingroup
4040 \chapentryfonts
4041 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4042 \endgroup
4043 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4044}
4045
4046\def\dosecentry#1#2{\begingroup
4047 \secentryfonts \leftskip=\tocindent
4048 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4049\endgroup}
4050
4051\def\dosubsecentry#1#2{\begingroup
4052 \subsecentryfonts \leftskip=2\tocindent
4053 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4054\endgroup}
4055
4056\def\dosubsubsecentry#1#2{\begingroup
4057 \subsubsecentryfonts \leftskip=3\tocindent
4058 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4059\endgroup}
4060
4061% Final typesetting of a toc entry; we use the same \entry macro as for
4062% the index entries, but we want to suppress hyphenation here. (We
4063% can't do that in the \entry macro, since index entries might consist
4064% of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4065\def\tocentry#1#2{\begingroup
4066 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4067 % Do not use \turnoffactive in these arguments. Since the toc is
4068 % typeset in cmr, so characters such as _ would come out wrong; we
4069 % have to do the usual translation tricks.
4070 \entry{#1}{#2}%
4071\endgroup}
4072
4073% Space between chapter (or whatever) number and the title.
4074\def\labelspace{\hskip1em \relax}
4075
4076\def\dopageno#1{{\rm #1}}
4077\def\doshortpageno#1{{\rm #1}}
4078
4079\def\chapentryfonts{\secfonts \rm}
4080\def\secentryfonts{\textfonts}
4081\let\subsecentryfonts = \textfonts
4082\let\subsubsecentryfonts = \textfonts
4083
4084
4085\message{environments,}
4086% @foo ... @end foo.
4087
4088% Since these characters are used in examples, it should be an even number of
4089% \tt widths. Each \tt character is 1en, so two makes it 1em.
4090% Furthermore, these definitions must come after we define our fonts.
4091\newbox\dblarrowbox \newbox\longdblarrowbox
4092\newbox\pushcharbox \newbox\bullbox
4093\newbox\equivbox \newbox\errorbox
4094
4095%{\tentt
4096%\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
4097%\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
4098%\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
4099%\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
4100% Adapted from the manmac format (p.420 of TeXbook)
4101%\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
4102% depth .1ex\hfil}
4103%}
4104
4105% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4106\def\point{$\star$}
4107\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4108\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4109\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4110\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4111
4112% Adapted from the TeXbook's \boxit.
4113{\tentt \global\dimen0 = 3em}% Width of the box.
4114\dimen2 = .55pt % Thickness of rules
4115% The text. (`r' is open on the right, `e' somewhat less so on the left.)
4116\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4117
4118\global\setbox\errorbox=\hbox to \dimen0{\hfil
4119 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4120 \advance\hsize by -2\dimen2 % Rules.
4121 \vbox{
4122 \hrule height\dimen2
4123 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4124 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4125 \kern3pt\vrule width\dimen2}% Space to right.
4126 \hrule height\dimen2}
4127 \hfil}
4128
4129% The @error{} command.
4130\def\error{\leavevmode\lower.7ex\copy\errorbox}
4131
4132% @tex ... @end tex escapes into raw Tex temporarily.
4133% One exception: @ is still an escape character, so that @end tex works.
4134% But \@ or @@ will get a plain tex @ character.
4135
4136\def\tex{\begingroup
4137 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4138 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4139 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4140 \catcode `\%=14
4141 \catcode 43=12 % plus
4142 \catcode`\"=12
4143 \catcode`\==12
4144 \catcode`\|=12
4145 \catcode`\<=12
4146 \catcode`\>=12
4147 \escapechar=`\\
4148 %
4149 \let\b=\ptexb
4150 \let\bullet=\ptexbullet
4151 \let\c=\ptexc
4152 \let\,=\ptexcomma
4153 \let\.=\ptexdot
4154 \let\dots=\ptexdots
4155 \let\equiv=\ptexequiv
4156 \let\!=\ptexexclam
4157 \let\i=\ptexi
4158 \let\{=\ptexlbrace
4159 \let\+=\tabalign
4160 \let\}=\ptexrbrace
4161 \let\*=\ptexstar
4162 \let\t=\ptext
4163 %
4164 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4165 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4166 \def\@{@}%
4167\let\Etex=\endgroup}
4168
4169% Define @lisp ... @endlisp.
4170% @lisp does a \begingroup so it can rebind things,
4171% including the definition of @endlisp (which normally is erroneous).
4172
4173% Amount to narrow the margins by for @lisp.
4174\newskip\lispnarrowing \lispnarrowing=0.4in
4175
4176% This is the definition that ^^M gets inside @lisp, @example, and other
4177% such environments. \null is better than a space, since it doesn't
4178% have any width.
4179\def\lisppar{\null\endgraf}
4180
4181% Make each space character in the input produce a normal interword
4182% space in the output. Don't allow a line break at this space, as this
4183% is used only in environments like @example, where each line of input
4184% should produce a line of output anyway.
4185%
4186{\obeyspaces %
4187\gdef\sepspaces{\obeyspaces\let =\tie}}
4188
4189% Define \obeyedspace to be our active space, whatever it is. This is
4190% for use in \parsearg.
4191{\sepspaces%
4192\global\let\obeyedspace= }
4193
4194% This space is always present above and below environments.
4195\newskip\envskipamount \envskipamount = 0pt
4196
4197% Make spacing and below environment symmetrical. We use \parskip here
4198% to help in doing that, since in @example-like environments \parskip
4199% is reset to zero; thus the \afterenvbreak inserts no space -- but the
4200% start of the next paragraph will insert \parskip
4201%
4202\def\aboveenvbreak{{%
4203 \ifnum\lastpenalty < 10000
4204 \advance\envskipamount by \parskip
4205 \endgraf
4206 \ifdim\lastskip<\envskipamount
4207 \removelastskip
4208 \penalty-50
4209 \vskip\envskipamount
4210 \fi
4211 \fi
4212}}
4213
4214\let\afterenvbreak = \aboveenvbreak
4215
4216% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4217\let\nonarrowing=\relax
4218
4219% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4220% environment contents.
4221\font\circle=lcircle10
4222\newdimen\circthick
4223\newdimen\cartouter\newdimen\cartinner
4224\newskip\normbskip\newskip\normpskip\newskip\normlskip
4225\circthick=\fontdimen8\circle
4226%
4227\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4228\def\ctr{{\hskip 6pt\circle\char'010}}
4229\def\cbl{{\circle\char'012\hskip -6pt}}
4230\def\cbr{{\hskip 6pt\circle\char'011}}
4231\def\carttop{\hbox to \cartouter{\hskip\lskip
4232 \ctl\leaders\hrule height\circthick\hfil\ctr
4233 \hskip\rskip}}
4234\def\cartbot{\hbox to \cartouter{\hskip\lskip
4235 \cbl\leaders\hrule height\circthick\hfil\cbr
4236 \hskip\rskip}}
4237%
4238\newskip\lskip\newskip\rskip
4239
4240\long\def\cartouche{%
4241\begingroup
4242 \lskip=\leftskip \rskip=\rightskip
4243 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4244 \cartinner=\hsize \advance\cartinner by-\lskip
4245 \advance\cartinner by-\rskip
4246 \cartouter=\hsize
4247 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4248% side, and for 6pt waste from
4249% each corner char, and rule thickness
4250 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4251 % Flag to tell @lisp, etc., not to narrow margin.
4252 \let\nonarrowing=\comment
4253 \vbox\bgroup
4254 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4255 \carttop
4256 \hbox\bgroup
4257 \hskip\lskip
4258 \vrule\kern3pt
4259 \vbox\bgroup
4260 \hsize=\cartinner
4261 \kern3pt
4262 \begingroup
4263 \baselineskip=\normbskip
4264 \lineskip=\normlskip
4265 \parskip=\normpskip
4266 \vskip -\parskip
4267\def\Ecartouche{%
4268 \endgroup
4269 \kern3pt
4270 \egroup
4271 \kern3pt\vrule
4272 \hskip\rskip
4273 \egroup
4274 \cartbot
4275 \egroup
4276\endgroup
4277}}
4278
4279
4280% This macro is called at the beginning of all the @example variants,
4281% inside a group.
4282\def\nonfillstart{%
4283 \aboveenvbreak
4284 \inENV % This group ends at the end of the body
4285 \hfuzz = 12pt % Don't be fussy
4286 \sepspaces % Make spaces be word-separators rather than space tokens.
4287 \singlespace
4288 \let\par = \lisppar % don't ignore blank lines
4289 \obeylines % each line of input is a line of output
4290 \parskip = 0pt
4291 \parindent = 0pt
4292 \emergencystretch = 0pt % don't try to avoid overfull boxes
4293 % @cartouche defines \nonarrowing to inhibit narrowing
4294 % at next level down.
4295 \ifx\nonarrowing\relax
4296 \advance \leftskip by \lispnarrowing
4297 \exdentamount=\lispnarrowing
4298 \let\exdent=\nofillexdent
4299 \let\nonarrowing=\relax
4300 \fi
4301}
4302
4303% Define the \E... control sequence only if we are inside the particular
4304% environment, so the error checking in \end will work.
4305%
4306% To end an @example-like environment, we first end the paragraph (via
4307% \afterenvbreak's vertical glue), and then the group. That way we keep
4308% the zero \parskip that the environments set -- \parskip glue will be
4309% inserted at the beginning of the next paragraph in the document, after
4310% the environment.
4311%
4312\def\nonfillfinish{\afterenvbreak\endgroup}
4313
4314% @lisp: indented, narrowed, typewriter font.
4315\def\lisp{\begingroup
4316 \nonfillstart
4317 \let\Elisp = \nonfillfinish
4318 \tt
4319 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4320 \gobble % eat return
4321}
4322
4323% @example: Same as @lisp.
4324\def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4325
4326% @small... is usually equivalent to the non-small (@smallbook
4327% redefines). We must call \example (or whatever) last in the
4328% definition, since it reads the return following the @example (or
4329% whatever) command.
4330%
4331% This actually allows (for example) @end display inside an
4332% @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4333%
4334\def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4335\def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4336\def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4337\def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4338
4339% Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4340% Originally contributed by Pavel@xerox.
4341\def\smalllispx{\begingroup
4342 \def\Esmalllisp{\nonfillfinish\endgroup}%
4343 \def\Esmallexample{\nonfillfinish\endgroup}%
4344 \smallexamplefonts
4345 \lisp
4346}
4347
4348% @display: same as @lisp except keep current font.
4349%
4350\def\display{\begingroup
4351 \nonfillstart
4352 \let\Edisplay = \nonfillfinish
4353 \gobble
4354}
4355%
4356% @smalldisplay (when @smallbook): @display plus smaller fonts.
4357%
4358\def\smalldisplayx{\begingroup
4359 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4360 \smallexamplefonts \rm
4361 \display
4362}
4363
4364% @format: same as @display except don't narrow margins.
4365%
4366\def\format{\begingroup
4367 \let\nonarrowing = t
4368 \nonfillstart
4369 \let\Eformat = \nonfillfinish
4370 \gobble
4371}
4372%
4373% @smallformat (when @smallbook): @format plus smaller fonts.
4374%
4375\def\smallformatx{\begingroup
4376 \def\Esmallformat{\nonfillfinish\endgroup}%
4377 \smallexamplefonts \rm
4378 \format
4379}
4380
4381% @flushleft (same as @format).
4382%
4383\def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4384
4385% @flushright.
4386%
4387\def\flushright{\begingroup
4388 \let\nonarrowing = t
4389 \nonfillstart
4390 \let\Eflushright = \nonfillfinish
4391 \advance\leftskip by 0pt plus 1fill
4392 \gobble
4393}
4394
4395
4396% @quotation does normal linebreaking (hence we can't use \nonfillstart)
4397% and narrows the margins.
4398%
4399\def\quotation{%
4400 \begingroup\inENV %This group ends at the end of the @quotation body
4401 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4402 \singlespace
4403 \parindent=0pt
4404 % We have retained a nonzero parskip for the environment, since we're
4405 % doing normal filling. So to avoid extra space below the environment...
4406 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4407 %
4408 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4409 \ifx\nonarrowing\relax
4410 \advance\leftskip by \lispnarrowing
4411 \advance\rightskip by \lispnarrowing
4412 \exdentamount = \lispnarrowing
4413 \let\nonarrowing = \relax
4414 \fi
4415}
4416
4417
4418% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4419% If we want to allow any <char> as delimiter,
4420% we need the curly braces so that makeinfo sees the @verb command, eg:
4421% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4422%
4423% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4424%
4425% [Knuth] p. 344; only we need to do '@' too
4426\def\dospecials{%
4427 \do\ \do\\\do\@\do\{\do\}\do\$\do\&%
4428 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~}
4429%
4430% [Knuth] p. 380
4431\def\uncatcodespecials{%
4432 \def\do##1{\catcode`##1=12}\dospecials}
4433%
4434% [Knuth] pp. 380,381,391
4435% Disable Spanish ligatures ?` and !` of \tt font
4436\begingroup
4437 \catcode`\`=\active\gdef`{\relax\lq}
4438\endgroup
4439%
4440% Setup for the @verb command.
4441%
4442% Eight spaces for a tab
4443\begingroup
4444 \catcode`\^^I=\active
4445 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4446\endgroup
4447%
4448\def\setupverb{%
4449 \tt % easiest (and conventionally used) font for verbatim
4450 \def\par{\leavevmode\endgraf}%
4451 \catcode`\`=\active
4452 \tabeightspaces
4453 % Respect line breaks,
4454 % print special symbols as themselves, and
4455 % make each space count
4456 % must do in this order:
4457 \obeylines \uncatcodespecials \sepspaces
4458}
4459
4460% Setup for the @verbatim environment
4461%
4462% Real tab expansion
4463\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4464%
4465\def\starttabbox{\setbox0=\hbox\bgroup}
4466\begingroup
4467 \catcode`\^^I=\active
4468 \gdef\tabexpand{%
4469 \catcode`\^^I=\active
4470 \def^^I{\leavevmode\egroup
4471 \dimen0=\wd0 % the width so far, or since the previous tab
4472 \divide\dimen0 by\tabw
4473 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4474 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4475 \wd0=\dimen0 \box0 \starttabbox
4476 }%
4477 }
4478\endgroup
4479\def\setupverbatim{%
4480 % Easiest (and conventionally used) font for verbatim
4481 \tt
4482 \def\par{\leavevmode\egroup\box0\endgraf}%
4483 \catcode`\`=\active
4484 \tabexpand
4485 % Respect line breaks,
4486 % print special symbols as themselves, and
4487 % make each space count
4488 % must do in this order:
4489 \obeylines \uncatcodespecials \sepspaces
4490 \everypar{\starttabbox}%
4491}
4492
4493% Do the @verb magic: verbatim text is quoted by unique
4494% delimiter characters. Before first delimiter expect a
4495% right brace, after last delimiter expect closing brace:
4496%
4497% \def\doverb'{'<char>#1<char>'}'{#1}
4498%
4499% [Knuth] p. 382; only eat outer {}
4500\begingroup
4501 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4502 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4503\endgroup
4504%
4505\def\verb{\begingroup\setupverb\doverb}
4506%
4507%
4508% Do the @verbatim magic: define the macro \doverbatim so that
4509% the (first) argument ends when '@end verbatim' is reached, ie:
4510%
4511% \def\doverbatim#1@end verbatim{#1}
4512%
4513% For Texinfo it's a lot easier than for LaTeX,
4514% because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4515% we need not redefine '\', '{' and '}'
4516%
4517% Inspired by LaTeX's verbatim command set [latex.ltx]
4518%% Include LaTeX hack for completeness -- never know
4519%% \begingroup
4520%% \catcode`|=0 \catcode`[=1
4521%% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4522%% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4523%% #1|endgroup|def|Everbatim[]|end[verbatim]]
4524%% |endgroup
4525\begingroup
4526 \catcode`\ =\active
4527 \gdef\doverbatim#1@end verbatim{#1\end{verbatim}}
4528\endgroup
4529%
4530\def\verbatim{%
4531 \def\Everbatim{\nonfillfinish\endgroup}%
4532 \begingroup
4533 \nonfillstart
4534 \advance\leftskip by -\defbodyindent
4535 \begingroup\setupverbatim\doverbatim
4536}
4537
4538% @verbatiminclude FILE - insert text of file in verbatim environment.
4539%
4540% Allow normal characters that we make active in the argument (a file name).
4541\def\verbatiminclude{%
4542 \begingroup
4543 \catcode`\\=12
4544 \catcode`~=12
4545 \catcode`^=12
4546 \catcode`_=12
4547 \catcode`|=12
4548 \catcode`<=12
4549 \catcode`>=12
4550 \catcode`+=12
4551 \parsearg\doverbatiminclude
4552}
4553\def\setupverbatiminclude{%
4554 \begingroup
4555 \nonfillstart
4556 \advance\leftskip by -\defbodyindent
4557 \begingroup\setupverbatim
4558}
4559%
4560\def\doverbatiminclude#1{%
4561 % Restore active chars for included file.
4562 \endgroup
4563 \begingroup
4564 \def\thisfile{#1}%
4565 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4566 \endgroup\nonfillfinish\endgroup
4567}
4568
4569
4570\message{defuns,}
4571% @defun etc.
4572
4573% Allow user to change definition object font (\df) internally
4574\def\setdeffont #1 {\csname DEF#1\endcsname}
4575
4576\newskip\defbodyindent \defbodyindent=.4in
4577\newskip\defargsindent \defargsindent=50pt
4578\newskip\deftypemargin \deftypemargin=12pt
4579\newskip\deflastargmargin \deflastargmargin=18pt
4580
4581\newcount\parencount
4582% define \functionparens, which makes ( and ) and & do special things.
4583% \functionparens affects the group it is contained in.
4584\def\activeparens{%
4585\catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4586\catcode`\[=\active \catcode`\]=\active}
4587
4588% Make control sequences which act like normal parenthesis chars.
4589\let\lparen = ( \let\rparen = )
4590
4591{\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4592
4593% Be sure that we always have a definition for `(', etc. For example,
4594% if the fn name has parens in it, \boldbrax will not be in effect yet,
4595% so TeX would otherwise complain about undefined control sequence.
4596\global\let(=\lparen \global\let)=\rparen
4597\global\let[=\lbrack \global\let]=\rbrack
4598
4599\gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4600\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4601% This is used to turn on special parens
4602% but make & act ordinary (given that it's active).
4603\gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4604
4605% Definitions of (, ) and & used in args for functions.
4606% This is the definition of ( outside of all parentheses.
4607\gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4608 \global\advance\parencount by 1
4609}
4610%
4611% This is the definition of ( when already inside a level of parens.
4612\gdef\opnested{\char`\(\global\advance\parencount by 1 }
4613%
4614\gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4615 % also in that case restore the outer-level definition of (.
4616 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4617 \global\advance \parencount by -1 }
4618% If we encounter &foo, then turn on ()-hacking afterwards
4619\gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
4620%
4621\gdef\normalparens{\boldbrax\let&=\ampnr}
4622} % End of definition inside \activeparens
4623%% These parens (in \boldbrax) actually are a little bolder than the
4624%% contained text. This is especially needed for [ and ]
4625\def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4626\def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4627\let\ampnr = \&
4628\def\lbrb{{\bf\char`\[}}
4629\def\rbrb{{\bf\char`\]}}
4630
4631% Active &'s sneak into the index arguments, so make sure it's defined.
4632{
4633 \catcode`& = 13
4634 \global\let& = \ampnr
4635}
4636
4637% First, defname, which formats the header line itself.
4638% #1 should be the function name.
4639% #2 should be the type of definition, such as "Function".
4640
4641\def\defname #1#2{%
4642% Get the values of \leftskip and \rightskip as they were
4643% outside the @def...
4644\dimen2=\leftskip
4645\advance\dimen2 by -\defbodyindent
4646\noindent
4647\setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4648\dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4649\dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4650\parshape 2 0in \dimen0 \defargsindent \dimen1
4651% Now output arg 2 ("Function" or some such)
4652% ending at \deftypemargin from the right margin,
4653% but stuck inside a box of width 0 so it does not interfere with linebreaking
4654{% Adjust \hsize to exclude the ambient margins,
4655% so that \rightline will obey them.
4656\advance \hsize by -\dimen2
4657\rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4658% Make all lines underfull and no complaints:
4659\tolerance=10000 \hbadness=10000
4660\advance\leftskip by -\defbodyindent
4661\exdentamount=\defbodyindent
4662{\df #1}\enskip % Generate function name
4663}
4664
4665% Actually process the body of a definition
4666% #1 should be the terminating control sequence, such as \Edefun.
4667% #2 should be the "another name" control sequence, such as \defunx.
4668% #3 should be the control sequence that actually processes the header,
4669% such as \defunheader.
4670
4671\def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4672\medbreak %
4673% Define the end token that this defining construct specifies
4674% so that it will exit this group.
4675\def#1{\endgraf\endgroup\medbreak}%
4676\def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4677\parindent=0in
4678\advance\leftskip by \defbodyindent
4679\exdentamount=\defbodyindent
4680\begingroup %
4681\catcode 61=\active % 61 is `='
4682\obeylines\activeparens\spacesplit#3}
4683
4684% #1 is the \E... control sequence to end the definition (which we define).
4685% #2 is the \...x control sequence for consecutive fns (which we define).
4686% #3 is the control sequence to call to resume processing.
4687% #4, delimited by the space, is the class name.
4688%
4689\def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4690\medbreak %
4691% Define the end token that this defining construct specifies
4692% so that it will exit this group.
4693\def#1{\endgraf\endgroup\medbreak}%
4694\def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4695\parindent=0in
4696\advance\leftskip by \defbodyindent
4697\exdentamount=\defbodyindent
4698\begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4699
4700% Used for @deftypemethod and @deftypeivar.
4701% #1 is the \E... control sequence to end the definition (which we define).
4702% #2 is the \...x control sequence for consecutive fns (which we define).
4703% #3 is the control sequence to call to resume processing.
4704% #4, delimited by a space, is the class name.
4705% #5 is the method's return type.
4706%
4707\def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4708 \medbreak
4709 \def#1{\endgraf\endgroup\medbreak}%
4710 \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4711 \parindent=0in
4712 \advance\leftskip by \defbodyindent
4713 \exdentamount=\defbodyindent
4714 \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4715
4716% Used for @deftypeop. The change from \deftypemethparsebody is an
4717% extra argument at the beginning which is the `category', instead of it
4718% being the hardwired string `Method' or `Instance Variable'. We have
4719% to account for this both in the \...x definition and in parsing the
4720% input at hand. Thus also need a control sequence (passed as #5) for
4721% the \E... definition to assign the category name to.
4722%
4723\def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4724 \medbreak
4725 \def#1{\endgraf\endgroup\medbreak}%
4726 \def#2##1 ##2 ##3 {%
4727 \def#4{##1}%
4728 \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4729 \parindent=0in
4730 \advance\leftskip by \defbodyindent
4731 \exdentamount=\defbodyindent
4732 \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4733
4734\def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4735\medbreak %
4736% Define the end token that this defining construct specifies
4737% so that it will exit this group.
4738\def#1{\endgraf\endgroup\medbreak}%
4739\def#2##1 ##2 {\def#4{##1}%
4740\begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4741\parindent=0in
4742\advance\leftskip by \defbodyindent
4743\exdentamount=\defbodyindent
4744\begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4745
4746% These parsing functions are similar to the preceding ones
4747% except that they do not make parens into active characters.
4748% These are used for "variables" since they have no arguments.
4749
4750\def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4751\medbreak %
4752% Define the end token that this defining construct specifies
4753% so that it will exit this group.
4754\def#1{\endgraf\endgroup\medbreak}%
4755\def#2{\begingroup\obeylines\spacesplit#3}%
4756\parindent=0in
4757\advance\leftskip by \defbodyindent
4758\exdentamount=\defbodyindent
4759\begingroup %
4760\catcode 61=\active %
4761\obeylines\spacesplit#3}
4762
4763% This is used for \def{tp,vr}parsebody. It could probably be used for
4764% some of the others, too, with some judicious conditionals.
4765%
4766\def\parsebodycommon#1#2#3{%
4767 \begingroup\inENV %
4768 \medbreak %
4769 % Define the end token that this defining construct specifies
4770 % so that it will exit this group.
4771 \def#1{\endgraf\endgroup\medbreak}%
4772 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4773 \parindent=0in
4774 \advance\leftskip by \defbodyindent
4775 \exdentamount=\defbodyindent
4776 \begingroup\obeylines
4777}
4778
4779\def\defvrparsebody#1#2#3#4 {%
4780 \parsebodycommon{#1}{#2}{#3}%
4781 \spacesplit{#3{#4}}%
4782}
4783
4784% This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4785% type is just `struct', because we lose the braces in `{struct
4786% termios}' when \spacesplit reads its undelimited argument. Sigh.
4787% \let\deftpparsebody=\defvrparsebody
4788%
4789% So, to get around this, we put \empty in with the type name. That
4790% way, TeX won't find exactly `{...}' as an undelimited argument, and
4791% won't strip off the braces.
4792%
4793\def\deftpparsebody #1#2#3#4 {%
4794 \parsebodycommon{#1}{#2}{#3}%
4795 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4796}
4797
4798% Fine, but then we have to eventually remove the \empty *and* the
4799% braces (if any). That's what this does.
4800%
4801\def\removeemptybraces\empty#1\relax{#1}
4802
4803% After \spacesplit has done its work, this is called -- #1 is the final
4804% thing to call, #2 the type name (which starts with \empty), and #3
4805% (which might be empty) the arguments.
4806%
4807\def\parsetpheaderline#1#2#3{%
4808 #1{\removeemptybraces#2\relax}{#3}%
4809}%
4810
4811\def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4812\medbreak %
4813% Define the end token that this defining construct specifies
4814% so that it will exit this group.
4815\def#1{\endgraf\endgroup\medbreak}%
4816\def#2##1 ##2 {\def#4{##1}%
4817\begingroup\obeylines\spacesplit{#3{##2}}}%
4818\parindent=0in
4819\advance\leftskip by \defbodyindent
4820\exdentamount=\defbodyindent
4821\begingroup\obeylines\spacesplit{#3{#5}}}
4822
4823% Split up #2 at the first space token.
4824% call #1 with two arguments:
4825% the first is all of #2 before the space token,
4826% the second is all of #2 after that space token.
4827% If #2 contains no space token, all of it is passed as the first arg
4828% and the second is passed as empty.
4829
4830{\obeylines
4831\gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4832\long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4833\ifx\relax #3%
4834#1{#2}{}\else #1{#2}{#3#4}\fi}}
4835
4836% So much for the things common to all kinds of definitions.
4837
4838% Define @defun.
4839
4840% First, define the processing that is wanted for arguments of \defun
4841% Use this to expand the args and terminate the paragraph they make up
4842
4843\def\defunargs#1{\functionparens \sl
4844% Expand, preventing hyphenation at `-' chars.
4845% Note that groups don't affect changes in \hyphenchar.
4846% Set the font temporarily and use \font in case \setfont made \tensl a macro.
4847{\tensl\hyphenchar\font=0}%
4848#1%
4849{\tensl\hyphenchar\font=45}%
4850\ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4851\interlinepenalty=10000
4852\advance\rightskip by 0pt plus 1fil
4853\endgraf\nobreak\vskip -\parskip\nobreak
4854}
4855
4856\def\deftypefunargs #1{%
4857% Expand, preventing hyphenation at `-' chars.
4858% Note that groups don't affect changes in \hyphenchar.
4859% Use \boldbraxnoamp, not \functionparens, so that & is not special.
4860\boldbraxnoamp
4861\tclose{#1}% avoid \code because of side effects on active chars
4862\interlinepenalty=10000
4863\advance\rightskip by 0pt plus 1fil
4864\endgraf\nobreak\vskip -\parskip\nobreak
4865}
4866
4867% Do complete processing of one @defun or @defunx line already parsed.
4868
4869% @deffn Command forward-char nchars
4870
4871\def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4872
4873\def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4874\begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4875\catcode 61=\other % Turn off change made in \defparsebody
4876}
4877
4878% @defun == @deffn Function
4879
4880\def\defun{\defparsebody\Edefun\defunx\defunheader}
4881
4882\def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4883\begingroup\defname {#1}{\putwordDeffunc}%
4884\defunargs {#2}\endgroup %
4885\catcode 61=\other % Turn off change made in \defparsebody
4886}
4887
4888% @deftypefun int foobar (int @var{foo}, float @var{bar})
4889
4890\def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4891
4892% #1 is the data type. #2 is the name and args.
4893\def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4894% #1 is the data type, #2 the name, #3 the args.
4895\def\deftypefunheaderx #1#2 #3\relax{%
4896\doind {fn}{\code{#2}}% Make entry in function index
4897\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}%
4898\deftypefunargs {#3}\endgroup %
4899\catcode 61=\other % Turn off change made in \defparsebody
4900}
4901
4902% @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4903
4904\def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4905
4906% \defheaderxcond#1\relax$$$
4907% puts #1 in @code, followed by a space, but does nothing if #1 is null.
4908\def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4909
4910% #1 is the classification. #2 is the data type. #3 is the name and args.
4911\def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4912% #1 is the classification, #2 the data type, #3 the name, #4 the args.
4913\def\deftypefnheaderx #1#2#3 #4\relax{%
4914\doind {fn}{\code{#3}}% Make entry in function index
4915\begingroup
4916\normalparens % notably, turn off `&' magic, which prevents
4917% at least some C++ text from working
4918\defname {\defheaderxcond#2\relax$$$#3}{#1}%
4919\deftypefunargs {#4}\endgroup %
4920\catcode 61=\other % Turn off change made in \defparsebody
4921}
4922
4923% @defmac == @deffn Macro
4924
4925\def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4926
4927\def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4928\begingroup\defname {#1}{\putwordDefmac}%
4929\defunargs {#2}\endgroup %
4930\catcode 61=\other % Turn off change made in \defparsebody
4931}
4932
4933% @defspec == @deffn Special Form
4934
4935\def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4936
4937\def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4938\begingroup\defname {#1}{\putwordDefspec}%
4939\defunargs {#2}\endgroup %
4940\catcode 61=\other % Turn off change made in \defparsebody
4941}
4942
4943% @defop CATEGORY CLASS OPERATION ARG...
4944%
4945\def\defop #1 {\def\defoptype{#1}%
4946\defopparsebody\Edefop\defopx\defopheader\defoptype}
4947%
4948\def\defopheader#1#2#3{%
4949\dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4950\begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4951\defunargs {#3}\endgroup %
4952}
4953
4954% @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4955%
4956\def\deftypeop #1 {\def\deftypeopcategory{#1}%
4957 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
4958 \deftypeopcategory}
4959%
4960% #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4961\def\deftypeopheader#1#2#3#4{%
4962 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4963 \begingroup
4964 \defname{\defheaderxcond#2\relax$$$#3}
4965 {\deftypeopcategory\ \putwordon\ \code{#1}}%
4966 \deftypefunargs{#4}%
4967 \endgroup
4968}
4969
4970% @deftypemethod CLASS TYPE METHOD ARG...
4971%
4972\def\deftypemethod{%
4973 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4974%
4975% #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4976\def\deftypemethodheader#1#2#3#4{%
4977 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4978 \begingroup
4979 \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}%
4980 \deftypefunargs{#4}%
4981 \endgroup
4982}
4983
4984% @deftypeivar CLASS TYPE VARNAME
4985%
4986\def\deftypeivar{%
4987 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
4988%
4989% #1 is the class name, #2 the data type, #3 the variable name.
4990\def\deftypeivarheader#1#2#3{%
4991 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
4992 \begingroup
4993 \defname{\defheaderxcond#2\relax$$$#3}
4994 {\putwordInstanceVariableof\ \code{#1}}%
4995 \defvarargs{#3}%
4996 \endgroup
4997}
4998
4999% @defmethod == @defop Method
5000%
5001\def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5002%
5003% #1 is the class name, #2 the method name, #3 the args.
5004\def\defmethodheader#1#2#3{%
5005 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5006 \begingroup
5007 \defname{#2}{\putwordMethodon\ \code{#1}}%
5008 \defunargs{#3}%
5009 \endgroup
5010}
5011
5012% @defcv {Class Option} foo-class foo-flag
5013
5014\def\defcv #1 {\def\defcvtype{#1}%
5015\defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5016
5017\def\defcvarheader #1#2#3{%
5018\dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5019\begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5020\defvarargs {#3}\endgroup %
5021}
5022
5023% @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5024%
5025\def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5026%
5027\def\defivarheader#1#2#3{%
5028 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5029 \begingroup
5030 \defname{#2}{\putwordInstanceVariableof\ #1}%
5031 \defvarargs{#3}%
5032 \endgroup
5033}
5034
5035% @defvar
5036% First, define the processing that is wanted for arguments of @defvar.
5037% This is actually simple: just print them in roman.
5038% This must expand the args and terminate the paragraph they make up
5039\def\defvarargs #1{\normalparens #1%
5040\interlinepenalty=10000
5041\endgraf\nobreak\vskip -\parskip\nobreak}
5042
5043% @defvr Counter foo-count
5044
5045\def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5046
5047\def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5048\begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5049
5050% @defvar == @defvr Variable
5051
5052\def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5053
5054\def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5055\begingroup\defname {#1}{\putwordDefvar}%
5056\defvarargs {#2}\endgroup %
5057}
5058
5059% @defopt == @defvr {User Option}
5060
5061\def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5062
5063\def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5064\begingroup\defname {#1}{\putwordDefopt}%
5065\defvarargs {#2}\endgroup %
5066}
5067
5068% @deftypevar int foobar
5069
5070\def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5071
5072% #1 is the data type. #2 is the name, perhaps followed by text that
5073% is actually part of the data type, which should not be put into the index.
5074\def\deftypevarheader #1#2{%
5075\dovarind#2 \relax% Make entry in variables index
5076\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}%
5077\interlinepenalty=10000
5078\endgraf\nobreak\vskip -\parskip\nobreak
5079\endgroup}
5080\def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5081
5082% @deftypevr {Global Flag} int enable
5083
5084\def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5085
5086\def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5087\begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
5088\interlinepenalty=10000
5089\endgraf\nobreak\vskip -\parskip\nobreak
5090\endgroup}
5091
5092% Now define @deftp
5093% Args are printed in bold, a slight difference from @defvar.
5094
5095\def\deftpargs #1{\bf \defvarargs{#1}}
5096
5097% @deftp Class window height width ...
5098
5099\def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5100
5101\def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5102\begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5103
5104% These definitions are used if you use @defunx (etc.)
5105% anywhere other than immediately after a @defun or @defunx.
5106%
5107\def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5108\def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5109\def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5110\def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5111\def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5112\def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5113\def\defopx#1 {\errmessage{@defopx in invalid context}}
5114\def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5115\def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5116\def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5117\def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5118\def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5119\def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5120\def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5121\def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5122\def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5123\def\defunx#1 {\errmessage{@defunx in invalid context}}
5124\def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5125\def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5126
5127
5128\message{macros,}
5129% @macro.
5130
5131% To do this right we need a feature of e-TeX, \scantokens,
5132% which we arrange to emulate with a temporary file in ordinary TeX.
5133\ifx\eTeXversion\undefined
5134 \newwrite\macscribble
5135 \def\scanmacro#1{%
5136 \begingroup \newlinechar`\^^M
5137 % Undo catcode changes of \startcontents and \doprintindex
5138 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5139 % Append \endinput to make sure that TeX does not see the ending newline.
5140 \toks0={#1\endinput}%
5141 \immediate\openout\macscribble=\jobname.tmp
5142 \immediate\write\macscribble{\the\toks0}%
5143 \immediate\closeout\macscribble
5144 \let\xeatspaces\eatspaces
5145 \input \jobname.tmp
5146 \endgroup
5147}
5148\else
5149\def\scanmacro#1{%
5150\begingroup \newlinechar`\^^M
5151% Undo catcode changes of \startcontents and \doprintindex
5152\catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5153\let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5154\fi
5155
5156\newcount\paramno % Count of parameters
5157\newtoks\macname % Macro name
5158\newif\ifrecursive % Is it recursive?
5159\def\macrolist{} % List of all defined macros in the form
5160 % \do\macro1\do\macro2...
5161
5162% Utility routines.
5163% Thisdoes \let #1 = #2, except with \csnames.
5164\def\cslet#1#2{%
5165\expandafter\expandafter
5166\expandafter\let
5167\expandafter\expandafter
5168\csname#1\endcsname
5169\csname#2\endcsname}
5170
5171% Trim leading and trailing spaces off a string.
5172% Concepts from aro-bend problem 15 (see CTAN).
5173{\catcode`\@=11
5174\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5175\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5176\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5177\def\unbrace#1{#1}
5178\unbrace{\gdef\trim@@@ #1 } #2@{#1}
5179}
5180
5181% Trim a single trailing ^^M off a string.
5182{\catcode`\^^M=12\catcode`\Q=3%
5183\gdef\eatcr #1{\eatcra #1Q^^MQ}%
5184\gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5185\gdef\eatcrb#1Q#2Q{#1}%
5186}
5187
5188% Macro bodies are absorbed as an argument in a context where
5189% all characters are catcode 10, 11 or 12, except \ which is active
5190% (as in normal texinfo). It is necessary to change the definition of \.
5191
5192% It's necessary to have hard CRs when the macro is executed. This is
5193% done by making ^^M (\endlinechar) catcode 12 when reading the macro
5194% body, and then making it the \newlinechar in \scanmacro.
5195
5196\def\macrobodyctxt{%
5197 \catcode`\~=12
5198 \catcode`\^=12
5199 \catcode`\_=12
5200 \catcode`\|=12
5201 \catcode`\<=12
5202 \catcode`\>=12
5203 \catcode`\+=12
5204 \catcode`\{=12
5205 \catcode`\}=12
5206 \catcode`\@=12
5207 \catcode`\^^M=12
5208 \usembodybackslash}
5209
5210\def\macroargctxt{%
5211 \catcode`\~=12
5212 \catcode`\^=12
5213 \catcode`\_=12
5214 \catcode`\|=12
5215 \catcode`\<=12
5216 \catcode`\>=12
5217 \catcode`\+=12
5218 \catcode`\@=12
5219 \catcode`\\=12}
5220
5221% \mbodybackslash is the definition of \ in @macro bodies.
5222% It maps \foo\ => \csname macarg.foo\endcsname => #N
5223% where N is the macro parameter number.
5224% We define \csname macarg.\endcsname to be \realbackslash, so
5225% \\ in macro replacement text gets you a backslash.
5226
5227{\catcode`@=0 @catcode`@\=@active
5228 @gdef@usembodybackslash{@let\=@mbodybackslash}
5229 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5230}
5231\expandafter\def\csname macarg.\endcsname{\realbackslash}
5232
5233\def\macro{\recursivefalse\parsearg\macroxxx}
5234\def\rmacro{\recursivetrue\parsearg\macroxxx}
5235
5236\def\macroxxx#1{%
5237 \getargs{#1}% now \macname is the macname and \argl the arglist
5238 \ifx\argl\empty % no arguments
5239 \paramno=0%
5240 \else
5241 \expandafter\parsemargdef \argl;%
5242 \fi
5243 \if1\csname ismacro.\the\macname\endcsname
5244 \message{Warning: redefining \the\macname}%
5245 \else
5246 \expandafter\ifx\csname \the\macname\endcsname \relax
5247 \else \errmessage{The name \the\macname\space is reserved}\fi
5248 \global\cslet{macsave.\the\macname}{\the\macname}%
5249 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5250 % Add the macroname to \macrolist
5251 \toks0 = \expandafter{\macrolist\do}%
5252 \xdef\macrolist{\the\toks0
5253 \expandafter\noexpand\csname\the\macname\endcsname}%
5254 \fi
5255 \begingroup \macrobodyctxt
5256 \ifrecursive \expandafter\parsermacbody
5257 \else \expandafter\parsemacbody
5258 \fi}
5259
5260\def\unmacro{\parsearg\unmacroxxx}
5261\def\unmacroxxx#1{%
5262 \if1\csname ismacro.#1\endcsname
5263 \global\cslet{#1}{macsave.#1}%
5264 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5265 % Remove the macro name from \macrolist
5266 \begingroup
5267 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5268 \def\do##1{%
5269 \def\tempb{##1}%
5270 \ifx\tempa\tempb
5271 % remove this
5272 \else
5273 \toks0 = \expandafter{\newmacrolist\do}%
5274 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5275 \fi}%
5276 \def\newmacrolist{}%
5277 % Execute macro list to define \newmacrolist
5278 \macrolist
5279 \global\let\macrolist\newmacrolist
5280 \endgroup
5281 \else
5282 \errmessage{Macro #1 not defined}%
5283 \fi
5284}
5285
5286% This makes use of the obscure feature that if the last token of a
5287% <parameter list> is #, then the preceding argument is delimited by
5288% an opening brace, and that opening brace is not consumed.
5289\def\getargs#1{\getargsxxx#1{}}
5290\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5291\def\getmacname #1 #2\relax{\macname={#1}}
5292\def\getmacargs#1{\def\argl{#1}}
5293
5294% Parse the optional {params} list. Set up \paramno and \paramlist
5295% so \defmacro knows what to do. Define \macarg.blah for each blah
5296% in the params list, to be ##N where N is the position in that list.
5297% That gets used by \mbodybackslash (above).
5298
5299% We need to get `macro parameter char #' into several definitions.
5300% The technique used is stolen from LaTeX: let \hash be something
5301% unexpandable, insert that wherever you need a #, and then redefine
5302% it to # just before using the token list produced.
5303%
5304% The same technique is used to protect \eatspaces till just before
5305% the macro is used.
5306
5307\def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5308 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5309\def\parsemargdefxxx#1,{%
5310 \if#1;\let\next=\relax
5311 \else \let\next=\parsemargdefxxx
5312 \advance\paramno by 1%
5313 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5314 {\xeatspaces{\hash\the\paramno}}%
5315 \edef\paramlist{\paramlist\hash\the\paramno,}%
5316 \fi\next}
5317
5318% These two commands read recursive and nonrecursive macro bodies.
5319% (They're different since rec and nonrec macros end differently.)
5320
5321\long\def\parsemacbody#1@end macro%
5322{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5323\long\def\parsermacbody#1@end rmacro%
5324{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5325
5326% This defines the macro itself. There are six cases: recursive and
5327% nonrecursive macros of zero, one, and many arguments.
5328% Much magic with \expandafter here.
5329% \xdef is used so that macro definitions will survive the file
5330% they're defined in; @include reads the file inside a group.
5331\def\defmacro{%
5332 \let\hash=##% convert placeholders to macro parameter chars
5333 \ifrecursive
5334 \ifcase\paramno
5335 % 0
5336 \expandafter\xdef\csname\the\macname\endcsname{%
5337 \noexpand\scanmacro{\temp}}%
5338 \or % 1
5339 \expandafter\xdef\csname\the\macname\endcsname{%
5340 \bgroup\noexpand\macroargctxt
5341 \noexpand\braceorline
5342 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5343 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5344 \egroup\noexpand\scanmacro{\temp}}%
5345 \else % many
5346 \expandafter\xdef\csname\the\macname\endcsname{%
5347 \bgroup\noexpand\macroargctxt
5348 \noexpand\csname\the\macname xx\endcsname}%
5349 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5350 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5351 \expandafter\expandafter
5352 \expandafter\xdef
5353 \expandafter\expandafter
5354 \csname\the\macname xxx\endcsname
5355 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5356 \fi
5357 \else
5358 \ifcase\paramno
5359 % 0
5360 \expandafter\xdef\csname\the\macname\endcsname{%
5361 \noexpand\norecurse{\the\macname}%
5362 \noexpand\scanmacro{\temp}\egroup}%
5363 \or % 1
5364 \expandafter\xdef\csname\the\macname\endcsname{%
5365 \bgroup\noexpand\macroargctxt
5366 \noexpand\braceorline
5367 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5368 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5369 \egroup
5370 \noexpand\norecurse{\the\macname}%
5371 \noexpand\scanmacro{\temp}\egroup}%
5372 \else % many
5373 \expandafter\xdef\csname\the\macname\endcsname{%
5374 \bgroup\noexpand\macroargctxt
5375 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5376 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5377 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5378 \expandafter\expandafter
5379 \expandafter\xdef
5380 \expandafter\expandafter
5381 \csname\the\macname xxx\endcsname
5382 \paramlist{%
5383 \egroup
5384 \noexpand\norecurse{\the\macname}%
5385 \noexpand\scanmacro{\temp}\egroup}%
5386 \fi
5387 \fi}
5388
5389\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5390
5391% \braceorline decides whether the next nonwhitespace character is a
5392% {. If so it reads up to the closing }, if not, it reads the whole
5393% line. Whatever was read is then fed to the next control sequence
5394% as an argument (by \parsebrace or \parsearg)
5395\def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5396\def\braceorlinexxx{%
5397 \ifx\nchar\bgroup\else
5398 \expandafter\parsearg
5399 \fi \next}
5400
5401% We mant to disable all macros during \shipout so that they are not
5402% expanded by \write.
5403\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5404 \edef\next{\macrolist}\expandafter\endgroup\next}
5405
5406
5407% @alias.
5408% We need some trickery to remove the optional spaces around the equal
5409% sign. Just make them active and then expand them all to nothing.
5410\def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5411\def\aliasxxx #1{\aliasyyy#1\relax}
5412\def\aliasyyy #1=#2\relax{\ignoreactivespaces
5413\edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5414 \expandafter\noexpand\csname#2\endcsname}%
5415\expandafter\endgroup\next}
5416
5417
5418\message{cross references,}
5419% @xref etc.
5420
5421\newwrite\auxfile
5422
5423\newif\ifhavexrefs % True if xref values are known.
5424\newif\ifwarnedxrefs % True if we warned once that they aren't known.
5425
5426% @inforef is relatively simple.
5427\def\inforef #1{\inforefzzz #1,,,,**}
5428\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5429 node \samp{\ignorespaces#1{}}}
5430
5431% @node's job is to define \lastnode.
5432\def\node{\ENVcheck\parsearg\nodezzz}
5433\def\nodezzz#1{\nodexxx [#1,]}
5434\def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5435\let\nwnode=\node
5436\let\lastnode=\relax
5437
5438% The sectioning commands (@chapter, etc.) call these.
5439\def\donoderef{%
5440 \ifx\lastnode\relax\else
5441 \expandafter\expandafter\expandafter\setref{\lastnode}%
5442 {Ysectionnumberandtype}%
5443 \global\let\lastnode=\relax
5444 \fi
5445}
5446\def\unnumbnoderef{%
5447 \ifx\lastnode\relax\else
5448 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5449 \global\let\lastnode=\relax
5450 \fi
5451}
5452\def\appendixnoderef{%
5453 \ifx\lastnode\relax\else
5454 \expandafter\expandafter\expandafter\setref{\lastnode}%
5455 {Yappendixletterandtype}%
5456 \global\let\lastnode=\relax
5457 \fi
5458}
5459
5460
5461% @anchor{NAME} -- define xref target at arbitrary point.
5462%
5463\newcount\savesfregister
5464\gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5465\gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5466\gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5467
5468% \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5469% NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5470% to set \indexdummies so commands such as @code in a section title
5471% aren't expanded. It would be nicer not to expand the titles in the
5472% first place, but there's so many layers that that is hard to do.
5473%
5474\def\setref#1#2{{%
5475 \indexdummies
5476 \pdfmkdest{#1}%
5477 \dosetq{#1-title}{Ytitle}%
5478 \dosetq{#1-pg}{Ypagenumber}%
5479 \dosetq{#1-snt}{#2}%
5480}}
5481
5482% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5483% the node name, #2 the name of the Info cross-reference, #3 the printed
5484% node name, #4 the name of the Info file, #5 the name of the printed
5485% manual. All but the node name can be omitted.
5486%
5487\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5488\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5489\def\ref#1{\xrefX[#1,,,,,,,]}
5490\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5491 \unsepspaces
5492 \def\printedmanual{\ignorespaces #5}%
5493 \def\printednodename{\ignorespaces #3}%
5494 \setbox1=\hbox{\printedmanual}%
5495 \setbox0=\hbox{\printednodename}%
5496 \ifdim \wd0 = 0pt
5497 % No printed node name was explicitly given.
5498 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5499 % Use the node name inside the square brackets.
5500 \def\printednodename{\ignorespaces #1}%
5501 \else
5502 % Use the actual chapter/section title appear inside
5503 % the square brackets. Use the real section title if we have it.
5504 \ifdim \wd1 > 0pt
5505 % It is in another manual, so we don't have it.
5506 \def\printednodename{\ignorespaces #1}%
5507 \else
5508 \ifhavexrefs
5509 % We know the real title if we have the xref values.
5510 \def\printednodename{\refx{#1-title}{}}%
5511 \else
5512 % Otherwise just copy the Info node name.
5513 \def\printednodename{\ignorespaces #1}%
5514 \fi%
5515 \fi
5516 \fi
5517 \fi
5518 %
5519 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5520 % insert empty discretionaries after hyphens, which means that it will
5521 % not find a line break at a hyphen in a node names. Since some manuals
5522 % are best written with fairly long node names, containing hyphens, this
5523 % is a loss. Therefore, we give the text of the node name again, so it
5524 % is as if TeX is seeing it for the first time.
5525 \ifpdf
5526 \leavevmode
5527 \getfilename{#4}%
5528 {\normalturnoffactive
5529 \ifnum\filenamelength>0
5530 \startlink attr{/Border [0 0 0]}%
5531 goto file{\the\filename.pdf} name{#1}%
5532 \else
5533 \startlink attr{/Border [0 0 0]}%
5534 goto name{#1}%
5535 \fi
5536 }%
5537 \linkcolor
5538 \fi
5539 %
5540 \ifdim \wd1 > 0pt
5541 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5542 \else
5543 % _ (for example) has to be the character _ for the purposes of the
5544 % control sequence corresponding to the node, but it has to expand
5545 % into the usual \leavevmode...\vrule stuff for purposes of
5546 % printing. So we \turnoffactive for the \refx-snt, back on for the
5547 % printing, back off for the \refx-pg.
5548 {\normalturnoffactive
5549 % Only output a following space if the -snt ref is nonempty; for
5550 % @unnumbered and @anchor, it won't be.
5551 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5552 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5553 }%
5554 % [mynode],
5555 [\printednodename],\space
5556 % page 3
5557 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5558 \fi
5559 \endlink
5560\endgroup}
5561
5562% \dosetq is the interface for calls from other macros
5563
5564% Use \normalturnoffactive so that punctuation chars such as underscore
5565% and backslash work in node names. (\turnoffactive doesn't do \.)
5566\def\dosetq#1#2{%
5567 {\let\folio=0%
5568 \normalturnoffactive
5569 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5570 \iflinks
5571 \next
5572 \fi
5573 }%
5574}
5575
5576% \internalsetq {foo}{page} expands into
5577% CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5578% When the aux file is read, ' is the escape character
5579
5580\def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5581
5582% Things to be expanded by \internalsetq
5583
5584\def\Ypagenumber{\folio}
5585
5586\def\Ytitle{\thissection}
5587
5588\def\Ynothing{}
5589
5590\def\Ysectionnumberandtype{%
5591\ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5592\else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5593\else \ifnum \subsubsecno=0 %
5594\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5595\else %
5596\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5597\fi \fi \fi }
5598
5599\def\Yappendixletterandtype{%
5600\ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5601\else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5602\else \ifnum \subsubsecno=0 %
5603\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5604\else %
5605\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5606\fi \fi \fi }
5607
5608\gdef\xreftie{'tie}
5609
5610% Use TeX 3.0's \inputlineno to get the line number, for better error
5611% messages, but if we're using an old version of TeX, don't do anything.
5612%
5613\ifx\inputlineno\thisisundefined
5614 \let\linenumber = \empty % Non-3.0.
5615\else
5616 \def\linenumber{\the\inputlineno:\space}
5617\fi
5618
5619% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5620% If its value is nonempty, SUFFIX is output afterward.
5621
5622\def\refx#1#2{%
5623 \expandafter\ifx\csname X#1\endcsname\relax
5624 % If not defined, say something at least.
5625 \angleleft un\-de\-fined\angleright
5626 \iflinks
5627 \ifhavexrefs
5628 \message{\linenumber Undefined cross reference `#1'.}%
5629 \else
5630 \ifwarnedxrefs\else
5631 \global\warnedxrefstrue
5632 \message{Cross reference values unknown; you must run TeX again.}%
5633 \fi
5634 \fi
5635 \fi
5636 \else
5637 % It's defined, so just use it.
5638 \csname X#1\endcsname
5639 \fi
5640 #2% Output the suffix in any case.
5641}
5642
5643% This is the macro invoked by entries in the aux file.
5644%
5645\def\xrdef#1{\begingroup
5646 % Reenable \ as an escape while reading the second argument.
5647 \catcode`\\ = 0
5648 \afterassignment\endgroup
5649 \expandafter\gdef\csname X#1\endcsname
5650}
5651
5652% Read the last existing aux file, if any. No error if none exists.
5653\def\readauxfile{\begingroup
5654 \catcode`\^^@=\other
5655 \catcode`\^^A=\other
5656 \catcode`\^^B=\other
5657 \catcode`\^^C=\other
5658 \catcode`\^^D=\other
5659 \catcode`\^^E=\other
5660 \catcode`\^^F=\other
5661 \catcode`\^^G=\other
5662 \catcode`\^^H=\other
5663 \catcode`\^^K=\other
5664 \catcode`\^^L=\other
5665 \catcode`\^^N=\other
5666 \catcode`\^^P=\other
5667 \catcode`\^^Q=\other
5668 \catcode`\^^R=\other
5669 \catcode`\^^S=\other
5670 \catcode`\^^T=\other
5671 \catcode`\^^U=\other
5672 \catcode`\^^V=\other
5673 \catcode`\^^W=\other
5674 \catcode`\^^X=\other
5675 \catcode`\^^Z=\other
5676 \catcode`\^^[=\other
5677 \catcode`\^^\=\other
5678 \catcode`\^^]=\other
5679 \catcode`\^^^=\other
5680 \catcode`\^^_=\other
5681 \catcode`\@=\other
5682 \catcode`\^=\other
5683 % It was suggested to define this as 7, which would allow ^^e4 etc.
5684 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5685 % supported in the main text, it doesn't seem desirable. Furthermore,
5686 % that is not enough: for node names that actually contain a ^
5687 % character, we would end up writing a line like this: 'xrdef {'hat
5688 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5689 % argument, and \hat is not an expandable control sequence. It could
5690 % all be worked out, but why? Either we support ^^ or we don't.
5691 %
5692 % The other change necessary for this was to define \auxhat:
5693 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5694 % and then to call \auxhat in \setq.
5695 %
5696 \catcode`\~=\other
5697 \catcode`\[=\other
5698 \catcode`\]=\other
5699 \catcode`\"=\other
5700 \catcode`\_=\other
5701 \catcode`\|=\other
5702 \catcode`\<=\other
5703 \catcode`\>=\other
5704 \catcode`\$=\other
5705 \catcode`\#=\other
5706 \catcode`\&=\other
5707 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5708 % Make the characters 128-255 be printing characters
5709 {%
5710 \count 1=128
5711 \def\loop{%
5712 \catcode\count 1=\other
5713 \advance\count 1 by 1
5714 \ifnum \count 1<256 \loop \fi
5715 }%
5716 }%
5717 % The aux file uses ' as the escape (for now).
5718 % Turn off \ as an escape so we do not lose on
5719 % entries which were dumped with control sequences in their names.
5720 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5721 % Reference to such entries still does not work the way one would wish,
5722 % but at least they do not bomb out when the aux file is read in.
5723 \catcode`\{=1
5724 \catcode`\}=2
5725 \catcode`\%=\other
5726 \catcode`\'=0
5727 \catcode`\\=\other
5728 %
5729 \openin 1 \jobname.aux
5730 \ifeof 1 \else
5731 \closein 1
5732 \input \jobname.aux
5733 \global\havexrefstrue
5734 \global\warnedobstrue
5735 \fi
5736 % Open the new aux file. TeX will close it automatically at exit.
5737 \openout\auxfile=\jobname.aux
5738\endgroup}
5739
5740
5741% Footnotes.
5742
5743\newcount \footnoteno
5744
5745% The trailing space in the following definition for supereject is
5746% vital for proper filling; pages come out unaligned when you do a
5747% pagealignmacro call if that space before the closing brace is
5748% removed. (Generally, numeric constants should always be followed by a
5749% space to prevent strange expansion errors.)
5750\def\supereject{\par\penalty -20000\footnoteno =0 }
5751
5752% @footnotestyle is meaningful for info output only.
5753\let\footnotestyle=\comment
5754
5755\let\ptexfootnote=\footnote
5756
5757{\catcode `\@=11
5758%
5759% Auto-number footnotes. Otherwise like plain.
5760\gdef\footnote{%
5761 \global\advance\footnoteno by \@ne
5762 \edef\thisfootno{$^{\the\footnoteno}$}%
5763 %
5764 % In case the footnote comes at the end of a sentence, preserve the
5765 % extra spacing after we do the footnote number.
5766 \let\@sf\empty
5767 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5768 %
5769 % Remove inadvertent blank space before typesetting the footnote number.
5770 \unskip
5771 \thisfootno\@sf
5772 \footnotezzz
5773}%
5774
5775% Don't bother with the trickery in plain.tex to not require the
5776% footnote text as a parameter. Our footnotes don't need to be so general.
5777%
5778% Oh yes, they do; otherwise, @ifset and anything else that uses
5779% \parseargline fail inside footnotes because the tokens are fixed when
5780% the footnote is read. --karl, 16nov96.
5781%
5782\long\gdef\footnotezzz{\insert\footins\bgroup
5783 % We want to typeset this text as a normal paragraph, even if the
5784 % footnote reference occurs in (for example) a display environment.
5785 % So reset some parameters.
5786 \interlinepenalty\interfootnotelinepenalty
5787 \splittopskip\ht\strutbox % top baseline for broken footnotes
5788 \splitmaxdepth\dp\strutbox
5789 \floatingpenalty\@MM
5790 \leftskip\z@skip
5791 \rightskip\z@skip
5792 \spaceskip\z@skip
5793 \xspaceskip\z@skip
5794 \parindent\defaultparindent
5795 %
5796 \smallfonts \rm
5797 %
5798 % Hang the footnote text off the number.
5799 \hang
5800 \textindent{\thisfootno}%
5801 %
5802 % Don't crash into the line above the footnote text. Since this
5803 % expands into a box, it must come within the paragraph, lest it
5804 % provide a place where TeX can split the footnote.
5805 \footstrut
5806 \futurelet\next\fo@t
5807}
5808\def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5809 \else\let\next\f@t\fi \next}
5810\def\f@@t{\bgroup\aftergroup\@foot\let\next}
5811\def\f@t#1{#1\@foot}
5812\def\@foot{\strut\par\egroup}
5813
5814}%end \catcode `\@=11
5815
5816% @| inserts a changebar to the left of the current line. It should
5817% surround any changed text. This approach does *not* work if the
5818% change spans more than two lines of output. To handle that, we would
5819% have adopt a much more difficult approach (putting marks into the main
5820% vertical list for the beginning and end of each change).
5821%
5822\def\|{%
5823 % \vadjust can only be used in horizontal mode.
5824 \leavevmode
5825 %
5826 % Append this vertical mode material after the current line in the output.
5827 \vadjust{%
5828 % We want to insert a rule with the height and depth of the current
5829 % leading; that is exactly what \strutbox is supposed to record.
5830 \vskip-\baselineskip
5831 %
5832 % \vadjust-items are inserted at the left edge of the type. So
5833 % the \llap here moves out into the left-hand margin.
5834 \llap{%
5835 %
5836 % For a thicker or thinner bar, change the `1pt'.
5837 \vrule height\baselineskip width1pt
5838 %
5839 % This is the space between the bar and the text.
5840 \hskip 12pt
5841 }%
5842 }%
5843}
5844
5845% For a final copy, take out the rectangles
5846% that mark overfull boxes (in case you have decided
5847% that the text looks ok even though it passes the margin).
5848%
5849\def\finalout{\overfullrule=0pt}
5850
5851% @image. We use the macros from epsf.tex to support this.
5852% If epsf.tex is not installed and @image is used, we complain.
5853%
5854% Check for and read epsf.tex up front. If we read it only at @image
5855% time, we might be inside a group, and then its definitions would get
5856% undone and the next image would fail.
5857\openin 1 = epsf.tex
5858\ifeof 1 \else
5859 \closein 1
5860 % Do not bother showing banner with post-v2.7 epsf.tex (available in
5861 % doc/epsf.tex until it shows up on ctan).
5862 \def\epsfannounce{\toks0 = }%
5863 \input epsf.tex
5864\fi
5865%
5866% We will only complain once about lack of epsf.tex.
5867\newif\ifwarnednoepsf
5868\newhelp\noepsfhelp{epsf.tex must be installed for images to
5869 work. It is also included in the Texinfo distribution, or you can get
5870 it from ftp://tug.org/tex/epsf.tex.}
5871%
5872\def\image#1{%
5873 \ifx\epsfbox\undefined
5874 \ifwarnednoepsf \else
5875 \errhelp = \noepsfhelp
5876 \errmessage{epsf.tex not found, images will be ignored}%
5877 \global\warnednoepsftrue
5878 \fi
5879 \else
5880 \imagexxx #1,,,\finish
5881 \fi
5882}
5883%
5884% Arguments to @image:
5885% #1 is (mandatory) image filename; we tack on .eps extension.
5886% #2 is (optional) width, #3 is (optional) height.
5887% #4 is (ignored optional) html alt text.
5888% #5 is (ignored optional) extension.
5889% #6 is just the usual extra ignored arg for parsing this stuff.
5890\def\imagexxx#1,#2,#3,#4,#5,#6\finish{%
5891 \ifpdf
5892 \centerline{\dopdfimage{#1}{#2}{#3}}%
5893 \else
5894 % \epsfbox itself resets \epsf?size at each figure.
5895 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5896 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5897 \begingroup
5898 \catcode`\^^M = 5 % in case we're inside an example
5899 \normalturnoffactive % allow _ et al. in names
5900 % If the image is by itself, center it.
5901 \ifvmode
5902 \nobreak\bigskip
5903 % Usually we'll have text after the image which will insert
5904 % \parskip glue, so insert it here too to equalize the space
5905 % above and below.
5906 \nobreak\vskip\parskip
5907 \nobreak
5908 \centerline{\epsfbox{#1.eps}}%
5909 \bigbreak
5910 \else
5911 % In the middle of a paragraph, no extra space.
5912 \epsfbox{#1.eps}%
5913 \fi
5914 \endgroup
5915 \fi
5916}
5917
5918
5919\message{localization,}
5920% and i18n.
5921
5922% @documentlanguage is usually given very early, just after
5923% @setfilename. If done too late, it may not override everything
5924% properly. Single argument is the language abbreviation.
5925% It would be nice if we could set up a hyphenation file here.
5926%
5927\def\documentlanguage{\parsearg\dodocumentlanguage}
5928\def\dodocumentlanguage#1{%
5929 \tex % read txi-??.tex file in plain TeX.
5930 % Read the file if it exists.
5931 \openin 1 txi-#1.tex
5932 \ifeof1
5933 \errhelp = \nolanghelp
5934 \errmessage{Cannot read language file txi-#1.tex}%
5935 \let\temp = \relax
5936 \else
5937 \def\temp{\input txi-#1.tex }%
5938 \fi
5939 \temp
5940 \endgroup
5941}
5942\newhelp\nolanghelp{The given language definition file cannot be found or
5943is empty. Maybe you need to install it? In the current directory
5944should work if nowhere else does.}
5945
5946
5947% @documentencoding should change something in TeX eventually, most
5948% likely, but for now just recognize it.
5949\let\documentencoding = \comment
5950
5951
5952% Page size parameters.
5953%
5954\newdimen\defaultparindent \defaultparindent = 15pt
5955
5956\chapheadingskip = 15pt plus 4pt minus 2pt
5957\secheadingskip = 12pt plus 3pt minus 2pt
5958\subsecheadingskip = 9pt plus 2pt minus 2pt
5959
5960% Prevent underfull vbox error messages.
5961\vbadness = 10000
5962
5963% Don't be so finicky about underfull hboxes, either.
5964\hbadness = 2000
5965
5966% Following George Bush, just get rid of widows and orphans.
5967\widowpenalty=10000
5968\clubpenalty=10000
5969
5970% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
5971% using an old version of TeX, don't do anything. We want the amount of
5972% stretch added to depend on the line length, hence the dependence on
5973% \hsize. We call this whenever the paper size is set.
5974%
5975\def\setemergencystretch{%
5976 \ifx\emergencystretch\thisisundefined
5977 % Allow us to assign to \emergencystretch anyway.
5978 \def\emergencystretch{\dimen0}%
5979 \else
5980 \emergencystretch = .15\hsize
5981 \fi
5982}
5983
5984% Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
5985% 4) hoffset; 5) binding offset; 6) topskip. We also call
5986% \setleading{\textleading}, so the caller should define \textleading.
5987% The caller should also set \parskip.
5988%
5989\def\internalpagesizes#1#2#3#4#5#6{%
5990 \voffset = #3\relax
5991 \topskip = #6\relax
5992 \splittopskip = \topskip
5993 %
5994 \vsize = #1\relax
5995 \advance\vsize by \topskip
5996 \outervsize = \vsize
5997 \advance\outervsize by 2\topandbottommargin
5998 \pageheight = \vsize
5999 %
6000 \hsize = #2\relax
6001 \outerhsize = \hsize
6002 \advance\outerhsize by 0.5in
6003 \pagewidth = \hsize
6004 %
6005 \normaloffset = #4\relax
6006 \bindingoffset = #5\relax
6007 %
6008 \setleading{\textleading}
6009 %
6010 \parindent = \defaultparindent
6011 \setemergencystretch
6012}
6013
6014% Use `small' versions.
6015%
6016\def\smallenvironments{%
6017 \let\smalldisplay = \smalldisplayx
6018 \let\smallexample = \smalllispx
6019 \let\smallformat = \smallformatx
6020 \let\smalllisp = \smalllispx
6021}
6022
6023% @letterpaper (the default).
6024\def\letterpaper{{\globaldefs = 1
6025 \parskip = 3pt plus 2pt minus 1pt
6026 \textleading = 13.2pt
6027 %
6028 % If page is nothing but text, make it come out even.
6029 \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}%
6030}}
6031
6032% Use @smallbook to reset parameters for 7x9.5 (or so) format.
6033\def\smallbook{{\globaldefs = 1
6034 \parskip = 2pt plus 1pt
6035 \textleading = 12pt
6036 %
6037 \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}%
6038 %
6039 \lispnarrowing = 0.3in
6040 \tolerance = 700
6041 \hfuzz = 1pt
6042 \contentsrightmargin = 0pt
6043 \deftypemargin = 0pt
6044 \defbodyindent = .5cm
6045 \smallenvironments
6046}}
6047
6048% Use @afourpaper to print on European A4 paper.
6049\def\afourpaper{{\globaldefs = 1
6050 \parskip = 3pt plus 2pt minus 1pt
6051 \textleading = 12pt
6052 %
6053 \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}%
6054 %
6055 \tolerance = 700
6056 \hfuzz = 1pt
6057}}
6058
6059% Use @afivepaper to print on European A5 paper.
6060% From romildo@urano.iceb.ufop.br, 2 July 2000.
6061% He also recommends making @example and @lisp be small.
6062\def\afivepaper{{\globaldefs = 1
6063 \parskip = 2pt plus 1pt minus 0.1pt
6064 \textleading = 12.5pt
6065 %
6066 \internalpagesizes{166mm}{120mm}{\voffset}{-8mm}{\bindingoffset}{8pt}%
6067 %
6068 \lispnarrowing = 0.2in
6069 \tolerance = 800
6070 \hfuzz = 1.2pt
6071 \contentsrightmargin = 0mm
6072 \deftypemargin = 0pt
6073 \defbodyindent = 2mm
6074 \tableindent = 12mm
6075 %
6076 \smallenvironments
6077}}
6078
6079% A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
6080% 29mm, hence bottom margin 28mm, nominal side margin 3cm.
6081\def\afourlatex{{\globaldefs = 1
6082 \textleading = 13.6pt
6083 %
6084 \afourpaper
6085 \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}%
6086}}
6087
6088% Use @afourwide to print on European A4 paper in wide format.
6089\def\afourwide{%
6090 \afourpaper
6091 \internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}%
6092}
6093
6094% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6095% Perhaps we should allow setting the margins, \topskip, \parskip,
6096% and/or leading, also. Or perhaps we should compute them somehow.
6097%
6098\def\pagesizes{\parsearg\pagesizesxxx}
6099\def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6100\def\pagesizesyyy#1,#2,#3\finish{{%
6101 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6102 \globaldefs = 1
6103 %
6104 \parskip = 3pt plus 2pt minus 1pt
6105 \setleading{\textleading}%
6106 %
6107 \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}%
6108}}
6109
6110% Set default to letter.
6111%
6112\letterpaper
6113
6114
6115\message{and turning on texinfo input format.}
6116
6117% Define macros to output various characters with catcode for normal text.
6118\catcode`\"=\other
6119\catcode`\~=\other
6120\catcode`\^=\other
6121\catcode`\_=\other
6122\catcode`\|=\other
6123\catcode`\<=\other
6124\catcode`\>=\other
6125\catcode`\+=\other
6126\catcode`\$=\other
6127\def\normaldoublequote{"}
6128\def\normaltilde{~}
6129\def\normalcaret{^}
6130\def\normalunderscore{_}
6131\def\normalverticalbar{|}
6132\def\normalless{<}
6133\def\normalgreater{>}
6134\def\normalplus{+}
6135\def\normaldollar{$}
6136
6137% This macro is used to make a character print one way in ttfont
6138% where it can probably just be output, and another way in other fonts,
6139% where something hairier probably needs to be done.
6140%
6141% #1 is what to print if we are indeed using \tt; #2 is what to print
6142% otherwise. Since all the Computer Modern typewriter fonts have zero
6143% interword stretch (and shrink), and it is reasonable to expect all
6144% typewriter fonts to have this, we can check that font parameter.
6145%
6146\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6147
6148% Same as above, but check for italic font. Actually this also catches
6149% non-italic slanted fonts since it is impossible to distinguish them from
6150% italic fonts. But since this is only used by $ and it uses \sl anyway
6151% this is not a problem.
6152\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6153
6154% Turn off all special characters except @
6155% (and those which the user can use as if they were ordinary).
6156% Most of these we simply print from the \tt font, but for some, we can
6157% use math or other variants that look better in normal text.
6158
6159\catcode`\"=\active
6160\def\activedoublequote{{\tt\char34}}
6161\let"=\activedoublequote
6162\catcode`\~=\active
6163\def~{{\tt\char126}}
6164\chardef\hat=`\^
6165\catcode`\^=\active
6166\def^{{\tt \hat}}
6167
6168\catcode`\_=\active
6169\def_{\ifusingtt\normalunderscore\_}
6170% Subroutine for the previous macro.
6171\def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
6172
6173\catcode`\|=\active
6174\def|{{\tt\char124}}
6175\chardef \less=`\<
6176\catcode`\<=\active
6177\def<{{\tt \less}}
6178\chardef \gtr=`\>
6179\catcode`\>=\active
6180\def>{{\tt \gtr}}
6181\catcode`\+=\active
6182\def+{{\tt \char 43}}
6183\catcode`\$=\active
6184\def${\ifusingit{{\sl\$}}\normaldollar}
6185%\catcode 27=\active
6186%\def^^[{$\diamondsuit$}
6187
6188% Set up an active definition for =, but don't enable it most of the time.
6189{\catcode`\==\active
6190\global\def={{\tt \char 61}}}
6191
6192\catcode`+=\active
6193\catcode`\_=\active
6194
6195% If a .fmt file is being used, characters that might appear in a file
6196% name cannot be active until we have parsed the command line.
6197% So turn them off again, and have \everyjob (or @setfilename) turn them on.
6198% \otherifyactive is called near the end of this file.
6199\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6200
6201\catcode`\@=0
6202
6203% \rawbackslashxx output one backslash character in current font
6204\global\chardef\rawbackslashxx=`\\
6205%{\catcode`\\=\other
6206%@gdef@rawbackslashxx{\}}
6207
6208% \rawbackslash redefines \ as input to do \rawbackslashxx.
6209{\catcode`\\=\active
6210@gdef@rawbackslash{@let\=@rawbackslashxx }}
6211
6212% \normalbackslash outputs one backslash in fixed width font.
6213\def\normalbackslash{{\tt\rawbackslashxx}}
6214
6215% \catcode 17=0 % Define control-q
6216\catcode`\\=\active
6217
6218% Used sometimes to turn off (effectively) the active characters
6219% even after parsing them.
6220@def@turnoffactive{@let"=@normaldoublequote
6221@let\=@realbackslash
6222@let~=@normaltilde
6223@let^=@normalcaret
6224@let_=@normalunderscore
6225@let|=@normalverticalbar
6226@let<=@normalless
6227@let>=@normalgreater
6228@let+=@normalplus
6229@let$=@normaldollar}
6230
6231@def@normalturnoffactive{@let"=@normaldoublequote
6232@let\=@normalbackslash
6233@let~=@normaltilde
6234@let^=@normalcaret
6235@let_=@normalunderscore
6236@let|=@normalverticalbar
6237@let<=@normalless
6238@let>=@normalgreater
6239@let+=@normalplus
6240@let$=@normaldollar}
6241
6242% Make _ and + \other characters, temporarily.
6243% This is canceled by @fixbackslash.
6244@otherifyactive
6245
6246% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6247% That is what \eatinput is for; after that, the `\' should revert to printing
6248% a backslash.
6249%
6250@gdef@eatinput input texinfo{@fixbackslash}
6251@global@let\ = @eatinput
6252
6253% On the other hand, perhaps the file did not have a `\input texinfo'. Then
6254% the first `\{ in the file would cause an error. This macro tries to fix
6255% that, assuming it is called before the first `\' could plausibly occur.
6256% Also back turn on active characters that might appear in the input
6257% file name, in case not using a pre-dumped format.
6258%
6259@gdef@fixbackslash{%
6260 @ifx\@eatinput @let\ = @normalbackslash @fi
6261 @catcode`+=@active
6262 @catcode`@_=@active
6263}
6264
6265% Say @foo, not \foo, in error messages.
6266@escapechar = `@@
6267
6268% These look ok in all fonts, so just make them not special.
6269@catcode`@& = @other
6270@catcode`@# = @other
6271@catcode`@% = @other
6272
6273@c Set initial fonts.
6274@textfonts
6275@rm
6276
6277
6278@c Local variables:
6279@c eval: (add-hook 'write-file-hooks 'time-stamp)
6280@c page-delimiter: "^\\\\message"
6281@c time-stamp-start: "def\\\\texinfoversion{"
6282@c time-stamp-format: "%:y-%02m-%02d.%02H"
6283@c time-stamp-end: "}"
6284@c End: