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