OSDN Git Service

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