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