source: trunk/essentials/app-shells/bash/lib/termcap/grot/texinfo.tex@ 3280

Last change on this file since 3280 was 3228, checked in by bird, 19 years ago

bash 3.1

File size: 142.7 KB
Line 
1%% TeX macros to handle texinfo files
2
3% Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 1994 Free Software Foundation, Inc.
4
5%This texinfo.tex file is free software; you can redistribute it and/or
6%modify it under the terms of the GNU General Public License as
7%published by the Free Software Foundation; either version 2, or (at
8%your option) any later version.
9
10%This texinfo.tex file is distributed in the hope that it will be
11%useful, but WITHOUT ANY WARRANTY; without even the implied warranty
12%of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13%General Public License for more details.
14
15%You should have received a copy of the GNU General Public License
16%along with this texinfo.tex file; see the file COPYING. If not, write
17%to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
18%USA.
19
20
21%In other words, you are welcome to use, share and improve this program.
22%You are forbidden to forbid anyone else to use, share and improve
23%what you give them. Help stamp out software-hoarding!
24
25
26% Send bug reports to [email protected].
27% Please include a *precise* test case in each bug report.
28
29
30% Make it possible to create a .fmt file just by loading this file:
31% if the underlying format is not loaded, start by loading it now.
32% Added by gildea November 1993.
33\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
34
35% This automatically updates the version number based on RCS.
36\def\deftexinfoversion$#1: #2 ${\def\texinfoversion{#2}}
37\deftexinfoversion$Revision: 2.146 $
38\message{Loading texinfo package [Version \texinfoversion]:}
39
40% If in a .fmt file, print the version number
41% and turn on active characters that we couldn't do earlier because
42% they might have appeared in the input file name.
43\everyjob{\message{[Texinfo version \texinfoversion]}\message{}
44 \catcode`+=\active \catcode`\_=\active}
45
46% Save some parts of plain tex whose names we will redefine.
47
48\let\ptextilde=\~
49\let\ptexlbrace=\{
50\let\ptexrbrace=\}
51\let\ptexdots=\dots
52\let\ptexdot=\.
53\let\ptexstar=\*
54\let\ptexend=\end
55\let\ptexbullet=\bullet
56\let\ptexb=\b
57\let\ptexc=\c
58\let\ptexi=\i
59\let\ptext=\t
60\let\ptexl=\l
61\let\ptexL=\L
62
63% Be sure we're in horizontal mode when doing a tie, since we make space
64% equivalent to this in @example-like environments. Otherwise, a space
65% at the beginning of a line will start with \penalty -- and
66% since \penalty is valid in vertical mode, we'd end up putting the
67% penalty on the vertical list instead of in the new paragraph.
68{\catcode`@ = 11
69 \gdef\tie{\leavevmode\penalty\@M\ }
70}
71\let\~ = \tie % And make it available as @~.
72
73\message{Basics,}
74\chardef\other=12
75
76% If this character appears in an error message or help string, it
77% starts a new line in the output.
78\newlinechar = `^^J
79
80% Set up fixed words for English.
81\ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter}}\fi%
82\def\putwordInfo{Info}%
83\ifx\putwordSee\undefined{\gdef\putwordSee{See}}\fi%
84\ifx\putwordsee\undefined{\gdef\putwordsee{see}}\fi%
85\ifx\putwordfile\undefined{\gdef\putwordfile{file}}\fi%
86\ifx\putwordpage\undefined{\gdef\putwordpage{page}}\fi%
87\ifx\putwordsection\undefined{\gdef\putwordsection{section}}\fi%
88\ifx\putwordSection\undefined{\gdef\putwordSection{Section}}\fi%
89\ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents}}\fi%
90\ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents}}\fi%
91\ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix}}\fi%
92
93% Ignore a token.
94%
95\def\gobble#1{}
96
97\hyphenation{ap-pen-dix}
98\hyphenation{mini-buf-fer mini-buf-fers}
99\hyphenation{eshell}
100
101% Margin to add to right of even pages, to left of odd pages.
102\newdimen \bindingoffset \bindingoffset=0pt
103\newdimen \normaloffset \normaloffset=\hoffset
104\newdimen\pagewidth \newdimen\pageheight
105\pagewidth=\hsize \pageheight=\vsize
106
107% Sometimes it is convenient to have everything in the transcript file
108% and nothing on the terminal. We don't just call \tracingall here,
109% since that produces some useless output on the terminal.
110%
111\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
112\def\loggingall{\tracingcommands2 \tracingstats2
113 \tracingpages1 \tracingoutput1 \tracinglostchars1
114 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
115 \showboxbreadth\maxdimen\showboxdepth\maxdimen
116}%
117
118%---------------------Begin change-----------------------
119%
120%%%% For @cropmarks command.
121% Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986
122%
123\newdimen\cornerlong \newdimen\cornerthick
124\newdimen \topandbottommargin
125\newdimen \outerhsize \newdimen \outervsize
126\cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks
127\outerhsize=7in
128%\outervsize=9.5in
129% Alternative @smallbook page size is 9.25in
130\outervsize=9.25in
131\topandbottommargin=.75in
132%
133%---------------------End change-----------------------
134
135% \onepageout takes a vbox as an argument. Note that \pagecontents
136% does insertions itself, but you have to call it yourself.
137\chardef\PAGE=255 \output={\onepageout{\pagecontents\PAGE}}
138\def\onepageout#1{\hoffset=\normaloffset
139\ifodd\pageno \advance\hoffset by \bindingoffset
140\else \advance\hoffset by -\bindingoffset\fi
141{\escapechar=`\\\relax % makes sure backslash is used in output files.
142\shipout\vbox{{\let\hsize=\pagewidth \makeheadline} \pagebody{#1}%
143{\let\hsize=\pagewidth \makefootline}}}%
144\advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
145
146%%%% For @cropmarks command %%%%
147
148% Here is a modification of the main output routine for Near East Publications
149% This provides right-angle cropmarks at all four corners.
150% The contents of the page are centerlined into the cropmarks,
151% and any desired binding offset is added as an \hskip on either
152% site of the centerlined box. (P. A. MacKay, 12 November, 1986)
153%
154\def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up
155{\escapechar=`\\\relax % makes sure backslash is used in output files.
156 \shipout
157 \vbox to \outervsize{\hsize=\outerhsize
158 \vbox{\line{\ewtop\hfill\ewtop}}
159 \nointerlineskip
160 \line{\vbox{\moveleft\cornerthick\nstop}
161 \hfill
162 \vbox{\moveright\cornerthick\nstop}}
163 \vskip \topandbottommargin
164 \centerline{\ifodd\pageno\hskip\bindingoffset\fi
165 \vbox{
166 {\let\hsize=\pagewidth \makeheadline}
167 \pagebody{#1}
168 {\let\hsize=\pagewidth \makefootline}}
169 \ifodd\pageno\else\hskip\bindingoffset\fi}
170 \vskip \topandbottommargin plus1fill minus1fill
171 \boxmaxdepth\cornerthick
172 \line{\vbox{\moveleft\cornerthick\nsbot}
173 \hfill
174 \vbox{\moveright\cornerthick\nsbot}}
175 \nointerlineskip
176 \vbox{\line{\ewbot\hfill\ewbot}}
177 }}
178 \advancepageno
179 \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
180%
181% Do @cropmarks to get crop marks
182\def\cropmarks{\let\onepageout=\croppageout }
183
184\newinsert\margin \dimen\margin=\maxdimen
185
186\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
187{\catcode`\@ =11
188\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
189% marginal hacks, [email protected] (Juha Takala)
190\ifvoid\margin\else % marginal info is present
191 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
192\dimen@=\dp#1 \unvbox#1
193\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
194\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
195}
196
197%
198% Here are the rules for the cropmarks. Note that they are
199% offset so that the space between them is truly \outerhsize or \outervsize
200% (P. A. MacKay, 12 November, 1986)
201%
202\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
203\def\nstop{\vbox
204 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
205\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
206\def\nsbot{\vbox
207 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
208
209% Parse an argument, then pass it to #1. The argument is the rest of
210% the input line (except we remove a trailing comment). #1 should be a
211% macro which expects an ordinary undelimited TeX argument.
212%
213\def\parsearg#1{%
214 \let\next = #1%
215 \begingroup
216 \obeylines
217 \futurelet\temp\parseargx
218}
219
220% If the next token is an obeyed space (from an @example environment or
221% the like), remove it and recurse. Otherwise, we're done.
222\def\parseargx{%
223 % \obeyedspace is defined far below, after the definition of \sepspaces.
224 \ifx\obeyedspace\temp
225 \expandafter\parseargdiscardspace
226 \else
227 \expandafter\parseargline
228 \fi
229}
230
231% Remove a single space (as the delimiter token to the macro call).
232{\obeyspaces %
233 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
234
235{\obeylines %
236 \gdef\parseargline#1^^M{%
237 \endgroup % End of the group started in \parsearg.
238 %
239 % First remove any @c comment, then any @comment.
240 % Result of each macro is put in \toks0.
241 \argremovec #1\c\relax %
242 \expandafter\argremovecomment \the\toks0 \comment\relax %
243 %
244 % Call the caller's macro, saved as \next in \parsearg.
245 \expandafter\next\expandafter{\the\toks0}%
246 }%
247}
248
249% Since all \c{,omment} does is throw away the argument, we can let TeX
250% do that for us. The \relax here is matched by the \relax in the call
251% in \parseargline; it could be more or less anything, its purpose is
252% just to delimit the argument to the \c.
253\def\argremovec#1\c#2\relax{\toks0 = {#1}}
254\def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
255
256% \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
257% @end itemize @c foo
258% will have two active spaces as part of the argument with the
259% `itemize'. Here we remove all active spaces from #1, and assign the
260% result to \toks0.
261%
262% This loses if there are any *other* active characters besides spaces
263% in the argument -- _ ^ +, for example -- since they get expanded.
264% Fortunately, Texinfo does not define any such commands. (If it ever
265% does, the catcode of the characters in questionwill have to be changed
266% here.) But this means we cannot call \removeactivespaces as part of
267% \argremovec{,omment}, since @c uses \parsearg, and thus the argument
268% that \parsearg gets might well have any character at all in it.
269%
270\def\removeactivespaces#1{%
271 \begingroup
272 \ignoreactivespaces
273 \edef\temp{#1}%
274 \global\toks0 = \expandafter{\temp}%
275 \endgroup
276}
277
278% Change the active space to expand to nothing.
279%
280\begingroup
281 \obeyspaces
282 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
283\endgroup
284
285
286\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
287
288%% These are used to keep @begin/@end levels from running away
289%% Call \inENV within environments (after a \begingroup)
290\newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
291\def\ENVcheck{%
292\ifENV\errmessage{Still within an environment. Type Return to continue.}
293\endgroup\fi} % This is not perfect, but it should reduce lossage
294
295% @begin foo is the same as @foo, for now.
296\newhelp\EMsimple{Type <Return> to continue.}
297
298\outer\def\begin{\parsearg\beginxxx}
299
300\def\beginxxx #1{%
301\expandafter\ifx\csname #1\endcsname\relax
302{\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
303\csname #1\endcsname\fi}
304
305% @end foo executes the definition of \Efoo.
306%
307\def\end{\parsearg\endxxx}
308\def\endxxx #1{%
309 \removeactivespaces{#1}%
310 \edef\endthing{\the\toks0}%
311 %
312 \expandafter\ifx\csname E\endthing\endcsname\relax
313 \expandafter\ifx\csname \endthing\endcsname\relax
314 % There's no \foo, i.e., no ``environment'' foo.
315 \errhelp = \EMsimple
316 \errmessage{Undefined command `@end \endthing'}%
317 \else
318 \unmatchedenderror\endthing
319 \fi
320 \else
321 % Everything's ok; the right environment has been started.
322 \csname E\endthing\endcsname
323 \fi
324}
325
326% There is an environment #1, but it hasn't been started. Give an error.
327%
328\def\unmatchedenderror#1{%
329 \errhelp = \EMsimple
330 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
331}
332
333% Define the control sequence \E#1 to give an unmatched @end error.
334%
335\def\defineunmatchedend#1{%
336 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
337}
338
339
340% Single-spacing is done by various environments (specifically, in
341% \nonfillstart and \quotations).
342\newskip\singlespaceskip \singlespaceskip = 12.5pt
343\def\singlespace{%
344 % Why was this kern here? It messes up equalizing space above and below
345 % environments. --karl, 6may93
346 %{\advance \baselineskip by -\singlespaceskip
347 %\kern \baselineskip}%
348 \setleading \singlespaceskip
349}
350
351%% Simple single-character @ commands
352
353% @@ prints an @
354% Kludge this until the fonts are right (grr).
355\def\@{{\tt \char '100}}
356
357% This is turned off because it was never documented
358% and you can use @w{...} around a quote to suppress ligatures.
359%% Define @` and @' to be the same as ` and '
360%% but suppressing ligatures.
361%\def\`{{`}}
362%\def\'{{'}}
363
364% Used to generate quoted braces.
365
366\def\mylbrace {{\tt \char '173}}
367\def\myrbrace {{\tt \char '175}}
368\let\{=\mylbrace
369\let\}=\myrbrace
370
371% @: forces normal size whitespace following.
372\def\:{\spacefactor=1000 }
373
374% @* forces a line break.
375\def\*{\hfil\break\hbox{}\ignorespaces}
376
377% @. is an end-of-sentence period.
378\def\.{.\spacefactor=3000 }
379
380% @enddots{} is an end-of-sentence ellipsis.
381\gdef\enddots{$\mathinner{\ldotp\ldotp\ldotp\ldotp}$\spacefactor=3000}
382
383% @! is an end-of-sentence bang.
384\gdef\!{!\spacefactor=3000 }
385
386% @? is an end-of-sentence query.
387\gdef\?{?\spacefactor=3000 }
388
389% @w prevents a word break. Without the \leavevmode, @w at the
390% beginning of a paragraph, when TeX is still in vertical mode, would
391% produce a whole line of output instead of starting the paragraph.
392\def\w#1{\leavevmode\hbox{#1}}
393
394% @group ... @end group forces ... to be all on one page, by enclosing
395% it in a TeX vbox. We use \vtop instead of \vbox to construct the box
396% to keep its height that of a normal line. According to the rules for
397% \topskip (p.114 of the TeXbook), the glue inserted is
398% max (\topskip - \ht (first item), 0). If that height is large,
399% therefore, no glue is inserted, and the space between the headline and
400% the text is small, which looks bad.
401%
402\def\group{\begingroup
403 \ifnum\catcode13=\active \else
404 \errhelp = \groupinvalidhelp
405 \errmessage{@group invalid in context where filling is enabled}%
406 \fi
407 %
408 % The \vtop we start below produces a box with normal height and large
409 % depth; thus, TeX puts \baselineskip glue before it, and (when the
410 % next line of text is done) \lineskip glue after it. (See p.82 of
411 % the TeXbook.) Thus, space below is not quite equal to space
412 % above. But it's pretty close.
413 \def\Egroup{%
414 \egroup % End the \vtop.
415 \endgroup % End the \group.
416 }%
417 %
418 \vtop\bgroup
419 % We have to put a strut on the last line in case the @group is in
420 % the midst of an example, rather than completely enclosing it.
421 % Otherwise, the interline space between the last line of the group
422 % and the first line afterwards is too small. But we can't put the
423 % strut in \Egroup, since there it would be on a line by itself.
424 % Hence this just inserts a strut at the beginning of each line.
425 \everypar = {\strut}%
426 %
427 % Since we have a strut on every line, we don't need any of TeX's
428 % normal interline spacing.
429 \offinterlineskip
430 %
431 % OK, but now we have to do something about blank
432 % lines in the input in @example-like environments, which normally
433 % just turn into \lisppar, which will insert no space now that we've
434 % turned off the interline space. Simplest is to make them be an
435 % empty paragraph.
436 \ifx\par\lisppar
437 \edef\par{\leavevmode \par}%
438 %
439 % Reset ^^M's definition to new definition of \par.
440 \obeylines
441 \fi
442 %
443 % Do @comment since we are called inside an environment such as
444 % @example, where each end-of-line in the input causes an
445 % end-of-line in the output. We don't want the end-of-line after
446 % the `@group' to put extra space in the output. Since @group
447 % should appear on a line by itself (according to the Texinfo
448 % manual), we don't worry about eating any user text.
449 \comment
450}
451%
452% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
453% message, so this ends up printing `@group can only ...'.
454%
455\newhelp\groupinvalidhelp{%
456group can only be used in environments such as @example,^^J%
457where each line of input produces a line of output.}
458
459% @need space-in-mils
460% forces a page break if there is not space-in-mils remaining.
461
462\newdimen\mil \mil=0.001in
463
464\def\need{\parsearg\needx}
465
466% Old definition--didn't work.
467%\def\needx #1{\par %
468%% This method tries to make TeX break the page naturally
469%% if the depth of the box does not fit.
470%{\baselineskip=0pt%
471%\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
472%\prevdepth=-1000pt
473%}}
474
475\def\needx#1{%
476 % Go into vertical mode, so we don't make a big box in the middle of a
477 % paragraph.
478 \par
479 %
480 % Don't add any leading before our big empty box, but allow a page
481 % break, since the best break might be right here.
482 \allowbreak
483 \nointerlineskip
484 \vtop to #1\mil{\vfil}%
485 %
486 % TeX does not even consider page breaks if a penalty added to the
487 % main vertical list is 10000 or more. But in order to see if the
488 % empty box we just added fits on the page, we must make it consider
489 % page breaks. On the other hand, we don't want to actually break the
490 % page after the empty box. So we use a penalty of 9999.
491 %
492 % There is an extremely small chance that TeX will actually break the
493 % page at this \penalty, if there are no other feasible breakpoints in
494 % sight. (If the user is using lots of big @group commands, which
495 % almost-but-not-quite fill up a page, TeX will have a hard time doing
496 % good page breaking, for example.) However, I could not construct an
497 % example where a page broke at this \penalty; if it happens in a real
498 % document, then we can reconsider our strategy.
499 \penalty9999
500 %
501 % Back up by the size of the box, whether we did a page break or not.
502 \kern -#1\mil
503 %
504 % Do not allow a page break right after this kern.
505 \nobreak
506}
507
508% @br forces paragraph break
509
510\let\br = \par
511
512% @dots{} output some dots
513
514\def\dots{$\ldots$}
515
516% @page forces the start of a new page
517
518\def\page{\par\vfill\supereject}
519
520% @exdent text....
521% outputs text on separate line in roman font, starting at standard page margin
522
523% This records the amount of indent in the innermost environment.
524% That's how much \exdent should take out.
525\newskip\exdentamount
526
527% This defn is used inside fill environments such as @defun.
528\def\exdent{\parsearg\exdentyyy}
529\def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
530
531% This defn is used inside nofill environments such as @example.
532\def\nofillexdent{\parsearg\nofillexdentyyy}
533\def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
534\leftline{\hskip\leftskip{\rm#1}}}}
535
536%\hbox{{\rm#1}}\hfil\break}}
537
538% @include file insert text of that file as input.
539
540\def\include{\parsearg\includezzz}
541%Use \input\thisfile to avoid blank after \input, which may be an active
542%char (in which case the blank would become the \input argument).
543%The grouping keeps the value of \thisfile correct even when @include
544%is nested.
545\def\includezzz #1{\begingroup
546\def\thisfile{#1}\input\thisfile
547\endgroup}
548
549\def\thisfile{}
550
551% @center line outputs that line, centered
552
553\def\center{\parsearg\centerzzz}
554\def\centerzzz #1{{\advance\hsize by -\leftskip
555\advance\hsize by -\rightskip
556\centerline{#1}}}
557
558% @sp n outputs n lines of vertical space
559
560\def\sp{\parsearg\spxxx}
561\def\spxxx #1{\par \vskip #1\baselineskip}
562
563% @comment ...line which is ignored...
564% @c is the same as @comment
565% @ignore ... @end ignore is another way to write a comment
566
567\def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
568\parsearg \commentxxx}
569
570\def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
571
572\let\c=\comment
573
574% Prevent errors for section commands.
575% Used in @ignore and in failing conditionals.
576\def\ignoresections{%
577\let\chapter=\relax
578\let\unnumbered=\relax
579\let\top=\relax
580\let\unnumberedsec=\relax
581\let\unnumberedsection=\relax
582\let\unnumberedsubsec=\relax
583\let\unnumberedsubsection=\relax
584\let\unnumberedsubsubsec=\relax
585\let\unnumberedsubsubsection=\relax
586\let\section=\relax
587\let\subsec=\relax
588\let\subsubsec=\relax
589\let\subsection=\relax
590\let\subsubsection=\relax
591\let\appendix=\relax
592\let\appendixsec=\relax
593\let\appendixsection=\relax
594\let\appendixsubsec=\relax
595\let\appendixsubsection=\relax
596\let\appendixsubsubsec=\relax
597\let\appendixsubsubsection=\relax
598\let\contents=\relax
599\let\smallbook=\relax
600\let\titlepage=\relax
601}
602
603% Used in nested conditionals, where we have to parse the Texinfo source
604% and so want to turn off most commands, in case they are used
605% incorrectly.
606%
607\def\ignoremorecommands{%
608 \let\defcv = \relax
609 \let\deffn = \relax
610 \let\deffnx = \relax
611 \let\defindex = \relax
612 \let\defivar = \relax
613 \let\defmac = \relax
614 \let\defmethod = \relax
615 \let\defop = \relax
616 \let\defopt = \relax
617 \let\defspec = \relax
618 \let\deftp = \relax
619 \let\deftypefn = \relax
620 \let\deftypefun = \relax
621 \let\deftypevar = \relax
622 \let\deftypevr = \relax
623 \let\defun = \relax
624 \let\defvar = \relax
625 \let\defvr = \relax
626 \let\ref = \relax
627 \let\xref = \relax
628 \let\printindex = \relax
629 \let\pxref = \relax
630 \let\settitle = \relax
631 \let\include = \relax
632 \let\lowersections = \relax
633 \let\down = \relax
634 \let\raisesections = \relax
635 \let\up = \relax
636 \let\set = \relax
637 \let\clear = \relax
638 \let\item = \relax
639 \let\message = \relax
640}
641
642% Ignore @ignore ... @end ignore.
643%
644\def\ignore{\doignore{ignore}}
645
646% Also ignore @ifinfo, @ifhtml, @html, @menu, and @direntry text.
647%
648\def\ifinfo{\doignore{ifinfo}}
649\def\ifhtml{\doignore{ifhtml}}
650\def\html{\doignore{html}}
651\def\menu{\doignore{menu}}
652\def\direntry{\doignore{direntry}}
653
654% Ignore text until a line `@end #1'.
655%
656\def\doignore#1{\begingroup
657 % Don't complain about control sequences we have declared \outer.
658 \ignoresections
659 %
660 % Define a command to swallow text until we reach `@end #1'.
661 \long\def\doignoretext##1\end #1{\enddoignore}%
662 %
663 % Make sure that spaces turn into tokens that match what \doignoretext wants.
664 \catcode32 = 10
665 %
666 % And now expand that command.
667 \doignoretext
668}
669
670% What we do to finish off ignored text.
671%
672\def\enddoignore{\endgroup\ignorespaces}%
673
674\newif\ifwarnedobs\warnedobsfalse
675\def\obstexwarn{%
676 \ifwarnedobs\relax\else
677 % We need to warn folks that they may have trouble with TeX 3.0.
678 % This uses \immediate\write16 rather than \message to get newlines.
679 \immediate\write16{}
680 \immediate\write16{***WARNING*** for users of Unix TeX 3.0!}
681 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
682 \immediate\write16{If you are running another version of TeX, relax.}
683 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
684 \immediate\write16{ Then upgrade your TeX installation if you can.}
685 \immediate\write16{If you are stuck with version 3.0, run the}
686 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
687 \immediate\write16{ to use a workaround.}
688 \immediate\write16{}
689 \warnedobstrue
690 \fi
691}
692
693% **In TeX 3.0, setting text in \nullfont hangs tex. For a
694% workaround (which requires the file ``dummy.tfm'' to be installed),
695% uncomment the following line:
696%%%%%\font\nullfont=dummy\let\obstexwarn=\relax
697
698% Ignore text, except that we keep track of conditional commands for
699% purposes of nesting, up to an `@end #1' command.
700%
701\def\nestedignore#1{%
702 \obstexwarn
703 % We must actually expand the ignored text to look for the @end
704 % command, so that nested ignore constructs work. Thus, we put the
705 % text into a \vbox and then do nothing with the result. To minimize
706 % the change of memory overflow, we follow the approach outlined on
707 % page 401 of the TeXbook: make the current font be a dummy font.
708 %
709 \setbox0 = \vbox\bgroup
710 % Don't complain about control sequences we have declared \outer.
711 \ignoresections
712 %
713 % Define `@end #1' to end the box, which will in turn undefine the
714 % @end command again.
715 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
716 %
717 % We are going to be parsing Texinfo commands. Most cause no
718 % trouble when they are used incorrectly, but some commands do
719 % complicated argument parsing or otherwise get confused, so we
720 % undefine them.
721 %
722 % We can't do anything about stray @-signs, unfortunately;
723 % they'll produce `undefined control sequence' errors.
724 \ignoremorecommands
725 %
726 % Set the current font to be \nullfont, a TeX primitive, and define
727 % all the font commands to also use \nullfont. We don't use
728 % dummy.tfm, as suggested in the TeXbook, because not all sites
729 % might have that installed. Therefore, math mode will still
730 % produce output, but that should be an extremely small amount of
731 % stuff compared to the main input.
732 %
733 \nullfont
734 \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont
735 \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont
736 \let\tensf = \nullfont
737 % Similarly for index fonts (mostly for their use in
738 % smallexample)
739 \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont
740 \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont
741 \let\indsf = \nullfont
742 %
743 % Don't complain when characters are missing from the fonts.
744 \tracinglostchars = 0
745 %
746 % Don't bother to do space factor calculations.
747 \frenchspacing
748 %
749 % Don't report underfull hboxes.
750 \hbadness = 10000
751 %
752 % Do minimal line-breaking.
753 \pretolerance = 10000
754 %
755 % Do not execute instructions in @tex
756 \def\tex{\doignore{tex}}
757}
758
759% @set VAR sets the variable VAR to an empty value.
760% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
761%
762% Since we want to separate VAR from REST-OF-LINE (which might be
763% empty), we can't just use \parsearg; we have to insert a space of our
764% own to delimit the rest of the line, and then take it out again if we
765% didn't need it.
766%
767\def\set{\parsearg\setxxx}
768\def\setxxx#1{\setyyy#1 \endsetyyy}
769\def\setyyy#1 #2\endsetyyy{%
770 \def\temp{#2}%
771 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
772 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
773 \fi
774}
775% Can't use \xdef to pre-expand #2 and save some time, since \temp or
776% \next or other control sequences that we've defined might get us into
777% an infinite loop. Consider `@set foo @cite{bar}'.
778\def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
779
780% @clear VAR clears (i.e., unsets) the variable VAR.
781%
782\def\clear{\parsearg\clearxxx}
783\def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
784
785% @value{foo} gets the text saved in variable foo.
786%
787\def\value#1{\expandafter
788 \ifx\csname SET#1\endcsname\relax
789 {\{No value for ``#1''\}}
790 \else \csname SET#1\endcsname \fi}
791
792% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
793% with @set.
794%
795\def\ifset{\parsearg\ifsetxxx}
796\def\ifsetxxx #1{%
797 \expandafter\ifx\csname SET#1\endcsname\relax
798 \expandafter\ifsetfail
799 \else
800 \expandafter\ifsetsucceed
801 \fi
802}
803\def\ifsetsucceed{\conditionalsucceed{ifset}}
804\def\ifsetfail{\nestedignore{ifset}}
805\defineunmatchedend{ifset}
806
807% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
808% defined with @set, or has been undefined with @clear.
809%
810\def\ifclear{\parsearg\ifclearxxx}
811\def\ifclearxxx #1{%
812 \expandafter\ifx\csname SET#1\endcsname\relax
813 \expandafter\ifclearsucceed
814 \else
815 \expandafter\ifclearfail
816 \fi
817}
818\def\ifclearsucceed{\conditionalsucceed{ifclear}}
819\def\ifclearfail{\nestedignore{ifclear}}
820\defineunmatchedend{ifclear}
821
822% @iftex always succeeds; we read the text following, through @end
823% iftex). But `@end iftex' should be valid only after an @iftex.
824%
825\def\iftex{\conditionalsucceed{iftex}}
826\defineunmatchedend{iftex}
827
828% We can't just want to start a group at @iftex (for example) and end it
829% at @end iftex, since then @set commands inside the conditional have no
830% effect (they'd get reverted at the end of the group). So we must
831% define \Eiftex to redefine itself to be its previous value. (We can't
832% just define it to fail again with an ``unmatched end'' error, since
833% the @ifset might be nested.)
834%
835\def\conditionalsucceed#1{%
836 \edef\temp{%
837 % Remember the current value of \E#1.
838 \let\nece{prevE#1} = \nece{E#1}%
839 %
840 % At the `@end #1', redefine \E#1 to be its previous value.
841 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
842 }%
843 \temp
844}
845
846% We need to expand lots of \csname's, but we don't want to expand the
847% control sequences after we've constructed them.
848%
849\def\nece#1{\expandafter\noexpand\csname#1\endcsname}
850
851% @asis just yields its argument. Used with @table, for example.
852%
853\def\asis#1{#1}
854
855% @math means output in math mode.
856% We don't use $'s directly in the definition of \math because control
857% sequences like \math are expanded when the toc file is written. Then,
858% we read the toc file back, the $'s will be normal characters (as they
859% should be, according to the definition of Texinfo). So we must use a
860% control sequence to switch into and out of math mode.
861%
862% This isn't quite enough for @math to work properly in indices, but it
863% seems unlikely it will ever be needed there.
864%
865\let\implicitmath = $
866\def\math#1{\implicitmath #1\implicitmath}
867
868% @bullet and @minus need the same treatment as @math, just above.
869\def\bullet{\implicitmath\ptexbullet\implicitmath}
870\def\minus{\implicitmath-\implicitmath}
871
872\def\node{\ENVcheck\parsearg\nodezzz}
873\def\nodezzz#1{\nodexxx [#1,]}
874\def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
875\let\nwnode=\node
876\let\lastnode=\relax
877
878\def\donoderef{\ifx\lastnode\relax\else
879\expandafter\expandafter\expandafter\setref{\lastnode}\fi
880\global\let\lastnode=\relax}
881
882\def\unnumbnoderef{\ifx\lastnode\relax\else
883\expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
884\global\let\lastnode=\relax}
885
886\def\appendixnoderef{\ifx\lastnode\relax\else
887\expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
888\global\let\lastnode=\relax}
889
890\let\refill=\relax
891
892% @setfilename is done at the beginning of every texinfo file.
893% So open here the files we need to have open while reading the input.
894% This makes it possible to make a .fmt file for texinfo.
895\def\setfilename{%
896 \readauxfile
897 \opencontents
898 \openindices
899 \fixbackslash % Turn off hack to swallow `\input texinfo'.
900 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
901 \comment % Ignore the actual filename.
902}
903
904\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
905
906\def\inforef #1{\inforefzzz #1,,,,**}
907\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
908 node \samp{\ignorespaces#1{}}}
909
910\message{fonts,}
911
912% Font-change commands.
913
914% Texinfo supports the sans serif font style, which plain TeX does not.
915% So we set up a \sf analogous to plain's \rm, etc.
916\newfam\sffam
917\def\sf{\fam=\sffam \tensf}
918\let\li = \sf % Sometimes we call it \li, not \sf.
919
920%% Try out Computer Modern fonts at \magstephalf
921\let\mainmagstep=\magstephalf
922
923% Set the font macro #1 to the font named #2, adding on the
924% specified font prefix (normally `cm').
925\def\setfont#1#2{\font#1=\fontprefix#2}
926
927% Use cm as the default font prefix.
928% To specify the font prefix, you must define \fontprefix
929% before you read in texinfo.tex.
930\ifx\fontprefix\undefined
931\def\fontprefix{cm}
932\fi
933
934\ifx\bigger\relax
935\let\mainmagstep=\magstep1
936\setfont\textrm{r12}
937\setfont\texttt{tt12}
938\else
939\setfont\textrm{r10 scaled \mainmagstep}
940\setfont\texttt{tt10 scaled \mainmagstep}
941\fi
942% Instead of cmb10, you many want to use cmbx10.
943% cmbx10 is a prettier font on its own, but cmb10
944% looks better when embedded in a line with cmr10.
945\setfont\textbf{b10 scaled \mainmagstep}
946\setfont\textit{ti10 scaled \mainmagstep}
947\setfont\textsl{sl10 scaled \mainmagstep}
948\setfont\textsf{ss10 scaled \mainmagstep}
949\setfont\textsc{csc10 scaled \mainmagstep}
950\font\texti=cmmi10 scaled \mainmagstep
951\font\textsy=cmsy10 scaled \mainmagstep
952
953% A few fonts for @defun, etc.
954\setfont\defbf{bx10 scaled \magstep1} %was 1314
955\setfont\deftt{tt10 scaled \magstep1}
956\def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
957
958% Fonts for indices and small examples.
959% We actually use the slanted font rather than the italic,
960% because texinfo normally uses the slanted fonts for that.
961% Do not make many font distinctions in general in the index, since they
962% aren't very useful.
963\setfont\ninett{tt9}
964\setfont\indrm{r9}
965\setfont\indit{sl9}
966\let\indsl=\indit
967\let\indtt=\ninett
968\let\indsf=\indrm
969\let\indbf=\indrm
970\setfont\indsc{csc10 at 9pt}
971\font\indi=cmmi9
972\font\indsy=cmsy9
973
974% Fonts for headings
975\setfont\chaprm{bx12 scaled \magstep2}
976\setfont\chapit{ti12 scaled \magstep2}
977\setfont\chapsl{sl12 scaled \magstep2}
978\setfont\chaptt{tt12 scaled \magstep2}
979\setfont\chapsf{ss12 scaled \magstep2}
980\let\chapbf=\chaprm
981\setfont\chapsc{csc10 scaled\magstep3}
982\font\chapi=cmmi12 scaled \magstep2
983\font\chapsy=cmsy10 scaled \magstep3
984
985\setfont\secrm{bx12 scaled \magstep1}
986\setfont\secit{ti12 scaled \magstep1}
987\setfont\secsl{sl12 scaled \magstep1}
988\setfont\sectt{tt12 scaled \magstep1}
989\setfont\secsf{ss12 scaled \magstep1}
990\setfont\secbf{bx12 scaled \magstep1}
991\setfont\secsc{csc10 scaled\magstep2}
992\font\seci=cmmi12 scaled \magstep1
993\font\secsy=cmsy10 scaled \magstep2
994
995% \setfont\ssecrm{bx10 scaled \magstep1} % This size an font looked bad.
996% \setfont\ssecit{cmti10 scaled \magstep1} % The letters were too crowded.
997% \setfont\ssecsl{sl10 scaled \magstep1}
998% \setfont\ssectt{tt10 scaled \magstep1}
999% \setfont\ssecsf{ss10 scaled \magstep1}
1000
1001%\setfont\ssecrm{b10 scaled 1315} % Note the use of cmb rather than cmbx.
1002%\setfont\ssecit{ti10 scaled 1315} % Also, the size is a little larger than
1003%\setfont\ssecsl{sl10 scaled 1315} % being scaled magstep1.
1004%\setfont\ssectt{tt10 scaled 1315}
1005%\setfont\ssecsf{ss10 scaled 1315}
1006
1007%\let\ssecbf=\ssecrm
1008
1009\setfont\ssecrm{bx12 scaled \magstephalf}
1010\setfont\ssecit{ti12 scaled \magstephalf}
1011\setfont\ssecsl{sl12 scaled \magstephalf}
1012\setfont\ssectt{tt12 scaled \magstephalf}
1013\setfont\ssecsf{ss12 scaled \magstephalf}
1014\setfont\ssecbf{bx12 scaled \magstephalf}
1015\setfont\ssecsc{csc10 scaled \magstep1}
1016\font\sseci=cmmi12 scaled \magstephalf
1017\font\ssecsy=cmsy10 scaled \magstep1
1018% The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1019% but that is not a standard magnification.
1020
1021% Fonts for title page:
1022\setfont\titlerm{bx12 scaled \magstep3}
1023\let\authorrm = \secrm
1024
1025% In order for the font changes to affect most math symbols and letters,
1026% we have to define the \textfont of the standard families. Since
1027% texinfo doesn't allow for producing subscripts and superscripts, we
1028% don't bother to reset \scriptfont and \scriptscriptfont (which would
1029% also require loading a lot more fonts).
1030%
1031\def\resetmathfonts{%
1032 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1033 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1034 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1035}
1036
1037
1038% The font-changing commands redefine the meanings of \tenSTYLE, instead
1039% of just \STYLE. We do this so that font changes will continue to work
1040% in math mode, where it is the current \fam that is relevant in most
1041% cases, not the current. Plain TeX does, for example,
1042% \def\bf{\fam=\bffam \tenbf} By redefining \tenbf, we obviate the need
1043% to redefine \bf itself.
1044\def\textfonts{%
1045 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1046 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1047 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1048 \resetmathfonts}
1049\def\chapfonts{%
1050 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1051 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1052 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1053 \resetmathfonts}
1054\def\secfonts{%
1055 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1056 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1057 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1058 \resetmathfonts}
1059\def\subsecfonts{%
1060 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1061 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1062 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1063 \resetmathfonts}
1064\def\indexfonts{%
1065 \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
1066 \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
1067 \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy
1068 \resetmathfonts}
1069
1070% Set up the default fonts, so we can use them for creating boxes.
1071%
1072\textfonts
1073
1074% Count depth in font-changes, for error checks
1075\newcount\fontdepth \fontdepth=0
1076
1077% Fonts for short table of contents.
1078\setfont\shortcontrm{r12}
1079\setfont\shortcontbf{bx12}
1080\setfont\shortcontsl{sl12}
1081
1082%% Add scribe-like font environments, plus @l for inline lisp (usually sans
1083%% serif) and @ii for TeX italic
1084
1085% \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1086% unless the following character is such as not to need one.
1087\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1088\def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1089
1090\let\i=\smartitalic
1091\let\var=\smartitalic
1092\let\dfn=\smartitalic
1093\let\emph=\smartitalic
1094\let\cite=\smartitalic
1095
1096\def\b#1{{\bf #1}}
1097\let\strong=\b
1098
1099% We can't just use \exhyphenpenalty, because that only has effect at
1100% the end of a paragraph. Restore normal hyphenation at the end of the
1101% group within which \nohyphenation is presumably called.
1102%
1103\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1104\def\restorehyphenation{\hyphenchar\font = `- }
1105
1106\def\t#1{%
1107 {\tt \rawbackslash \frenchspacing #1}%
1108 \null
1109}
1110\let\ttfont=\t
1111\def\samp #1{`\tclose{#1}'\null}
1112\def\key #1{{\tt \nohyphenation \uppercase{#1}}\null}
1113\def\ctrl #1{{\tt \rawbackslash \hat}#1}
1114
1115\let\file=\samp
1116
1117% @code is a modification of @t,
1118% which makes spaces the same size as normal in the surrounding text.
1119\def\tclose#1{%
1120 {%
1121 % Change normal interword space to be same as for the current font.
1122 \spaceskip = \fontdimen2\font
1123 %
1124 % Switch to typewriter.
1125 \tt
1126 %
1127 % But `\ ' produces the large typewriter interword space.
1128 \def\ {{\spaceskip = 0pt{} }}%
1129 %
1130 % Turn off hyphenation.
1131 \nohyphenation
1132 %
1133 \rawbackslash
1134 \frenchspacing
1135 #1%
1136 }%
1137 \null
1138}
1139
1140% We *must* turn on hyphenation at `-' and `_' in \code.
1141% Otherwise, it is too hard to avoid overful hboxes
1142% in the Emacs manual, the Library manual, etc.
1143
1144% Unfortunately, TeX uses one parameter (\hyphenchar) to control
1145% both hyphenation at - and hyphenation within words.
1146% We must therefore turn them both off (\tclose does that)
1147% and arrange explicitly to hyphenate an a dash.
1148% -- rms.
1149{
1150\catcode`\-=\active
1151\catcode`\_=\active
1152\global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex}
1153% The following is used by \doprintindex to insure that long function names
1154% wrap around. It is necessary for - and _ to be active before the index is
1155% read from the file, as \entry parses the arguments long before \code is
1156% ever called. -- mycroft
1157\global\def\indexbreaks{\catcode`\-=\active \let-\realdash \catcode`\_=\active \let_\realunder}
1158}
1159
1160\def\realdash{-}
1161\def\realunder{_}
1162\def\codedash{-\discretionary{}{}{}}
1163\def\codeunder{\normalunderscore\discretionary{}{}{}}
1164\def\codex #1{\tclose{#1}\endgroup}
1165
1166%\let\exp=\tclose %Was temporary
1167
1168% @kbd is like @code, except that if the argument is just one @key command,
1169% then @kbd has no effect.
1170
1171\def\xkey{\key}
1172\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1173\ifx\one\xkey\ifx\threex\three \key{#2}%
1174\else\tclose{\look}\fi
1175\else\tclose{\look}\fi}
1176
1177% Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1178% argument is to make the input look right: @dmn{pt} instead of
1179% @dmn{}pt.
1180%
1181\def\dmn#1{\thinspace #1}
1182
1183\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1184
1185\def\l#1{{\li #1}\null} %
1186
1187\def\r#1{{\rm #1}} % roman font
1188% Use of \lowercase was suggested.
1189\def\sc#1{{\smallcaps#1}} % smallcaps font
1190\def\ii#1{{\it #1}} % italic font
1191
1192\message{page headings,}
1193
1194\newskip\titlepagetopglue \titlepagetopglue = 1.5in
1195\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1196
1197% First the title page. Must do @settitle before @titlepage.
1198\def\titlefont#1{{\titlerm #1}}
1199
1200\newif\ifseenauthor
1201\newif\iffinishedtitlepage
1202
1203\def\shorttitlepage{\parsearg\shorttitlepagezzz}
1204\def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1205 \endgroup\page\hbox{}\page}
1206
1207\def\titlepage{\begingroup \parindent=0pt \textfonts
1208 \let\subtitlerm=\tenrm
1209% I deinstalled the following change because \cmr12 is undefined.
1210% This change was not in the ChangeLog anyway. --rms.
1211% \let\subtitlerm=\cmr12
1212 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1213 %
1214 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1215 %
1216 % Leave some space at the very top of the page.
1217 \vglue\titlepagetopglue
1218 %
1219 % Now you can print the title using @title.
1220 \def\title{\parsearg\titlezzz}%
1221 \def\titlezzz##1{\leftline{\titlefont{##1}}
1222 % print a rule at the page bottom also.
1223 \finishedtitlepagefalse
1224 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1225 % No rule at page bottom unless we print one at the top with @title.
1226 \finishedtitlepagetrue
1227 %
1228 % Now you can put text using @subtitle.
1229 \def\subtitle{\parsearg\subtitlezzz}%
1230 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1231 %
1232 % @author should come last, but may come many times.
1233 \def\author{\parsearg\authorzzz}%
1234 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1235 {\authorfont \leftline{##1}}}%
1236 %
1237 % Most title ``pages'' are actually two pages long, with space
1238 % at the top of the second. We don't want the ragged left on the second.
1239 \let\oldpage = \page
1240 \def\page{%
1241 \iffinishedtitlepage\else
1242 \finishtitlepage
1243 \fi
1244 \oldpage
1245 \let\page = \oldpage
1246 \hbox{}}%
1247% \def\page{\oldpage \hbox{}}
1248}
1249
1250\def\Etitlepage{%
1251 \iffinishedtitlepage\else
1252 \finishtitlepage
1253 \fi
1254 % It is important to do the page break before ending the group,
1255 % because the headline and footline are only empty inside the group.
1256 % If we use the new definition of \page, we always get a blank page
1257 % after the title page, which we certainly don't want.
1258 \oldpage
1259 \endgroup
1260 \HEADINGSon
1261}
1262
1263\def\finishtitlepage{%
1264 \vskip4pt \hrule height 2pt width \hsize
1265 \vskip\titlepagebottomglue
1266 \finishedtitlepagetrue
1267}
1268
1269%%% Set up page headings and footings.
1270
1271\let\thispage=\folio
1272
1273\newtoks \evenheadline % Token sequence for heading line of even pages
1274\newtoks \oddheadline % Token sequence for heading line of odd pages
1275\newtoks \evenfootline % Token sequence for footing line of even pages
1276\newtoks \oddfootline % Token sequence for footing line of odd pages
1277
1278% Now make Tex use those variables
1279\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1280 \else \the\evenheadline \fi}}
1281\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1282 \else \the\evenfootline \fi}\HEADINGShook}
1283\let\HEADINGShook=\relax
1284
1285% Commands to set those variables.
1286% For example, this is what @headings on does
1287% @evenheading @thistitle|@thispage|@thischapter
1288% @oddheading @thischapter|@thispage|@thistitle
1289% @evenfooting @thisfile||
1290% @oddfooting ||@thisfile
1291
1292\def\evenheading{\parsearg\evenheadingxxx}
1293\def\oddheading{\parsearg\oddheadingxxx}
1294\def\everyheading{\parsearg\everyheadingxxx}
1295
1296\def\evenfooting{\parsearg\evenfootingxxx}
1297\def\oddfooting{\parsearg\oddfootingxxx}
1298\def\everyfooting{\parsearg\everyfootingxxx}
1299
1300{\catcode`\@=0 %
1301
1302\gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1303\gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1304\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1305
1306\gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1307\gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1308\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1309
1310\gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish}
1311\gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{%
1312\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1313\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1314
1315\gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1316\gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1317\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1318
1319\gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1320\gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1321\global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1322
1323\gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish}
1324\gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{%
1325\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1326\global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1327%
1328}% unbind the catcode of @.
1329
1330% @headings double turns headings on for double-sided printing.
1331% @headings single turns headings on for single-sided printing.
1332% @headings off turns them off.
1333% @headings on same as @headings double, retained for compatibility.
1334% @headings after turns on double-sided headings after this page.
1335% @headings doubleafter turns on double-sided headings after this page.
1336% @headings singleafter turns on single-sided headings after this page.
1337% By default, they are off.
1338
1339\def\headings #1 {\csname HEADINGS#1\endcsname}
1340
1341\def\HEADINGSoff{
1342\global\evenheadline={\hfil} \global\evenfootline={\hfil}
1343\global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1344\HEADINGSoff
1345% When we turn headings on, set the page number to 1.
1346% For double-sided printing, put current file name in lower left corner,
1347% chapter name on inside top of right hand pages, document
1348% title on inside top of left hand pages, and page numbers on outside top
1349% edge of all pages.
1350\def\HEADINGSdouble{
1351%\pagealignmacro
1352\global\pageno=1
1353\global\evenfootline={\hfil}
1354\global\oddfootline={\hfil}
1355\global\evenheadline={\line{\folio\hfil\thistitle}}
1356\global\oddheadline={\line{\thischapter\hfil\folio}}
1357}
1358% For single-sided printing, chapter title goes across top left of page,
1359% page number on top right.
1360\def\HEADINGSsingle{
1361%\pagealignmacro
1362\global\pageno=1
1363\global\evenfootline={\hfil}
1364\global\oddfootline={\hfil}
1365\global\evenheadline={\line{\thischapter\hfil\folio}}
1366\global\oddheadline={\line{\thischapter\hfil\folio}}
1367}
1368\def\HEADINGSon{\HEADINGSdouble}
1369
1370\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1371\let\HEADINGSdoubleafter=\HEADINGSafter
1372\def\HEADINGSdoublex{%
1373\global\evenfootline={\hfil}
1374\global\oddfootline={\hfil}
1375\global\evenheadline={\line{\folio\hfil\thistitle}}
1376\global\oddheadline={\line{\thischapter\hfil\folio}}
1377}
1378
1379\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1380\def\HEADINGSsinglex{%
1381\global\evenfootline={\hfil}
1382\global\oddfootline={\hfil}
1383\global\evenheadline={\line{\thischapter\hfil\folio}}
1384\global\oddheadline={\line{\thischapter\hfil\folio}}
1385}
1386
1387% Subroutines used in generating headings
1388% Produces Day Month Year style of output.
1389\def\today{\number\day\space
1390\ifcase\month\or
1391January\or February\or March\or April\or May\or June\or
1392July\or August\or September\or October\or November\or December\fi
1393\space\number\year}
1394
1395% Use this if you want the Month Day, Year style of output.
1396%\def\today{\ifcase\month\or
1397%January\or February\or March\or April\or May\or June\or
1398%July\or August\or September\or October\or November\or December\fi
1399%\space\number\day, \number\year}
1400
1401% @settitle line... specifies the title of the document, for headings
1402% It generates no output of its own
1403
1404\def\thistitle{No Title}
1405\def\settitle{\parsearg\settitlezzz}
1406\def\settitlezzz #1{\gdef\thistitle{#1}}
1407
1408\message{tables,}
1409
1410% @tabs -- simple alignment
1411
1412% These don't work. For one thing, \+ is defined as outer.
1413% So these macros cannot even be defined.
1414
1415%\def\tabs{\parsearg\tabszzz}
1416%\def\tabszzz #1{\settabs\+#1\cr}
1417%\def\tabline{\parsearg\tablinezzz}
1418%\def\tablinezzz #1{\+#1\cr}
1419%\def\&{&}
1420
1421% Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1422
1423% default indentation of table text
1424\newdimen\tableindent \tableindent=.8in
1425% default indentation of @itemize and @enumerate text
1426\newdimen\itemindent \itemindent=.3in
1427% margin between end of table item and start of table text.
1428\newdimen\itemmargin \itemmargin=.1in
1429
1430% used internally for \itemindent minus \itemmargin
1431\newdimen\itemmax
1432
1433% Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1434% these defs.
1435% They also define \itemindex
1436% to index the item name in whatever manner is desired (perhaps none).
1437
1438\newif\ifitemxneedsnegativevskip
1439
1440\def\itemxpar{\par\ifitemxneedsnegativevskip\vskip-\parskip\nobreak\fi}
1441
1442\def\internalBitem{\smallbreak \parsearg\itemzzz}
1443\def\internalBitemx{\itemxpar \parsearg\itemzzz}
1444
1445\def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1446\def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1447
1448\def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1449\def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1450
1451\def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1452 \itemzzz {#1}}
1453
1454\def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1455 \itemzzz {#1}}
1456
1457\def\itemzzz #1{\begingroup %
1458 \advance\hsize by -\rightskip
1459 \advance\hsize by -\tableindent
1460 \setbox0=\hbox{\itemfont{#1}}%
1461 \itemindex{#1}%
1462 \nobreak % This prevents a break before @itemx.
1463 %
1464 % Be sure we are not still in the middle of a paragraph.
1465 %{\parskip = 0in
1466 %\par
1467 %}%
1468 %
1469 % If the item text does not fit in the space we have, put it on a line
1470 % by itself, and do not allow a page break either before or after that
1471 % line. We do not start a paragraph here because then if the next
1472 % command is, e.g., @kindex, the whatsit would get put into the
1473 % horizontal list on a line by itself, resulting in extra blank space.
1474 \ifdim \wd0>\itemmax
1475 %
1476 % Make this a paragraph so we get the \parskip glue and wrapping,
1477 % but leave it ragged-right.
1478 \begingroup
1479 \advance\leftskip by-\tableindent
1480 \advance\hsize by\tableindent
1481 \advance\rightskip by0pt plus1fil
1482 \leavevmode\unhbox0\par
1483 \endgroup
1484 %
1485 % We're going to be starting a paragraph, but we don't want the
1486 % \parskip glue -- logically it's part of the @item we just started.
1487 \nobreak \vskip-\parskip
1488 %
1489 % Stop a page break at the \parskip glue coming up. Unfortunately
1490 % we can't prevent a possible page break at the following
1491 % \baselineskip glue.
1492 \nobreak
1493 \endgroup
1494 \itemxneedsnegativevskipfalse
1495 \else
1496 % The item text fits into the space. Start a paragraph, so that the
1497 % following text (if any) will end up on the same line. Since that
1498 % text will be indented by \tableindent, we make the item text be in
1499 % a zero-width box.
1500 \noindent
1501 \rlap{\hskip -\tableindent\box0}\ignorespaces%
1502 \endgroup%
1503 \itemxneedsnegativevskiptrue%
1504 \fi
1505}
1506
1507\def\item{\errmessage{@item while not in a table}}
1508\def\itemx{\errmessage{@itemx while not in a table}}
1509\def\kitem{\errmessage{@kitem while not in a table}}
1510\def\kitemx{\errmessage{@kitemx while not in a table}}
1511\def\xitem{\errmessage{@xitem while not in a table}}
1512\def\xitemx{\errmessage{@xitemx while not in a table}}
1513
1514%% Contains a kludge to get @end[description] to work
1515\def\description{\tablez{\dontindex}{1}{}{}{}{}}
1516
1517\def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1518{\obeylines\obeyspaces%
1519\gdef\tablex #1^^M{%
1520\tabley\dontindex#1 \endtabley}}
1521
1522\def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1523{\obeylines\obeyspaces%
1524\gdef\ftablex #1^^M{%
1525\tabley\fnitemindex#1 \endtabley
1526\def\Eftable{\endgraf\afterenvbreak\endgroup}%
1527\let\Etable=\relax}}
1528
1529\def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1530{\obeylines\obeyspaces%
1531\gdef\vtablex #1^^M{%
1532\tabley\vritemindex#1 \endtabley
1533\def\Evtable{\endgraf\afterenvbreak\endgroup}%
1534\let\Etable=\relax}}
1535
1536\def\dontindex #1{}
1537\def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1538\def\vritemindex #1{\doind {vr}{\code{#1}}}%
1539
1540{\obeyspaces %
1541\gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1542\tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1543
1544\def\tablez #1#2#3#4#5#6{%
1545\aboveenvbreak %
1546\begingroup %
1547\def\Edescription{\Etable}% Neccessary kludge.
1548\let\itemindex=#1%
1549\ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1550\ifnum 0#4>0 \tableindent=#4\mil \fi %
1551\ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1552\def\itemfont{#2}%
1553\itemmax=\tableindent %
1554\advance \itemmax by -\itemmargin %
1555\advance \leftskip by \tableindent %
1556\exdentamount=\tableindent
1557\parindent = 0pt
1558\parskip = \smallskipamount
1559\ifdim \parskip=0pt \parskip=2pt \fi%
1560\def\Etable{\endgraf\afterenvbreak\endgroup}%
1561\let\item = \internalBitem %
1562\let\itemx = \internalBitemx %
1563\let\kitem = \internalBkitem %
1564\let\kitemx = \internalBkitemx %
1565\let\xitem = \internalBxitem %
1566\let\xitemx = \internalBxitemx %
1567}
1568
1569% This is the counter used by @enumerate, which is really @itemize
1570
1571\newcount \itemno
1572
1573\def\itemize{\parsearg\itemizezzz}
1574
1575\def\itemizezzz #1{%
1576 \begingroup % ended by the @end itemsize
1577 \itemizey {#1}{\Eitemize}
1578}
1579
1580\def\itemizey #1#2{%
1581\aboveenvbreak %
1582\itemmax=\itemindent %
1583\advance \itemmax by -\itemmargin %
1584\advance \leftskip by \itemindent %
1585\exdentamount=\itemindent
1586\parindent = 0pt %
1587\parskip = \smallskipamount %
1588\ifdim \parskip=0pt \parskip=2pt \fi%
1589\def#2{\endgraf\afterenvbreak\endgroup}%
1590\def\itemcontents{#1}%
1591\let\item=\itemizeitem}
1592
1593% Set sfcode to normal for the chars that usually have another value.
1594% These are `.?!:;,'
1595\def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1596 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1597
1598% \splitoff TOKENS\endmark defines \first to be the first token in
1599% TOKENS, and \rest to be the remainder.
1600%
1601\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1602
1603% Allow an optional argument of an uppercase letter, lowercase letter,
1604% or number, to specify the first label in the enumerated list. No
1605% argument is the same as `1'.
1606%
1607\def\enumerate{\parsearg\enumeratezzz}
1608\def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1609\def\enumeratey #1 #2\endenumeratey{%
1610 \begingroup % ended by the @end enumerate
1611 %
1612 % If we were given no argument, pretend we were given `1'.
1613 \def\thearg{#1}%
1614 \ifx\thearg\empty \def\thearg{1}\fi
1615 %
1616 % Detect if the argument is a single token. If so, it might be a
1617 % letter. Otherwise, the only valid thing it can be is a number.
1618 % (We will always have one token, because of the test we just made.
1619 % This is a good thing, since \splitoff doesn't work given nothing at
1620 % all -- the first parameter is undelimited.)
1621 \expandafter\splitoff\thearg\endmark
1622 \ifx\rest\empty
1623 % Only one token in the argument. It could still be anything.
1624 % A ``lowercase letter'' is one whose \lccode is nonzero.
1625 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1626 % not equal to itself.
1627 % Otherwise, we assume it's a number.
1628 %
1629 % We need the \relax at the end of the \ifnum lines to stop TeX from
1630 % continuing to look for a <number>.
1631 %
1632 \ifnum\lccode\expandafter`\thearg=0\relax
1633 \numericenumerate % a number (we hope)
1634 \else
1635 % It's a letter.
1636 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1637 \lowercaseenumerate % lowercase letter
1638 \else
1639 \uppercaseenumerate % uppercase letter
1640 \fi
1641 \fi
1642 \else
1643 % Multiple tokens in the argument. We hope it's a number.
1644 \numericenumerate
1645 \fi
1646}
1647
1648% An @enumerate whose labels are integers. The starting integer is
1649% given in \thearg.
1650%
1651\def\numericenumerate{%
1652 \itemno = \thearg
1653 \startenumeration{\the\itemno}%
1654}
1655
1656% The starting (lowercase) letter is in \thearg.
1657\def\lowercaseenumerate{%
1658 \itemno = \expandafter`\thearg
1659 \startenumeration{%
1660 % Be sure we're not beyond the end of the alphabet.
1661 \ifnum\itemno=0
1662 \errmessage{No more lowercase letters in @enumerate; get a bigger
1663 alphabet}%
1664 \fi
1665 \char\lccode\itemno
1666 }%
1667}
1668
1669% The starting (uppercase) letter is in \thearg.
1670\def\uppercaseenumerate{%
1671 \itemno = \expandafter`\thearg
1672 \startenumeration{%
1673 % Be sure we're not beyond the end of the alphabet.
1674 \ifnum\itemno=0
1675 \errmessage{No more uppercase letters in @enumerate; get a bigger
1676 alphabet}
1677 \fi
1678 \char\uccode\itemno
1679 }%
1680}
1681
1682% Call itemizey, adding a period to the first argument and supplying the
1683% common last two arguments. Also subtract one from the initial value in
1684% \itemno, since @item increments \itemno.
1685%
1686\def\startenumeration#1{%
1687 \advance\itemno by -1
1688 \itemizey{#1.}\Eenumerate\flushcr
1689}
1690
1691% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1692% to @enumerate.
1693%
1694\def\alphaenumerate{\enumerate{a}}
1695\def\capsenumerate{\enumerate{A}}
1696\def\Ealphaenumerate{\Eenumerate}
1697\def\Ecapsenumerate{\Eenumerate}
1698
1699% Definition of @item while inside @itemize.
1700
1701\def\itemizeitem{%
1702\advance\itemno by 1
1703{\let\par=\endgraf \smallbreak}%
1704\ifhmode \errmessage{\in hmode at itemizeitem}\fi
1705{\parskip=0in \hskip 0pt
1706\hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1707\vadjust{\penalty 1200}}%
1708\flushcr}
1709
1710% @multitable macros
1711% Amy Hendrickson, 8/18/94
1712%
1713% @multitable ... @endmultitable will make as many columns as desired.
1714% Contents of each column will wrap at width given in preamble. Width
1715% can be specified either with sample text given in a template line,
1716% or in percent of \hsize, the current width of text on page.
1717
1718% Table can continue over pages but will only break between lines.
1719
1720% To make preamble:
1721%
1722% Either define widths of columns in terms of percent of \hsize:
1723% @multitable @percentofhsize .2 .3 .5
1724% @item ...
1725%
1726% Numbers following @percentofhsize are the percent of the total
1727% current hsize to be used for each column. You may use as many
1728% columns as desired.
1729
1730% Or use a template:
1731% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1732% @item ...
1733% using the widest term desired in each column.
1734
1735
1736% Each new table line starts with @item, each subsequent new column
1737% starts with @tab. Empty columns may be produced by supplying @tab's
1738% with nothing between them for as many times as empty columns are needed,
1739% ie, @tab@tab@tab will produce two empty columns.
1740
1741% @item, @tab, @multicolumn or @endmulticolumn do not need to be on their
1742% own lines, but it will not hurt if they are.
1743
1744% Sample multitable:
1745
1746% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1747% @item first col stuff @tab second col stuff @tab third col
1748% @item
1749% first col stuff
1750% @tab
1751% second col stuff
1752% @tab
1753% third col
1754% @item first col stuff @tab second col stuff
1755% @tab Many paragraphs of text may be used in any column.
1756%
1757% They will wrap at the width determined by the template.
1758% @item@tab@tab This will be in third column.
1759% @endmultitable
1760
1761% Default dimensions may be reset by user.
1762% @intableparskip will set vertical space between paragraphs in table.
1763% @intableparindent will set paragraph indent in table.
1764% @spacebetweencols will set horizontal space to be left between columns.
1765% @spacebetweenlines will set vertical space to be left between lines.
1766
1767%%%%
1768% Dimensions
1769
1770\newdimen\intableparskip
1771\newdimen\intableparindent
1772\newdimen\spacebetweencols
1773\newdimen\spacebetweenlines
1774\intableparskip=0pt
1775\intableparindent=6pt
1776\spacebetweencols=12pt
1777\spacebetweenlines=12pt
1778
1779%%%%
1780% Macros used to set up halign preamble:
1781\let\endsetuptable\relax
1782\def\xendsetuptable{\endsetuptable}
1783\let\percentofhsize\relax
1784\def\xpercentofhsize{\percentofhsize}
1785\newif\ifsetpercent
1786
1787\newcount\colcount
1788\def\setuptable#1{\def\firstarg{#1}%
1789\ifx\firstarg\xendsetuptable\let\go\relax%
1790\else
1791 \ifx\firstarg\xpercentofhsize\global\setpercenttrue%
1792 \else
1793 \ifsetpercent
1794 \if#1.\else%
1795 \global\advance\colcount by1 %
1796 \expandafter\xdef\csname col\the\colcount\endcsname{.#1\hsize}%
1797 \fi
1798 \else
1799 \global\advance\colcount by1
1800 \setbox0=\hbox{#1}%
1801 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
1802 \fi%
1803 \fi%
1804 \let\go\setuptable%
1805\fi\go}
1806%%%%
1807% multitable syntax
1808\def\tab{&}
1809
1810%%%%
1811% @multitable ... @endmultitable definitions:
1812
1813\def\multitable#1\item{\bgroup
1814\let\item\cr
1815\tolerance=9500
1816\hbadness=9500
1817\parskip=\intableparskip
1818\parindent=\intableparindent
1819\overfullrule=0pt
1820\global\colcount=0\relax%
1821\def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}%
1822 % To parse everything between @multitable and @item :
1823\def\one{#1}\expandafter\setuptable\one\endsetuptable
1824 % Need to reset this to 0 after \setuptable.
1825\global\colcount=0\relax%
1826 %
1827 % This preamble sets up a generic column definition, which will
1828 % be used as many times as user calls for columns.
1829 % \vtop will set a single line and will also let text wrap and
1830 % continue for many paragraphs if desired.
1831\halign\bgroup&\global\advance\colcount by 1\relax%
1832\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
1833 % In order to keep entries from bumping into each other
1834 % we will add a \leftskip of \spacebetweencols to all columns after
1835 % the first one.
1836 % If a template has been used, we will add \spacebetweencols
1837 % to the width of each template entry.
1838 % If user has set preamble in terms of percent of \hsize
1839 % we will use that dimension as the width of the column, and
1840 % the \leftskip will keep entries from bumping into each other.
1841 % Table will start at left margin and final column will justify at
1842 % right margin.
1843\ifnum\colcount=1
1844\else
1845 \ifsetpercent
1846 \else
1847 % If user has <not> set preamble in terms of percent of \hsize
1848 % we will advance \hsize by \spacebetweencols
1849 \advance\hsize by \spacebetweencols
1850 \fi
1851 % In either case we will make \leftskip=\spacebetweencols:
1852\leftskip=\spacebetweencols
1853\fi
1854\noindent##}\cr%
1855 % \everycr will reset column counter, \colcount, at the end of
1856 % each line. Every column entry will cause \colcount to advance by one.
1857 % The table preamble
1858 % looks at the current \colcount to find the correct column width.
1859\global\everycr{\noalign{\nointerlineskip\vskip\spacebetweenlines
1860\filbreak%% keeps underfull box messages off when table breaks over pages.
1861\global\colcount=0\relax}}}
1862
1863\message{indexing,}
1864% Index generation facilities
1865
1866% Define \newwrite to be identical to plain tex's \newwrite
1867% except not \outer, so it can be used within \newindex.
1868{\catcode`\@=11
1869\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
1870
1871% \newindex {foo} defines an index named foo.
1872% It automatically defines \fooindex such that
1873% \fooindex ...rest of line... puts an entry in the index foo.
1874% It also defines \fooindfile to be the number of the output channel for
1875% the file that accumulates this index. The file's extension is foo.
1876% The name of an index should be no more than 2 characters long
1877% for the sake of vms.
1878
1879\def\newindex #1{
1880\expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
1881\openout \csname#1indfile\endcsname \jobname.#1 % Open the file
1882\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1883\noexpand\doindex {#1}}
1884}
1885
1886% @defindex foo == \newindex{foo}
1887
1888\def\defindex{\parsearg\newindex}
1889
1890% Define @defcodeindex, like @defindex except put all entries in @code.
1891
1892\def\newcodeindex #1{
1893\expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
1894\openout \csname#1indfile\endcsname \jobname.#1 % Open the file
1895\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1896\noexpand\docodeindex {#1}}
1897}
1898
1899\def\defcodeindex{\parsearg\newcodeindex}
1900
1901% @synindex foo bar makes index foo feed into index bar.
1902% Do this instead of @defindex foo if you don't want it as a separate index.
1903\def\synindex #1 #2 {%
1904\expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
1905\expandafter\let\csname#1indfile\endcsname=\synindexfoo
1906\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1907\noexpand\doindex {#2}}%
1908}
1909
1910% @syncodeindex foo bar similar, but put all entries made for index foo
1911% inside @code.
1912\def\syncodeindex #1 #2 {%
1913\expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
1914\expandafter\let\csname#1indfile\endcsname=\synindexfoo
1915\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1916\noexpand\docodeindex {#2}}%
1917}
1918
1919% Define \doindex, the driver for all \fooindex macros.
1920% Argument #1 is generated by the calling \fooindex macro,
1921% and it is "foo", the name of the index.
1922
1923% \doindex just uses \parsearg; it calls \doind for the actual work.
1924% This is because \doind is more useful to call from other macros.
1925
1926% There is also \dosubind {index}{topic}{subtopic}
1927% which makes an entry in a two-level index such as the operation index.
1928
1929\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
1930\def\singleindexer #1{\doind{\indexname}{#1}}
1931
1932% like the previous two, but they put @code around the argument.
1933\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
1934\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
1935
1936\def\indexdummies{%
1937% Take care of the plain tex accent commands.
1938\def\"{\realbackslash "}%
1939\def\`{\realbackslash `}%
1940\def\'{\realbackslash '}%
1941\def\^{\realbackslash ^}%
1942\def\~{\realbackslash ~}%
1943\def\={\realbackslash =}%
1944\def\b{\realbackslash b}%
1945\def\c{\realbackslash c}%
1946\def\d{\realbackslash d}%
1947\def\u{\realbackslash u}%
1948\def\v{\realbackslash v}%
1949\def\H{\realbackslash H}%
1950% Take care of the plain tex special European modified letters.
1951\def\oe{\realbackslash oe}%
1952\def\ae{\realbackslash ae}%
1953\def\aa{\realbackslash aa}%
1954\def\OE{\realbackslash OE}%
1955\def\AE{\realbackslash AE}%
1956\def\AA{\realbackslash AA}%
1957\def\o{\realbackslash o}%
1958\def\O{\realbackslash O}%
1959\def\l{\realbackslash l}%
1960\def\L{\realbackslash L}%
1961\def\ss{\realbackslash ss}%
1962% Take care of texinfo commands likely to appear in an index entry.
1963\def\_{{\realbackslash _}}%
1964\def\w{\realbackslash w }%
1965\def\bf{\realbackslash bf }%
1966\def\rm{\realbackslash rm }%
1967\def\sl{\realbackslash sl }%
1968\def\sf{\realbackslash sf}%
1969\def\tt{\realbackslash tt}%
1970\def\gtr{\realbackslash gtr}%
1971\def\less{\realbackslash less}%
1972\def\hat{\realbackslash hat}%
1973\def\char{\realbackslash char}%
1974\def\TeX{\realbackslash TeX}%
1975\def\dots{\realbackslash dots }%
1976\def\copyright{\realbackslash copyright }%
1977\def\tclose##1{\realbackslash tclose {##1}}%
1978\def\code##1{\realbackslash code {##1}}%
1979\def\samp##1{\realbackslash samp {##1}}%
1980\def\t##1{\realbackslash r {##1}}%
1981\def\r##1{\realbackslash r {##1}}%
1982\def\i##1{\realbackslash i {##1}}%
1983\def\b##1{\realbackslash b {##1}}%
1984\def\cite##1{\realbackslash cite {##1}}%
1985\def\key##1{\realbackslash key {##1}}%
1986\def\file##1{\realbackslash file {##1}}%
1987\def\var##1{\realbackslash var {##1}}%
1988\def\kbd##1{\realbackslash kbd {##1}}%
1989\def\dfn##1{\realbackslash dfn {##1}}%
1990\def\emph##1{\realbackslash emph {##1}}%
1991}
1992
1993% \indexnofonts no-ops all font-change commands.
1994% This is used when outputting the strings to sort the index by.
1995\def\indexdummyfont#1{#1}
1996\def\indexdummytex{TeX}
1997\def\indexdummydots{...}
1998
1999\def\indexnofonts{%
2000% Just ignore accents.
2001\let\"=\indexdummyfont
2002\let\`=\indexdummyfont
2003\let\'=\indexdummyfont
2004\let\^=\indexdummyfont
2005\let\~=\indexdummyfont
2006\let\==\indexdummyfont
2007\let\b=\indexdummyfont
2008\let\c=\indexdummyfont
2009\let\d=\indexdummyfont
2010\let\u=\indexdummyfont
2011\let\v=\indexdummyfont
2012\let\H=\indexdummyfont
2013% Take care of the plain tex special European modified letters.
2014\def\oe{oe}%
2015\def\ae{ae}%
2016\def\aa{aa}%
2017\def\OE{OE}%
2018\def\AE{AE}%
2019\def\AA{AA}%
2020\def\o{o}%
2021\def\O{O}%
2022\def\l{l}%
2023\def\L{L}%
2024\def\ss{ss}%
2025\let\w=\indexdummyfont
2026\let\t=\indexdummyfont
2027\let\r=\indexdummyfont
2028\let\i=\indexdummyfont
2029\let\b=\indexdummyfont
2030\let\emph=\indexdummyfont
2031\let\strong=\indexdummyfont
2032\let\cite=\indexdummyfont
2033\let\sc=\indexdummyfont
2034%Don't no-op \tt, since it isn't a user-level command
2035% and is used in the definitions of the active chars like <, >, |...
2036%\let\tt=\indexdummyfont
2037\let\tclose=\indexdummyfont
2038\let\code=\indexdummyfont
2039\let\file=\indexdummyfont
2040\let\samp=\indexdummyfont
2041\let\kbd=\indexdummyfont
2042\let\key=\indexdummyfont
2043\let\var=\indexdummyfont
2044\let\TeX=\indexdummytex
2045\let\dots=\indexdummydots
2046}
2047
2048% To define \realbackslash, we must make \ not be an escape.
2049% We must first make another character (@) an escape
2050% so we do not become unable to do a definition.
2051
2052{\catcode`\@=0 \catcode`\\=\other
2053@gdef@realbackslash{\}}
2054
2055\let\indexbackslash=0 %overridden during \printindex.
2056
2057\let\SETmarginindex=\relax %initialize!
2058% workhorse for all \fooindexes
2059% #1 is name of index, #2 is stuff to put there
2060\def\doind #1#2{%
2061% Put the index entry in the margin if desired.
2062\ifx\SETmarginindex\relax\else%
2063\insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2064\fi%
2065{\count10=\lastpenalty %
2066{\indexdummies % Must do this here, since \bf, etc expand at this stage
2067\escapechar=`\\%
2068{\let\folio=0% Expand all macros now EXCEPT \folio
2069\def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2070% so it will be output as is; and it will print as backslash in the indx.
2071%
2072% Now process the index-string once, with all font commands turned off,
2073% to get the string to sort the index by.
2074{\indexnofonts
2075\xdef\temp1{#2}%
2076}%
2077% Now produce the complete index entry. We process the index-string again,
2078% this time with font commands expanded, to get what to print in the index.
2079\edef\temp{%
2080\write \csname#1indfile\endcsname{%
2081\realbackslash entry {\temp1}{\folio}{#2}}}%
2082\temp }%
2083}\penalty\count10}}
2084
2085\def\dosubind #1#2#3{%
2086{\count10=\lastpenalty %
2087{\indexdummies % Must do this here, since \bf, etc expand at this stage
2088\escapechar=`\\%
2089{\let\folio=0%
2090\def\rawbackslashxx{\indexbackslash}%
2091%
2092% Now process the index-string once, with all font commands turned off,
2093% to get the string to sort the index by.
2094{\indexnofonts
2095\xdef\temp1{#2 #3}%
2096}%
2097% Now produce the complete index entry. We process the index-string again,
2098% this time with font commands expanded, to get what to print in the index.
2099\edef\temp{%
2100\write \csname#1indfile\endcsname{%
2101\realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
2102\temp }%
2103}\penalty\count10}}
2104
2105% The index entry written in the file actually looks like
2106% \entry {sortstring}{page}{topic}
2107% or
2108% \entry {sortstring}{page}{topic}{subtopic}
2109% The texindex program reads in these files and writes files
2110% containing these kinds of lines:
2111% \initial {c}
2112% before the first topic whose initial is c
2113% \entry {topic}{pagelist}
2114% for a topic that is used without subtopics
2115% \primary {topic}
2116% for the beginning of a topic that is used with subtopics
2117% \secondary {subtopic}{pagelist}
2118% for each subtopic.
2119
2120% Define the user-accessible indexing commands
2121% @findex, @vindex, @kindex, @cindex.
2122
2123\def\findex {\fnindex}
2124\def\kindex {\kyindex}
2125\def\cindex {\cpindex}
2126\def\vindex {\vrindex}
2127\def\tindex {\tpindex}
2128\def\pindex {\pgindex}
2129
2130\def\cindexsub {\begingroup\obeylines\cindexsub}
2131{\obeylines %
2132\gdef\cindexsub "#1" #2^^M{\endgroup %
2133\dosubind{cp}{#2}{#1}}}
2134
2135% Define the macros used in formatting output of the sorted index material.
2136
2137% This is what you call to cause a particular index to get printed.
2138% Write
2139% @unnumbered Function Index
2140% @printindex fn
2141
2142\def\printindex{\parsearg\doprintindex}
2143
2144\def\doprintindex#1{%
2145 \tex
2146 \dobreak \chapheadingskip {10000}
2147 \catcode`\%=\other\catcode`\&=\other\catcode`\#=\other
2148 \catcode`\$=\other
2149 \catcode`\~=\other
2150 \indexbreaks
2151 %
2152 % The following don't help, since the chars were translated
2153 % when the raw index was written, and their fonts were discarded
2154 % due to \indexnofonts.
2155 %\catcode`\"=\active
2156 %\catcode`\^=\active
2157 %\catcode`\_=\active
2158 %\catcode`\|=\active
2159 %\catcode`\<=\active
2160 %\catcode`\>=\active
2161 % %
2162 \def\indexbackslash{\rawbackslashxx}
2163 \indexfonts\rm \tolerance=9500 \advance\baselineskip -1pt
2164 \begindoublecolumns
2165 %
2166 % See if the index file exists and is nonempty.
2167 \openin 1 \jobname.#1s
2168 \ifeof 1
2169 % \enddoublecolumns gets confused if there is no text in the index,
2170 % and it loses the chapter title and the aux file entries for the
2171 % index. The easiest way to prevent this problem is to make sure
2172 % there is some text.
2173 (Index is nonexistent)
2174 \else
2175 %
2176 % If the index file exists but is empty, then \openin leaves \ifeof
2177 % false. We have to make TeX try to read something from the file, so
2178 % it can discover if there is anything in it.
2179 \read 1 to \temp
2180 \ifeof 1
2181 (Index is empty)
2182 \else
2183 \input \jobname.#1s
2184 \fi
2185 \fi
2186 \closein 1
2187 \enddoublecolumns
2188 \Etex
2189}
2190
2191% These macros are used by the sorted index file itself.
2192% Change them to control the appearance of the index.
2193
2194% Same as \bigskipamount except no shrink.
2195% \balancecolumns gets confused if there is any shrink.
2196\newskip\initialskipamount \initialskipamount 12pt plus4pt
2197
2198\def\initial #1{%
2199{\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
2200\ifdim\lastskip<\initialskipamount
2201\removelastskip \penalty-200 \vskip \initialskipamount\fi
2202\line{\secbf#1\hfill}\kern 2pt\penalty10000}}
2203
2204% This typesets a paragraph consisting of #1, dot leaders, and then #2
2205% flush to the right margin. It is used for index and table of contents
2206% entries. The paragraph is indented by \leftskip.
2207%
2208\def\entry #1#2{\begingroup
2209 %
2210 % Start a new paragraph if necessary, so our assignments below can't
2211 % affect previous text.
2212 \par
2213 %
2214 % Do not fill out the last line with white space.
2215 \parfillskip = 0in
2216 %
2217 % No extra space above this paragraph.
2218 \parskip = 0in
2219 %
2220 % Do not prefer a separate line ending with a hyphen to fewer lines.
2221 \finalhyphendemerits = 0
2222 %
2223 % \hangindent is only relevant when the entry text and page number
2224 % don't both fit on one line. In that case, bob suggests starting the
2225 % dots pretty far over on the line. Unfortunately, a large
2226 % indentation looks wrong when the entry text itself is broken across
2227 % lines. So we use a small indentation and put up with long leaders.
2228 %
2229 % \hangafter is reset to 1 (which is the value we want) at the start
2230 % of each paragraph, so we need not do anything with that.
2231 \hangindent=2em
2232 %
2233 % When the entry text needs to be broken, just fill out the first line
2234 % with blank space.
2235 \rightskip = 0pt plus1fil
2236 %
2237 % Start a ``paragraph'' for the index entry so the line breaking
2238 % parameters we've set above will have an effect.
2239 \noindent
2240 %
2241 % Insert the text of the index entry. TeX will do line-breaking on it.
2242 #1%
2243 % The following is kluged to not output a line of dots in the index if
2244 % there are no page numbers. The next person who breaks this will be
2245 % cursed by a Unix daemon.
2246 \def\tempa{{\rm }}%
2247 \def\tempb{#2}%
2248 \edef\tempc{\tempa}%
2249 \edef\tempd{\tempb}%
2250 \ifx\tempc\tempd\ \else%
2251 %
2252 % If we must, put the page number on a line of its own, and fill out
2253 % this line with blank space. (The \hfil is overwhelmed with the
2254 % fill leaders glue in \indexdotfill if the page number does fit.)
2255 \hfil\penalty50
2256 \null\nobreak\indexdotfill % Have leaders before the page number.
2257 %
2258 % The `\ ' here is removed by the implicit \unskip that TeX does as
2259 % part of (the primitive) \par. Without it, a spurious underfull
2260 % \hbox ensues.
2261 \ #2% The page number ends the paragraph.
2262 \fi%
2263 \par
2264\endgroup}
2265
2266% Like \dotfill except takes at least 1 em.
2267\def\indexdotfill{\cleaders
2268 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
2269
2270\def\primary #1{\line{#1\hfil}}
2271
2272\newskip\secondaryindent \secondaryindent=0.5cm
2273
2274\def\secondary #1#2{
2275{\parfillskip=0in \parskip=0in
2276\hangindent =1in \hangafter=1
2277\noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
2278}}
2279
2280%% Define two-column mode, which is used in indexes.
2281%% Adapted from the TeXbook, page 416.
2282\catcode `\@=11
2283
2284\newbox\partialpage
2285
2286\newdimen\doublecolumnhsize
2287
2288\def\begindoublecolumns{\begingroup
2289 % Grab any single-column material above us.
2290 \output = {\global\setbox\partialpage
2291 =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}%
2292 \eject
2293 %
2294 % Now switch to the double-column output routine.
2295 \output={\doublecolumnout}%
2296 %
2297 % Change the page size parameters. We could do this once outside this
2298 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2299 % format, but then we repeat the same computation. Repeating a couple
2300 % of assignments once per index is clearly meaningless for the
2301 % execution time, so we may as well do it once.
2302 %
2303 % First we halve the line length, less a little for the gutter between
2304 % the columns. We compute the gutter based on the line length, so it
2305 % changes automatically with the paper format. The magic constant
2306 % below is chosen so that the gutter has the same value (well, +- <
2307 % 1pt) as it did when we hard-coded it.
2308 %
2309 % We put the result in a separate register, \doublecolumhsize, so we
2310 % can restore it in \pagesofar, after \hsize itself has (potentially)
2311 % been clobbered.
2312 %
2313 \doublecolumnhsize = \hsize
2314 \advance\doublecolumnhsize by -.04154\hsize
2315 \divide\doublecolumnhsize by 2
2316 \hsize = \doublecolumnhsize
2317 %
2318 % Double the \vsize as well. (We don't need a separate register here,
2319 % since nobody clobbers \vsize.)
2320 \vsize = 2\vsize
2321 \doublecolumnpagegoal
2322}
2323
2324\def\enddoublecolumns{\eject \endgroup \pagegoal=\vsize \unvbox\partialpage}
2325
2326\def\doublecolumnsplit{\splittopskip=\topskip \splitmaxdepth=\maxdepth
2327 \global\dimen@=\pageheight \global\advance\dimen@ by-\ht\partialpage
2328 \global\setbox1=\vsplit255 to\dimen@ \global\setbox0=\vbox{\unvbox1}
2329 \global\setbox3=\vsplit255 to\dimen@ \global\setbox2=\vbox{\unvbox3}
2330 \ifdim\ht0>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2331 \ifdim\ht2>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2332}
2333\def\doublecolumnpagegoal{%
2334 \dimen@=\vsize \advance\dimen@ by-2\ht\partialpage \global\pagegoal=\dimen@
2335}
2336\def\pagesofar{\unvbox\partialpage %
2337 \hsize=\doublecolumnhsize % have to restore this since output routine
2338 \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}}
2339\def\doublecolumnout{%
2340 \setbox5=\copy255
2341 {\vbadness=10000 \doublecolumnsplit}
2342 \ifvbox255
2343 \setbox0=\vtop to\dimen@{\unvbox0}
2344 \setbox2=\vtop to\dimen@{\unvbox2}
2345 \onepageout\pagesofar \unvbox255 \penalty\outputpenalty
2346 \else
2347 \setbox0=\vbox{\unvbox5}
2348 \ifvbox0
2349 \dimen@=\ht0 \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
2350 \divide\dimen@ by2 \splittopskip=\topskip \splitmaxdepth=\maxdepth
2351 {\vbadness=10000
2352 \loop \global\setbox5=\copy0
2353 \setbox1=\vsplit5 to\dimen@
2354 \setbox3=\vsplit5 to\dimen@
2355 \ifvbox5 \global\advance\dimen@ by1pt \repeat
2356 \setbox0=\vbox to\dimen@{\unvbox1}
2357 \setbox2=\vbox to\dimen@{\unvbox3}
2358 \global\setbox\partialpage=\vbox{\pagesofar}
2359 \doublecolumnpagegoal
2360 }
2361 \fi
2362 \fi
2363}
2364
2365\catcode `\@=\other
2366\message{sectioning,}
2367% Define chapters, sections, etc.
2368
2369\newcount \chapno
2370\newcount \secno \secno=0
2371\newcount \subsecno \subsecno=0
2372\newcount \subsubsecno \subsubsecno=0
2373
2374% This counter is funny since it counts through charcodes of letters A, B, ...
2375\newcount \appendixno \appendixno = `\@
2376\def\appendixletter{\char\the\appendixno}
2377
2378\newwrite \contentsfile
2379% This is called from \setfilename.
2380\def\opencontents{\openout \contentsfile = \jobname.toc}
2381
2382% Each @chapter defines this as the name of the chapter.
2383% page headings and footings can use it. @section does likewise
2384
2385\def\thischapter{} \def\thissection{}
2386\def\seccheck#1{\if \pageno<0 %
2387\errmessage{@#1 not allowed after generating table of contents}\fi
2388%
2389}
2390
2391\def\chapternofonts{%
2392\let\rawbackslash=\relax%
2393\let\frenchspacing=\relax%
2394\def\result{\realbackslash result}
2395\def\equiv{\realbackslash equiv}
2396\def\expansion{\realbackslash expansion}
2397\def\print{\realbackslash print}
2398\def\TeX{\realbackslash TeX}
2399\def\dots{\realbackslash dots}
2400\def\copyright{\realbackslash copyright}
2401\def\tt{\realbackslash tt}
2402\def\bf{\realbackslash bf }
2403\def\w{\realbackslash w}
2404\def\less{\realbackslash less}
2405\def\gtr{\realbackslash gtr}
2406\def\hat{\realbackslash hat}
2407\def\char{\realbackslash char}
2408\def\tclose##1{\realbackslash tclose {##1}}
2409\def\code##1{\realbackslash code {##1}}
2410\def\samp##1{\realbackslash samp {##1}}
2411\def\r##1{\realbackslash r {##1}}
2412\def\b##1{\realbackslash b {##1}}
2413\def\key##1{\realbackslash key {##1}}
2414\def\file##1{\realbackslash file {##1}}
2415\def\kbd##1{\realbackslash kbd {##1}}
2416% These are redefined because @smartitalic wouldn't work inside xdef.
2417\def\i##1{\realbackslash i {##1}}
2418\def\cite##1{\realbackslash cite {##1}}
2419\def\var##1{\realbackslash var {##1}}
2420\def\emph##1{\realbackslash emph {##1}}
2421\def\dfn##1{\realbackslash dfn {##1}}
2422}
2423
2424\newcount\absseclevel % used to calculate proper heading level
2425\newcount\secbase\secbase=0 % @raise/lowersections modify this count
2426
2427% @raisesections: treat @section as chapter, @subsection as section, etc.
2428\def\raisesections{\global\advance\secbase by -1}
2429\let\up=\raisesections % original BFox name
2430
2431% @lowersections: treat @chapter as section, @section as subsection, etc.
2432\def\lowersections{\global\advance\secbase by 1}
2433\let\down=\lowersections % original BFox name
2434
2435% Choose a numbered-heading macro
2436% #1 is heading level if unmodified by @raisesections or @lowersections
2437% #2 is text for heading
2438\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2439\ifcase\absseclevel
2440 \chapterzzz{#2}
2441\or
2442 \seczzz{#2}
2443\or
2444 \numberedsubseczzz{#2}
2445\or
2446 \numberedsubsubseczzz{#2}
2447\else
2448 \ifnum \absseclevel<0
2449 \chapterzzz{#2}
2450 \else
2451 \numberedsubsubseczzz{#2}
2452 \fi
2453\fi
2454}
2455
2456% like \numhead, but chooses appendix heading levels
2457\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2458\ifcase\absseclevel
2459 \appendixzzz{#2}
2460\or
2461 \appendixsectionzzz{#2}
2462\or
2463 \appendixsubseczzz{#2}
2464\or
2465 \appendixsubsubseczzz{#2}
2466\else
2467 \ifnum \absseclevel<0
2468 \appendixzzz{#2}
2469 \else
2470 \appendixsubsubseczzz{#2}
2471 \fi
2472\fi
2473}
2474
2475% like \numhead, but chooses numberless heading levels
2476\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2477\ifcase\absseclevel
2478 \unnumberedzzz{#2}
2479\or
2480 \unnumberedseczzz{#2}
2481\or
2482 \unnumberedsubseczzz{#2}
2483\or
2484 \unnumberedsubsubseczzz{#2}
2485\else
2486 \ifnum \absseclevel<0
2487 \unnumberedzzz{#2}
2488 \else
2489 \unnumberedsubsubseczzz{#2}
2490 \fi
2491\fi
2492}
2493
2494
2495\def\thischaptername{No Chapter Title}
2496\outer\def\chapter{\parsearg\chapteryyy}
2497\def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2498\def\chapterzzz #1{\seccheck{chapter}%
2499\secno=0 \subsecno=0 \subsubsecno=0
2500\global\advance \chapno by 1 \message{\putwordChapter \the\chapno}%
2501\chapmacro {#1}{\the\chapno}%
2502\gdef\thissection{#1}%
2503\gdef\thischaptername{#1}%
2504% We don't substitute the actual chapter name into \thischapter
2505% because we don't want its macros evaluated now.
2506\xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
2507{\chapternofonts%
2508\edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}%
2509\escapechar=`\\%
2510\write \contentsfile \temp %
2511\donoderef %
2512\global\let\section = \numberedsec
2513\global\let\subsection = \numberedsubsec
2514\global\let\subsubsection = \numberedsubsubsec
2515}}
2516
2517\outer\def\appendix{\parsearg\appendixyyy}
2518\def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2519\def\appendixzzz #1{\seccheck{appendix}%
2520\secno=0 \subsecno=0 \subsubsecno=0
2521\global\advance \appendixno by 1 \message{Appendix \appendixletter}%
2522\chapmacro {#1}{\putwordAppendix{} \appendixletter}%
2523\gdef\thissection{#1}%
2524\gdef\thischaptername{#1}%
2525\xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
2526{\chapternofonts%
2527\edef\temp{{\realbackslash chapentry
2528 {#1}{\putwordAppendix{} \appendixletter}{\noexpand\folio}}}%
2529\escapechar=`\\%
2530\write \contentsfile \temp %
2531\appendixnoderef %
2532\global\let\section = \appendixsec
2533\global\let\subsection = \appendixsubsec
2534\global\let\subsubsection = \appendixsubsubsec
2535}}
2536
2537\outer\def\top{\parsearg\unnumberedyyy}
2538\outer\def\unnumbered{\parsearg\unnumberedyyy}
2539\def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2540\def\unnumberedzzz #1{\seccheck{unnumbered}%
2541\secno=0 \subsecno=0 \subsubsecno=0
2542%
2543% This used to be simply \message{#1}, but TeX fully expands the
2544% argument to \message. Therefore, if #1 contained @-commands, TeX
2545% expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2546% expanded @cite (which turns out to cause errors because \cite is meant
2547% to be executed, not expanded).
2548%
2549% Anyway, we don't want the fully-expanded definition of @cite to appear
2550% as a result of the \message, we just want `@cite' itself. We use
2551% \the<toks register> to achieve this: TeX expands \the<toks> only once,
2552% simply yielding the contents of the <toks register>.
2553\toks0 = {#1}\message{(\the\toks0)}%
2554%
2555\unnumbchapmacro {#1}%
2556\gdef\thischapter{#1}\gdef\thissection{#1}%
2557{\chapternofonts%
2558\edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}%
2559\escapechar=`\\%
2560\write \contentsfile \temp %
2561\unnumbnoderef %
2562\global\let\section = \unnumberedsec
2563\global\let\subsection = \unnumberedsubsec
2564\global\let\subsubsection = \unnumberedsubsubsec
2565}}
2566
2567\outer\def\numberedsec{\parsearg\secyyy}
2568\def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2569\def\seczzz #1{\seccheck{section}%
2570\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2571\gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2572{\chapternofonts%
2573\edef\temp{{\realbackslash secentry %
2574{#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
2575\escapechar=`\\%
2576\write \contentsfile \temp %
2577\donoderef %
2578\penalty 10000 %
2579}}
2580
2581\outer\def\appenixsection{\parsearg\appendixsecyyy}
2582\outer\def\appendixsec{\parsearg\appendixsecyyy}
2583\def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2584\def\appendixsectionzzz #1{\seccheck{appendixsection}%
2585\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2586\gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2587{\chapternofonts%
2588\edef\temp{{\realbackslash secentry %
2589{#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
2590\escapechar=`\\%
2591\write \contentsfile \temp %
2592\appendixnoderef %
2593\penalty 10000 %
2594}}
2595
2596\outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2597\def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2598\def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
2599\plainsecheading {#1}\gdef\thissection{#1}%
2600{\chapternofonts%
2601\edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}%
2602\escapechar=`\\%
2603\write \contentsfile \temp %
2604\unnumbnoderef %
2605\penalty 10000 %
2606}}
2607
2608\outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
2609\def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
2610\def\numberedsubseczzz #1{\seccheck{subsection}%
2611\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2612\subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
2613{\chapternofonts%
2614\edef\temp{{\realbackslash subsecentry %
2615{#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2616\escapechar=`\\%
2617\write \contentsfile \temp %
2618\donoderef %
2619\penalty 10000 %
2620}}
2621
2622\outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
2623\def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
2624\def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
2625\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2626\subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
2627{\chapternofonts%
2628\edef\temp{{\realbackslash subsecentry %
2629{#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2630\escapechar=`\\%
2631\write \contentsfile \temp %
2632\appendixnoderef %
2633\penalty 10000 %
2634}}
2635
2636\outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
2637\def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
2638\def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
2639\plainsecheading {#1}\gdef\thissection{#1}%
2640{\chapternofonts%
2641\edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}%
2642\escapechar=`\\%
2643\write \contentsfile \temp %
2644\unnumbnoderef %
2645\penalty 10000 %
2646}}
2647
2648\outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
2649\def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
2650\def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
2651\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2652\subsubsecheading {#1}
2653 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2654{\chapternofonts%
2655\edef\temp{{\realbackslash subsubsecentry %
2656 {#1}
2657 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
2658 {\noexpand\folio}}}%
2659\escapechar=`\\%
2660\write \contentsfile \temp %
2661\donoderef %
2662\penalty 10000 %
2663}}
2664
2665\outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
2666\def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
2667\def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
2668\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2669\subsubsecheading {#1}
2670 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2671{\chapternofonts%
2672\edef\temp{{\realbackslash subsubsecentry{#1}%
2673 {\appendixletter}
2674 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
2675\escapechar=`\\%
2676\write \contentsfile \temp %
2677\appendixnoderef %
2678\penalty 10000 %
2679}}
2680
2681\outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
2682\def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
2683\def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
2684\plainsecheading {#1}\gdef\thissection{#1}%
2685{\chapternofonts%
2686\edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}%
2687\escapechar=`\\%
2688\write \contentsfile \temp %
2689\unnumbnoderef %
2690\penalty 10000 %
2691}}
2692
2693% These are variants which are not "outer", so they can appear in @ifinfo.
2694% Actually, they should now be obsolete; ordinary section commands should work.
2695\def\infotop{\parsearg\unnumberedzzz}
2696\def\infounnumbered{\parsearg\unnumberedzzz}
2697\def\infounnumberedsec{\parsearg\unnumberedseczzz}
2698\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
2699\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
2700
2701\def\infoappendix{\parsearg\appendixzzz}
2702\def\infoappendixsec{\parsearg\appendixseczzz}
2703\def\infoappendixsubsec{\parsearg\appendixsubseczzz}
2704\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
2705
2706\def\infochapter{\parsearg\chapterzzz}
2707\def\infosection{\parsearg\sectionzzz}
2708\def\infosubsection{\parsearg\subsectionzzz}
2709\def\infosubsubsection{\parsearg\subsubsectionzzz}
2710
2711% These macros control what the section commands do, according
2712% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
2713% Define them by default for a numbered chapter.
2714\global\let\section = \numberedsec
2715\global\let\subsection = \numberedsubsec
2716\global\let\subsubsection = \numberedsubsubsec
2717
2718% Define @majorheading, @heading and @subheading
2719
2720% NOTE on use of \vbox for chapter headings, section headings, and
2721% such:
2722% 1) We use \vbox rather than the earlier \line to permit
2723% overlong headings to fold.
2724% 2) \hyphenpenalty is set to 10000 because hyphenation in a
2725% heading is obnoxious; this forbids it.
2726% 3) Likewise, headings look best if no \parindent is used, and
2727% if justification is not attempted. Hence \raggedright.
2728
2729
2730\def\majorheading{\parsearg\majorheadingzzz}
2731\def\majorheadingzzz #1{%
2732{\advance\chapheadingskip by 10pt \chapbreak }%
2733{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2734 \parindent=0pt\raggedright
2735 \rm #1\hfill}}\bigskip \par\penalty 200}
2736
2737\def\chapheading{\parsearg\chapheadingzzz}
2738\def\chapheadingzzz #1{\chapbreak %
2739{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2740 \parindent=0pt\raggedright
2741 \rm #1\hfill}}\bigskip \par\penalty 200}
2742
2743\def\heading{\parsearg\secheadingi}
2744
2745\def\subheading{\parsearg\subsecheadingi}
2746
2747\def\subsubheading{\parsearg\subsubsecheadingi}
2748
2749% These macros generate a chapter, section, etc. heading only
2750% (including whitespace, linebreaking, etc. around it),
2751% given all the information in convenient, parsed form.
2752
2753%%% Args are the skip and penalty (usually negative)
2754\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
2755
2756\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
2757
2758%%% Define plain chapter starts, and page on/off switching for it
2759% Parameter controlling skip before chapter headings (if needed)
2760
2761\newskip \chapheadingskip \chapheadingskip = 30pt plus 8pt minus 4pt
2762
2763\def\chapbreak{\dobreak \chapheadingskip {-4000}}
2764\def\chappager{\par\vfill\supereject}
2765\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
2766
2767\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
2768
2769\def\CHAPPAGoff{
2770\global\let\pchapsepmacro=\chapbreak
2771\global\let\pagealignmacro=\chappager}
2772
2773\def\CHAPPAGon{
2774\global\let\pchapsepmacro=\chappager
2775\global\let\pagealignmacro=\chappager
2776\global\def\HEADINGSon{\HEADINGSsingle}}
2777
2778\def\CHAPPAGodd{
2779\global\let\pchapsepmacro=\chapoddpage
2780\global\let\pagealignmacro=\chapoddpage
2781\global\def\HEADINGSon{\HEADINGSdouble}}
2782
2783\CHAPPAGon
2784
2785\def\CHAPFplain{
2786\global\let\chapmacro=\chfplain
2787\global\let\unnumbchapmacro=\unnchfplain}
2788
2789\def\chfplain #1#2{%
2790 \pchapsepmacro
2791 {%
2792 \chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2793 \parindent=0pt\raggedright
2794 \rm #2\enspace #1}%
2795 }%
2796 \bigskip
2797 \penalty5000
2798}
2799
2800\def\unnchfplain #1{%
2801\pchapsepmacro %
2802{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2803 \parindent=0pt\raggedright
2804 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2805}
2806\CHAPFplain % The default
2807
2808\def\unnchfopen #1{%
2809\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2810 \parindent=0pt\raggedright
2811 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2812}
2813
2814\def\chfopen #1#2{\chapoddpage {\chapfonts
2815\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
2816\par\penalty 5000 %
2817}
2818
2819\def\CHAPFopen{
2820\global\let\chapmacro=\chfopen
2821\global\let\unnumbchapmacro=\unnchfopen}
2822
2823% Parameter controlling skip before section headings.
2824
2825\newskip \subsecheadingskip \subsecheadingskip = 17pt plus 8pt minus 4pt
2826\def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
2827
2828\newskip \secheadingskip \secheadingskip = 21pt plus 8pt minus 4pt
2829\def\secheadingbreak{\dobreak \secheadingskip {-1000}}
2830
2831% @paragraphindent is defined for the Info formatting commands only.
2832\let\paragraphindent=\comment
2833
2834% Section fonts are the base font at magstep2, which produces
2835% a size a bit more than 14 points in the default situation.
2836
2837\def\secheading #1#2#3{\secheadingi {#2.#3\enspace #1}}
2838\def\plainsecheading #1{\secheadingi {#1}}
2839\def\secheadingi #1{{\advance \secheadingskip by \parskip %
2840\secheadingbreak}%
2841{\secfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2842 \parindent=0pt\raggedright
2843 \rm #1\hfill}}%
2844\ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
2845
2846
2847% Subsection fonts are the base font at magstep1,
2848% which produces a size of 12 points.
2849
2850\def\subsecheading #1#2#3#4{\subsecheadingi {#2.#3.#4\enspace #1}}
2851\def\subsecheadingi #1{{\advance \subsecheadingskip by \parskip %
2852\subsecheadingbreak}%
2853{\subsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2854 \parindent=0pt\raggedright
2855 \rm #1\hfill}}%
2856\ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
2857
2858\def\subsubsecfonts{\subsecfonts} % Maybe this should change:
2859 % Perhaps make sssec fonts scaled
2860 % magstep half
2861\def\subsubsecheading #1#2#3#4#5{\subsubsecheadingi {#2.#3.#4.#5\enspace #1}}
2862\def\subsubsecheadingi #1{{\advance \subsecheadingskip by \parskip %
2863\subsecheadingbreak}%
2864{\subsubsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2865 \parindent=0pt\raggedright
2866 \rm #1\hfill}}%
2867\ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000}
2868
2869
2870\message{toc printing,}
2871
2872% Finish up the main text and prepare to read what we've written
2873% to \contentsfile.
2874
2875\newskip\contentsrightmargin \contentsrightmargin=1in
2876\def\startcontents#1{%
2877 \pagealignmacro
2878 \immediate\closeout \contentsfile
2879 \ifnum \pageno>0
2880 \pageno = -1 % Request roman numbered pages.
2881 \fi
2882 % Don't need to put `Contents' or `Short Contents' in the headline.
2883 % It is abundantly clear what they are.
2884 \unnumbchapmacro{#1}\def\thischapter{}%
2885 \begingroup % Set up to handle contents files properly.
2886 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
2887 \catcode`\^=7 % to see ^^e4 as \"a etc. [email protected]
2888 \raggedbottom % Worry more about breakpoints than the bottom.
2889 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
2890}
2891
2892
2893% Normal (long) toc.
2894\outer\def\contents{%
2895 \startcontents{\putwordTableofContents}%
2896 \input \jobname.toc
2897 \endgroup
2898 \vfill \eject
2899}
2900
2901% And just the chapters.
2902\outer\def\summarycontents{%
2903 \startcontents{\putwordShortContents}%
2904 %
2905 \let\chapentry = \shortchapentry
2906 \let\unnumbchapentry = \shortunnumberedentry
2907 % We want a true roman here for the page numbers.
2908 \secfonts
2909 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
2910 \rm
2911 \advance\baselineskip by 1pt % Open it up a little.
2912 \def\secentry ##1##2##3##4{}
2913 \def\unnumbsecentry ##1##2{}
2914 \def\subsecentry ##1##2##3##4##5{}
2915 \def\unnumbsubsecentry ##1##2{}
2916 \def\subsubsecentry ##1##2##3##4##5##6{}
2917 \def\unnumbsubsubsecentry ##1##2{}
2918 \input \jobname.toc
2919 \endgroup
2920 \vfill \eject
2921}
2922\let\shortcontents = \summarycontents
2923
2924% These macros generate individual entries in the table of contents.
2925% The first argument is the chapter or section name.
2926% The last argument is the page number.
2927% The arguments in between are the chapter number, section number, ...
2928
2929% Chapter-level things, for both the long and short contents.
2930\def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
2931
2932% See comments in \dochapentry re vbox and related settings
2933\def\shortchapentry#1#2#3{%
2934 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
2935}
2936
2937% Typeset the label for a chapter or appendix for the short contents.
2938% The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
2939% We could simplify the code here by writing out an \appendixentry
2940% command in the toc file for appendices, instead of using \chapentry
2941% for both, but it doesn't seem worth it.
2942\setbox0 = \hbox{\shortcontrm \putwordAppendix }
2943\newdimen\shortappendixwidth \shortappendixwidth = \wd0
2944
2945\def\shortchaplabel#1{%
2946 % We typeset #1 in a box of constant width, regardless of the text of
2947 % #1, so the chapter titles will come out aligned.
2948 \setbox0 = \hbox{#1}%
2949 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
2950 %
2951 % This space should be plenty, since a single number is .5em, and the
2952 % widest letter (M) is 1em, at least in the Computer Modern fonts.
2953 % (This space doesn't include the extra space that gets added after
2954 % the label; that gets put in in \shortchapentry above.)
2955 \advance\dimen0 by 1.1em
2956 \hbox to \dimen0{#1\hfil}%
2957}
2958
2959\def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
2960\def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
2961
2962% Sections.
2963\def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
2964\def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
2965
2966% Subsections.
2967\def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
2968\def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
2969
2970% And subsubsections.
2971\def\subsubsecentry#1#2#3#4#5#6{%
2972 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
2973\def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
2974
2975
2976% This parameter controls the indentation of the various levels.
2977\newdimen\tocindent \tocindent = 3pc
2978
2979% Now for the actual typesetting. In all these, #1 is the text and #2 is the
2980% page number.
2981%
2982% If the toc has to be broken over pages, we would want to be at chapters
2983% if at all possible; hence the \penalty.
2984\def\dochapentry#1#2{%
2985 \penalty-300 \vskip\baselineskip
2986 \begingroup
2987 \chapentryfonts
2988 \tocentry{#1}{\dopageno{#2}}%
2989 \endgroup
2990 \nobreak\vskip .25\baselineskip
2991}
2992
2993\def\dosecentry#1#2{\begingroup
2994 \secentryfonts \leftskip=\tocindent
2995 \tocentry{#1}{\dopageno{#2}}%
2996\endgroup}
2997
2998\def\dosubsecentry#1#2{\begingroup
2999 \subsecentryfonts \leftskip=2\tocindent
3000 \tocentry{#1}{\dopageno{#2}}%
3001\endgroup}
3002
3003\def\dosubsubsecentry#1#2{\begingroup
3004 \subsubsecentryfonts \leftskip=3\tocindent
3005 \tocentry{#1}{\dopageno{#2}}%
3006\endgroup}
3007
3008% Final typesetting of a toc entry; we use the same \entry macro as for
3009% the index entries, but we want to suppress hyphenation here. (We
3010% can't do that in the \entry macro, since index entries might consist
3011% of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3012%
3013% \turnoffactive is for the sake of @" used for umlauts.
3014\def\tocentry#1#2{\begingroup
3015 \hyphenpenalty = 10000
3016 \entry{\turnoffactive #1}{\turnoffactive #2}%
3017\endgroup}
3018
3019% Space between chapter (or whatever) number and the title.
3020\def\labelspace{\hskip1em \relax}
3021
3022\def\dopageno#1{{\rm #1}}
3023\def\doshortpageno#1{{\rm #1}}
3024
3025\def\chapentryfonts{\secfonts \rm}
3026\def\secentryfonts{\textfonts}
3027\let\subsecentryfonts = \textfonts
3028\let\subsubsecentryfonts = \textfonts
3029
3030
3031\message{environments,}
3032
3033% Since these characters are used in examples, it should be an even number of
3034% \tt widths. Each \tt character is 1en, so two makes it 1em.
3035% Furthermore, these definitions must come after we define our fonts.
3036\newbox\dblarrowbox \newbox\longdblarrowbox
3037\newbox\pushcharbox \newbox\bullbox
3038\newbox\equivbox \newbox\errorbox
3039
3040\let\ptexequiv = \equiv
3041
3042%{\tentt
3043%\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3044%\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3045%\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3046%\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3047% Adapted from the manmac format (p.420 of TeXbook)
3048%\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3049% depth .1ex\hfil}
3050%}
3051
3052\def\point{$\star$}
3053
3054\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3055\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
3056\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3057
3058\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3059
3060% Adapted from the TeXbook's \boxit.
3061{\tentt \global\dimen0 = 3em}% Width of the box.
3062\dimen2 = .55pt % Thickness of rules
3063% The text. (`r' is open on the right, `e' somewhat less so on the left.)
3064\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
3065
3066\global\setbox\errorbox=\hbox to \dimen0{\hfil
3067 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3068 \advance\hsize by -2\dimen2 % Rules.
3069 \vbox{
3070 \hrule height\dimen2
3071 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3072 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3073 \kern3pt\vrule width\dimen2}% Space to right.
3074 \hrule height\dimen2}
3075 \hfil}
3076
3077% The @error{} command.
3078\def\error{\leavevmode\lower.7ex\copy\errorbox}
3079
3080% @tex ... @end tex escapes into raw Tex temporarily.
3081% One exception: @ is still an escape character, so that @end tex works.
3082% But \@ or @@ will get a plain tex @ character.
3083
3084\def\tex{\begingroup
3085\catcode `\\=0 \catcode `\{=1 \catcode `\}=2
3086\catcode `\$=3 \catcode `\&=4 \catcode `\#=6
3087\catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
3088\catcode `\%=14
3089\catcode 43=12
3090\catcode`\"=12
3091\catcode`\==12
3092\catcode`\|=12
3093\catcode`\<=12
3094\catcode`\>=12
3095\escapechar=`\\
3096%
3097\let\~=\ptextilde
3098\let\{=\ptexlbrace
3099\let\}=\ptexrbrace
3100\let\.=\ptexdot
3101\let\*=\ptexstar
3102\let\dots=\ptexdots
3103\def\@{@}%
3104\let\bullet=\ptexbullet
3105\let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext \let\l=\ptexl
3106\let\L=\ptexL
3107%
3108\let\Etex=\endgroup}
3109
3110% Define @lisp ... @endlisp.
3111% @lisp does a \begingroup so it can rebind things,
3112% including the definition of @endlisp (which normally is erroneous).
3113
3114% Amount to narrow the margins by for @lisp.
3115\newskip\lispnarrowing \lispnarrowing=0.4in
3116
3117% This is the definition that ^^M gets inside @lisp, @example, and other
3118% such environments. \null is better than a space, since it doesn't
3119% have any width.
3120\def\lisppar{\null\endgraf}
3121
3122% Make each space character in the input produce a normal interword
3123% space in the output. Don't allow a line break at this space, as this
3124% is used only in environments like @example, where each line of input
3125% should produce a line of output anyway.
3126%
3127{\obeyspaces %
3128\gdef\sepspaces{\obeyspaces\let =\tie}}
3129
3130% Define \obeyedspace to be our active space, whatever it is. This is
3131% for use in \parsearg.
3132{\sepspaces%
3133\global\let\obeyedspace= }
3134
3135% This space is always present above and below environments.
3136\newskip\envskipamount \envskipamount = 0pt
3137
3138% Make spacing and below environment symmetrical. We use \parskip here
3139% to help in doing that, since in @example-like environments \parskip
3140% is reset to zero; thus the \afterenvbreak inserts no space -- but the
3141% start of the next paragraph will insert \parskip
3142%
3143\def\aboveenvbreak{{\advance\envskipamount by \parskip
3144\endgraf \ifdim\lastskip<\envskipamount
3145\removelastskip \penalty-50 \vskip\envskipamount \fi}}
3146
3147\let\afterenvbreak = \aboveenvbreak
3148
3149% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
3150\let\nonarrowing=\relax
3151
3152%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3153% \cartouche: draw rectangle w/rounded corners around argument
3154\font\circle=lcircle10
3155\newdimen\circthick
3156\newdimen\cartouter\newdimen\cartinner
3157\newskip\normbskip\newskip\normpskip\newskip\normlskip
3158\circthick=\fontdimen8\circle
3159%
3160\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
3161\def\ctr{{\hskip 6pt\circle\char'010}}
3162\def\cbl{{\circle\char'012\hskip -6pt}}
3163\def\cbr{{\hskip 6pt\circle\char'011}}
3164\def\carttop{\hbox to \cartouter{\hskip\lskip
3165 \ctl\leaders\hrule height\circthick\hfil\ctr
3166 \hskip\rskip}}
3167\def\cartbot{\hbox to \cartouter{\hskip\lskip
3168 \cbl\leaders\hrule height\circthick\hfil\cbr
3169 \hskip\rskip}}
3170%
3171\newskip\lskip\newskip\rskip
3172
3173\long\def\cartouche{%
3174\begingroup
3175 \lskip=\leftskip \rskip=\rightskip
3176 \leftskip=0pt\rightskip=0pt %we want these *outside*.
3177 \cartinner=\hsize \advance\cartinner by-\lskip
3178 \advance\cartinner by-\rskip
3179 \cartouter=\hsize
3180 \advance\cartouter by 18pt % allow for 3pt kerns on either
3181% side, and for 6pt waste from
3182% each corner char
3183 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
3184 % Flag to tell @lisp, etc., not to narrow margin.
3185 \let\nonarrowing=\comment
3186 \vbox\bgroup
3187 \baselineskip=0pt\parskip=0pt\lineskip=0pt
3188 \carttop
3189 \hbox\bgroup
3190 \hskip\lskip
3191 \vrule\kern3pt
3192 \vbox\bgroup
3193 \hsize=\cartinner
3194 \kern3pt
3195 \begingroup
3196 \baselineskip=\normbskip
3197 \lineskip=\normlskip
3198 \parskip=\normpskip
3199 \vskip -\parskip
3200\def\Ecartouche{%
3201 \endgroup
3202 \kern3pt
3203 \egroup
3204 \kern3pt\vrule
3205 \hskip\rskip
3206 \egroup
3207 \cartbot
3208 \egroup
3209\endgroup
3210}}
3211
3212
3213% This macro is called at the beginning of all the @example variants,
3214% inside a group.
3215\def\nonfillstart{%
3216 \aboveenvbreak
3217 \inENV % This group ends at the end of the body
3218 \hfuzz = 12pt % Don't be fussy
3219 \sepspaces % Make spaces be word-separators rather than space tokens.
3220 \singlespace
3221 \let\par = \lisppar % don't ignore blank lines
3222 \obeylines % each line of input is a line of output
3223 \parskip = 0pt
3224 \parindent = 0pt
3225 \emergencystretch = 0pt % don't try to avoid overfull boxes
3226 % @cartouche defines \nonarrowing to inhibit narrowing
3227 % at next level down.
3228 \ifx\nonarrowing\relax
3229 \advance \leftskip by \lispnarrowing
3230 \exdentamount=\lispnarrowing
3231 \let\exdent=\nofillexdent
3232 \let\nonarrowing=\relax
3233 \fi
3234}
3235
3236% To ending an @example-like environment, we first end the paragraph
3237% (via \afterenvbreak's vertical glue), and then the group. That way we
3238% keep the zero \parskip that the environments set -- \parskip glue
3239% will be inserted at the beginning of the next paragraph in the
3240% document, after the environment.
3241%
3242\def\nonfillfinish{\afterenvbreak\endgroup}%
3243
3244% This macro is
3245\def\lisp{\begingroup
3246 \nonfillstart
3247 \let\Elisp = \nonfillfinish
3248 \tt
3249 \rawbackslash % have \ input char produce \ char from current font
3250 \gobble
3251}
3252
3253% Define the \E... control sequence only if we are inside the
3254% environment, so the error checking in \end will work.
3255%
3256% We must call \lisp last in the definition, since it reads the
3257% return following the @example (or whatever) command.
3258%
3259\def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
3260\def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
3261\def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
3262
3263% @smallexample and @smalllisp. This is not used unless the @smallbook
3264% command is given. Originally contributed by Pavel@xerox.
3265%
3266\def\smalllispx{\begingroup
3267 \nonfillstart
3268 \let\Esmalllisp = \nonfillfinish
3269 \let\Esmallexample = \nonfillfinish
3270 %
3271 % Smaller interline space and fonts for small examples.
3272 \setleading{10pt}%
3273 \indexfonts \tt
3274 \rawbackslash % make \ output the \ character from the current font (tt)
3275 \gobble
3276}
3277
3278% This is @display; same as @lisp except use roman font.
3279%
3280\def\display{\begingroup
3281 \nonfillstart
3282 \let\Edisplay = \nonfillfinish
3283 \gobble
3284}
3285
3286% This is @format; same as @display except don't narrow margins.
3287%
3288\def\format{\begingroup
3289 \let\nonarrowing = t
3290 \nonfillstart
3291 \let\Eformat = \nonfillfinish
3292 \gobble
3293}
3294
3295% @flushleft (same as @format) and @flushright.
3296%
3297\def\flushleft{\begingroup
3298 \let\nonarrowing = t
3299 \nonfillstart
3300 \let\Eflushleft = \nonfillfinish
3301 \gobble
3302}
3303\def\flushright{\begingroup
3304 \let\nonarrowing = t
3305 \nonfillstart
3306 \let\Eflushright = \nonfillfinish
3307 \advance\leftskip by 0pt plus 1fill
3308 \gobble}
3309
3310% @quotation does normal linebreaking (hence we can't use \nonfillstart)
3311% and narrows the margins.
3312%
3313\def\quotation{%
3314 \begingroup\inENV %This group ends at the end of the @quotation body
3315 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
3316 \singlespace
3317 \parindent=0pt
3318 % We have retained a nonzero parskip for the environment, since we're
3319 % doing normal filling. So to avoid extra space below the environment...
3320 \def\Equotation{\parskip = 0pt \nonfillfinish}%
3321 %
3322 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
3323 \ifx\nonarrowing\relax
3324 \advance\leftskip by \lispnarrowing
3325 \advance\rightskip by \lispnarrowing
3326 \exdentamount = \lispnarrowing
3327 \let\nonarrowing = \relax
3328 \fi
3329}
3330
3331\message{defuns,}
3332% Define formatter for defuns
3333% First, allow user to change definition object font (\df) internally
3334\def\setdeffont #1 {\csname DEF#1\endcsname}
3335
3336\newskip\defbodyindent \defbodyindent=.4in
3337\newskip\defargsindent \defargsindent=50pt
3338\newskip\deftypemargin \deftypemargin=12pt
3339\newskip\deflastargmargin \deflastargmargin=18pt
3340
3341\newcount\parencount
3342% define \functionparens, which makes ( and ) and & do special things.
3343% \functionparens affects the group it is contained in.
3344\def\activeparens{%
3345\catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
3346\catcode`\[=\active \catcode`\]=\active}
3347
3348% Make control sequences which act like normal parenthesis chars.
3349\let\lparen = ( \let\rparen = )
3350
3351{\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3352
3353% Be sure that we always have a definition for `(', etc. For example,
3354% if the fn name has parens in it, \boldbrax will not be in effect yet,
3355% so TeX would otherwise complain about undefined control sequence.
3356\global\let(=\lparen \global\let)=\rparen
3357\global\let[=\lbrack \global\let]=\rbrack
3358
3359\gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
3360\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
3361% This is used to turn on special parens
3362% but make & act ordinary (given that it's active).
3363\gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
3364
3365% Definitions of (, ) and & used in args for functions.
3366% This is the definition of ( outside of all parentheses.
3367\gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested %
3368\global\advance\parencount by 1 }
3369%
3370% This is the definition of ( when already inside a level of parens.
3371\gdef\opnested{\char`\(\global\advance\parencount by 1 }
3372%
3373\gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
3374% also in that case restore the outer-level definition of (.
3375\ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
3376\global\advance \parencount by -1 }
3377% If we encounter &foo, then turn on ()-hacking afterwards
3378\gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
3379%
3380\gdef\normalparens{\boldbrax\let&=\ampnr}
3381} % End of definition inside \activeparens
3382%% These parens (in \boldbrax) actually are a little bolder than the
3383%% contained text. This is especially needed for [ and ]
3384\def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&}
3385\def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}}
3386
3387% First, defname, which formats the header line itself.
3388% #1 should be the function name.
3389% #2 should be the type of definition, such as "Function".
3390
3391\def\defname #1#2{%
3392% Get the values of \leftskip and \rightskip as they were
3393% outside the @def...
3394\dimen2=\leftskip
3395\advance\dimen2 by -\defbodyindent
3396\dimen3=\rightskip
3397\advance\dimen3 by -\defbodyindent
3398\noindent %
3399\setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3400\dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
3401\dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
3402\parshape 2 0in \dimen0 \defargsindent \dimen1 %
3403% Now output arg 2 ("Function" or some such)
3404% ending at \deftypemargin from the right margin,
3405% but stuck inside a box of width 0 so it does not interfere with linebreaking
3406{% Adjust \hsize to exclude the ambient margins,
3407% so that \rightline will obey them.
3408\advance \hsize by -\dimen2 \advance \hsize by -\dimen3
3409\rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3410% Make all lines underfull and no complaints:
3411\tolerance=10000 \hbadness=10000
3412\advance\leftskip by -\defbodyindent
3413\exdentamount=\defbodyindent
3414{\df #1}\enskip % Generate function name
3415}
3416
3417% Actually process the body of a definition
3418% #1 should be the terminating control sequence, such as \Edefun.
3419% #2 should be the "another name" control sequence, such as \defunx.
3420% #3 should be the control sequence that actually processes the header,
3421% such as \defunheader.
3422
3423\def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3424\medbreak %
3425% Define the end token that this defining construct specifies
3426% so that it will exit this group.
3427\def#1{\endgraf\endgroup\medbreak}%
3428\def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3429\parindent=0in
3430\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3431\exdentamount=\defbodyindent
3432\begingroup %
3433\catcode 61=\active % 61 is `='
3434\obeylines\activeparens\spacesplit#3}
3435
3436\def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3437\medbreak %
3438% Define the end token that this defining construct specifies
3439% so that it will exit this group.
3440\def#1{\endgraf\endgroup\medbreak}%
3441\def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
3442\parindent=0in
3443\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3444\exdentamount=\defbodyindent
3445\begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3446
3447\def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3448\medbreak %
3449% Define the end token that this defining construct specifies
3450% so that it will exit this group.
3451\def#1{\endgraf\endgroup\medbreak}%
3452\def#2##1 ##2 {\def#4{##1}%
3453\begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
3454\parindent=0in
3455\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3456\exdentamount=\defbodyindent
3457\begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3458
3459% These parsing functions are similar to the preceding ones
3460% except that they do not make parens into active characters.
3461% These are used for "variables" since they have no arguments.
3462
3463\def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3464\medbreak %
3465% Define the end token that this defining construct specifies
3466% so that it will exit this group.
3467\def#1{\endgraf\endgroup\medbreak}%
3468\def#2{\begingroup\obeylines\spacesplit#3}%
3469\parindent=0in
3470\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3471\exdentamount=\defbodyindent
3472\begingroup %
3473\catcode 61=\active %
3474\obeylines\spacesplit#3}
3475
3476% This is used for \def{tp,vr}parsebody. It could probably be used for
3477% some of the others, too, with some judicious conditionals.
3478%
3479\def\parsebodycommon#1#2#3{%
3480 \begingroup\inENV %
3481 \medbreak %
3482 % Define the end token that this defining construct specifies
3483 % so that it will exit this group.
3484 \def#1{\endgraf\endgroup\medbreak}%
3485 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
3486 \parindent=0in
3487 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3488 \exdentamount=\defbodyindent
3489 \begingroup\obeylines
3490}
3491
3492\def\defvrparsebody#1#2#3#4 {%
3493 \parsebodycommon{#1}{#2}{#3}%
3494 \spacesplit{#3{#4}}%
3495}
3496
3497% This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3498% type is just `struct', because we lose the braces in `{struct
3499% termios}' when \spacesplit reads its undelimited argument. Sigh.
3500% \let\deftpparsebody=\defvrparsebody
3501%
3502% So, to get around this, we put \empty in with the type name. That
3503% way, TeX won't find exactly `{...}' as an undelimited argument, and
3504% won't strip off the braces.
3505%
3506\def\deftpparsebody #1#2#3#4 {%
3507 \parsebodycommon{#1}{#2}{#3}%
3508 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3509}
3510
3511% Fine, but then we have to eventually remove the \empty *and* the
3512% braces (if any). That's what this does, putting the result in \tptemp.
3513%
3514\def\removeemptybraces\empty#1\relax{\def\tptemp{#1}}%
3515
3516% After \spacesplit has done its work, this is called -- #1 is the final
3517% thing to call, #2 the type name (which starts with \empty), and #3
3518% (which might be empty) the arguments.
3519%
3520\def\parsetpheaderline#1#2#3{%
3521 \removeemptybraces#2\relax
3522 #1{\tptemp}{#3}%
3523}%
3524
3525\def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3526\medbreak %
3527% Define the end token that this defining construct specifies
3528% so that it will exit this group.
3529\def#1{\endgraf\endgroup\medbreak}%
3530\def#2##1 ##2 {\def#4{##1}%
3531\begingroup\obeylines\spacesplit{#3{##2}}}%
3532\parindent=0in
3533\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3534\exdentamount=\defbodyindent
3535\begingroup\obeylines\spacesplit{#3{#5}}}
3536
3537% Split up #2 at the first space token.
3538% call #1 with two arguments:
3539% the first is all of #2 before the space token,
3540% the second is all of #2 after that space token.
3541% If #2 contains no space token, all of it is passed as the first arg
3542% and the second is passed as empty.
3543
3544{\obeylines
3545\gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3546\long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3547\ifx\relax #3%
3548#1{#2}{}\else #1{#2}{#3#4}\fi}}
3549
3550% So much for the things common to all kinds of definitions.
3551
3552% Define @defun.
3553
3554% First, define the processing that is wanted for arguments of \defun
3555% Use this to expand the args and terminate the paragraph they make up
3556
3557\def\defunargs #1{\functionparens \sl
3558% Expand, preventing hyphenation at `-' chars.
3559% Note that groups don't affect changes in \hyphenchar.
3560\hyphenchar\tensl=0
3561#1%
3562\hyphenchar\tensl=45
3563\ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi%
3564\interlinepenalty=10000
3565\advance\rightskip by 0pt plus 1fil
3566\endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3567}
3568
3569\def\deftypefunargs #1{%
3570% Expand, preventing hyphenation at `-' chars.
3571% Note that groups don't affect changes in \hyphenchar.
3572% Use \boldbraxnoamp, not \functionparens, so that & is not special.
3573\boldbraxnoamp
3574\tclose{#1}% avoid \code because of side effects on active chars
3575\interlinepenalty=10000
3576\advance\rightskip by 0pt plus 1fil
3577\endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3578}
3579
3580% Do complete processing of one @defun or @defunx line already parsed.
3581
3582% @deffn Command forward-char nchars
3583
3584\def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
3585
3586\def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
3587\begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
3588\catcode 61=\other % Turn off change made in \defparsebody
3589}
3590
3591% @defun == @deffn Function
3592
3593\def\defun{\defparsebody\Edefun\defunx\defunheader}
3594
3595\def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3596\begingroup\defname {#1}{Function}%
3597\defunargs {#2}\endgroup %
3598\catcode 61=\other % Turn off change made in \defparsebody
3599}
3600
3601% @deftypefun int foobar (int @var{foo}, float @var{bar})
3602
3603\def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
3604
3605% #1 is the data type. #2 is the name and args.
3606\def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
3607% #1 is the data type, #2 the name, #3 the args.
3608\def\deftypefunheaderx #1#2 #3\relax{%
3609\doind {fn}{\code{#2}}% Make entry in function index
3610\begingroup\defname {\defheaderxcond#1\relax$$$#2}{Function}%
3611\deftypefunargs {#3}\endgroup %
3612\catcode 61=\other % Turn off change made in \defparsebody
3613}
3614
3615% @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
3616
3617\def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
3618
3619% \defheaderxcond#1\relax$$$
3620% puts #1 in @code, followed by a space, but does nothing if #1 is null.
3621\def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
3622
3623% #1 is the classification. #2 is the data type. #3 is the name and args.
3624\def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
3625% #1 is the classification, #2 the data type, #3 the name, #4 the args.
3626\def\deftypefnheaderx #1#2#3 #4\relax{%
3627\doind {fn}{\code{#3}}% Make entry in function index
3628\begingroup
3629\normalparens % notably, turn off `&' magic, which prevents
3630% at least some C++ text from working
3631\defname {\defheaderxcond#2\relax$$$#3}{#1}%
3632\deftypefunargs {#4}\endgroup %
3633\catcode 61=\other % Turn off change made in \defparsebody
3634}
3635
3636% @defmac == @deffn Macro
3637
3638\def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
3639
3640\def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3641\begingroup\defname {#1}{Macro}%
3642\defunargs {#2}\endgroup %
3643\catcode 61=\other % Turn off change made in \defparsebody
3644}
3645
3646% @defspec == @deffn Special Form
3647
3648\def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
3649
3650\def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3651\begingroup\defname {#1}{Special Form}%
3652\defunargs {#2}\endgroup %
3653\catcode 61=\other % Turn off change made in \defparsebody
3654}
3655
3656% This definition is run if you use @defunx
3657% anywhere other than immediately after a @defun or @defunx.
3658
3659\def\deffnx #1 {\errmessage{@deffnx in invalid context}}
3660\def\defunx #1 {\errmessage{@defunx in invalid context}}
3661\def\defmacx #1 {\errmessage{@defmacx in invalid context}}
3662\def\defspecx #1 {\errmessage{@defspecx in invalid context}}
3663\def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
3664\def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
3665
3666% @defmethod, and so on
3667
3668% @defop {Funny Method} foo-class frobnicate argument
3669
3670\def\defop #1 {\def\defoptype{#1}%
3671\defopparsebody\Edefop\defopx\defopheader\defoptype}
3672
3673\def\defopheader #1#2#3{%
3674\dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
3675\begingroup\defname {#2}{\defoptype{} on #1}%
3676\defunargs {#3}\endgroup %
3677}
3678
3679% @defmethod == @defop Method
3680
3681\def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
3682
3683\def\defmethodheader #1#2#3{%
3684\dosubind {fn}{\code{#2}}{on #1}% entry in function index
3685\begingroup\defname {#2}{Method on #1}%
3686\defunargs {#3}\endgroup %
3687}
3688
3689% @defcv {Class Option} foo-class foo-flag
3690
3691\def\defcv #1 {\def\defcvtype{#1}%
3692\defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
3693
3694\def\defcvarheader #1#2#3{%
3695\dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3696\begingroup\defname {#2}{\defcvtype{} of #1}%
3697\defvarargs {#3}\endgroup %
3698}
3699
3700% @defivar == @defcv {Instance Variable}
3701
3702\def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
3703
3704\def\defivarheader #1#2#3{%
3705\dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3706\begingroup\defname {#2}{Instance Variable of #1}%
3707\defvarargs {#3}\endgroup %
3708}
3709
3710% These definitions are run if you use @defmethodx, etc.,
3711% anywhere other than immediately after a @defmethod, etc.
3712
3713\def\defopx #1 {\errmessage{@defopx in invalid context}}
3714\def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
3715\def\defcvx #1 {\errmessage{@defcvx in invalid context}}
3716\def\defivarx #1 {\errmessage{@defivarx in invalid context}}
3717
3718% Now @defvar
3719
3720% First, define the processing that is wanted for arguments of @defvar.
3721% This is actually simple: just print them in roman.
3722% This must expand the args and terminate the paragraph they make up
3723\def\defvarargs #1{\normalparens #1%
3724\interlinepenalty=10000
3725\endgraf\penalty 10000\vskip -\parskip\penalty 10000}
3726
3727% @defvr Counter foo-count
3728
3729\def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
3730
3731\def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
3732\begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
3733
3734% @defvar == @defvr Variable
3735
3736\def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
3737
3738\def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3739\begingroup\defname {#1}{Variable}%
3740\defvarargs {#2}\endgroup %
3741}
3742
3743% @defopt == @defvr {User Option}
3744
3745\def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
3746
3747\def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3748\begingroup\defname {#1}{User Option}%
3749\defvarargs {#2}\endgroup %
3750}
3751
3752% @deftypevar int foobar
3753
3754\def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
3755
3756% #1 is the data type. #2 is the name.
3757\def\deftypevarheader #1#2{%
3758\doind {vr}{\code{#2}}% Make entry in variables index
3759\begingroup\defname {\defheaderxcond#1\relax$$$#2}{Variable}%
3760\interlinepenalty=10000
3761\endgraf\penalty 10000\vskip -\parskip\penalty 10000
3762\endgroup}
3763
3764% @deftypevr {Global Flag} int enable
3765
3766\def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
3767
3768\def\deftypevrheader #1#2#3{\doind {vr}{\code{#3}}%
3769\begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
3770\interlinepenalty=10000
3771\endgraf\penalty 10000\vskip -\parskip\penalty 10000
3772\endgroup}
3773
3774% This definition is run if you use @defvarx
3775% anywhere other than immediately after a @defvar or @defvarx.
3776
3777\def\defvrx #1 {\errmessage{@defvrx in invalid context}}
3778\def\defvarx #1 {\errmessage{@defvarx in invalid context}}
3779\def\defoptx #1 {\errmessage{@defoptx in invalid context}}
3780\def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
3781\def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
3782
3783% Now define @deftp
3784% Args are printed in bold, a slight difference from @defvar.
3785
3786\def\deftpargs #1{\bf \defvarargs{#1}}
3787
3788% @deftp Class window height width ...
3789
3790\def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
3791
3792\def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
3793\begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
3794
3795% This definition is run if you use @deftpx, etc
3796% anywhere other than immediately after a @deftp, etc.
3797
3798\def\deftpx #1 {\errmessage{@deftpx in invalid context}}
3799
3800\message{cross reference,}
3801% Define cross-reference macros
3802\newwrite \auxfile
3803
3804\newif\ifhavexrefs % True if xref values are known.
3805\newif\ifwarnedxrefs % True if we warned once that they aren't known.
3806
3807% \setref{foo} defines a cross-reference point named foo.
3808
3809\def\setref#1{%
3810\dosetq{#1-title}{Ytitle}%
3811\dosetq{#1-pg}{Ypagenumber}%
3812\dosetq{#1-snt}{Ysectionnumberandtype}}
3813
3814\def\unnumbsetref#1{%
3815\dosetq{#1-title}{Ytitle}%
3816\dosetq{#1-pg}{Ypagenumber}%
3817\dosetq{#1-snt}{Ynothing}}
3818
3819\def\appendixsetref#1{%
3820\dosetq{#1-title}{Ytitle}%
3821\dosetq{#1-pg}{Ypagenumber}%
3822\dosetq{#1-snt}{Yappendixletterandtype}}
3823
3824% \xref, \pxref, and \ref generate cross-references to specified points.
3825% For \xrefX, #1 is the node name, #2 the name of the Info
3826% cross-reference, #3 the printed node name, #4 the name of the Info
3827% file, #5 the name of the printed manual. All but the node name can be
3828% omitted.
3829%
3830\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
3831\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
3832\def\ref#1{\xrefX[#1,,,,,,,]}
3833\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
3834 \def\printedmanual{\ignorespaces #5}%
3835 \def\printednodename{\ignorespaces #3}%
3836 \setbox1=\hbox{\printedmanual}%
3837 \setbox0=\hbox{\printednodename}%
3838 \ifdim \wd0 = 0pt
3839 % No printed node name was explicitly given.
3840 \ifx\SETxref-automatic-section-title\relax %
3841 % Use the actual chapter/section title appear inside
3842 % the square brackets. Use the real section title if we have it.
3843 \ifdim \wd1>0pt%
3844 % It is in another manual, so we don't have it.
3845 \def\printednodename{\ignorespaces #1}%
3846 \else
3847 \ifhavexrefs
3848 % We know the real title if we have the xref values.
3849 \def\printednodename{\refx{#1-title}}%
3850 \else
3851 % Otherwise just copy the Info node name.
3852 \def\printednodename{\ignorespaces #1}%
3853 \fi%
3854 \fi
3855 \def\printednodename{#1-title}%
3856 \else
3857 % Use the node name inside the square brackets.
3858 \def\printednodename{\ignorespaces #1}%
3859 \fi
3860 \fi
3861 %
3862 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
3863 % insert empty discretionaries after hyphens, which means that it will
3864 % not find a line break at a hyphen in a node names. Since some manuals
3865 % are best written with fairly long node names, containing hyphens, this
3866 % is a loss. Therefore, we give the text of the node name again, so it
3867 % is as if TeX is seeing it for the first time.
3868 \ifdim \wd1 > 0pt
3869 \putwordsection{} ``\printednodename'' in \cite{\printedmanual}%
3870 \else
3871 % _ (for example) has to be the character _ for the purposes of the
3872 % control sequence corresponding to the node, but it has to expand
3873 % into the usual \leavevmode...\vrule stuff for purposes of
3874 % printing. So we \turnoffactive for the \refx-snt, back on for the
3875 % printing, back off for the \refx-pg.
3876 {\turnoffactive \refx{#1-snt}{}}%
3877 \space [\printednodename],\space
3878 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
3879 \fi
3880\endgroup}
3881
3882% \dosetq is the interface for calls from other macros
3883
3884% Use \turnoffactive so that punctuation chars such as underscore
3885% work in node names.
3886\def\dosetq #1#2{{\let\folio=0 \turnoffactive \auxhat%
3887\edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
3888\next}}
3889
3890% \internalsetq {foo}{page} expands into
3891% CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
3892% When the aux file is read, ' is the escape character
3893
3894\def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
3895
3896% Things to be expanded by \internalsetq
3897
3898\def\Ypagenumber{\folio}
3899
3900\def\Ytitle{\thissection}
3901
3902\def\Ynothing{}
3903
3904\def\Ysectionnumberandtype{%
3905\ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
3906\else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
3907\else \ifnum \subsubsecno=0 %
3908\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
3909\else %
3910\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
3911\fi \fi \fi }
3912
3913\def\Yappendixletterandtype{%
3914\ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
3915\else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
3916\else \ifnum \subsubsecno=0 %
3917\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
3918\else %
3919\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
3920\fi \fi \fi }
3921
3922\gdef\xreftie{'tie}
3923
3924% Use TeX 3.0's \inputlineno to get the line number, for better error
3925% messages, but if we're using an old version of TeX, don't do anything.
3926%
3927\ifx\inputlineno\thisisundefined
3928 \let\linenumber = \empty % Non-3.0.
3929\else
3930 \def\linenumber{\the\inputlineno:\space}
3931\fi
3932
3933% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
3934% If its value is nonempty, SUFFIX is output afterward.
3935
3936\def\refx#1#2{%
3937 \expandafter\ifx\csname X#1\endcsname\relax
3938 % If not defined, say something at least.
3939 $\langle$un\-de\-fined$\rangle$%
3940 \ifhavexrefs
3941 \message{\linenumber Undefined cross reference `#1'.}%
3942 \else
3943 \ifwarnedxrefs\else
3944 \global\warnedxrefstrue
3945 \message{Cross reference values unknown; you must run TeX again.}%
3946 \fi
3947 \fi
3948 \else
3949 % It's defined, so just use it.
3950 \csname X#1\endcsname
3951 \fi
3952 #2% Output the suffix in any case.
3953}
3954
3955% Read the last existing aux file, if any. No error if none exists.
3956
3957% This is the macro invoked by entries in the aux file.
3958\def\xrdef #1#2{
3959{\catcode`\'=\other\expandafter \gdef \csname X#1\endcsname {#2}}}
3960
3961\def\readauxfile{%
3962\begingroup
3963\catcode `\^^@=\other
3964\catcode `\=\other
3965\catcode `\=\other
3966\catcode `\^^C=\other
3967\catcode `\^^D=\other
3968\catcode `\^^E=\other
3969\catcode `\^^F=\other
3970\catcode `\^^G=\other
3971\catcode `\^^H=\other
3972\catcode `\
3973=\other
3974\catcode `\^^L=\other
3975\catcode `\=\other
3976\catcode `\=\other
3977\catcode `\=\other
3978\catcode `\=\other
3979\catcode `\=\other
3980\catcode `\=\other
3981\catcode `\=\other
3982\catcode `\=\other
3983\catcode `\=\other
3984\catcode `\=\other
3985\catcode `\=\other
3986\catcode `\=\other
3987\catcode 26=\other
3988\catcode `\^^[=\other
3989\catcode `\^^\=\other
3990\catcode `\^^]=\other
3991\catcode `\^^^=\other
3992\catcode `\^^_=\other
3993\catcode `\@=\other
3994\catcode `\^=\other
3995\catcode `\~=\other
3996\catcode `\[=\other
3997\catcode `\]=\other
3998\catcode`\"=\other
3999\catcode`\_=\other
4000\catcode`\|=\other
4001\catcode`\<=\other
4002\catcode`\>=\other
4003\catcode `\$=\other
4004\catcode `\#=\other
4005\catcode `\&=\other
4006% `\+ does not work, so use 43.
4007\catcode 43=\other
4008% Make the characters 128-255 be printing characters
4009{%
4010 \count 1=128
4011 \def\loop{%
4012 \catcode\count 1=\other
4013 \advance\count 1 by 1
4014 \ifnum \count 1<256 \loop \fi
4015 }%
4016}%
4017% the aux file uses ' as the escape.
4018% Turn off \ as an escape so we do not lose on
4019% entries which were dumped with control sequences in their names.
4020% For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
4021% Reference to such entries still does not work the way one would wish,
4022% but at least they do not bomb out when the aux file is read in.
4023\catcode `\{=1 \catcode `\}=2
4024\catcode `\%=\other
4025\catcode `\'=0
4026\catcode`\^=7 % to make ^^e4 etc usable in xref tags
4027\catcode `\\=\other
4028\openin 1 \jobname.aux
4029\ifeof 1 \else \closein 1 \input \jobname.aux \global\havexrefstrue
4030\global\warnedobstrue
4031\fi
4032% Open the new aux file. Tex will close it automatically at exit.
4033\openout \auxfile=\jobname.aux
4034\endgroup}
4035
4036
4037% Footnotes.
4038
4039\newcount \footnoteno
4040
4041% The trailing space in the following definition for supereject is
4042% vital for proper filling; pages come out unaligned when you do a
4043% pagealignmacro call if that space before the closing brace is
4044% removed.
4045\def\supereject{\par\penalty -20000\footnoteno =0 }
4046
4047% @footnotestyle is meaningful for info output only..
4048\let\footnotestyle=\comment
4049
4050\let\ptexfootnote=\footnote
4051
4052{\catcode `\@=11
4053%
4054% Auto-number footnotes. Otherwise like plain.
4055\gdef\footnote{%
4056 \global\advance\footnoteno by \@ne
4057 \edef\thisfootno{$^{\the\footnoteno}$}%
4058 %
4059 % In case the footnote comes at the end of a sentence, preserve the
4060 % extra spacing after we do the footnote number.
4061 \let\@sf\empty
4062 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
4063 %
4064 % Remove inadvertent blank space before typesetting the footnote number.
4065 \unskip
4066 \thisfootno\@sf
4067 \footnotezzz
4068}%
4069
4070% Don't bother with the trickery in plain.tex to not require the
4071% footnote text as a parameter. Our footnotes don't need to be so general.
4072%
4073\long\gdef\footnotezzz#1{\insert\footins{%
4074 % We want to typeset this text as a normal paragraph, even if the
4075 % footnote reference occurs in (for example) a display environment.
4076 % So reset some parameters.
4077 \interlinepenalty\interfootnotelinepenalty
4078 \splittopskip\ht\strutbox % top baseline for broken footnotes
4079 \splitmaxdepth\dp\strutbox
4080 \floatingpenalty\@MM
4081 \leftskip\z@skip
4082 \rightskip\z@skip
4083 \spaceskip\z@skip
4084 \xspaceskip\z@skip
4085 \parindent\defaultparindent
4086 %
4087 % Hang the footnote text off the number.
4088 \hang
4089 \textindent{\thisfootno}%
4090 %
4091 % Don't crash into the line above the footnote text. Since this
4092 % expands into a box, it must come within the paragraph, lest it
4093 % provide a place where TeX can split the footnote.
4094 \footstrut
4095 #1\strut}%
4096}
4097
4098}%end \catcode `\@=11
4099
4100% Set the baselineskip to #1, and the lineskip and strut size
4101% correspondingly. There is no deep meaning behind these magic numbers
4102% used as factors; they just match (closely enough) what Knuth defined.
4103%
4104\def\lineskipfactor{.08333}
4105\def\strutheightpercent{.70833}
4106\def\strutdepthpercent {.29167}
4107%
4108\def\setleading#1{%
4109 \normalbaselineskip = #1\relax
4110 \normallineskip = \lineskipfactor\normalbaselineskip
4111 \normalbaselines
4112 \setbox\strutbox =\hbox{%
4113 \vrule width0pt height\strutheightpercent\baselineskip
4114 depth \strutdepthpercent \baselineskip
4115 }%
4116}
4117
4118% @| inserts a changebar to the left of the current line. It should
4119% surround any changed text. This approach does *not* work if the
4120% change spans more than two lines of output. To handle that, we would
4121% have adopt a much more difficult approach (putting marks into the main
4122% vertical list for the beginning and end of each change).
4123%
4124\def\|{%
4125 % \vadjust can only be used in horizontal mode.
4126 \leavevmode
4127 %
4128 % Append this vertical mode material after the current line in the output.
4129 \vadjust{%
4130 % We want to insert a rule with the height and depth of the current
4131 % leading; that is exactly what \strutbox is supposed to record.
4132 \vskip-\baselineskip
4133 %
4134 % \vadjust-items are inserted at the left edge of the type. So
4135 % the \llap here moves out into the left-hand margin.
4136 \llap{%
4137 %
4138 % For a thicker or thinner bar, change the `1pt'.
4139 \vrule height\baselineskip width1pt
4140 %
4141 % This is the space between the bar and the text.
4142 \hskip 12pt
4143 }%
4144 }%
4145}
4146
4147% For a final copy, take out the rectangles
4148% that mark overfull boxes (in case you have decided
4149% that the text looks ok even though it passes the margin).
4150%
4151\def\finalout{\overfullrule=0pt}
4152
4153
4154% End of control word definitions.
4155
4156\message{and turning on texinfo input format.}
4157
4158\def\openindices{%
4159 \newindex{cp}%
4160 \newcodeindex{fn}%
4161 \newcodeindex{vr}%
4162 \newcodeindex{tp}%
4163 \newcodeindex{ky}%
4164 \newcodeindex{pg}%
4165}
4166
4167% Set some numeric style parameters, for 8.5 x 11 format.
4168
4169%\hsize = 6.5in
4170\newdimen\defaultparindent \defaultparindent = 15pt
4171\parindent = \defaultparindent
4172\parskip 18pt plus 1pt
4173\setleading{15pt}
4174\advance\topskip by 1.2cm
4175
4176% Prevent underfull vbox error messages.
4177\vbadness=10000
4178
4179% Following George Bush, just get rid of widows and orphans.
4180\widowpenalty=10000
4181\clubpenalty=10000
4182
4183% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
4184% using an old version of TeX, don't do anything. We want the amount of
4185% stretch added to depend on the line length, hence the dependence on
4186% \hsize. This makes it come to about 9pt for the 8.5x11 format.
4187%
4188\ifx\emergencystretch\thisisundefined
4189 % Allow us to assign to \emergencystretch anyway.
4190 \def\emergencystretch{\dimen0}%
4191\else
4192 \emergencystretch = \hsize
4193 \divide\emergencystretch by 45
4194\fi
4195
4196% Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
4197\def\smallbook{
4198
4199% These values for secheadingskip and subsecheadingskip are
4200% experiments. RJC 7 Aug 1992
4201\global\secheadingskip = 17pt plus 6pt minus 3pt
4202\global\subsecheadingskip = 14pt plus 6pt minus 3pt
4203
4204\global\lispnarrowing = 0.3in
4205\setleading{12pt}
4206\advance\topskip by -1cm
4207\global\parskip 3pt plus 1pt
4208\global\hsize = 5in
4209\global\vsize=7.5in
4210\global\tolerance=700
4211\global\hfuzz=1pt
4212\global\contentsrightmargin=0pt
4213\global\deftypemargin=0pt
4214\global\defbodyindent=.5cm
4215
4216\global\pagewidth=\hsize
4217\global\pageheight=\vsize
4218
4219\global\let\smalllisp=\smalllispx
4220\global\let\smallexample=\smalllispx
4221\global\def\Esmallexample{\Esmalllisp}
4222}
4223
4224% Use @afourpaper to print on European A4 paper.
4225\def\afourpaper{
4226\global\tolerance=700
4227\global\hfuzz=1pt
4228\setleading{12pt}
4229\global\parskip 15pt plus 1pt
4230
4231\global\vsize= 53\baselineskip
4232\advance\vsize by \topskip
4233%\global\hsize= 5.85in % A4 wide 10pt
4234\global\hsize= 6.5in
4235\global\outerhsize=\hsize
4236\global\advance\outerhsize by 0.5in
4237\global\outervsize=\vsize
4238\global\advance\outervsize by 0.6in
4239
4240\global\pagewidth=\hsize
4241\global\pageheight=\vsize
4242}
4243
4244% Allow control of the text dimensions. Parameters in order: textheight;
4245% textwidth; \voffset; \hoffset (!); binding offset. All require a dimension;
4246% header is additional; added length extends the bottom of the page.
4247
4248\def\changepagesizes#1#2#3#4#5{
4249 \global\vsize= #1
4250 \advance\vsize by \topskip
4251 \global\voffset= #3
4252 \global\hsize= #2
4253 \global\outerhsize=\hsize
4254 \global\advance\outerhsize by 0.5in
4255 \global\outervsize=\vsize
4256 \global\advance\outervsize by 0.6in
4257 \global\pagewidth=\hsize
4258 \global\pageheight=\vsize
4259 \global\normaloffset= #4
4260 \global\bindingoffset= #5}
4261
4262% This layout is compatible with Latex on A4 paper.
4263
4264\def\afourlatex{\changepagesizes{22cm}{15cm}{7mm}{4.6mm}{5mm}}
4265
4266% Use @afourwide to print on European A4 paper in wide format.
4267\def\afourwide{\afourpaper
4268\changepagesizes{9.5in}{6.5in}{\hoffset}{\normaloffset}{\bindingoffset}}
4269
4270% Define macros to output various characters with catcode for normal text.
4271\catcode`\"=\other
4272\catcode`\~=\other
4273\catcode`\^=\other
4274\catcode`\_=\other
4275\catcode`\|=\other
4276\catcode`\<=\other
4277\catcode`\>=\other
4278\catcode`\+=\other
4279\def\normaldoublequote{"}
4280\def\normaltilde{~}
4281\def\normalcaret{^}
4282\def\normalunderscore{_}
4283\def\normalverticalbar{|}
4284\def\normalless{<}
4285\def\normalgreater{>}
4286\def\normalplus{+}
4287
4288% This macro is used to make a character print one way in ttfont
4289% where it can probably just be output, and another way in other fonts,
4290% where something hairier probably needs to be done.
4291%
4292% #1 is what to print if we are indeed using \tt; #2 is what to print
4293% otherwise. Since all the Computer Modern typewriter fonts have zero
4294% interword stretch (and shrink), and it is reasonable to expect all
4295% typewriter fonts to have this, we can check that font parameter.
4296%
4297\def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
4298
4299% Turn off all special characters except @
4300% (and those which the user can use as if they were ordinary).
4301% Most of these we simply print from the \tt font, but for some, we can
4302% use math or other variants that look better in normal text.
4303
4304\catcode`\"=\active
4305\def\activedoublequote{{\tt \char '042}}
4306\let"=\activedoublequote
4307\catcode`\~=\active
4308\def~{{\tt \char '176}}
4309\chardef\hat=`\^
4310\catcode`\^=\active
4311\def\auxhat{\def^{'hat}}
4312\def^{{\tt \hat}}
4313
4314\catcode`\_=\active
4315\def_{\ifusingtt\normalunderscore\_}
4316% Subroutine for the previous macro.
4317\def\_{\lvvmode \kern.06em \vbox{\hrule width.3em height.1ex}}
4318
4319% \lvvmode is equivalent in function to \leavevmode.
4320% Using \leavevmode runs into trouble when written out to
4321% an index file due to the expansion of \leavevmode into ``\unhbox
4322% \voidb@x'' ---which looks to TeX like ``\unhbox \voidb\x'' due to our
4323% magic tricks with @.
4324\def\lvvmode{\vbox to 0pt{}}
4325
4326\catcode`\|=\active
4327\def|{{\tt \char '174}}
4328\chardef \less=`\<
4329\catcode`\<=\active
4330\def<{{\tt \less}}
4331\chardef \gtr=`\>
4332\catcode`\>=\active
4333\def>{{\tt \gtr}}
4334\catcode`\+=\active
4335\def+{{\tt \char 43}}
4336%\catcode 27=\active
4337%\def^^[{$\diamondsuit$}
4338
4339% Set up an active definition for =, but don't enable it most of the time.
4340{\catcode`\==\active
4341\global\def={{\tt \char 61}}}
4342
4343\catcode`+=\active
4344\catcode`\_=\active
4345
4346% If a .fmt file is being used, characters that might appear in a file
4347% name cannot be active until we have parsed the command line.
4348% So turn them off again, and have \everyjob (or @setfilename) turn them on.
4349% \otherifyactive is called near the end of this file.
4350\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
4351
4352\catcode`\@=0
4353
4354% \rawbackslashxx output one backslash character in current font
4355\global\chardef\rawbackslashxx=`\\
4356%{\catcode`\\=\other
4357%@gdef@rawbackslashxx{\}}
4358
4359% \rawbackslash redefines \ as input to do \rawbackslashxx.
4360{\catcode`\\=\active
4361@gdef@rawbackslash{@let\=@rawbackslashxx }}
4362
4363% \normalbackslash outputs one backslash in fixed width font.
4364\def\normalbackslash{{\tt\rawbackslashxx}}
4365
4366% Say @foo, not \foo, in error messages.
4367\escapechar=`\@
4368
4369% \catcode 17=0 % Define control-q
4370\catcode`\\=\active
4371
4372% Used sometimes to turn off (effectively) the active characters
4373% even after parsing them.
4374@def@turnoffactive{@let"=@normaldoublequote
4375@let\=@realbackslash
4376@let~=@normaltilde
4377@let^=@normalcaret
4378@let_=@normalunderscore
4379@let|=@normalverticalbar
4380@let<=@normalless
4381@let>=@normalgreater
4382@let+=@normalplus}
4383
4384@def@normalturnoffactive{@let"=@normaldoublequote
4385@let\=@normalbackslash
4386@let~=@normaltilde
4387@let^=@normalcaret
4388@let_=@normalunderscore
4389@let|=@normalverticalbar
4390@let<=@normalless
4391@let>=@normalgreater
4392@let+=@normalplus}
4393
4394% Make _ and + \other characters, temporarily.
4395% This is canceled by @fixbackslash.
4396@otherifyactive
4397
4398% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4399% That is what \eatinput is for; after that, the `\' should revert to printing
4400% a backslash.
4401%
4402@gdef@eatinput input texinfo{@fixbackslash}
4403@global@let\ = @eatinput
4404
4405% On the other hand, perhaps the file did not have a `\input texinfo'. Then
4406% the first `\{ in the file would cause an error. This macro tries to fix
4407% that, assuming it is called before the first `\' could plausibly occur.
4408% Also back turn on active characters that might appear in the input
4409% file name, in case not using a pre-dumped format.
4410%
4411@gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi
4412 @catcode`+=@active @catcode`@_=@active}
4413
4414%% These look ok in all fonts, so just make them not special. The @rm below
4415%% makes sure that the current font starts out as the newly loaded cmr10
4416@catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
4417
4418@textfonts
4419@rm
4420
4421@c Local variables:
4422@c page-delimiter: "^\\\\message"
4423@c End:
Note: See TracBrowser for help on using the repository browser.