update from texinfo
[pspp] / config / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2004-02-15.09}
7 %
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
10 % Foundation, Inc.
11 %
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
16 %
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 % General Public License for more details.
21 %
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING.  If not, write
24 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 % Boston, MA 02111-1307, USA.
26 %
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction.  (This has been our intent since Texinfo was invented.)
30
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 %   ftp://tug.org/tex/texinfo.tex
35 %     (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
38 %
39 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem.  Patches are, of course, greatly appreciated.
42 %
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution.  For a simple
45 % manual foo.texi, however, you can get away with this:
46 %   tex foo.texi
47 %   texindex foo.??
48 %   tex foo.texi
49 %   tex foo.texi
50 %   dvips foo.dvi -o  # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
54 %
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent.  You can get the existing language-specific files from the
57 % full Texinfo distribution.
58
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60
61
62 \message{Loading texinfo [version \texinfoversion]:}
63
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68   \catcode`+=\active \catcode`\_=\active}
69
70 \message{Basics,}
71 \chardef\other=12
72
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
76
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexnoindent=\noindent
93 \let\ptexinsert=\insert
94 \let\ptexlbrace=\{
95 \let\ptexless=<
96 \let\ptexplus=+
97 \let\ptexrbrace=\}
98 \let\ptexslash=\/
99 \let\ptexstar=\*
100 \let\ptext=\t
101
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
104 \newlinechar = `^^J
105
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
108 %
109 \ifx\inputlineno\thisisundefined
110   \let\linenumber = \empty % Pre-3.0.
111 \else
112   \def\linenumber{l.\the\inputlineno:\space}
113 \fi
114
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined     \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
135 %
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
148 %
149 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
154
155 % In some macros, we cannot use the `\? notation---the left quote is
156 % in some cases the escape char.
157 \chardef\colonChar = `\:
158 \chardef\commaChar = `\,
159 \chardef\dotChar   = `\.
160 \chardef\exclamChar= `\!
161 \chardef\questChar = `\?
162 \chardef\semiChar  = `\;
163 \chardef\underChar = `\_
164
165 \chardef\spaceChar = `\ %
166 \chardef\spacecat = 10
167 \def\spaceisspace{\catcode\spaceChar=\spacecat}
168
169 % Ignore a token.
170 %
171 \def\gobble#1{}
172
173 % The following is used inside several \edef's.
174 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
175
176 % Hyphenation fixes.
177 \hyphenation{
178   Flor-i-da Ghost-script Ghost-view Mac-OS Ra-dha-krish-nan
179   ap-pen-dix bit-map data-base data-bases eshell fall-ing half-way
180   long-est mini-buf-fer mini-buf-fers over-view par-a-digm
181   rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces strong-est
182   time-stamp which-ever white-space wide-spread wrap-around
183 }
184
185 % Margin to add to right of even pages, to left of odd pages.
186 \newdimen\bindingoffset
187 \newdimen\normaloffset
188 \newdimen\pagewidth \newdimen\pageheight
189
190 % For a final copy, take out the rectangles
191 % that mark overfull boxes (in case you have decided
192 % that the text looks ok even though it passes the margin).
193 %
194 \def\finalout{\overfullrule=0pt}
195
196 % @| inserts a changebar to the left of the current line.  It should
197 % surround any changed text.  This approach does *not* work if the
198 % change spans more than two lines of output.  To handle that, we would
199 % have adopt a much more difficult approach (putting marks into the main
200 % vertical list for the beginning and end of each change).
201 %
202 \def\|{%
203   % \vadjust can only be used in horizontal mode.
204   \leavevmode
205   %
206   % Append this vertical mode material after the current line in the output.
207   \vadjust{%
208     % We want to insert a rule with the height and depth of the current
209     % leading; that is exactly what \strutbox is supposed to record.
210     \vskip-\baselineskip
211     %
212     % \vadjust-items are inserted at the left edge of the type.  So
213     % the \llap here moves out into the left-hand margin.
214     \llap{%
215       %
216       % For a thicker or thinner bar, change the `1pt'.
217       \vrule height\baselineskip width1pt
218       %
219       % This is the space between the bar and the text.
220       \hskip 12pt
221     }%
222   }%
223 }
224
225 % Sometimes it is convenient to have everything in the transcript file
226 % and nothing on the terminal.  We don't just call \tracingall here,
227 % since that produces some useless output on the terminal.  We also make
228 % some effort to order the tracing commands to reduce output in the log
229 % file; cf. trace.sty in LaTeX.
230 %
231 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
232 \def\loggingall{%
233   \tracingstats2
234   \tracingpages1
235   \tracinglostchars2  % 2 gives us more in etex
236   \tracingparagraphs1
237   \tracingoutput1
238   \tracingmacros2
239   \tracingrestores1
240   \showboxbreadth\maxdimen \showboxdepth\maxdimen
241   \ifx\eTeXversion\undefined\else % etex gives us more logging
242     \tracingscantokens1
243     \tracingifs1
244     \tracinggroups1
245     \tracingnesting2
246     \tracingassigns1
247   \fi
248   \tracingcommands3  % 3 gives us more in etex
249   \errorcontextlines16
250 }%
251
252 % add check for \lastpenalty to plain's definitions.  If the last thing
253 % we did was a \nobreak, we don't want to insert more space.
254 %
255 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
256   \removelastskip\penalty-50\smallskip\fi\fi}
257 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
258   \removelastskip\penalty-100\medskip\fi\fi}
259 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
260   \removelastskip\penalty-200\bigskip\fi\fi}
261
262 % For @cropmarks command.
263 % Do @cropmarks to get crop marks.
264 %
265 \newif\ifcropmarks
266 \let\cropmarks = \cropmarkstrue
267 %
268 % Dimensions to add cropmarks at corners.
269 % Added by P. A. MacKay, 12 Nov. 1986
270 %
271 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
272 \newdimen\cornerlong  \cornerlong=1pc
273 \newdimen\cornerthick \cornerthick=.3pt
274 \newdimen\topandbottommargin \topandbottommargin=.75in
275
276 % Main output routine.
277 \chardef\PAGE = 255
278 \output = {\onepageout{\pagecontents\PAGE}}
279
280 \newbox\headlinebox
281 \newbox\footlinebox
282
283 % \onepageout takes a vbox as an argument.  Note that \pagecontents
284 % does insertions, but you have to call it yourself.
285 \def\onepageout#1{%
286   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
287   %
288   \ifodd\pageno  \advance\hoffset by \bindingoffset
289   \else \advance\hoffset by -\bindingoffset\fi
290   %
291   % Do this outside of the \shipout so @code etc. will be expanded in
292   % the headline as they should be, not taken literally (outputting ''code).
293   \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
294   \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
295   %
296   {%
297     % Have to do this stuff outside the \shipout because we want it to
298     % take effect in \write's, yet the group defined by the \vbox ends
299     % before the \shipout runs.
300     %
301     \escapechar = `\\     % use backslash in output files.
302     \indexdummies         % don't expand commands in the output.
303     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
304                    % the page break happens to be in the middle of an example.
305     \shipout\vbox{%
306       % Do this early so pdf references go to the beginning of the page.
307       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
308       %
309       \ifcropmarks \vbox to \outervsize\bgroup
310         \hsize = \outerhsize
311         \vskip-\topandbottommargin
312         \vtop to0pt{%
313           \line{\ewtop\hfil\ewtop}%
314           \nointerlineskip
315           \line{%
316             \vbox{\moveleft\cornerthick\nstop}%
317             \hfill
318             \vbox{\moveright\cornerthick\nstop}%
319           }%
320           \vss}%
321         \vskip\topandbottommargin
322         \line\bgroup
323           \hfil % center the page within the outer (page) hsize.
324           \ifodd\pageno\hskip\bindingoffset\fi
325           \vbox\bgroup
326       \fi
327       %
328       \unvbox\headlinebox
329       \pagebody{#1}%
330       \ifdim\ht\footlinebox > 0pt
331         % Only leave this space if the footline is nonempty.
332         % (We lessened \vsize for it in \oddfootingxxx.)
333         % The \baselineskip=24pt in plain's \makefootline has no effect.
334         \vskip 2\baselineskip
335         \unvbox\footlinebox
336       \fi
337       %
338       \ifcropmarks
339           \egroup % end of \vbox\bgroup
340         \hfil\egroup % end of (centering) \line\bgroup
341         \vskip\topandbottommargin plus1fill minus1fill
342         \boxmaxdepth = \cornerthick
343         \vbox to0pt{\vss
344           \line{%
345             \vbox{\moveleft\cornerthick\nsbot}%
346             \hfill
347             \vbox{\moveright\cornerthick\nsbot}%
348           }%
349           \nointerlineskip
350           \line{\ewbot\hfil\ewbot}%
351         }%
352       \egroup % \vbox from first cropmarks clause
353       \fi
354     }% end of \shipout\vbox
355   }% end of group with \normalturnoffactive
356   \advancepageno
357   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
358 }
359
360 \newinsert\margin \dimen\margin=\maxdimen
361
362 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
363 {\catcode`\@ =11
364 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
365 % marginal hacks, juha@viisa.uucp (Juha Takala)
366 \ifvoid\margin\else % marginal info is present
367   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
368 \dimen@=\dp#1 \unvbox#1
369 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
370 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
371 }
372
373 % Here are the rules for the cropmarks.  Note that they are
374 % offset so that the space between them is truly \outerhsize or \outervsize
375 % (P. A. MacKay, 12 November, 1986)
376 %
377 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
378 \def\nstop{\vbox
379   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
380 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
381 \def\nsbot{\vbox
382   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
383
384 % Parse an argument, then pass it to #1.  The argument is the rest of
385 % the input line (except we remove a trailing comment).  #1 should be a
386 % macro which expects an ordinary undelimited TeX argument.
387 %
388 \def\parsearg{\parseargusing{}}
389 \def\parseargusing#1#2{%
390   \def\next{#2}%
391   \begingroup
392     \obeylines
393     \spaceisspace
394     #1%
395     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
396 }
397
398 {\obeylines %
399   \gdef\parseargline#1^^M{%
400     \endgroup % End of the group started in \parsearg.
401     \argremovecomment #1\comment\ArgTerm%
402   }%
403 }
404
405 % First remove any @comment, then any @c comment.
406 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
407 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
408
409 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
410 %
411 % \argremovec might leave us with trailing space, e.g.,
412 %    @end itemize  @c foo
413 % This space token undergoes the same procedure and is eventually removed
414 % by \finishparsearg.
415 %
416 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
417 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
418 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
419   \def\temp{#3}%
420   \ifx\temp\empty
421     % We cannot use \next here, as it holds the macro to run;
422     % thus we reuse \temp.
423     \let\temp\finishparsearg
424   \else
425     \let\temp\argcheckspaces
426   \fi
427   % Put the space token in:
428   \temp#1 #3\ArgTerm
429 }
430
431 % If a _delimited_ argument is enclosed in braces, they get stripped; so
432 % to get _exactly_ the rest of the line, we had to prevent such situation.
433 % We prepended an \empty token at the very beginning and we expand it now,
434 % just before passing the control to \next.
435 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
436 % either the null string, or it ends with \^^M---thus there is no danger
437 % that a pair of braces would be stripped.
438 %
439 % But first, we have to remove the trailing space token.
440 %
441 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
442
443 % \parseargdef\foo{...}
444 %       is roughly equivalent to
445 % \def\foo{\parsearg\Xfoo}
446 % \def\Xfoo#1{...}
447 %
448 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
449 % favourite TeX trick.  --kasal, 16nov03
450
451 \def\parseargdef#1{%
452   \expandafter \doparseargdef \csname\string#1\endcsname #1%
453 }
454 \def\doparseargdef#1#2{%
455   \def#2{\parsearg#1}%
456   \def#1##1%
457 }
458
459 % Several utility definitions with active space:
460 {
461   \obeyspaces
462   \gdef\obeyedspace{ }
463
464   % Make each space character in the input produce a normal interword
465   % space in the output.  Don't allow a line break at this space, as this
466   % is used only in environments like @example, where each line of input
467   % should produce a line of output anyway.
468   %
469   \gdef\sepspaces{\obeyspaces\let =\tie}
470
471   % If an index command is used in an @example environment, any spaces
472   % therein should become regular spaces in the raw index file, not the
473   % expansion of \tie (\leavevmode \penalty \@M \ ).
474   \gdef\unsepspaces{\let =\space}
475 }
476
477
478 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
479
480 % Define the framework for environments in texinfo.tex.  It's used like this:
481
482 %   \envdef\foo{...}
483 %   \def\Efoo{...}
484 %   
485 % It's the responsibility of \envdef to insert \begingroup before the
486 % actual body; @end closes the group after calling \Efoo.  \envdef also
487 % defines \thisenv, so the current environment is known; @end checks
488 % whether the environment name matches.  The \checkenv macro can also be
489 % used to check whether the current environment is the one expected.
490
491 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
492 % are not treated as enviroments; they don't open a group.  (The
493 % implementation of @end takes care not to call \endgroup in this
494 % special case.)
495
496
497 % At runtime, environments start with this:
498 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
499 % initialize
500 \let\thisenv\empty
501
502 % ... but they get defined via ``\envdef\foo{...}'':
503 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
504 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
505
506 % Check whether we're in the right environment:
507 \def\checkenv#1{%
508   \def\temp{#1}%
509   \ifx\thisenv\temp
510   \else
511     \badenverr
512   \fi
513 }
514
515 % Evironment mismatch, #1 expected:
516 \def\badenverr{%
517   \errhelp = \EMsimple
518   \errmessage{This command can appear only \inenvironment\temp,
519     not \inenvironment\thisenv}%
520 }
521 \def\inenvironment#1{%
522   \ifx#1\empty
523     out of any environment%
524   \else
525     in environment \expandafter\string#1%
526   \fi
527 }
528
529 % @end foo executes the definition of \Efoo.
530 % But first, it executes a specialized version of \checkenv
531 %
532 \parseargdef\end{%
533   \if 1\csname iscond.#1\endcsname
534   \else
535     % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
536     \expandafter\checkenv\csname#1\endcsname
537     \csname E#1\endcsname
538     \endgroup
539   \fi
540 }
541
542 \newhelp\EMsimple{Press RETURN to continue.}
543
544
545 %% Simple single-character @ commands
546
547 % @@ prints an @
548 % Kludge this until the fonts are right (grr).
549 \def\@{{\tt\char64}}
550
551 % This is turned off because it was never documented
552 % and you can use @w{...} around a quote to suppress ligatures.
553 %% Define @` and @' to be the same as ` and '
554 %% but suppressing ligatures.
555 %\def\`{{`}}
556 %\def\'{{'}}
557
558 % Used to generate quoted braces.
559 \def\mylbrace {{\tt\char123}}
560 \def\myrbrace {{\tt\char125}}
561 \let\{=\mylbrace
562 \let\}=\myrbrace
563 \begingroup
564   % Definitions to produce \{ and \} commands for indices,
565   % and @{ and @} for the aux file.
566   \catcode`\{ = \other \catcode`\} = \other
567   \catcode`\[ = 1 \catcode`\] = 2
568   \catcode`\! = 0 \catcode`\\ = \other
569   !gdef!lbracecmd[\{]%
570   !gdef!rbracecmd[\}]%
571   !gdef!lbraceatcmd[@{]%
572   !gdef!rbraceatcmd[@}]%
573 !endgroup
574
575 % @comma{} to avoid , parsing problems.
576 \let\comma = ,
577
578 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
579 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
580 \let\, = \c
581 \let\dotaccent = \.
582 \def\ringaccent#1{{\accent23 #1}}
583 \let\tieaccent = \t
584 \let\ubaraccent = \b
585 \let\udotaccent = \d
586
587 % Other special characters: @questiondown @exclamdown @ordf @ordm
588 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
589 \def\questiondown{?`}
590 \def\exclamdown{!`}
591 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
592 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
593
594 % Dotless i and dotless j, used for accents.
595 \def\imacro{i}
596 \def\jmacro{j}
597 \def\dotless#1{%
598   \def\temp{#1}%
599   \ifx\temp\imacro \ptexi
600   \else\ifx\temp\jmacro \j
601   \else \errmessage{@dotless can be used only with i or j}%
602   \fi\fi
603 }
604
605 % The \TeX{} logo, as in plain, but resetting the spacing so that a
606 % period following counts as ending a sentence.  (Idea found in latex.)
607
608 \edef\TeX{\TeX \spacefactor=3000 }
609
610 % @LaTeX{} logo.  Not quite the same results as the definition in
611 % latex.ltx, since we use a different font for the raised A; it's most
612 % convenient for us to use an explicitly smaller font, rather than using
613 % the \scriptstyle font (since we don't reset \scriptstyle and
614 % \scriptscriptstyle).
615
616 \def\LaTeX{%
617   L\kern-.36em
618   {\setbox0=\hbox{T}%
619    \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
620   \kern-.15em
621   \TeX
622 }
623
624 % Be sure we're in horizontal mode when doing a tie, since we make space
625 % equivalent to this in @example-like environments. Otherwise, a space
626 % at the beginning of a line will start with \penalty -- and
627 % since \penalty is valid in vertical mode, we'd end up putting the
628 % penalty on the vertical list instead of in the new paragraph.
629 {\catcode`@ = 11
630  % Avoid using \@M directly, because that causes trouble
631  % if the definition is written into an index file.
632  \global\let\tiepenalty = \@M
633  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
634 }
635
636 % @: forces normal size whitespace following.
637 \def\:{\spacefactor=1000 }
638
639 % @* forces a line break.
640 \def\*{\hfil\break\hbox{}\ignorespaces}
641
642 % @/ allows a line break.
643 \let\/=\allowbreak
644
645 % @. is an end-of-sentence period.
646 \def\.{.\spacefactor=3000 }
647
648 % @! is an end-of-sentence bang.
649 \def\!{!\spacefactor=3000 }
650
651 % @? is an end-of-sentence query.
652 \def\?{?\spacefactor=3000 }
653
654 % @w prevents a word break.  Without the \leavevmode, @w at the
655 % beginning of a paragraph, when TeX is still in vertical mode, would
656 % produce a whole line of output instead of starting the paragraph.
657 \def\w#1{\leavevmode\hbox{#1}}
658
659 % @group ... @end group forces ... to be all on one page, by enclosing
660 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
661 % to keep its height that of a normal line.  According to the rules for
662 % \topskip (p.114 of the TeXbook), the glue inserted is
663 % max (\topskip - \ht (first item), 0).  If that height is large,
664 % therefore, no glue is inserted, and the space between the headline and
665 % the text is small, which looks bad.
666 %
667 % Another complication is that the group might be very large.  This can
668 % cause the glue on the previous page to be unduly stretched, because it
669 % does not have much material.  In this case, it's better to add an
670 % explicit \vfill so that the extra space is at the bottom.  The
671 % threshold for doing this is if the group is more than \vfilllimit
672 % percent of a page (\vfilllimit can be changed inside of @tex).
673 %
674 \newbox\groupbox
675 \def\vfilllimit{0.7}
676 %
677 \envdef\group{%
678   \ifnum\catcode`\^^M=\active \else
679     \errhelp = \groupinvalidhelp
680     \errmessage{@group invalid in context where filling is enabled}%
681   \fi
682   \startsavinginserts
683   %
684   \setbox\groupbox = \vtop\bgroup
685     % Do @comment since we are called inside an environment such as
686     % @example, where each end-of-line in the input causes an
687     % end-of-line in the output.  We don't want the end-of-line after
688     % the `@group' to put extra space in the output.  Since @group
689     % should appear on a line by itself (according to the Texinfo
690     % manual), we don't worry about eating any user text.
691     \comment
692 }
693 %
694 % The \vtop produces a box with normal height and large depth; thus, TeX puts
695 % \baselineskip glue before it, and (when the next line of text is done)
696 % \lineskip glue after it.  Thus, space below is not quite equal to space
697 % above.  But it's pretty close.
698 \def\Egroup{%
699     % To get correct interline space between the last line of the group
700     % and the first line afterwards, we have to propagate \prevdepth.
701     \endgraf % Not \par, as it may have been set to \lisppar.
702     \global\dimen1 = \prevdepth
703   \egroup           % End the \vtop.
704   % \dimen0 is the vertical size of the group's box.
705   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
706   % \dimen2 is how much space is left on the page (more or less).
707   \dimen2 = \pageheight   \advance\dimen2 by -\pagetotal
708   % if the group doesn't fit on the current page, and it's a big big
709   % group, force a page break.
710   \ifdim \dimen0 > \dimen2
711     \ifdim \pagetotal < \vfilllimit\pageheight
712       \page
713     \fi
714   \fi
715   \box\groupbox
716   \prevdepth = \dimen1
717   \checkinserts
718 }
719 %
720 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
721 % message, so this ends up printing `@group can only ...'.
722 %
723 \newhelp\groupinvalidhelp{%
724 group can only be used in environments such as @example,^^J%
725 where each line of input produces a line of output.}
726
727 % @need space-in-mils
728 % forces a page break if there is not space-in-mils remaining.
729
730 \newdimen\mil  \mil=0.001in
731
732 % Old definition--didn't work.
733 %\parseargdef\need{\par %
734 %% This method tries to make TeX break the page naturally
735 %% if the depth of the box does not fit.
736 %{\baselineskip=0pt%
737 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
738 %\prevdepth=-1000pt
739 %}}
740
741 \parseargdef\need{%
742   % Ensure vertical mode, so we don't make a big box in the middle of a
743   % paragraph.
744   \par
745   %
746   % If the @need value is less than one line space, it's useless.
747   \dimen0 = #1\mil
748   \dimen2 = \ht\strutbox
749   \advance\dimen2 by \dp\strutbox
750   \ifdim\dimen0 > \dimen2
751     %
752     % Do a \strut just to make the height of this box be normal, so the
753     % normal leading is inserted relative to the preceding line.
754     % And a page break here is fine.
755     \vtop to #1\mil{\strut\vfil}%
756     %
757     % TeX does not even consider page breaks if a penalty added to the
758     % main vertical list is 10000 or more.  But in order to see if the
759     % empty box we just added fits on the page, we must make it consider
760     % page breaks.  On the other hand, we don't want to actually break the
761     % page after the empty box.  So we use a penalty of 9999.
762     %
763     % There is an extremely small chance that TeX will actually break the
764     % page at this \penalty, if there are no other feasible breakpoints in
765     % sight.  (If the user is using lots of big @group commands, which
766     % almost-but-not-quite fill up a page, TeX will have a hard time doing
767     % good page breaking, for example.)  However, I could not construct an
768     % example where a page broke at this \penalty; if it happens in a real
769     % document, then we can reconsider our strategy.
770     \penalty9999
771     %
772     % Back up by the size of the box, whether we did a page break or not.
773     \kern -#1\mil
774     %
775     % Do not allow a page break right after this kern.
776     \nobreak
777   \fi
778 }
779
780 % @br   forces paragraph break (and is undocumented).
781
782 \let\br = \par
783
784 % @page forces the start of a new page.
785 %
786 \def\page{\par\vfill\supereject}
787
788 % @exdent text....
789 % outputs text on separate line in roman font, starting at standard page margin
790
791 % This records the amount of indent in the innermost environment.
792 % That's how much \exdent should take out.
793 \newskip\exdentamount
794
795 % This defn is used inside fill environments such as @defun.
796 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
797
798 % This defn is used inside nofill environments such as @example.
799 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
800   \leftline{\hskip\leftskip{\rm#1}}}}
801
802 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
803 % paragraph.  For more general purposes, use the \margin insertion
804 % class.  WHICH is `l' or `r'.
805 %
806 \newskip\inmarginspacing \inmarginspacing=1cm
807 \def\strutdepth{\dp\strutbox}
808 %
809 \def\doinmargin#1#2{\strut\vadjust{%
810   \nobreak
811   \kern-\strutdepth
812   \vtop to \strutdepth{%
813     \baselineskip=\strutdepth
814     \vss
815     % if you have multiple lines of stuff to put here, you'll need to
816     % make the vbox yourself of the appropriate size.
817     \ifx#1l%
818       \llap{\ignorespaces #2\hskip\inmarginspacing}%
819     \else
820       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
821     \fi
822     \null
823   }%
824 }}
825 \def\inleftmargin{\doinmargin l}
826 \def\inrightmargin{\doinmargin r}
827 %
828 % @inmargin{TEXT [, RIGHT-TEXT]}
829 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
830 % else use TEXT for both).
831 %
832 \def\inmargin#1{\parseinmargin #1,,\finish}
833 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
834   \setbox0 = \hbox{\ignorespaces #2}%
835   \ifdim\wd0 > 0pt
836     \def\lefttext{#1}%  have both texts
837     \def\righttext{#2}%
838   \else
839     \def\lefttext{#1}%  have only one text
840     \def\righttext{#1}%
841   \fi
842   %
843   \ifodd\pageno
844     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
845   \else
846     \def\temp{\inleftmargin\lefttext}%
847   \fi
848   \temp
849 }
850
851 % @include file    insert text of that file as input.
852 %
853 \def\include{\parseargusing\filenamecatcodes\includezzz}
854 \def\includezzz#1{%
855   \pushthisfilestack
856   \def\thisfile{#1}%
857   {%
858     \makevalueexpandable
859     \def\temp{\input #1 }%
860     \expandafter
861   }\temp
862   \popthisfilestack
863 }
864 \def\filenamecatcodes{%
865   \catcode`\\=\other
866   \catcode`~=\other
867   \catcode`^=\other
868   \catcode`_=\other
869   \catcode`|=\other
870   \catcode`<=\other
871   \catcode`>=\other
872   \catcode`+=\other
873   \catcode`-=\other
874 }
875
876 \def\pushthisfilestack{%
877   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
878 }
879 \def\pushthisfilestackX{%
880   \expandafter\pushthisfilestackY\thisfile\StackTerm
881 }
882 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
883   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
884 }
885
886 \def\popthisfilestack{\errthisfilestackempty}
887 \def\errthisfilestackempty{\errmessage{Internal error:
888   the stack of filenames is empty.}}
889
890 \def\thisfile{}
891
892 % @center line
893 % outputs that line, centered.
894 %
895 \parseargdef\center{%
896   \ifhmode
897     \let\next\centerH
898   \else
899     \let\next\centerV
900   \fi
901   \next{\hfil \ignorespaces#1\unskip \hfil}%
902 }
903 \def\centerH#1{%
904   {%
905     \hfil\break
906     \advance\hsize by -\leftskip
907     \advance\hsize by -\rightskip
908     \line{#1}%
909     \break
910   }%
911 }
912 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
913
914 % @sp n   outputs n lines of vertical space
915
916 \parseargdef\sp{\vskip #1\baselineskip}
917
918 % @comment ...line which is ignored...
919 % @c is the same as @comment
920 % @ignore ... @end ignore  is another way to write a comment
921
922 \def\comment{\begingroup \catcode`\^^M=\other%
923 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
924 \commentxxx}
925 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
926
927 \let\c=\comment
928
929 % @paragraphindent NCHARS
930 % We'll use ems for NCHARS, close enough.
931 % NCHARS can also be the word `asis' or `none'.
932 % We cannot feasibly implement @paragraphindent asis, though.
933 %
934 \def\asisword{asis} % no translation, these are keywords
935 \def\noneword{none}
936 %
937 \parseargdef\paragraphindent{%
938   \def\temp{#1}%
939   \ifx\temp\asisword
940   \else
941     \ifx\temp\noneword
942       \defaultparindent = 0pt
943     \else
944       \defaultparindent = #1em
945     \fi
946   \fi
947   \parindent = \defaultparindent
948 }
949
950 % @exampleindent NCHARS
951 % We'll use ems for NCHARS like @paragraphindent.
952 % It seems @exampleindent asis isn't necessary, but
953 % I preserve it to make it similar to @paragraphindent.
954 \parseargdef\exampleindent{%
955   \def\temp{#1}%
956   \ifx\temp\asisword
957   \else
958     \ifx\temp\noneword
959       \lispnarrowing = 0pt
960     \else
961       \lispnarrowing = #1em
962     \fi
963   \fi
964 }
965
966 % @firstparagraphindent WORD
967 % If WORD is `none', then suppress indentation of the first paragraph
968 % after a section heading.  If WORD is `insert', then do indent at such
969 % paragraphs.
970 %
971 % The paragraph indentation is suppressed or not by calling
972 % \suppressfirstparagraphindent, which the sectioning commands do.
973 % We switch the definition of this back and forth according to WORD.
974 % By default, we suppress indentation.
975 %
976 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
977 \def\insertword{insert}
978 %
979 \parseargdef\firstparagraphindent{%
980   \def\temp{#1}%
981   \ifx\temp\noneword
982     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
983   \else\ifx\temp\insertword
984     \let\suppressfirstparagraphindent = \relax
985   \else
986     \errhelp = \EMsimple
987     \errmessage{Unknown @firstparagraphindent option `\temp'}%
988   \fi\fi
989 }
990
991 % Here is how we actually suppress indentation.  Redefine \everypar to
992 % \kern backwards by \parindent, and then reset itself to empty.
993 %
994 % We also make \indent itself not actually do anything until the next
995 % paragraph.
996 %
997 \gdef\dosuppressfirstparagraphindent{%
998   \gdef\indent{%
999     \restorefirstparagraphindent
1000     \indent
1001   }%
1002   \gdef\noindent{%
1003     \restorefirstparagraphindent
1004     \noindent
1005   }%
1006   \global\everypar = {%
1007     \kern -\parindent
1008     \restorefirstparagraphindent
1009   }%
1010 }
1011
1012 \gdef\restorefirstparagraphindent{%
1013   \global \let \indent = \ptexindent
1014   \global \let \noindent = \ptexnoindent
1015   \global \everypar = {}%
1016 }
1017
1018
1019 % @asis just yields its argument.  Used with @table, for example.
1020 %
1021 \def\asis#1{#1}
1022
1023 % @math outputs its argument in math mode.
1024 %
1025 % One complication: _ usually means subscripts, but it could also mean
1026 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
1027 % _ active, and distinguish by seeing if the current family is \slfam,
1028 % which is what @var uses.
1029 {
1030   \catcode\underChar = \active
1031   \gdef\mathunderscore{%
1032     \catcode\underChar=\active
1033     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1034   }
1035 }
1036 % Another complication: we want \\ (and @\) to output a \ character.
1037 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1038 % this is not advertised and we don't care.  Texinfo does not
1039 % otherwise define @\.
1040 %
1041 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1042 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1043 %
1044 \def\math{%
1045   \tex
1046   \mathunderscore
1047   \let\\ = \mathbackslash
1048   \mathactive
1049   $\finishmath
1050 }
1051 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1052
1053 % Some active characters (such as <) are spaced differently in math.
1054 % We have to reset their definitions in case the @math was an argument
1055 % to a command which sets the catcodes (such as @item or @section).
1056 %
1057 {
1058   \catcode`^ = \active
1059   \catcode`< = \active
1060   \catcode`> = \active
1061   \catcode`+ = \active
1062   \gdef\mathactive{%
1063     \let^ = \ptexhat
1064     \let< = \ptexless
1065     \let> = \ptexgtr
1066     \let+ = \ptexplus
1067   }
1068 }
1069
1070 % @bullet and @minus need the same treatment as @math, just above.
1071 \def\bullet{$\ptexbullet$}
1072 \def\minus{$-$}
1073
1074 % @dots{} outputs an ellipsis using the current font.
1075 % We do .5em per period so that it has the same spacing in a typewriter
1076 % font as three actual period characters.
1077 %
1078 \def\dots{%
1079   \leavevmode
1080   \hbox to 1.5em{%
1081     \hskip 0pt plus 0.25fil
1082     .\hfil.\hfil.%
1083     \hskip 0pt plus 0.5fil
1084   }%
1085 }
1086
1087 % @enddots{} is an end-of-sentence ellipsis.
1088 %
1089 \def\enddots{%
1090   \dots
1091   \spacefactor=3000
1092 }
1093
1094 % @comma{} is so commas can be inserted into text without messing up
1095 % Texinfo's parsing.
1096
1097 \let\comma = ,
1098
1099 % @refill is a no-op.
1100 \let\refill=\relax
1101
1102 % If working on a large document in chapters, it is convenient to
1103 % be able to disable indexing, cross-referencing, and contents, for test runs.
1104 % This is done with @novalidate (before @setfilename).
1105 %
1106 \newif\iflinks \linkstrue % by default we want the aux files.
1107 \let\novalidate = \linksfalse
1108
1109 % @setfilename is done at the beginning of every texinfo file.
1110 % So open here the files we need to have open while reading the input.
1111 % This makes it possible to make a .fmt file for texinfo.
1112 \def\setfilename{%
1113    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1114    \iflinks
1115      \tryauxfile
1116      % Open the new aux file.  TeX will close it automatically at exit.
1117      \immediate\openout\auxfile=\jobname.aux
1118    \fi % \openindices needs to do some work in any case.
1119    \openindices
1120    \let\setfilename=\comment % Ignore extra @setfilename cmds.
1121    %
1122    % If texinfo.cnf is present on the system, read it.
1123    % Useful for site-wide @afourpaper, etc.
1124    \openin 1 texinfo.cnf
1125    \ifeof 1 \else \input texinfo.cnf \fi
1126    \closein 1
1127    %
1128    \comment % Ignore the actual filename.
1129 }
1130
1131 % Called from \setfilename.
1132 %
1133 \def\openindices{%
1134   \newindex{cp}%
1135   \newcodeindex{fn}%
1136   \newcodeindex{vr}%
1137   \newcodeindex{tp}%
1138   \newcodeindex{ky}%
1139   \newcodeindex{pg}%
1140 }
1141
1142 % @bye.
1143 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1144
1145
1146 \message{pdf,}
1147 % adobe `portable' document format
1148 \newcount\tempnum
1149 \newcount\lnkcount
1150 \newtoks\filename
1151 \newcount\filenamelength
1152 \newcount\pgn
1153 \newtoks\toksA
1154 \newtoks\toksB
1155 \newtoks\toksC
1156 \newtoks\toksD
1157 \newbox\boxA
1158 \newcount\countA
1159 \newif\ifpdf
1160 \newif\ifpdfmakepagedest
1161
1162 \ifx\pdfoutput\undefined
1163   \pdffalse
1164   \let\pdfmkdest = \gobble
1165   \let\pdfurl = \gobble
1166   \let\endlink = \relax
1167   \let\linkcolor = \relax
1168   \let\pdfmakeoutlines = \relax
1169 \else
1170   \pdftrue
1171   \pdfoutput = 1
1172   \input pdfcolor
1173   \pdfcatalog{/PageMode /UseOutlines}%
1174   \def\dopdfimage#1#2#3{%
1175     \def\imagewidth{#2}%
1176     \def\imageheight{#3}%
1177     % without \immediate, pdftex seg faults when the same image is
1178     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1179     \ifnum\pdftexversion < 14
1180       \immediate\pdfimage
1181     \else
1182       \immediate\pdfximage
1183     \fi
1184       \ifx\empty\imagewidth\else width \imagewidth \fi
1185       \ifx\empty\imageheight\else height \imageheight \fi
1186       \ifnum\pdftexversion<13
1187          #1.pdf%
1188        \else
1189          {#1.pdf}%
1190        \fi
1191     \ifnum\pdftexversion < 14 \else
1192       \pdfrefximage \pdflastximage
1193     \fi}
1194   \def\pdfmkdest#1{{%
1195     % We have to set dummies so commands such as @code in a section title
1196     % aren't expanded.
1197     \atdummies
1198     \normalturnoffactive
1199     \pdfdest name{#1} xyz%
1200   }}
1201   \def\pdfmkpgn#1{#1}
1202   \let\linkcolor = \Blue  % was Cyan, but that seems light?
1203   \def\endlink{\Black\pdfendlink}
1204   % Adding outlines to PDF; macros for calculating structure of outlines
1205   % come from Petr Olsak
1206   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1207     \else \csname#1\endcsname \fi}
1208   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1209     \advance\tempnum by 1
1210     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1211   %
1212   % #1 is the section text.  #2 is the pdf expression for the number
1213   % of subentries (or empty, for subsubsections).  #3 is the node
1214   % text, which might be empty if this toc entry had no
1215   % corresponding node.  #4 is the page number.
1216   % 
1217   \def\dopdfoutline#1#2#3#4{%
1218     % Generate a link to the node text if that exists; else, use the
1219     % page number.  We could generate a destination for the section
1220     % text in the case where a section has no node, but it doesn't
1221     % seem worthwhile, since most documents are normally structured.
1222     \def\pdfoutlinedest{#3}%
1223     \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1224     %
1225     \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1226   }
1227   %
1228   \def\pdfmakeoutlines{%
1229     \begingroup
1230       % Thanh's hack / proper braces in bookmarks
1231       \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1232       \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1233       %
1234       % Read toc silently, to get counts of subentries for \pdfoutline.
1235       \def\numchapentry##1##2##3##4{%
1236         \def\thischapnum{##2}%
1237         \let\thissecnum\empty
1238         \let\thissubsecnum\empty
1239       }%
1240       \def\numsecentry##1##2##3##4{%
1241         \advancenumber{chap\thischapnum}%
1242         \def\thissecnum{##2}%
1243         \let\thissubsecnum\empty
1244       }%
1245       \def\numsubsecentry##1##2##3##4{%
1246         \advancenumber{sec\thissecnum}%
1247         \def\thissubsecnum{##2}%
1248       }%
1249       \def\numsubsubsecentry##1##2##3##4{%
1250         \advancenumber{subsec\thissubsecnum}%
1251       }%
1252       \let\thischapnum\empty
1253       \let\thissecnum\empty
1254       \let\thissubsecnum\empty
1255       %
1256       % use \def rather than \let here because we redefine \chapentry et
1257       % al. a second time, below.
1258       \def\appentry{\numchapentry}%
1259       \def\appsecentry{\numsecentry}%
1260       \def\appsubsecentry{\numsubsecentry}%
1261       \def\appsubsubsecentry{\numsubsubsecentry}%
1262       \def\unnchapentry{\numchapentry}%
1263       \def\unnsecentry{\numsecentry}%
1264       \def\unnsubsecentry{\numsubsecentry}%
1265       \def\unnsubsubsecentry{\numsubsubsecentry}%
1266       \input \jobname.toc
1267       %
1268       % Read toc second time, this time actually producing the outlines.
1269       % The `-' means take the \expnumber as the absolute number of
1270       % subentries, which we calculated on our first read of the .toc above.
1271       % 
1272       % We use the node names as the destinations.
1273       \def\numchapentry##1##2##3##4{%
1274         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1275       \def\numsecentry##1##2##3##4{%
1276         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1277       \def\numsubsecentry##1##2##3##4{%
1278         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1279       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1280         \dopdfoutline{##1}{}{##3}{##4}}%
1281       %
1282       % PDF outlines are displayed using system fonts, instead of
1283       % document fonts.  Therefore we cannot use special characters,
1284       % since the encoding is unknown.  For example, the eogonek from
1285       % Latin 2 (0xea) gets translated to a | character.  Info from
1286       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1287       % 
1288       % xx to do this right, we have to translate 8-bit characters to
1289       % their "best" equivalent, based on the @documentencoding.  Right
1290       % now, I guess we'll just let the pdf reader have its way.
1291       \indexnofonts
1292       \turnoffactive
1293       \input \jobname.toc
1294     \endgroup
1295   }
1296   %
1297   \def\makelinks #1,{%
1298     \def\params{#1}\def\E{END}%
1299     \ifx\params\E
1300       \let\nextmakelinks=\relax
1301     \else
1302       \let\nextmakelinks=\makelinks
1303       \ifnum\lnkcount>0,\fi
1304       \picknum{#1}%
1305       \startlink attr{/Border [0 0 0]}
1306         goto name{\pdfmkpgn{\the\pgn}}%
1307       \linkcolor #1%
1308       \advance\lnkcount by 1%
1309       \endlink
1310     \fi
1311     \nextmakelinks
1312   }
1313   \def\picknum#1{\expandafter\pn#1}
1314   \def\pn#1{%
1315     \def\p{#1}%
1316     \ifx\p\lbrace
1317       \let\nextpn=\ppn
1318     \else
1319       \let\nextpn=\ppnn
1320       \def\first{#1}
1321     \fi
1322     \nextpn
1323   }
1324   \def\ppn#1{\pgn=#1\gobble}
1325   \def\ppnn{\pgn=\first}
1326   \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1327   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1328     \ifx\PP\D\let\nextsp\relax
1329     \else\let\nextsp\skipspaces
1330       \ifx\p\space\else\addtokens{\filename}{\PP}%
1331         \advance\filenamelength by 1
1332       \fi
1333     \fi
1334     \nextsp}
1335   \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1336   \ifnum\pdftexversion < 14
1337     \let \startlink \pdfannotlink
1338   \else
1339     \let \startlink \pdfstartlink
1340   \fi
1341   \def\pdfurl#1{%
1342     \begingroup
1343       \normalturnoffactive\def\@{@}%
1344       \makevalueexpandable
1345       \leavevmode\Red
1346       \startlink attr{/Border [0 0 0]}%
1347         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1348     \endgroup}
1349   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1350   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1351   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1352   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1353   \def\maketoks{%
1354     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1355     \ifx\first0\adn0
1356     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1357     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1358     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1359     \else
1360       \ifnum0=\countA\else\makelink\fi
1361       \ifx\first.\let\next=\done\else
1362         \let\next=\maketoks
1363         \addtokens{\toksB}{\the\toksD}
1364         \ifx\first,\addtokens{\toksB}{\space}\fi
1365       \fi
1366     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1367     \next}
1368   \def\makelink{\addtokens{\toksB}%
1369     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1370   \def\pdflink#1{%
1371     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1372     \linkcolor #1\endlink}
1373   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1374 \fi % \ifx\pdfoutput
1375
1376
1377 \message{fonts,}
1378
1379 % Change the current font style to #1, remembering it in \curfontstyle.
1380 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1381 % italics, not bold italics.
1382
1383 \def\setfontstyle#1{%
1384   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1385   \csname ten#1\endcsname  % change the current font
1386 }
1387
1388 % Select #1 fonts with the current style.
1389
1390 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1391
1392 \def\rm{\fam=0 \setfontstyle{rm}}
1393 \def\it{\fam=\itfam \setfontstyle{it}}
1394 \def\sl{\fam=\slfam \setfontstyle{sl}}
1395 \def\bf{\fam=\bffam \setfontstyle{bf}}
1396 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1397
1398 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1399 % So we set up a \sf.
1400 \newfam\sffam
1401 \def\sf{\fam=\sffam \setfontstyle{sf}}
1402 \let\li = \sf % Sometimes we call it \li, not \sf.
1403
1404 % We don't need math for this font style.
1405 \def\ttsl{\setfontstyle{ttsl}}
1406
1407 % Default leading.
1408 \newdimen\textleading  \textleading = 13.2pt
1409
1410 % Set the baselineskip to #1, and the lineskip and strut size
1411 % correspondingly.  There is no deep meaning behind these magic numbers
1412 % used as factors; they just match (closely enough) what Knuth defined.
1413 %
1414 \def\lineskipfactor{.08333}
1415 \def\strutheightpercent{.70833}
1416 \def\strutdepthpercent {.29167}
1417 %
1418 \def\setleading#1{%
1419   \normalbaselineskip = #1\relax
1420   \normallineskip = \lineskipfactor\normalbaselineskip
1421   \normalbaselines
1422   \setbox\strutbox =\hbox{%
1423     \vrule width0pt height\strutheightpercent\baselineskip
1424                     depth \strutdepthpercent \baselineskip
1425   }%
1426 }
1427
1428 % Set the font macro #1 to the font named #2, adding on the
1429 % specified font prefix (normally `cm').
1430 % #3 is the font's design size, #4 is a scale factor
1431 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1432
1433 % Use cm as the default font prefix.
1434 % To specify the font prefix, you must define \fontprefix
1435 % before you read in texinfo.tex.
1436 \ifx\fontprefix\undefined
1437 \def\fontprefix{cm}
1438 \fi
1439 % Support font families that don't use the same naming scheme as CM.
1440 \def\rmshape{r}
1441 \def\rmbshape{bx}               %where the normal face is bold
1442 \def\bfshape{b}
1443 \def\bxshape{bx}
1444 \def\ttshape{tt}
1445 \def\ttbshape{tt}
1446 \def\ttslshape{sltt}
1447 \def\itshape{ti}
1448 \def\itbshape{bxti}
1449 \def\slshape{sl}
1450 \def\slbshape{bxsl}
1451 \def\sfshape{ss}
1452 \def\sfbshape{ss}
1453 \def\scshape{csc}
1454 \def\scbshape{csc}
1455
1456 % Text fonts (11.2pt, magstep1).
1457 \newcount\mainmagstep
1458 \ifx\bigger\relax
1459   % not really supported.
1460   \mainmagstep=\magstep1
1461   \setfont\textrm\rmshape{12}{1000}
1462   \setfont\texttt\ttshape{12}{1000}
1463 \else
1464   \mainmagstep=\magstephalf
1465   \setfont\textrm\rmshape{10}{\mainmagstep}
1466   \setfont\texttt\ttshape{10}{\mainmagstep}
1467 \fi
1468 \setfont\textbf\bfshape{10}{\mainmagstep}
1469 \setfont\textit\itshape{10}{\mainmagstep}
1470 \setfont\textsl\slshape{10}{\mainmagstep}
1471 \setfont\textsf\sfshape{10}{\mainmagstep}
1472 \setfont\textsc\scshape{10}{\mainmagstep}
1473 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1474 \font\texti=cmmi10 scaled \mainmagstep
1475 \font\textsy=cmsy10 scaled \mainmagstep
1476
1477 % A few fonts for @defun names and args.
1478 \setfont\defbf\bfshape{10}{\magstep1}
1479 \setfont\deftt\ttshape{10}{\magstep1}
1480 \setfont\defttsl\ttslshape{10}{\magstep1}
1481 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1482
1483 % Fonts for indices, footnotes, small examples (9pt).
1484 \setfont\smallrm\rmshape{9}{1000}
1485 \setfont\smalltt\ttshape{9}{1000}
1486 \setfont\smallbf\bfshape{10}{900}
1487 \setfont\smallit\itshape{9}{1000}
1488 \setfont\smallsl\slshape{9}{1000}
1489 \setfont\smallsf\sfshape{9}{1000}
1490 \setfont\smallsc\scshape{10}{900}
1491 \setfont\smallttsl\ttslshape{10}{900}
1492 \font\smalli=cmmi9
1493 \font\smallsy=cmsy9
1494
1495 % Fonts for small examples (8pt).
1496 \setfont\smallerrm\rmshape{8}{1000}
1497 \setfont\smallertt\ttshape{8}{1000}
1498 \setfont\smallerbf\bfshape{10}{800}
1499 \setfont\smallerit\itshape{8}{1000}
1500 \setfont\smallersl\slshape{8}{1000}
1501 \setfont\smallersf\sfshape{8}{1000}
1502 \setfont\smallersc\scshape{10}{800}
1503 \setfont\smallerttsl\ttslshape{10}{800}
1504 \font\smalleri=cmmi8
1505 \font\smallersy=cmsy8
1506
1507 % Fonts for title page (20.4pt):
1508 \setfont\titlerm\rmbshape{12}{\magstep3}
1509 \setfont\titleit\itbshape{10}{\magstep4}
1510 \setfont\titlesl\slbshape{10}{\magstep4}
1511 \setfont\titlett\ttbshape{12}{\magstep3}
1512 \setfont\titlettsl\ttslshape{10}{\magstep4}
1513 \setfont\titlesf\sfbshape{17}{\magstep1}
1514 \let\titlebf=\titlerm
1515 \setfont\titlesc\scbshape{10}{\magstep4}
1516 \font\titlei=cmmi12 scaled \magstep3
1517 \font\titlesy=cmsy10 scaled \magstep4
1518 \def\authorrm{\secrm}
1519 \def\authortt{\sectt}
1520
1521 % Chapter (and unnumbered) fonts (17.28pt).
1522 \setfont\chaprm\rmbshape{12}{\magstep2}
1523 \setfont\chapit\itbshape{10}{\magstep3}
1524 \setfont\chapsl\slbshape{10}{\magstep3}
1525 \setfont\chaptt\ttbshape{12}{\magstep2}
1526 \setfont\chapttsl\ttslshape{10}{\magstep3}
1527 \setfont\chapsf\sfbshape{17}{1000}
1528 \let\chapbf=\chaprm
1529 \setfont\chapsc\scbshape{10}{\magstep3}
1530 \font\chapi=cmmi12 scaled \magstep2
1531 \font\chapsy=cmsy10 scaled \magstep3
1532
1533 % Section fonts (14.4pt).
1534 \setfont\secrm\rmbshape{12}{\magstep1}
1535 \setfont\secit\itbshape{10}{\magstep2}
1536 \setfont\secsl\slbshape{10}{\magstep2}
1537 \setfont\sectt\ttbshape{12}{\magstep1}
1538 \setfont\secttsl\ttslshape{10}{\magstep2}
1539 \setfont\secsf\sfbshape{12}{\magstep1}
1540 \let\secbf\secrm
1541 \setfont\secsc\scbshape{10}{\magstep2}
1542 \font\seci=cmmi12 scaled \magstep1
1543 \font\secsy=cmsy10 scaled \magstep2
1544
1545 % Subsection fonts (13.15pt).
1546 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1547 \setfont\ssecit\itbshape{10}{1315}
1548 \setfont\ssecsl\slbshape{10}{1315}
1549 \setfont\ssectt\ttbshape{12}{\magstephalf}
1550 \setfont\ssecttsl\ttslshape{10}{1315}
1551 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1552 \let\ssecbf\ssecrm
1553 \setfont\ssecsc\scbshape{10}{1315}
1554 \font\sseci=cmmi12 scaled \magstephalf
1555 \font\ssecsy=cmsy10 scaled 1315
1556
1557 % Reduced fonts for @acro in text (10pt).
1558 \setfont\reducedrm\rmshape{10}{1000}
1559 \setfont\reducedtt\ttshape{10}{1000}
1560 \setfont\reducedbf\bfshape{10}{1000}
1561 \setfont\reducedit\itshape{10}{1000}
1562 \setfont\reducedsl\slshape{10}{1000}
1563 \setfont\reducedsf\sfshape{10}{1000}
1564 \setfont\reducedsc\scshape{10}{1000}
1565 \setfont\reducedttsl\ttslshape{10}{1000}
1566 \font\reducedi=cmmi10
1567 \font\reducedsy=cmsy10
1568
1569 % In order for the font changes to affect most math symbols and letters,
1570 % we have to define the \textfont of the standard families.  Since
1571 % texinfo doesn't allow for producing subscripts and superscripts except
1572 % in the main text, we don't bother to reset \scriptfont and
1573 % \scriptscriptfont (which would also require loading a lot more fonts).
1574 %
1575 \def\resetmathfonts{%
1576   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1577   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1578   \textfont\ttfam=\tentt \textfont\sffam=\tensf
1579 }
1580
1581 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1582 % of just \STYLE.  We do this because \STYLE needs to also set the
1583 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
1584 % \tenSTYLE to set the current font.
1585
1586 % Each font-changing command also sets the names \lsize (one size lower)
1587 % and \lllsize (three sizes lower).  These relative commands are used in
1588 % the LaTeX logo and acronyms.
1589
1590 % This all needs generalizing, badly.
1591
1592 \def\textfonts{%
1593   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1594   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1595   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1596   \let\tenttsl=\textttsl
1597   \def\lsize{reduced}\def\lllsize{smaller}%
1598   \resetmathfonts \setleading{\textleading}}
1599 \def\titlefonts{%
1600   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1601   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1602   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1603   \let\tenttsl=\titlettsl
1604   \def\lsize{chap}\def\lllsize{subsec}%
1605   \resetmathfonts \setleading{25pt}}
1606 \def\titlefont#1{{\titlefonts\rm #1}}
1607 \def\chapfonts{%
1608   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1609   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1610   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1611   \def\lsize{sec}\def\lllsize{text}%
1612   \resetmathfonts \setleading{19pt}}
1613 \def\secfonts{%
1614   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1615   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1616   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1617   \let\tenttsl=\secttsl
1618   \def\lsize{subsec}\def\lllsize{reduced}%
1619   \resetmathfonts \setleading{16pt}}
1620 \def\subsecfonts{%
1621   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1622   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1623   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1624   \let\tenttsl=\ssecttsl
1625   \def\lsize{text}\def\lllsize{small}%
1626   \resetmathfonts \setleading{15pt}}
1627 \let\subsubsecfonts = \subsecfonts
1628 \def\reducedfonts{%
1629   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1630   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1631   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1632   \let\tenttsl=\reducedttsl
1633   \def\lsize{small}\def\lllsize{smaller}%
1634   \resetmathfonts \setleading{10.5pt}}
1635 \def\smallfonts{%
1636   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1637   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1638   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1639   \let\tenttsl=\smallttsl
1640   \def\lsize{smaller}\def\lllsize{smaller}%
1641   \resetmathfonts \setleading{10.5pt}}
1642 \def\smallerfonts{%
1643   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1644   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1645   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1646   \let\tenttsl=\smallerttsl
1647   \def\lsize{smaller}\def\lllsize{smaller}%
1648   \resetmathfonts \setleading{9.5pt}}
1649
1650 % Set the fonts to use with the @small... environments.
1651 \let\smallexamplefonts = \smallfonts
1652
1653 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
1654 % can fit this many characters:
1655 %   8.5x11=86   smallbook=72  a4=90  a5=69
1656 % If we use \scriptfonts (8pt), then we can fit this many characters:
1657 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
1658 % For me, subjectively, the few extra characters that fit aren't worth
1659 % the additional smallness of 8pt.  So I'm making the default 9pt.
1660 %
1661 % By the way, for comparison, here's what fits with @example (10pt):
1662 %   8.5x11=71  smallbook=60  a4=75  a5=58
1663 %
1664 % I wish the USA used A4 paper.
1665 % --karl, 24jan03.
1666
1667
1668 % Set up the default fonts, so we can use them for creating boxes.
1669 %
1670 \textfonts \rm
1671
1672 % Define these so they can be easily changed for other fonts.
1673 \def\angleleft{$\langle$}
1674 \def\angleright{$\rangle$}
1675
1676 % Count depth in font-changes, for error checks
1677 \newcount\fontdepth \fontdepth=0
1678
1679 % Fonts for short table of contents.
1680 \setfont\shortcontrm\rmshape{12}{1000}
1681 \setfont\shortcontbf\bfshape{10}{\magstep1}  % no cmb12
1682 \setfont\shortcontsl\slshape{12}{1000}
1683 \setfont\shortconttt\ttshape{12}{1000}
1684
1685 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1686 %% serif) and @ii for TeX italic
1687
1688 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1689 % unless the following character is such as not to need one.
1690 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1691                     \ptexslash\fi\fi\fi}
1692 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1693 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1694
1695 % like \smartslanted except unconditionally uses \ttsl.
1696 % @var is set to this for defun arguments.
1697 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1698
1699 % like \smartslanted except unconditionally use \sl.  We never want
1700 % ttsl for book titles, do we?
1701 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1702
1703 \let\i=\smartitalic
1704 \let\var=\smartslanted
1705 \let\dfn=\smartslanted
1706 \let\emph=\smartitalic
1707
1708 \def\b#1{{\bf #1}}
1709 \let\strong=\b
1710
1711 % We can't just use \exhyphenpenalty, because that only has effect at
1712 % the end of a paragraph.  Restore normal hyphenation at the end of the
1713 % group within which \nohyphenation is presumably called.
1714 %
1715 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
1716 \def\restorehyphenation{\hyphenchar\font = `- }
1717
1718 % Set sfcode to normal for the chars that usually have another value.
1719 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1720 % sometimes \x has an active definition that messes things up.
1721 %
1722 \catcode`@=11
1723   \def\frenchspacing{%
1724     \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1725     \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1726   }
1727 \catcode`@=\other
1728
1729 \def\t#1{%
1730   {\tt \rawbackslash \frenchspacing #1}%
1731   \null
1732 }
1733 \def\samp#1{`\tclose{#1}'\null}
1734 \setfont\keyrm\rmshape{8}{1000}
1735 \font\keysy=cmsy9
1736 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1737   \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1738     \vbox{\hrule\kern-0.4pt
1739      \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1740     \kern-0.4pt\hrule}%
1741   \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1742 % The old definition, with no lozenge:
1743 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1744 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1745
1746 % @file, @option are the same as @samp.
1747 \let\file=\samp
1748 \let\option=\samp
1749
1750 % @code is a modification of @t,
1751 % which makes spaces the same size as normal in the surrounding text.
1752 \def\tclose#1{%
1753   {%
1754     % Change normal interword space to be same as for the current font.
1755     \spaceskip = \fontdimen2\font
1756     %
1757     % Switch to typewriter.
1758     \tt
1759     %
1760     % But `\ ' produces the large typewriter interword space.
1761     \def\ {{\spaceskip = 0pt{} }}%
1762     %
1763     % Turn off hyphenation.
1764     \nohyphenation
1765     %
1766     \rawbackslash
1767     \frenchspacing
1768     #1%
1769   }%
1770   \null
1771 }
1772
1773 % We *must* turn on hyphenation at `-' and `_' in @code.
1774 % Otherwise, it is too hard to avoid overfull hboxes
1775 % in the Emacs manual, the Library manual, etc.
1776
1777 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1778 % both hyphenation at - and hyphenation within words.
1779 % We must therefore turn them both off (\tclose does that)
1780 % and arrange explicitly to hyphenate at a dash.
1781 %  -- rms.
1782 {
1783   \catcode`\-=\active
1784   \catcode`\_=\active
1785   %
1786   \global\def\code{\begingroup
1787     \catcode`\-=\active \let-\codedash
1788     \catcode`\_=\active \let_\codeunder
1789     \codex
1790   }
1791 }
1792
1793 \def\realdash{-}
1794 \def\codedash{-\discretionary{}{}{}}
1795 \def\codeunder{%
1796   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
1797   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1798   % will therefore expand the active definition of _, which is us
1799   % (inside @code that is), therefore an endless loop.
1800   \ifusingtt{\ifmmode
1801                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1802              \else\normalunderscore \fi
1803              \discretionary{}{}{}}%
1804             {\_}%
1805 }
1806 \def\codex #1{\tclose{#1}\endgroup}
1807
1808 % @kbd is like @code, except that if the argument is just one @key command,
1809 % then @kbd has no effect.
1810
1811 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1812 %   `example' (@kbd uses ttsl only inside of @example and friends),
1813 %   or `code' (@kbd uses normal tty font always).
1814 \parseargdef\kbdinputstyle{%
1815   \def\arg{#1}%
1816   \ifx\arg\worddistinct
1817     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1818   \else\ifx\arg\wordexample
1819     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1820   \else\ifx\arg\wordcode
1821     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1822   \else
1823     \errhelp = \EMsimple
1824     \errmessage{Unknown @kbdinputstyle option `\arg'}%
1825   \fi\fi\fi
1826 }
1827 \def\worddistinct{distinct}
1828 \def\wordexample{example}
1829 \def\wordcode{code}
1830
1831 % Default is `distinct.'
1832 \kbdinputstyle distinct
1833
1834 \def\xkey{\key}
1835 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1836 \ifx\one\xkey\ifx\threex\three \key{#2}%
1837 \else{\tclose{\kbdfont\look}}\fi
1838 \else{\tclose{\kbdfont\look}}\fi}
1839
1840 % For @url, @env, @command quotes seem unnecessary, so use \code.
1841 \let\url=\code
1842 \let\env=\code
1843 \let\command=\code
1844
1845 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1846 % second argument specifying the text to display and an optional third
1847 % arg as text to display instead of (rather than in addition to) the url
1848 % itself.  First (mandatory) arg is the url.  Perhaps eventually put in
1849 % a hypertex \special here.
1850 %
1851 \def\uref#1{\douref #1,,,\finish}
1852 \def\douref#1,#2,#3,#4\finish{\begingroup
1853   \unsepspaces
1854   \pdfurl{#1}%
1855   \setbox0 = \hbox{\ignorespaces #3}%
1856   \ifdim\wd0 > 0pt
1857     \unhbox0 % third arg given, show only that
1858   \else
1859     \setbox0 = \hbox{\ignorespaces #2}%
1860     \ifdim\wd0 > 0pt
1861       \ifpdf
1862         \unhbox0             % PDF: 2nd arg given, show only it
1863       \else
1864         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1865       \fi
1866     \else
1867       \code{#1}% only url given, so show it
1868     \fi
1869   \fi
1870   \endlink
1871 \endgroup}
1872
1873 % rms does not like angle brackets --karl, 17may97.
1874 % So now @email is just like @uref, unless we are pdf.
1875 %
1876 %\def\email#1{\angleleft{\tt #1}\angleright}
1877 \ifpdf
1878   \def\email#1{\doemail#1,,\finish}
1879   \def\doemail#1,#2,#3\finish{\begingroup
1880     \unsepspaces
1881     \pdfurl{mailto:#1}%
1882     \setbox0 = \hbox{\ignorespaces #2}%
1883     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1884     \endlink
1885   \endgroup}
1886 \else
1887   \let\email=\uref
1888 \fi
1889
1890 % Check if we are currently using a typewriter font.  Since all the
1891 % Computer Modern typewriter fonts have zero interword stretch (and
1892 % shrink), and it is reasonable to expect all typewriter fonts to have
1893 % this property, we can check that font parameter.
1894 %
1895 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1896
1897 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
1898 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1899 %
1900 \def\dmn#1{\thinspace #1}
1901
1902 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1903
1904 % @l was never documented to mean ``switch to the Lisp font'',
1905 % and it is not used as such in any manual I can find.  We need it for
1906 % Polish suppressed-l.  --karl, 22sep96.
1907 %\def\l#1{{\li #1}\null}
1908
1909 % Explicit font changes: @r, @sc, undocumented @ii.
1910 \def\r#1{{\rm #1}}              % roman font
1911 \def\sc#1{{\smallcaps#1}}       % smallcaps font
1912 \def\ii#1{{\it #1}}             % italic font
1913
1914 \def\acronym#1{\doacronym #1,,\finish}
1915 \def\doacronym#1,#2,#3\finish{%
1916   {\selectfonts\lsize #1}%
1917   \def\temp{#2}%
1918   \ifx\temp\empty \else
1919     \space ({\unsepspaces \ignorespaces \temp \unskip})%
1920   \fi
1921 }
1922
1923 % @pounds{} is a sterling sign, which is in the CM italic font.
1924
1925 \def\pounds{{\it\$}}
1926
1927 % @registeredsymbol - R in a circle.  The font for the R should really
1928 % be smaller yet, but lllsize is the best we can do for now.
1929 % Adapted from the plain.tex definition of \copyright.
1930 %
1931 \def\registeredsymbol{%
1932   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
1933                \hfil\crcr\Orb}}%
1934     }$%
1935 }
1936
1937
1938 \message{page headings,}
1939
1940 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1941 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1942
1943 % First the title page.  Must do @settitle before @titlepage.
1944 \newif\ifseenauthor
1945 \newif\iffinishedtitlepage
1946
1947 % Do an implicit @contents or @shortcontents after @end titlepage if the
1948 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1949 %
1950 \newif\ifsetcontentsaftertitlepage
1951  \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1952 \newif\ifsetshortcontentsaftertitlepage
1953  \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1954
1955 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1956         \endgroup\page\hbox{}\page}
1957
1958 \envdef\titlepage{%
1959   % Open one extra group, as we want to close it in the middle of \Etitlepage.
1960   \begingroup
1961     \parindent=0pt \textfonts
1962     % Leave some space at the very top of the page.
1963     \vglue\titlepagetopglue
1964     % No rule at page bottom unless we print one at the top with @title.
1965     \finishedtitlepagetrue
1966     %
1967     % Most title ``pages'' are actually two pages long, with space
1968     % at the top of the second.  We don't want the ragged left on the second.
1969     \let\oldpage = \page
1970     \def\page{%
1971       \iffinishedtitlepage\else
1972          \finishtitlepage
1973       \fi
1974       \let\page = \oldpage
1975       \page
1976       \null
1977     }%
1978 }
1979
1980 \def\Etitlepage{%
1981     \iffinishedtitlepage\else
1982         \finishtitlepage
1983     \fi
1984     % It is important to do the page break before ending the group,
1985     % because the headline and footline are only empty inside the group.
1986     % If we use the new definition of \page, we always get a blank page
1987     % after the title page, which we certainly don't want.
1988     \oldpage
1989   \endgroup
1990   %
1991   % Need this before the \...aftertitlepage checks so that if they are
1992   % in effect the toc pages will come out with page numbers.
1993   \HEADINGSon
1994   %
1995   % If they want short, they certainly want long too.
1996   \ifsetshortcontentsaftertitlepage
1997     \shortcontents
1998     \contents
1999     \global\let\shortcontents = \relax
2000     \global\let\contents = \relax
2001   \fi
2002   %
2003   \ifsetcontentsaftertitlepage
2004     \contents
2005     \global\let\contents = \relax
2006     \global\let\shortcontents = \relax
2007   \fi
2008 }
2009
2010 \def\finishtitlepage{%
2011   \vskip4pt \hrule height 2pt width \hsize
2012   \vskip\titlepagebottomglue
2013   \finishedtitlepagetrue
2014 }
2015
2016 %%% Macros to be used within @titlepage:
2017
2018 \let\subtitlerm=\tenrm
2019 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2020
2021 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2022                 \let\tt=\authortt}
2023
2024 \parseargdef\title{%
2025   \checkenv\titlepage
2026   \leftline{\titlefonts\rm #1}
2027   % print a rule at the page bottom also.
2028   \finishedtitlepagefalse
2029   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2030 }
2031
2032 \parseargdef\subtitle{%
2033   \checkenv\titlepage
2034   {\subtitlefont \rightline{#1}}%
2035 }
2036
2037 % @author should come last, but may come many times.
2038 \parseargdef\author{%
2039   \def\temp{\quotation}%
2040   \ifx\thisenv\temp
2041     This edition of the manual is dedicated to Karl Berry who should
2042     really make affiliations work.
2043   \else
2044     \checkenv\titlepage
2045     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2046     {\authorfont \leftline{#1}}%
2047   \fi
2048 }
2049
2050
2051 %%% Set up page headings and footings.
2052
2053 \let\thispage=\folio
2054
2055 \newtoks\evenheadline    % headline on even pages
2056 \newtoks\oddheadline     % headline on odd pages
2057 \newtoks\evenfootline    % footline on even pages
2058 \newtoks\oddfootline     % footline on odd pages
2059
2060 % Now make TeX use those variables
2061 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2062                             \else \the\evenheadline \fi}}
2063 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2064                             \else \the\evenfootline \fi}\HEADINGShook}
2065 \let\HEADINGShook=\relax
2066
2067 % Commands to set those variables.
2068 % For example, this is what  @headings on  does
2069 % @evenheading @thistitle|@thispage|@thischapter
2070 % @oddheading @thischapter|@thispage|@thistitle
2071 % @evenfooting @thisfile||
2072 % @oddfooting ||@thisfile
2073
2074
2075 \def\evenheading{\parsearg\evenheadingxxx}
2076 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2077 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2078 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2079
2080 \def\oddheading{\parsearg\oddheadingxxx}
2081 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2082 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2083 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2084
2085 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2086
2087 \def\evenfooting{\parsearg\evenfootingxxx}
2088 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2089 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2090 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2091
2092 \def\oddfooting{\parsearg\oddfootingxxx}
2093 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2094 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2095   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2096   %
2097   % Leave some space for the footline.  Hopefully ok to assume
2098   % @evenfooting will not be used by itself.
2099   \global\advance\pageheight by -\baselineskip
2100   \global\advance\vsize by -\baselineskip
2101 }
2102
2103 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2104
2105
2106 % @headings double      turns headings on for double-sided printing.
2107 % @headings single      turns headings on for single-sided printing.
2108 % @headings off         turns them off.
2109 % @headings on          same as @headings double, retained for compatibility.
2110 % @headings after       turns on double-sided headings after this page.
2111 % @headings doubleafter turns on double-sided headings after this page.
2112 % @headings singleafter turns on single-sided headings after this page.
2113 % By default, they are off at the start of a document,
2114 % and turned `on' after @end titlepage.
2115
2116 \def\headings #1 {\csname HEADINGS#1\endcsname}
2117
2118 \def\HEADINGSoff{%
2119 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2120 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2121 \HEADINGSoff
2122 % When we turn headings on, set the page number to 1.
2123 % For double-sided printing, put current file name in lower left corner,
2124 % chapter name on inside top of right hand pages, document
2125 % title on inside top of left hand pages, and page numbers on outside top
2126 % edge of all pages.
2127 \def\HEADINGSdouble{%
2128 \global\pageno=1
2129 \global\evenfootline={\hfil}
2130 \global\oddfootline={\hfil}
2131 \global\evenheadline={\line{\folio\hfil\thistitle}}
2132 \global\oddheadline={\line{\thischapter\hfil\folio}}
2133 \global\let\contentsalignmacro = \chapoddpage
2134 }
2135 \let\contentsalignmacro = \chappager
2136
2137 % For single-sided printing, chapter title goes across top left of page,
2138 % page number on top right.
2139 \def\HEADINGSsingle{%
2140 \global\pageno=1
2141 \global\evenfootline={\hfil}
2142 \global\oddfootline={\hfil}
2143 \global\evenheadline={\line{\thischapter\hfil\folio}}
2144 \global\oddheadline={\line{\thischapter\hfil\folio}}
2145 \global\let\contentsalignmacro = \chappager
2146 }
2147 \def\HEADINGSon{\HEADINGSdouble}
2148
2149 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2150 \let\HEADINGSdoubleafter=\HEADINGSafter
2151 \def\HEADINGSdoublex{%
2152 \global\evenfootline={\hfil}
2153 \global\oddfootline={\hfil}
2154 \global\evenheadline={\line{\folio\hfil\thistitle}}
2155 \global\oddheadline={\line{\thischapter\hfil\folio}}
2156 \global\let\contentsalignmacro = \chapoddpage
2157 }
2158
2159 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2160 \def\HEADINGSsinglex{%
2161 \global\evenfootline={\hfil}
2162 \global\oddfootline={\hfil}
2163 \global\evenheadline={\line{\thischapter\hfil\folio}}
2164 \global\oddheadline={\line{\thischapter\hfil\folio}}
2165 \global\let\contentsalignmacro = \chappager
2166 }
2167
2168 % Subroutines used in generating headings
2169 % This produces Day Month Year style of output.
2170 % Only define if not already defined, in case a txi-??.tex file has set
2171 % up a different format (e.g., txi-cs.tex does this).
2172 \ifx\today\undefined
2173 \def\today{%
2174   \number\day\space
2175   \ifcase\month
2176   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2177   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2178   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2179   \fi
2180   \space\number\year}
2181 \fi
2182
2183 % @settitle line...  specifies the title of the document, for headings.
2184 % It generates no output of its own.
2185 \def\thistitle{\putwordNoTitle}
2186 \def\settitle{\parsearg{\gdef\thistitle}}
2187
2188
2189 \message{tables,}
2190 % Tables -- @table, @ftable, @vtable, @item(x).
2191
2192 % default indentation of table text
2193 \newdimen\tableindent \tableindent=.8in
2194 % default indentation of @itemize and @enumerate text
2195 \newdimen\itemindent  \itemindent=.3in
2196 % margin between end of table item and start of table text.
2197 \newdimen\itemmargin  \itemmargin=.1in
2198
2199 % used internally for \itemindent minus \itemmargin
2200 \newdimen\itemmax
2201
2202 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2203 % these defs.
2204 % They also define \itemindex
2205 % to index the item name in whatever manner is desired (perhaps none).
2206
2207 \newif\ifitemxneedsnegativevskip
2208
2209 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2210
2211 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2212 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2213
2214 \def\itemzzz #1{\begingroup %
2215   \advance\hsize by -\rightskip
2216   \advance\hsize by -\tableindent
2217   \setbox0=\hbox{\itemindicate{#1}}%
2218   \itemindex{#1}%
2219   \nobreak % This prevents a break before @itemx.
2220   %
2221   % If the item text does not fit in the space we have, put it on a line
2222   % by itself, and do not allow a page break either before or after that
2223   % line.  We do not start a paragraph here because then if the next
2224   % command is, e.g., @kindex, the whatsit would get put into the
2225   % horizontal list on a line by itself, resulting in extra blank space.
2226   \ifdim \wd0>\itemmax
2227     %
2228     % Make this a paragraph so we get the \parskip glue and wrapping,
2229     % but leave it ragged-right.
2230     \begingroup
2231       \advance\leftskip by-\tableindent
2232       \advance\hsize by\tableindent
2233       \advance\rightskip by0pt plus1fil
2234       \leavevmode\unhbox0\par
2235     \endgroup
2236     %
2237     % We're going to be starting a paragraph, but we don't want the
2238     % \parskip glue -- logically it's part of the @item we just started.
2239     \nobreak \vskip-\parskip
2240     %
2241     % Stop a page break at the \parskip glue coming up.  (Unfortunately
2242     % we can't prevent a possible page break at the following
2243     % \baselineskip glue.)  However, if what follows is an environment
2244     % such as @example, there will be no \parskip glue; then
2245     % the negative vskip we just would cause the example and the item to
2246     % crash together.  So we use this bizarre value of 10001 as a signal
2247     % to \aboveenvbreak to insert \parskip glue after all.
2248     % (Possibly there are other commands that could be followed by
2249     % @example which need the same treatment, but not section titles; or
2250     % maybe section titles are the only special case and they should be
2251     % penalty 10001...)
2252     \penalty 10001
2253     \endgroup
2254     \itemxneedsnegativevskipfalse
2255   \else
2256     % The item text fits into the space.  Start a paragraph, so that the
2257     % following text (if any) will end up on the same line.
2258     \noindent
2259     % Do this with kerns and \unhbox so that if there is a footnote in
2260     % the item text, it can migrate to the main vertical list and
2261     % eventually be printed.
2262     \nobreak\kern-\tableindent
2263     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2264     \unhbox0
2265     \nobreak\kern\dimen0
2266     \endgroup
2267     \itemxneedsnegativevskiptrue
2268   \fi
2269 }
2270
2271 \def\item{\errmessage{@item while not in a list environment}}
2272 \def\itemx{\errmessage{@itemx while not in a list environment}}
2273
2274 % @table, @ftable, @vtable.
2275 \envdef\table{%
2276   \let\itemindex\gobble
2277   \tablex
2278 }
2279 \envdef\ftable{%
2280   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2281   \tablex
2282 }
2283 \envdef\vtable{%
2284   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2285   \tablex
2286 }
2287 \def\tablex#1{%
2288   \def\itemindicate{#1}%
2289   \parsearg\tabley
2290 }
2291 \def\tabley#1{%
2292   {%
2293     \makevalueexpandable
2294     \edef\temp{\noexpand\tablez #1\space\space\space}%
2295     \expandafter
2296   }\temp \endtablez
2297 }
2298 \def\tablez #1 #2 #3 #4\endtablez{%
2299   \aboveenvbreak
2300   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2301   \ifnum 0#2>0 \tableindent=#2\mil \fi
2302   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2303   \itemmax=\tableindent
2304   \advance \itemmax by -\itemmargin
2305   \advance \leftskip by \tableindent
2306   \exdentamount=\tableindent
2307   \parindent = 0pt
2308   \parskip = \smallskipamount
2309   \ifdim \parskip=0pt \parskip=2pt \fi
2310   \let\item = \internalBitem
2311   \let\itemx = \internalBitemx
2312 }
2313 \def\Etable{\endgraf\afterenvbreak}
2314 \let\Eftable\Etable
2315 \let\Evtable\Etable
2316 \let\Eitemize\Etable
2317 \let\Eenumerate\Etable
2318
2319 % This is the counter used by @enumerate, which is really @itemize
2320
2321 \newcount \itemno
2322
2323 \envdef\itemize{\parsearg\doitemize}
2324
2325 \def\doitemize#1{%
2326   \aboveenvbreak
2327   \itemmax=\itemindent
2328   \advance\itemmax by -\itemmargin
2329   \advance\leftskip by \itemindent
2330   \exdentamount=\itemindent
2331   \parindent=0pt
2332   \parskip=\smallskipamount
2333   \ifdim\parskip=0pt \parskip=2pt \fi
2334   \def\itemcontents{#1}%
2335   % @itemize with no arg is equivalent to @itemize @bullet.
2336   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2337   \let\item=\itemizeitem
2338 }
2339
2340 % Definition of @item while inside @itemize and @enumerate.
2341 %
2342 \def\itemizeitem{%
2343   \advance\itemno by 1  % for enumerations
2344   {\let\par=\endgraf \smallbreak}% reasonable place to break
2345   {%
2346    % If the document has an @itemize directly after a section title, a
2347    % \nobreak will be last on the list, and \sectionheading will have
2348    % done a \vskip-\parskip.  In that case, we don't want to zero
2349    % parskip, or the item text will crash with the heading.  On the
2350    % other hand, when there is normal text preceding the item (as there
2351    % usually is), we do want to zero parskip, or there would be too much
2352    % space.  In that case, we won't have a \nobreak before.  At least
2353    % that's the theory.
2354    \ifnum\lastpenalty<10000 \parskip=0in \fi
2355    \noindent
2356    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2357    \vadjust{\penalty 1200}}% not good to break after first line of item.
2358   \flushcr
2359 }
2360
2361 % \splitoff TOKENS\endmark defines \first to be the first token in
2362 % TOKENS, and \rest to be the remainder.
2363 %
2364 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2365
2366 % Allow an optional argument of an uppercase letter, lowercase letter,
2367 % or number, to specify the first label in the enumerated list.  No
2368 % argument is the same as `1'.
2369 %
2370 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
2371 \def\enumeratey #1 #2\endenumeratey{%
2372   % If we were given no argument, pretend we were given `1'.
2373   \def\thearg{#1}%
2374   \ifx\thearg\empty \def\thearg{1}\fi
2375   %
2376   % Detect if the argument is a single token.  If so, it might be a
2377   % letter.  Otherwise, the only valid thing it can be is a number.
2378   % (We will always have one token, because of the test we just made.
2379   % This is a good thing, since \splitoff doesn't work given nothing at
2380   % all -- the first parameter is undelimited.)
2381   \expandafter\splitoff\thearg\endmark
2382   \ifx\rest\empty
2383     % Only one token in the argument.  It could still be anything.
2384     % A ``lowercase letter'' is one whose \lccode is nonzero.
2385     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2386     %   not equal to itself.
2387     % Otherwise, we assume it's a number.
2388     %
2389     % We need the \relax at the end of the \ifnum lines to stop TeX from
2390     % continuing to look for a <number>.
2391     %
2392     \ifnum\lccode\expandafter`\thearg=0\relax
2393       \numericenumerate % a number (we hope)
2394     \else
2395       % It's a letter.
2396       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2397         \lowercaseenumerate % lowercase letter
2398       \else
2399         \uppercaseenumerate % uppercase letter
2400       \fi
2401     \fi
2402   \else
2403     % Multiple tokens in the argument.  We hope it's a number.
2404     \numericenumerate
2405   \fi
2406 }
2407
2408 % An @enumerate whose labels are integers.  The starting integer is
2409 % given in \thearg.
2410 %
2411 \def\numericenumerate{%
2412   \itemno = \thearg
2413   \startenumeration{\the\itemno}%
2414 }
2415
2416 % The starting (lowercase) letter is in \thearg.
2417 \def\lowercaseenumerate{%
2418   \itemno = \expandafter`\thearg
2419   \startenumeration{%
2420     % Be sure we're not beyond the end of the alphabet.
2421     \ifnum\itemno=0
2422       \errmessage{No more lowercase letters in @enumerate; get a bigger
2423                   alphabet}%
2424     \fi
2425     \char\lccode\itemno
2426   }%
2427 }
2428
2429 % The starting (uppercase) letter is in \thearg.
2430 \def\uppercaseenumerate{%
2431   \itemno = \expandafter`\thearg
2432   \startenumeration{%
2433     % Be sure we're not beyond the end of the alphabet.
2434     \ifnum\itemno=0
2435       \errmessage{No more uppercase letters in @enumerate; get a bigger
2436                   alphabet}
2437     \fi
2438     \char\uccode\itemno
2439   }%
2440 }
2441
2442 % Call \doitemize, adding a period to the first argument and supplying the
2443 % common last two arguments.  Also subtract one from the initial value in
2444 % \itemno, since @item increments \itemno.
2445 %
2446 \def\startenumeration#1{%
2447   \advance\itemno by -1
2448   \doitemize{#1.}\flushcr
2449 }
2450
2451 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2452 % to @enumerate.
2453 %
2454 \def\alphaenumerate{\enumerate{a}}
2455 \def\capsenumerate{\enumerate{A}}
2456 \def\Ealphaenumerate{\Eenumerate}
2457 \def\Ecapsenumerate{\Eenumerate}
2458
2459
2460 % @multitable macros
2461 % Amy Hendrickson, 8/18/94, 3/6/96
2462 %
2463 % @multitable ... @end multitable will make as many columns as desired.
2464 % Contents of each column will wrap at width given in preamble.  Width
2465 % can be specified either with sample text given in a template line,
2466 % or in percent of \hsize, the current width of text on page.
2467
2468 % Table can continue over pages but will only break between lines.
2469
2470 % To make preamble:
2471 %
2472 % Either define widths of columns in terms of percent of \hsize:
2473 %   @multitable @columnfractions .25 .3 .45
2474 %   @item ...
2475 %
2476 %   Numbers following @columnfractions are the percent of the total
2477 %   current hsize to be used for each column. You may use as many
2478 %   columns as desired.
2479
2480
2481 % Or use a template:
2482 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2483 %   @item ...
2484 %   using the widest term desired in each column.
2485
2486 % Each new table line starts with @item, each subsequent new column
2487 % starts with @tab. Empty columns may be produced by supplying @tab's
2488 % with nothing between them for as many times as empty columns are needed,
2489 % ie, @tab@tab@tab will produce two empty columns.
2490
2491 % @item, @tab do not need to be on their own lines, but it will not hurt
2492 % if they are.
2493
2494 % Sample multitable:
2495
2496 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2497 %   @item first col stuff @tab second col stuff @tab third col
2498 %   @item
2499 %   first col stuff
2500 %   @tab
2501 %   second col stuff
2502 %   @tab
2503 %   third col
2504 %   @item first col stuff @tab second col stuff
2505 %   @tab Many paragraphs of text may be used in any column.
2506 %
2507 %         They will wrap at the width determined by the template.
2508 %   @item@tab@tab This will be in third column.
2509 %   @end multitable
2510
2511 % Default dimensions may be reset by user.
2512 % @multitableparskip is vertical space between paragraphs in table.
2513 % @multitableparindent is paragraph indent in table.
2514 % @multitablecolmargin is horizontal space to be left between columns.
2515 % @multitablelinespace is space to leave between table items, baseline
2516 %                                                            to baseline.
2517 %   0pt means it depends on current normal line spacing.
2518 %
2519 \newskip\multitableparskip
2520 \newskip\multitableparindent
2521 \newdimen\multitablecolspace
2522 \newskip\multitablelinespace
2523 \multitableparskip=0pt
2524 \multitableparindent=6pt
2525 \multitablecolspace=12pt
2526 \multitablelinespace=0pt
2527
2528 % Macros used to set up halign preamble:
2529 %
2530 \let\endsetuptable\relax
2531 \def\xendsetuptable{\endsetuptable}
2532 \let\columnfractions\relax
2533 \def\xcolumnfractions{\columnfractions}
2534 \newif\ifsetpercent
2535
2536 % #1 is the @columnfraction, usually a decimal number like .5, but might
2537 % be just 1.  We just use it, whatever it is.
2538
2539 \def\pickupwholefraction#1 {%
2540   \global\advance\colcount by 1
2541   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2542   \setuptable
2543 }
2544
2545 \newcount\colcount
2546 \def\setuptable#1{%
2547   \def\firstarg{#1}%
2548   \ifx\firstarg\xendsetuptable
2549     \let\go = \relax
2550   \else
2551     \ifx\firstarg\xcolumnfractions
2552       \global\setpercenttrue
2553     \else
2554       \ifsetpercent
2555          \let\go\pickupwholefraction
2556       \else
2557          \global\advance\colcount by 1
2558          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2559                    % separator; typically that is always in the input, anyway.
2560          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2561       \fi
2562     \fi
2563     \ifx\go\pickupwholefraction
2564       % Put the argument back for the \pickupwholefraction call, so
2565       % we'll always have a period there to be parsed.
2566       \def\go{\pickupwholefraction#1}%
2567     \else
2568       \let\go = \setuptable
2569     \fi%
2570   \fi
2571   \go
2572 }
2573
2574 % multitable-only commands.
2575 %
2576 % @headitem starts a heading row, which we typeset in bold.
2577 % Assignments have to be global since we are inside the implicit group
2578 % of an alignment entry.  Note that \everycr resets \everytab.
2579 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2580 %
2581 % A \tab used to include \hskip1sp.  But then the space in a template
2582 % line is not enough.  That is bad.  So let's go back to just `&' until
2583 % we encounter the problem it was intended to solve again.
2584 %                                       --karl, nathan@acm.org, 20apr99.
2585 \def\tab{\checkenv\multitable &\the\everytab}%
2586
2587 % @multitable ... @end multitable definitions:
2588 %
2589 \newtoks\everytab  % insert after every tab.
2590 %
2591 \envdef\multitable{%
2592   \vskip\parskip
2593   \startsavinginserts
2594   %
2595   % @item within a multitable starts a normal row.
2596   \let\item\crcr
2597   %
2598   \tolerance=9500
2599   \hbadness=9500
2600   \setmultitablespacing
2601   \parskip=\multitableparskip
2602   \parindent=\multitableparindent
2603   \overfullrule=0pt
2604   \global\colcount=0
2605   %
2606   \everycr = {%
2607     \noalign{%
2608       \global\everytab={}%
2609       \global\colcount=0 % Reset the column counter.
2610       % Check for saved footnotes, etc.
2611       \checkinserts
2612       % Keeps underfull box messages off when table breaks over pages.
2613       %\filbreak
2614         % Maybe so, but it also creates really weird page breaks when the
2615         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
2616         % problem manifests itself, so it can be fixed for real --karl.
2617     }%
2618   }%
2619   %
2620   \parsearg\domultitable
2621 }
2622 \def\domultitable#1{%
2623   % To parse everything between @multitable and @item:
2624   \setuptable#1 \endsetuptable
2625   %
2626   % This preamble sets up a generic column definition, which will
2627   % be used as many times as user calls for columns.
2628   % \vtop will set a single line and will also let text wrap and
2629   % continue for many paragraphs if desired.
2630   \halign\bgroup &%
2631     \global\advance\colcount by 1
2632     \multistrut
2633     \vtop{%
2634       % Use the current \colcount to find the correct column width:
2635       \hsize=\expandafter\csname col\the\colcount\endcsname
2636       %
2637       % In order to keep entries from bumping into each other
2638       % we will add a \leftskip of \multitablecolspace to all columns after
2639       % the first one.
2640       %
2641       % If a template has been used, we will add \multitablecolspace
2642       % to the width of each template entry.
2643       %
2644       % If the user has set preamble in terms of percent of \hsize we will
2645       % use that dimension as the width of the column, and the \leftskip
2646       % will keep entries from bumping into each other.  Table will start at
2647       % left margin and final column will justify at right margin.
2648       %
2649       % Make sure we don't inherit \rightskip from the outer environment.
2650       \rightskip=0pt
2651       \ifnum\colcount=1
2652         % The first column will be indented with the surrounding text.
2653         \advance\hsize by\leftskip
2654       \else
2655         \ifsetpercent \else
2656           % If user has not set preamble in terms of percent of \hsize
2657           % we will advance \hsize by \multitablecolspace.
2658           \advance\hsize by \multitablecolspace
2659         \fi
2660        % In either case we will make \leftskip=\multitablecolspace:
2661       \leftskip=\multitablecolspace
2662       \fi
2663       % Ignoring space at the beginning and end avoids an occasional spurious
2664       % blank line, when TeX decides to break the line at the space before the
2665       % box from the multistrut, so the strut ends up on a line by itself.
2666       % For example:
2667       % @multitable @columnfractions .11 .89
2668       % @item @code{#}
2669       % @tab Legal holiday which is valid in major parts of the whole country.
2670       % Is automatically provided with highlighting sequences respectively
2671       % marking characters.
2672       \noindent\ignorespaces##\unskip\multistrut
2673     }\cr
2674 }
2675 \def\Emultitable{%
2676   \crcr
2677   \egroup % end the \halign
2678   \global\setpercentfalse
2679 }
2680
2681 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2682 % If so, do nothing. If not, give it an appropriate dimension based on
2683 % current baselineskip.
2684 \ifdim\multitablelinespace=0pt
2685 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2686 \global\advance\multitablelinespace by-\ht0
2687 %% strut to put in table in case some entry doesn't have descenders,
2688 %% to keep lines equally spaced
2689 \let\multistrut = \strut
2690 \else
2691 %% FIXME: what is \box0 supposed to be?
2692 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2693 width0pt\relax} \fi
2694 %% Test to see if parskip is larger than space between lines of
2695 %% table. If not, do nothing.
2696 %%        If so, set to same dimension as multitablelinespace.
2697 \ifdim\multitableparskip>\multitablelinespace
2698 \global\multitableparskip=\multitablelinespace
2699 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2700                                       %% than skip between lines in the table.
2701 \fi%
2702 \ifdim\multitableparskip=0pt
2703 \global\multitableparskip=\multitablelinespace
2704 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2705                                       %% than skip between lines in the table.
2706 \fi}
2707
2708
2709 \message{conditionals,}
2710
2711 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2712 % @ifnotxml always succeed.  They currently do nothing; we don't
2713 % attempt to check whether the conditionals are properly nested.  But we
2714 % have to remember that they are conditionals, so that @end doesn't
2715 % attempt to close an environment group.
2716 %
2717 \def\makecond#1{%
2718   \expandafter\let\csname #1\endcsname = \relax
2719   \expandafter\let\csname iscond.#1\endcsname = 1
2720 }
2721 \makecond{iftex}
2722 \makecond{ifnotdocbook}
2723 \makecond{ifnothtml}
2724 \makecond{ifnotinfo}
2725 \makecond{ifnotplaintext}
2726 \makecond{ifnotxml}
2727
2728 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2729 %
2730 \def\direntry{\doignore{direntry}}
2731 \def\documentdescription{\doignore{documentdescription}}
2732 \def\docbook{\doignore{docbook}}
2733 \def\html{\doignore{html}}
2734 \def\ifdocbook{\doignore{ifdocbook}}
2735 \def\ifhtml{\doignore{ifhtml}}
2736 \def\ifinfo{\doignore{ifinfo}}
2737 \def\ifnottex{\doignore{ifnottex}}
2738 \def\ifplaintext{\doignore{ifplaintext}}
2739 \def\ifxml{\doignore{ifxml}}
2740 \def\ignore{\doignore{ignore}}
2741 \def\menu{\doignore{menu}}
2742 \def\xml{\doignore{xml}}
2743
2744 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2745 %
2746 % A count to remember the depth of nesting.
2747 \newcount\doignorecount
2748
2749 \def\doignore#1{\begingroup
2750   % Scan in ``verbatim'' mode:
2751   \catcode`\@ = \other
2752   \catcode`\{ = \other
2753   \catcode`\} = \other
2754   %
2755   % Make sure that spaces turn into tokens that match what \doignoretext wants.
2756   \spaceisspace
2757   %
2758   % Count number of #1's that we've seen.
2759   \doignorecount = 0
2760   %
2761   % Swallow text until we reach the matching `@end #1'.
2762   \dodoignore {#1}%
2763 }
2764
2765 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2766   \obeylines %
2767   %
2768   \gdef\dodoignore#1{%
2769     % #1 contains the string `ifinfo'.
2770     %
2771     % Define a command to find the next `@end #1', which must be on a line
2772     % by itself.
2773     \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2774     % And this command to find another #1 command, at the beginning of a
2775     % line.  (Otherwise, we would consider a line `@c @ifset', for
2776     % example, to count as an @ifset for nesting.)
2777     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2778     %
2779     % And now expand that command.
2780     \obeylines %
2781     \doignoretext ^^M%
2782   }%
2783 }
2784
2785 \def\doignoreyyy#1{%
2786   \def\temp{#1}%
2787   \ifx\temp\empty                       % Nothing found.
2788     \let\next\doignoretextzzz
2789   \else                                 % Found a nested condition, ...
2790     \advance\doignorecount by 1
2791     \let\next\doignoretextyyy           % ..., look for another.
2792     % If we're here, #1 ends with ^^M\ifinfo (for example).
2793   \fi
2794   \next #1% the token \_STOP_ is present just after this macro.
2795 }
2796
2797 % We have to swallow the remaining "\_STOP_".
2798
2799 \def\doignoretextzzz#1{%
2800   \ifnum\doignorecount = 0      % We have just found the outermost @end.
2801     \let\next\enddoignore
2802   \else                         % Still inside a nested condition.
2803     \advance\doignorecount by -1
2804     \let\next\doignoretext      % Look for the next @end.
2805   \fi
2806   \next
2807 }
2808
2809 % Finish off ignored text.
2810 \def\enddoignore{\endgroup\ignorespaces}
2811
2812
2813 % @set VAR sets the variable VAR to an empty value.
2814 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2815 %
2816 % Since we want to separate VAR from REST-OF-LINE (which might be
2817 % empty), we can't just use \parsearg; we have to insert a space of our
2818 % own to delimit the rest of the line, and then take it out again if we
2819 % didn't need it.
2820 % We rely on the fact that \parsearg sets \catcode`\ =10.
2821 %
2822 \parseargdef\set{\setyyy#1 \endsetyyy}
2823 \def\setyyy#1 #2\endsetyyy{%
2824   {%
2825     \makevalueexpandable
2826     \def\temp{#2}%
2827     \edef\next{\gdef\makecsname{SET#1}}%
2828     \ifx\temp\empty
2829       \next{}%
2830     \else
2831       \setzzz#2\endsetzzz
2832     \fi
2833   }%
2834 }
2835 % Remove the trailing space \setxxx inserted.
2836 \def\setzzz#1 \endsetzzz{\next{#1}}
2837
2838 % @clear VAR clears (i.e., unsets) the variable VAR.
2839 %
2840 \parseargdef\clear{%
2841   {%
2842     \makevalueexpandable
2843     \global\expandafter\let\csname SET#1\endcsname=\relax
2844   }%
2845 }
2846
2847 % @value{foo} gets the text saved in variable foo.
2848 \def\value{\begingroup\makevalueexpandable\valuexxx}
2849 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2850 {
2851   \catcode`\- = \active \catcode`\_ = \active
2852   %
2853   \gdef\makevalueexpandable{%
2854     \let\value = \expandablevalue
2855     % We don't want these characters active, ...
2856     \catcode`\-=\other \catcode`\_=\other
2857     % ..., but we might end up with active ones in the argument if
2858     % we're called from @code, as @code{@value{foo-bar_}}, though.
2859     % So \let them to their normal equivalents.
2860     \let-\realdash \let_\normalunderscore
2861   }
2862 }
2863
2864 % We have this subroutine so that we can handle at least some @value's
2865 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2866 % The command has to be fully expandable (if the variable is set), since
2867 % the result winds up in the index file.  This means that if the
2868 % variable's value contains other Texinfo commands, it's almost certain
2869 % it will fail (although perhaps we could fix that with sufficient work
2870 % to do a one-level expansion on the result, instead of complete).
2871 %
2872 \def\expandablevalue#1{%
2873   \expandafter\ifx\csname SET#1\endcsname\relax
2874     {[No value for ``#1'']}%
2875     \message{Variable `#1', used in @value, is not set.}%
2876   \else
2877     \csname SET#1\endcsname
2878   \fi
2879 }
2880
2881 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2882 % with @set.
2883 %
2884 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2885 %
2886 \makecond{ifset}
2887 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
2888 \def\doifset#1#2{%
2889   {%
2890     \makevalueexpandable
2891     \let\next=\empty
2892     \expandafter\ifx\csname SET#2\endcsname\relax
2893       #1% If not set, redefine \next.
2894     \fi
2895     \expandafter
2896   }\next
2897 }
2898 \def\ifsetfail{\doignore{ifset}}
2899
2900 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2901 % defined with @set, or has been undefined with @clear.
2902 %
2903 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2904 % above code: if the variable is not set, do nothing, if it is set,
2905 % then redefine \next to \ifclearfail.
2906 %
2907 \makecond{ifclear}
2908 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
2909 \def\ifclearfail{\doignore{ifclear}}
2910
2911 % @dircategory CATEGORY  -- specify a category of the dir file
2912 % which this file should belong to.  Ignore this in TeX.
2913 \let\dircategory=\comment
2914
2915 % @defininfoenclose.
2916 \let\definfoenclose=\comment
2917
2918
2919 \message{indexing,}
2920 % Index generation facilities
2921
2922 % Define \newwrite to be identical to plain tex's \newwrite
2923 % except not \outer, so it can be used within \newindex.
2924 {\catcode`\@=11
2925 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2926
2927 % \newindex {foo} defines an index named foo.
2928 % It automatically defines \fooindex such that
2929 % \fooindex ...rest of line... puts an entry in the index foo.
2930 % It also defines \fooindfile to be the number of the output channel for
2931 % the file that accumulates this index.  The file's extension is foo.
2932 % The name of an index should be no more than 2 characters long
2933 % for the sake of vms.
2934 %
2935 \def\newindex#1{%
2936   \iflinks
2937     \expandafter\newwrite \csname#1indfile\endcsname
2938     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2939   \fi
2940   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
2941     \noexpand\doindex{#1}}
2942 }
2943
2944 % @defindex foo  ==  \newindex{foo}
2945 %
2946 \def\defindex{\parsearg\newindex}
2947
2948 % Define @defcodeindex, like @defindex except put all entries in @code.
2949 %
2950 \def\defcodeindex{\parsearg\newcodeindex}
2951 %
2952 \def\newcodeindex#1{%
2953   \iflinks
2954     \expandafter\newwrite \csname#1indfile\endcsname
2955     \openout \csname#1indfile\endcsname \jobname.#1
2956   \fi
2957   \expandafter\xdef\csname#1index\endcsname{%
2958     \noexpand\docodeindex{#1}}%
2959 }
2960
2961
2962 % @synindex foo bar    makes index foo feed into index bar.
2963 % Do this instead of @defindex foo if you don't want it as a separate index.
2964 %
2965 % @syncodeindex foo bar   similar, but put all entries made for index foo
2966 % inside @code.
2967 %
2968 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2969 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2970
2971 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2972 % #3 the target index (bar).
2973 \def\dosynindex#1#2#3{%
2974   % Only do \closeout if we haven't already done it, else we'll end up
2975   % closing the target index.
2976   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2977     % The \closeout helps reduce unnecessary open files; the limit on the
2978     % Acorn RISC OS is a mere 16 files.
2979     \expandafter\closeout\csname#2indfile\endcsname
2980     \expandafter\let\csname\donesynindex#2\endcsname = 1
2981   \fi
2982   % redefine \fooindfile:
2983   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2984   \expandafter\let\csname#2indfile\endcsname=\temp
2985   % redefine \fooindex:
2986   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2987 }
2988
2989 % Define \doindex, the driver for all \fooindex macros.
2990 % Argument #1 is generated by the calling \fooindex macro,
2991 %  and it is "foo", the name of the index.
2992
2993 % \doindex just uses \parsearg; it calls \doind for the actual work.
2994 % This is because \doind is more useful to call from other macros.
2995
2996 % There is also \dosubind {index}{topic}{subtopic}
2997 % which makes an entry in a two-level index such as the operation index.
2998
2999 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3000 \def\singleindexer #1{\doind{\indexname}{#1}}
3001
3002 % like the previous two, but they put @code around the argument.
3003 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3004 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3005
3006 % Take care of Texinfo commands that can appear in an index entry.
3007 % Since there are some commands we want to expand, and others we don't,
3008 % we have to laboriously prevent expansion for those that we don't.
3009 %
3010 \def\indexdummies{%
3011   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3012   \def\ {\realbackslash\space }%
3013   % Need these in case \tex is in effect and \{ is a \delimiter again.
3014   % But can't use \lbracecmd and \rbracecmd because texindex assumes
3015   % braces and backslashes are used only as delimiters.
3016   \let\{ = \mylbrace
3017   \let\} = \myrbrace
3018   %
3019   % \definedummyword defines \#1 as \realbackslash #1\space, thus
3020   % effectively preventing its expansion.  This is used only for control
3021   % words, not control letters, because the \space would be incorrect
3022   % for control characters, but is needed to separate the control word
3023   % from whatever follows.
3024   %
3025   % For control letters, we have \definedummyletter, which omits the
3026   % space.
3027   %
3028   % These can be used both for control words that take an argument and
3029   % those that do not.  If it is followed by {arg} in the input, then
3030   % that will dutifully get written to the index (or wherever).
3031   %
3032   \def\definedummyword##1{%
3033     \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3034   }%
3035   \def\definedummyletter##1{%
3036     \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3037   }%
3038   %
3039   % Do the redefinitions.
3040   \commondummies
3041 }
3042
3043 % For the aux file, @ is the escape character.  So we want to redefine
3044 % everything using @ instead of \realbackslash.  When everything uses
3045 % @, this will be simpler.
3046 %
3047 \def\atdummies{%
3048   \def\@{@@}%
3049   \def\ {@ }%
3050   \let\{ = \lbraceatcmd
3051   \let\} = \rbraceatcmd
3052   %
3053   % (See comments in \indexdummies.)
3054   \def\definedummyword##1{%
3055     \expandafter\def\csname ##1\endcsname{@##1\space}%
3056   }%
3057   \def\definedummyletter##1{%
3058     \expandafter\def\csname ##1\endcsname{@##1}%
3059   }%
3060   %
3061   % Do the redefinitions.
3062   \commondummies
3063 }
3064
3065 % Called from \indexdummies and \atdummies.  \definedummyword and
3066 % \definedummyletter must be defined first.
3067 %
3068 \def\commondummies{%
3069   %
3070   \normalturnoffactive
3071   %
3072   \commondummiesnofonts
3073   %
3074   \definedummyletter{_}%
3075   %
3076   % Non-English letters.
3077   \definedummyword{AA}%
3078   \definedummyword{AE}%
3079   \definedummyword{L}%
3080   \definedummyword{OE}%
3081   \definedummyword{O}%
3082   \definedummyword{aa}%
3083   \definedummyword{ae}%
3084   \definedummyword{l}%
3085   \definedummyword{oe}%
3086   \definedummyword{o}%
3087   \definedummyword{ss}%
3088   \definedummyword{exclamdown}%
3089   \definedummyword{questiondown}%
3090   \definedummyword{ordf}%
3091   \definedummyword{ordm}%
3092   %
3093   % Although these internal commands shouldn't show up, sometimes they do.
3094   \definedummyword{bf}%
3095   \definedummyword{gtr}%
3096   \definedummyword{hat}%
3097   \definedummyword{less}%
3098   \definedummyword{sf}%
3099   \definedummyword{sl}%
3100   \definedummyword{tclose}%
3101   \definedummyword{tt}%
3102   %
3103   \definedummyword{LaTeX}%
3104   \definedummyword{TeX}%
3105   %
3106   % Assorted special characters.
3107   \definedummyword{bullet}%
3108   \definedummyword{copyright}%
3109   \definedummyword{registeredsymbol}%
3110   \definedummyword{dots}%
3111   \definedummyword{enddots}%
3112   \definedummyword{equiv}%
3113   \definedummyword{error}%
3114   \definedummyword{expansion}%
3115   \definedummyword{minus}%
3116   \definedummyword{pounds}%
3117   \definedummyword{point}%
3118   \definedummyword{print}%
3119   \definedummyword{result}%
3120   %
3121   % Handle some cases of @value -- where it does not contain any
3122   % (non-fully-expandable) commands.
3123   \makevalueexpandable
3124   %
3125   % Normal spaces, not active ones.
3126   \unsepspaces
3127   %
3128   % No macro expansion.
3129   \turnoffmacros
3130 }
3131
3132 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3133 %
3134 % Better have this without active chars.
3135 {
3136   \catcode`\~=\other
3137   \gdef\commondummiesnofonts{%
3138     % Control letters and accents.
3139     \definedummyletter{!}%
3140     \definedummyletter{"}%
3141     \definedummyletter{'}%
3142     \definedummyletter{*}%
3143     \definedummyletter{,}%
3144     \definedummyletter{.}%
3145     \definedummyletter{/}%
3146     \definedummyletter{:}%
3147     \definedummyletter{=}%
3148     \definedummyletter{?}%
3149     \definedummyletter{^}%
3150     \definedummyletter{`}%
3151     \definedummyletter{~}%
3152     \definedummyword{u}%
3153     \definedummyword{v}%
3154     \definedummyword{H}%
3155     \definedummyword{dotaccent}%
3156     \definedummyword{ringaccent}%
3157     \definedummyword{tieaccent}%
3158     \definedummyword{ubaraccent}%
3159     \definedummyword{udotaccent}%
3160     \definedummyword{dotless}%
3161     %
3162     % Texinfo font commands.
3163     \definedummyword{b}%
3164     \definedummyword{i}%
3165     \definedummyword{r}%
3166     \definedummyword{sc}%
3167     \definedummyword{t}%
3168     %
3169     % Commands that take arguments.
3170     \definedummyword{acronym}%
3171     \definedummyword{cite}%
3172     \definedummyword{code}%
3173     \definedummyword{command}%
3174     \definedummyword{dfn}%
3175     \definedummyword{emph}%
3176     \definedummyword{env}%
3177     \definedummyword{file}%
3178     \definedummyword{kbd}%
3179     \definedummyword{key}%
3180     \definedummyword{math}%
3181     \definedummyword{option}%
3182     \definedummyword{samp}%
3183     \definedummyword{strong}%
3184     \definedummyword{tie}%
3185     \definedummyword{uref}%
3186     \definedummyword{url}%
3187     \definedummyword{var}%
3188     \definedummyword{verb}%
3189     \definedummyword{w}%
3190   }
3191 }
3192
3193 % \indexnofonts is used when outputting the strings to sort the index
3194 % by, and when constructing control sequence names.  It eliminates all
3195 % control sequences and just writes whatever the best ASCII sort string
3196 % would be for a given command (usually its argument).
3197 %
3198 \def\indexnofonts{%
3199   \def\definedummyword##1{%
3200     \expandafter\let\csname ##1\endcsname\asis
3201   }%
3202   \let\definedummyletter=\definedummyword
3203   %
3204   \commondummiesnofonts
3205   %
3206   % Don't no-op \tt, since it isn't a user-level command
3207   % and is used in the definitions of the active chars like <, >, |, etc.
3208   % Likewise with the other plain tex font commands.
3209   %\let\tt=\asis
3210   %
3211   \def\ { }%
3212   \def\@{@}%
3213   % how to handle braces?
3214   \def\_{\normalunderscore}%
3215   %
3216   % Non-English letters.
3217   \def\AA{AA}%
3218   \def\AE{AE}%
3219   \def\L{L}%
3220   \def\OE{OE}%
3221   \def\O{O}%
3222   \def\aa{aa}%
3223   \def\ae{ae}%
3224   \def\l{l}%
3225   \def\oe{oe}%
3226   \def\o{o}%
3227   \def\ss{ss}%
3228   \def\exclamdown{!}%
3229   \def\questiondown{?}%
3230   \def\ordf{a}%
3231   \def\ordm{o}%
3232   %
3233   \def\LaTeX{LaTeX}%
3234   \def\TeX{TeX}%
3235   %
3236   % Assorted special characters.
3237   % (The following {} will end up in the sort string, but that's ok.)
3238   \def\bullet{bullet}%
3239   \def\copyright{copyright}%
3240   \def\registeredsymbol{R}%
3241   \def\dots{...}%
3242   \def\enddots{...}%
3243   \def\equiv{==}%
3244   \def\error{error}%
3245   \def\expansion{==>}%
3246   \def\minus{-}%
3247   \def\pounds{pounds}%
3248   \def\point{.}%
3249   \def\print{-|}%
3250   \def\result{=>}%
3251 }
3252
3253 \let\indexbackslash=0  %overridden during \printindex.
3254 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3255
3256 % Most index entries go through here, but \dosubind is the general case.
3257 % #1 is the index name, #2 is the entry text.
3258 \def\doind#1#2{\dosubind{#1}{#2}{}}
3259
3260 % Workhorse for all \fooindexes.
3261 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3262 % empty if called from \doind, as we usually are (the main exception
3263 % is with most defuns, which call us directly).
3264 %
3265 \def\dosubind#1#2#3{%
3266   \iflinks
3267   {%
3268     % Store the main index entry text (including the third arg).
3269     \toks0 = {#2}%
3270     % If third arg is present, precede it with a space.
3271     \def\thirdarg{#3}%
3272     \ifx\thirdarg\empty \else
3273       \toks0 = \expandafter{\the\toks0 \space #3}%
3274     \fi
3275     %
3276     \edef\writeto{\csname#1indfile\endcsname}%
3277     %
3278     \ifvmode
3279       \dosubindsanitize
3280     \else
3281       \dosubindwrite
3282     \fi
3283   }%
3284   \fi
3285 }
3286
3287 % Write the entry in \toks0 to the index file:
3288 %
3289 \def\dosubindwrite{%
3290   % Put the index entry in the margin if desired.
3291   \ifx\SETmarginindex\relax\else
3292     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3293   \fi
3294   %
3295   % Remember, we are within a group.
3296   \indexdummies % Must do this here, since \bf, etc expand at this stage
3297   \escapechar=`\\
3298   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3299       % so it will be output as is; and it will print as backslash.
3300   %
3301   % Process the index entry with all font commands turned off, to
3302   % get the string to sort by.
3303   {\indexnofonts
3304    \edef\temp{\the\toks0}% need full expansion
3305    \xdef\indexsorttmp{\temp}%
3306   }%
3307   %
3308   % Set up the complete index entry, with both the sort key and
3309   % the original text, including any font commands.  We write
3310   % three arguments to \entry to the .?? file (four in the
3311   % subentry case), texindex reduces to two when writing the .??s
3312   % sorted result.
3313   \edef\temp{%
3314     \write\writeto{%
3315       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3316   }%
3317   \temp
3318 }
3319
3320 % Take care of unwanted page breaks:
3321 %
3322 % If a skip is the last thing on the list now, preserve it
3323 % by backing up by \lastskip, doing the \write, then inserting
3324 % the skip again.  Otherwise, the whatsit generated by the
3325 % \write will make \lastskip zero.  The result is that sequences
3326 % like this:
3327 % @end defun
3328 % @tindex whatever
3329 % @defun ...
3330 % will have extra space inserted, because the \medbreak in the
3331 % start of the @defun won't see the skip inserted by the @end of
3332 % the previous defun.
3333 %
3334 % But don't do any of this if we're not in vertical mode.  We
3335 % don't want to do a \vskip and prematurely end a paragraph.
3336 %
3337 % Avoid page breaks due to these extra skips, too.
3338 %
3339 % But wait, there is a catch there:
3340 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
3341 % sufficient for this purpose, as it ignores stretch and shrink parts
3342 % of the skip.  The only way seems to be to check the textual
3343 % representation of the skip.
3344 %
3345 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3346 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3347 %
3348 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3349 %
3350 % ..., ready, GO:
3351 %
3352 \def\dosubindsanitize{%
3353   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3354   \skip0 = \lastskip
3355   \edef\lastskipmacro{\the\lastskip}%
3356   \count255 = \lastpenalty
3357   %
3358   % If \lastskip is nonzero, that means the last item was a
3359   % skip.  And since a skip is discardable, that means this
3360   % -\skip0 glue we're inserting is preceded by a
3361   % non-discardable item, therefore it is not a potential
3362   % breakpoint, therefore no \nobreak needed.
3363   \ifx\lastskipmacro\zeroskipmacro
3364   \else
3365     \vskip-\skip0
3366   \fi
3367   %
3368   \dosubindwrite
3369   %
3370   \ifx\lastskipmacro\zeroskipmacro
3371     % if \lastskip was zero, perhaps the last item was a
3372     % penalty, and perhaps it was >=10000, e.g., a \nobreak.
3373     % In that case, we want to re-insert the penalty; since we
3374     % just inserted a non-discardable item, any following glue
3375     % (such as a \parskip) would be a breakpoint.  For example:
3376     %   @deffn deffn-whatever
3377     %   @vindex index-whatever
3378     %   Description.
3379     % would allow a break between the index-whatever whatsit
3380     % and the "Description." paragraph.
3381     \ifnum\count255>9999 \nobreak \fi
3382   \else
3383     % On the other hand, if we had a nonzero \lastskip,
3384     % this make-up glue would be preceded by a non-discardable item
3385     % (the whatsit from the \write), so we must insert a \nobreak.
3386     \nobreak\vskip\skip0
3387   \fi
3388 }
3389
3390 % The index entry written in the file actually looks like
3391 %  \entry {sortstring}{page}{topic}
3392 % or
3393 %  \entry {sortstring}{page}{topic}{subtopic}
3394 % The texindex program reads in these files and writes files
3395 % containing these kinds of lines:
3396 %  \initial {c}
3397 %     before the first topic whose initial is c
3398 %  \entry {topic}{pagelist}
3399 %     for a topic that is used without subtopics
3400 %  \primary {topic}
3401 %     for the beginning of a topic that is used with subtopics
3402 %  \secondary {subtopic}{pagelist}
3403 %     for each subtopic.
3404
3405 % Define the user-accessible indexing commands
3406 % @findex, @vindex, @kindex, @cindex.
3407
3408 \def\findex {\fnindex}
3409 \def\kindex {\kyindex}
3410 \def\cindex {\cpindex}
3411 \def\vindex {\vrindex}
3412 \def\tindex {\tpindex}
3413 \def\pindex {\pgindex}
3414
3415 \def\cindexsub {\begingroup\obeylines\cindexsub}
3416 {\obeylines %
3417 \gdef\cindexsub "#1" #2^^M{\endgroup %
3418 \dosubind{cp}{#2}{#1}}}
3419
3420 % Define the macros used in formatting output of the sorted index material.
3421
3422 % @printindex causes a particular index (the ??s file) to get printed.
3423 % It does not print any chapter heading (usually an @unnumbered).
3424 %
3425 \parseargdef\printindex{\begingroup
3426   \dobreak \chapheadingskip{10000}%
3427   %
3428   \smallfonts \rm
3429   \tolerance = 9500
3430   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3431   %
3432   % See if the index file exists and is nonempty.
3433   % Change catcode of @ here so that if the index file contains
3434   % \initial {@}
3435   % as its first line, TeX doesn't complain about mismatched braces
3436   % (because it thinks @} is a control sequence).
3437   \catcode`\@ = 11
3438   \openin 1 \jobname.#1s
3439   \ifeof 1
3440     % \enddoublecolumns gets confused if there is no text in the index,
3441     % and it loses the chapter title and the aux file entries for the
3442     % index.  The easiest way to prevent this problem is to make sure
3443     % there is some text.
3444     \putwordIndexNonexistent
3445   \else
3446     %
3447     % If the index file exists but is empty, then \openin leaves \ifeof
3448     % false.  We have to make TeX try to read something from the file, so
3449     % it can discover if there is anything in it.
3450     \read 1 to \temp
3451     \ifeof 1
3452       \putwordIndexIsEmpty
3453     \else
3454       % Index files are almost Texinfo source, but we use \ as the escape
3455       % character.  It would be better to use @, but that's too big a change
3456       % to make right now.
3457       \def\indexbackslash{\backslashcurfont}%
3458       \catcode`\\ = 0
3459       \escapechar = `\\
3460       \begindoublecolumns
3461       \input \jobname.#1s
3462       \enddoublecolumns
3463     \fi
3464   \fi
3465   \closein 1
3466 \endgroup}
3467
3468 % These macros are used by the sorted index file itself.
3469 % Change them to control the appearance of the index.
3470
3471 \def\initial#1{{%
3472   % Some minor font changes for the special characters.
3473   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3474   %
3475   % Remove any glue we may have, we'll be inserting our own.
3476   \removelastskip
3477   %
3478   % We like breaks before the index initials, so insert a bonus.
3479   \penalty -300
3480   %
3481   % Typeset the initial.  Making this add up to a whole number of
3482   % baselineskips increases the chance of the dots lining up from column
3483   % to column.  It still won't often be perfect, because of the stretch
3484   % we need before each entry, but it's better.
3485   %
3486   % No shrink because it confuses \balancecolumns.
3487   \vskip 1.67\baselineskip plus .5\baselineskip
3488   \leftline{\secbf #1}%
3489   \vskip .33\baselineskip plus .1\baselineskip
3490   %
3491   % Do our best not to break after the initial.
3492   \nobreak
3493 }}
3494
3495 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3496 % then page number (#2) flushed to the right margin.  It is used for index
3497 % and table of contents entries.  The paragraph is indented by \leftskip.
3498 %
3499 % A straightforward implementation would start like this:
3500 %       \def\entry#1#2{...
3501 % But this frozes the catcodes in the argument, and can cause problems to
3502 % @code, which sets - active.  This problem was fixed by a kludge---
3503 % ``-'' was active throughout whole index, but this isn't really right.
3504
3505 % The right solution is to prevent \entry from swallowing the whole text.
3506 %                                 --kasal, 21nov03
3507 \def\entry{%
3508   \begingroup
3509     %
3510     % Start a new paragraph if necessary, so our assignments below can't
3511     % affect previous text.
3512     \par
3513     %
3514     % Do not fill out the last line with white space.
3515     \parfillskip = 0in
3516     %
3517     % No extra space above this paragraph.
3518     \parskip = 0in
3519     %
3520     % Do not prefer a separate line ending with a hyphen to fewer lines.
3521     \finalhyphendemerits = 0
3522     %
3523     % \hangindent is only relevant when the entry text and page number
3524     % don't both fit on one line.  In that case, bob suggests starting the
3525     % dots pretty far over on the line.  Unfortunately, a large
3526     % indentation looks wrong when the entry text itself is broken across
3527     % lines.  So we use a small indentation and put up with long leaders.
3528     %
3529     % \hangafter is reset to 1 (which is the value we want) at the start
3530     % of each paragraph, so we need not do anything with that.
3531     \hangindent = 2em
3532     %
3533     % When the entry text needs to be broken, just fill out the first line
3534     % with blank space.
3535     \rightskip = 0pt plus1fil
3536     %
3537     % A bit of stretch before each entry for the benefit of balancing
3538     % columns.
3539     \vskip 0pt plus1pt
3540     %
3541     % Swallow the left brace of the text (first parameter):
3542     \afterassignment\doentry
3543     \let\temp =
3544 }
3545 \def\doentry{%
3546     \bgroup % Instead of the swallowed brace.
3547       \noindent
3548       \aftergroup\finishentry
3549       % And now comes the text of the entry.
3550 }
3551 \def\finishentry#1{%
3552     % #1 is the page number.
3553     %
3554     % The following is kludged to not output a line of dots in the index if
3555     % there are no page numbers.  The next person who breaks this will be
3556     % cursed by a Unix daemon.
3557     \def\tempa{{\rm }}%
3558     \def\tempb{#1}%
3559     \edef\tempc{\tempa}%
3560     \edef\tempd{\tempb}%
3561     \ifx\tempc\tempd
3562       \ %
3563     \else
3564       %
3565       % If we must, put the page number on a line of its own, and fill out
3566       % this line with blank space.  (The \hfil is overwhelmed with the
3567       % fill leaders glue in \indexdotfill if the page number does fit.)
3568       \hfil\penalty50
3569       \null\nobreak\indexdotfill % Have leaders before the page number.
3570       %
3571       % The `\ ' here is removed by the implicit \unskip that TeX does as
3572       % part of (the primitive) \par.  Without it, a spurious underfull
3573       % \hbox ensues.
3574       \ifpdf
3575         \pdfgettoks#1.%
3576         \ \the\toksA
3577       \else
3578         \ #1%
3579       \fi
3580     \fi
3581     \par
3582   \endgroup
3583 }
3584
3585 % Like \dotfill except takes at least 1 em.
3586 \def\indexdotfill{\cleaders
3587   \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3588
3589 \def\primary #1{\line{#1\hfil}}
3590
3591 \newskip\secondaryindent \secondaryindent=0.5cm
3592 \def\secondary#1#2{{%
3593   \parfillskip=0in
3594   \parskip=0in
3595   \hangindent=1in
3596   \hangafter=1
3597   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3598   \ifpdf
3599     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3600   \else
3601     #2
3602   \fi
3603   \par
3604 }}
3605
3606 % Define two-column mode, which we use to typeset indexes.
3607 % Adapted from the TeXbook, page 416, which is to say,
3608 % the manmac.tex format used to print the TeXbook itself.
3609 \catcode`\@=11
3610
3611 \newbox\partialpage
3612 \newdimen\doublecolumnhsize
3613
3614 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3615   % Grab any single-column material above us.
3616   \output = {%
3617     %
3618     % Here is a possibility not foreseen in manmac: if we accumulate a
3619     % whole lot of material, we might end up calling this \output
3620     % routine twice in a row (see the doublecol-lose test, which is
3621     % essentially a couple of indexes with @setchapternewpage off).  In
3622     % that case we just ship out what is in \partialpage with the normal
3623     % output routine.  Generally, \partialpage will be empty when this
3624     % runs and this will be a no-op.  See the indexspread.tex test case.
3625     \ifvoid\partialpage \else
3626       \onepageout{\pagecontents\partialpage}%
3627     \fi
3628     %
3629     \global\setbox\partialpage = \vbox{%
3630       % Unvbox the main output page.
3631       \unvbox\PAGE
3632       \kern-\topskip \kern\baselineskip
3633     }%
3634   }%
3635   \eject % run that output routine to set \partialpage
3636   %
3637   % Use the double-column output routine for subsequent pages.
3638   \output = {\doublecolumnout}%
3639   %
3640   % Change the page size parameters.  We could do this once outside this
3641   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3642   % format, but then we repeat the same computation.  Repeating a couple
3643   % of assignments once per index is clearly meaningless for the
3644   % execution time, so we may as well do it in one place.
3645   %
3646   % First we halve the line length, less a little for the gutter between
3647   % the columns.  We compute the gutter based on the line length, so it
3648   % changes automatically with the paper format.  The magic constant
3649   % below is chosen so that the gutter has the same value (well, +-<1pt)
3650   % as it did when we hard-coded it.
3651   %
3652   % We put the result in a separate register, \doublecolumhsize, so we
3653   % can restore it in \pagesofar, after \hsize itself has (potentially)
3654   % been clobbered.
3655   %
3656   \doublecolumnhsize = \hsize
3657     \advance\doublecolumnhsize by -.04154\hsize
3658     \divide\doublecolumnhsize by 2
3659   \hsize = \doublecolumnhsize
3660   %
3661   % Double the \vsize as well.  (We don't need a separate register here,
3662   % since nobody clobbers \vsize.)
3663   \vsize = 2\vsize
3664 }
3665
3666 % The double-column output routine for all double-column pages except
3667 % the last.
3668 %
3669 \def\doublecolumnout{%
3670   \splittopskip=\topskip \splitmaxdepth=\maxdepth
3671   % Get the available space for the double columns -- the normal
3672   % (undoubled) page height minus any material left over from the
3673   % previous page.
3674   \dimen@ = \vsize
3675   \divide\dimen@ by 2
3676   \advance\dimen@ by -\ht\partialpage
3677   %
3678   % box0 will be the left-hand column, box2 the right.
3679   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3680   \onepageout\pagesofar
3681   \unvbox255
3682   \penalty\outputpenalty
3683 }
3684 %
3685 % Re-output the contents of the output page -- any previous material,
3686 % followed by the two boxes we just split, in box0 and box2.
3687 \def\pagesofar{%
3688   \unvbox\partialpage
3689   %
3690   \hsize = \doublecolumnhsize
3691   \wd0=\hsize \wd2=\hsize
3692   \hbox to\pagewidth{\box0\hfil\box2}%
3693 }
3694 %
3695 % All done with double columns.
3696 \def\enddoublecolumns{%
3697   \output = {%
3698     % Split the last of the double-column material.  Leave it on the
3699     % current page, no automatic page break.
3700     \balancecolumns
3701     %
3702     % If we end up splitting too much material for the current page,
3703     % though, there will be another page break right after this \output
3704     % invocation ends.  Having called \balancecolumns once, we do not
3705     % want to call it again.  Therefore, reset \output to its normal
3706     % definition right away.  (We hope \balancecolumns will never be
3707     % called on to balance too much material, but if it is, this makes
3708     % the output somewhat more palatable.)
3709     \global\output = {\onepageout{\pagecontents\PAGE}}%
3710   }%
3711   \eject
3712   \endgroup % started in \begindoublecolumns
3713   %
3714   % \pagegoal was set to the doubled \vsize above, since we restarted
3715   % the current page.  We're now back to normal single-column
3716   % typesetting, so reset \pagegoal to the normal \vsize (after the
3717   % \endgroup where \vsize got restored).
3718   \pagegoal = \vsize
3719 }
3720 %
3721 % Called at the end of the double column material.
3722 \def\balancecolumns{%
3723   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3724   \dimen@ = \ht0
3725   \advance\dimen@ by \topskip
3726   \advance\dimen@ by-\baselineskip
3727   \divide\dimen@ by 2 % target to split to
3728   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3729   \splittopskip = \topskip
3730   % Loop until we get a decent breakpoint.
3731   {%
3732     \vbadness = 10000
3733     \loop
3734       \global\setbox3 = \copy0
3735       \global\setbox1 = \vsplit3 to \dimen@
3736     \ifdim\ht3>\dimen@
3737       \global\advance\dimen@ by 1pt
3738     \repeat
3739   }%
3740   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3741   \setbox0=\vbox to\dimen@{\unvbox1}%
3742   \setbox2=\vbox to\dimen@{\unvbox3}%
3743   %
3744   \pagesofar
3745 }
3746 \catcode`\@ = \other
3747
3748
3749 \message{sectioning,}
3750 % Chapters, sections, etc.
3751
3752 % \unnumberedno is an oxymoron, of course.  But we count the unnumbered
3753 % sections so that we can refer to them unambiguously in the pdf
3754 % outlines by their "section number".  We avoid collisions with chapter
3755 % numbers by starting them at 10000.  (If a document ever has 10000
3756 % chapters, we're in trouble anyway, I'm sure.)
3757 \newcount\unnumberedno \unnumberedno = 10000
3758 \newcount\chapno
3759 \newcount\secno        \secno=0
3760 \newcount\subsecno     \subsecno=0
3761 \newcount\subsubsecno  \subsubsecno=0
3762
3763 % This counter is funny since it counts through charcodes of letters A, B, ...
3764 \newcount\appendixno  \appendixno = `\@
3765 %
3766 % \def\appendixletter{\char\the\appendixno}
3767 % We do the following ugly conditional instead of the above simple
3768 % construct for the sake of pdftex, which needs the actual
3769 % letter in the expansion, not just typeset.
3770
3771 \def\appendixletter{%
3772   \ifnum\appendixno=`A A%
3773   \else\ifnum\appendixno=`B B%
3774   \else\ifnum\appendixno=`C C%
3775   \else\ifnum\appendixno=`D D%
3776   \else\ifnum\appendixno=`E E%
3777   \else\ifnum\appendixno=`F F%
3778   \else\ifnum\appendixno=`G G%
3779   \else\ifnum\appendixno=`H H%
3780   \else\ifnum\appendixno=`I I%
3781   \else\ifnum\appendixno=`J J%
3782   \else\ifnum\appendixno=`K K%
3783   \else\ifnum\appendixno=`L L%
3784   \else\ifnum\appendixno=`M M%
3785   \else\ifnum\appendixno=`N N%
3786   \else\ifnum\appendixno=`O O%
3787   \else\ifnum\appendixno=`P P%
3788   \else\ifnum\appendixno=`Q Q%
3789   \else\ifnum\appendixno=`R R%
3790   \else\ifnum\appendixno=`S S%
3791   \else\ifnum\appendixno=`T T%
3792   \else\ifnum\appendixno=`U U%
3793   \else\ifnum\appendixno=`V V%
3794   \else\ifnum\appendixno=`W W%
3795   \else\ifnum\appendixno=`X X%
3796   \else\ifnum\appendixno=`Y Y%
3797   \else\ifnum\appendixno=`Z Z%
3798   % The \the is necessary, despite appearances, because \appendixletter is
3799   % expanded while writing the .toc file.  \char\appendixno is not
3800   % expandable, thus it is written literally, thus all appendixes come out
3801   % with the same letter (or @) in the toc without it.
3802   \else\char\the\appendixno
3803   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3804   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3805
3806 % Each @chapter defines this as the name of the chapter.
3807 % page headings and footings can use it.  @section does likewise.
3808 % However, they are not reliable, because we don't use marks.
3809 \def\thischapter{}
3810 \def\thissection{}
3811
3812 \newcount\absseclevel % used to calculate proper heading level
3813 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3814
3815 % @raisesections: treat @section as chapter, @subsection as section, etc.
3816 \def\raisesections{\global\advance\secbase by -1}
3817 \let\up=\raisesections % original BFox name
3818
3819 % @lowersections: treat @chapter as section, @section as subsection, etc.
3820 \def\lowersections{\global\advance\secbase by 1}
3821 \let\down=\lowersections % original BFox name
3822
3823 % Choose a numbered-heading macro
3824 % #1 is heading level if unmodified by @raisesections or @lowersections
3825 % #2 is text for heading
3826 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3827 \ifcase\absseclevel
3828       \chapterzzz{#2}%
3829   \or \seczzz{#2}%
3830   \or \numberedsubseczzz{#2}%
3831   \or \numberedsubsubseczzz{#2}%
3832   \else
3833     \ifnum \absseclevel<0 \chapterzzz{#2}%
3834     \else \numberedsubsubseczzz{#2}%
3835     \fi
3836   \fi
3837   \suppressfirstparagraphindent
3838 }
3839
3840 % like \numhead, but chooses appendix heading levels
3841 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3842 \ifcase\absseclevel
3843       \appendixzzz{#2}%
3844   \or \appendixsectionzzz{#2}%
3845   \or \appendixsubseczzz{#2}%
3846   \or \appendixsubsubseczzz{#2}%
3847   \else
3848     \ifnum \absseclevel<0 \appendixzzz{#2}%
3849     \else \appendixsubsubseczzz{#2}%
3850     \fi
3851   \fi
3852   \suppressfirstparagraphindent
3853 }
3854
3855 % like \numhead, but chooses numberless heading levels
3856 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3857   \ifcase\absseclevel
3858       \unnumberedzzz{#2}%
3859   \or \unnumberedseczzz{#2}%
3860   \or \unnumberedsubseczzz{#2}%
3861   \or \unnumberedsubsubseczzz{#2}%
3862   \else
3863     \ifnum \absseclevel<0 \unnumberedzzz{#2}%
3864     \else \unnumberedsubsubseczzz{#2}%
3865     \fi
3866   \fi
3867   \suppressfirstparagraphindent
3868 }
3869
3870 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
3871 % all lower-level sectioning counters to zero.
3872
3873 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
3874 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
3875 \let\chaplevelprefix = \empty
3876
3877 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
3878 \def\chapterzzz#1{%
3879   % section resetting is \global in case the chapter is in a group, such
3880   % as an @include file.
3881   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3882     \global\advance\chapno by 1
3883   %
3884   % Used for \float.
3885   \gdef\chaplevelprefix{\the\chapno.}%
3886   \resetallfloatnos
3887   %
3888   \message{\putwordChapter\space \the\chapno}%
3889   %
3890   % Write the actual heading.
3891   \chapmacro{#1}{Ynumbered}{\the\chapno}%
3892   %
3893   % So @section and the like are numbered underneath this chapter.
3894   \global\let\section = \numberedsec
3895   \global\let\subsection = \numberedsubsec
3896   \global\let\subsubsection = \numberedsubsubsec
3897 }
3898
3899 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
3900 \def\appendixzzz#1{%
3901   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3902     \global\advance\appendixno by 1
3903   \gdef\chaplevelprefix{\appendixletter.}%
3904   \resetallfloatnos
3905   %
3906   \def\appendixnum{\putwordAppendix\space \appendixletter}%
3907   \message{\appendixnum}%
3908   %
3909   \chapmacro{#1}{Yappendix}{\appendixletter}%
3910   %
3911   \global\let\section = \appendixsec
3912   \global\let\subsection = \appendixsubsec
3913   \global\let\subsubsection = \appendixsubsubsec
3914 }
3915
3916 % @centerchap is like @unnumbered, but the heading is centered.
3917 \outer\parseargdef\centerchap{{\unnumberedyyy{#1}}}
3918
3919 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3920 \def\unnumberedzzz#1{%
3921   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3922     \global\advance\unnumberedno by 1
3923   %
3924   % Since an unnumbered has no number, no prefix for figures.
3925   \global\let\chaplevelprefix = \empty
3926   \resetallfloatnos
3927   %
3928   % This used to be simply \message{#1}, but TeX fully expands the
3929   % argument to \message.  Therefore, if #1 contained @-commands, TeX
3930   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
3931   % expanded @cite (which turns out to cause errors because \cite is meant
3932   % to be executed, not expanded).
3933   %
3934   % Anyway, we don't want the fully-expanded definition of @cite to appear
3935   % as a result of the \message, we just want `@cite' itself.  We use
3936   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3937   % simply yielding the contents of <toks register>.  (We also do this for
3938   % the toc entries.)
3939   \toks0 = {#1}%
3940   \message{(\the\toks0)}%
3941   %
3942   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
3943   %
3944   \global\let\section = \unnumberedsec
3945   \global\let\subsection = \unnumberedsubsec
3946   \global\let\subsubsection = \unnumberedsubsubsec
3947 }
3948
3949 % @top is like @unnumbered.
3950 \let\top\unnumbered
3951
3952 % Sections.
3953 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
3954 \def\seczzz#1{%
3955   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3956   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
3957 }
3958
3959 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
3960 \def\appendixsectionzzz#1{%
3961   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3962   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
3963 }
3964 \let\appendixsec\appendixsection
3965
3966 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
3967 \def\unnumberedseczzz#1{%
3968   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3969   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
3970 }
3971
3972 % Subsections.
3973 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
3974 \def\numberedsubseczzz#1{%
3975   \global\subsubsecno=0  \global\advance\subsecno by 1
3976   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
3977 }
3978
3979 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
3980 \def\appendixsubseczzz#1{%
3981   \global\subsubsecno=0  \global\advance\subsecno by 1
3982   \sectionheading{#1}{subsec}{Yappendix}%
3983                  {\appendixletter.\the\secno.\the\subsecno}%
3984 }
3985
3986 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3987 \def\unnumberedsubseczzz#1{%
3988   \global\subsubsecno=0  \global\advance\subsecno by 1
3989   \sectionheading{#1}{subsec}{Ynothing}%
3990                  {\the\unnumberedno.\the\secno.\the\subsecno}%
3991 }
3992
3993 % Subsubsections.
3994 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
3995 \def\numberedsubsubseczzz#1{%
3996   \global\advance\subsubsecno by 1
3997   \sectionheading{#1}{subsubsec}{Ynumbered}%
3998                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
3999 }
4000
4001 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4002 \def\appendixsubsubseczzz#1{%
4003   \global\advance\subsubsecno by 1
4004   \sectionheading{#1}{subsubsec}{Yappendix}%
4005                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4006 }
4007
4008 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4009 \def\unnumberedsubsubseczzz#1{%
4010   \global\advance\subsubsecno by 1
4011   \sectionheading{#1}{subsubsec}{Ynothing}%
4012                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4013 }
4014
4015 % These are variants which are not "outer", so they can appear in @ifinfo.
4016 % Actually, they are now be obsolete; ordinary section commands should work.
4017 \def\infotop{\parsearg\unnumberedzzz}
4018 \def\infounnumbered{\parsearg\unnumberedzzz}
4019 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
4020 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
4021 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
4022
4023 \def\infoappendix{\parsearg\appendixzzz}
4024 \def\infoappendixsec{\parsearg\appendixseczzz}
4025 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
4026 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
4027
4028 \def\infochapter{\parsearg\chapterzzz}
4029 \def\infosection{\parsearg\sectionzzz}
4030 \def\infosubsection{\parsearg\subsectionzzz}
4031 \def\infosubsubsection{\parsearg\subsubsectionzzz}
4032
4033 % These macros control what the section commands do, according
4034 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4035 % Define them by default for a numbered chapter.
4036 \let\section = \numberedsec
4037 \let\subsection = \numberedsubsec
4038 \let\subsubsection = \numberedsubsubsec
4039
4040 % Define @majorheading, @heading and @subheading
4041
4042 % NOTE on use of \vbox for chapter headings, section headings, and such:
4043 %       1) We use \vbox rather than the earlier \line to permit
4044 %          overlong headings to fold.
4045 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
4046 %          heading is obnoxious; this forbids it.
4047 %       3) Likewise, headings look best if no \parindent is used, and
4048 %          if justification is not attempted.  Hence \raggedright.
4049
4050
4051 \def\majorheading{%
4052   {\advance\chapheadingskip by 10pt \chapbreak }%
4053   \parsearg\chapheadingzzz
4054 }
4055
4056 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4057 \def\chapheadingzzz#1{%
4058   {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4059                     \parindent=0pt\raggedright
4060                     \rm #1\hfill}}%
4061   \bigskip \par\penalty 200\relax
4062   \suppressfirstparagraphindent
4063 }
4064
4065 % @heading, @subheading, @subsubheading.
4066 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4067   \suppressfirstparagraphindent}
4068 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4069   \suppressfirstparagraphindent}
4070 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4071   \suppressfirstparagraphindent}
4072
4073 % These macros generate a chapter, section, etc. heading only
4074 % (including whitespace, linebreaking, etc. around it),
4075 % given all the information in convenient, parsed form.
4076
4077 %%% Args are the skip and penalty (usually negative)
4078 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4079
4080 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4081
4082 %%% Define plain chapter starts, and page on/off switching for it
4083 % Parameter controlling skip before chapter headings (if needed)
4084
4085 \newskip\chapheadingskip
4086
4087 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4088 \def\chappager{\par\vfill\supereject}
4089 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4090
4091 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4092
4093 \def\CHAPPAGoff{%
4094 \global\let\contentsalignmacro = \chappager
4095 \global\let\pchapsepmacro=\chapbreak
4096 \global\let\pagealignmacro=\chappager}
4097
4098 \def\CHAPPAGon{%
4099 \global\let\contentsalignmacro = \chappager
4100 \global\let\pchapsepmacro=\chappager
4101 \global\let\pagealignmacro=\chappager
4102 \global\def\HEADINGSon{\HEADINGSsingle}}
4103
4104 \def\CHAPPAGodd{%
4105 \global\let\contentsalignmacro = \chapoddpage
4106 \global\let\pchapsepmacro=\chapoddpage
4107 \global\let\pagealignmacro=\chapoddpage
4108 \global\def\HEADINGSon{\HEADINGSdouble}}
4109
4110 \CHAPPAGon
4111
4112 \def\CHAPFplain{%
4113 \global\let\chapmacro=\chfplain
4114 \global\let\centerchapmacro=\centerchfplain}
4115
4116 % Normal chapter opening.
4117
4118 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4119 % Yappendix, Yomitfromtoc), #3 the chapter number.
4120
4121 % To test against our argument.
4122 \def\Ynothingkeyword{Ynothing}
4123 \def\Yomitfromtockeyword{Yomitfromtoc}
4124 \def\Yappendixkeyword{Yappendix}
4125 %
4126 \def\chfplain#1#2#3{%
4127   \pchapsepmacro
4128   {%
4129     \chapfonts \rm
4130     %
4131     % Have to define \thissection before calling \donoderef, because the
4132     % xref code eventually uses it.  On the other hand, it has to be called
4133     % after \pchapsepmacro, or the headline will change too soon.
4134     \gdef\thissection{#1}%
4135     \gdef\thischaptername{#1}%
4136     %
4137     % Only insert the separating space if we have a chapter/appendix
4138     % number, and don't print the unnumbered ``number''.
4139     \def\temptype{#2}%
4140     \ifx\temptype\Ynothingkeyword
4141       \setbox0 = \hbox{}%
4142       \def\toctype{unnchap}%
4143       \def\thischapter{#1}%
4144     \else\ifx\temptype\Yomitfromtockeyword
4145       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4146       \def\toctype{omit}%
4147       \xdef\thischapter{}%
4148     \else\ifx\temptype\Yappendixkeyword
4149       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4150       \def\toctype{app}%
4151       % We don't substitute the actual chapter name into \thischapter
4152       % because we don't want its macros evaluated now.  And we don't
4153       % use \thissection because that changes with each section.
4154       %
4155       \xdef\thischapter{\putwordAppendix{} \appendixletter:
4156                         \noexpand\thischaptername}%
4157     \else
4158       \setbox0 = \hbox{#3\enspace}%
4159       \def\toctype{numchap}%
4160       \xdef\thischapter{\putwordChapter{} \the\chapno:
4161                         \noexpand\thischaptername}%
4162     \fi\fi\fi
4163     %
4164     % Write the toc entry for this chapter.  Must come before the
4165     % \donoderef, because we include the current node name in the toc
4166     % entry, and \donoderef resets it to empty.
4167     \writetocentry{\toctype}{#1}{#3}%
4168     %
4169     % For pdftex, we have to write out the node definition (aka, make
4170     % the pdfdest) after any page break, but before the actual text has
4171     % been typeset.  If the destination for the pdf outline is after the
4172     % text, then jumping from the outline may wind up with the text not
4173     % being visible, for instance under high magnification.
4174     \donoderef{#2}%
4175     %
4176     % Typeset the actual heading.
4177     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4178           \hangindent=\wd0 \centerparametersmaybe
4179           \unhbox0 #1\par}%
4180   }%
4181   \nobreak\bigskip % no page break after a chapter title
4182   \nobreak
4183 }
4184
4185 % @centerchap -- centered and unnumbered.
4186 \let\centerparametersmaybe = \relax
4187 \def\centerchfplain#1{{%
4188   \def\centerparametersmaybe{%
4189     \advance\rightskip by 3\rightskip
4190     \leftskip = \rightskip
4191     \parfillskip = 0pt
4192   }%
4193   \chfplain{#1}{Ynothing}{}%
4194 }}
4195
4196 \CHAPFplain % The default
4197
4198 % I don't think this chapter style is supported any more, so I'm not
4199 % updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
4200
4201 \def\unnchfopen #1{%
4202 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4203                        \parindent=0pt\raggedright
4204                        \rm #1\hfill}}\bigskip \par\nobreak
4205 }
4206
4207 \def\chfopen #1#2{\chapoddpage {\chapfonts
4208 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4209 \par\penalty 5000 %
4210 }
4211
4212 \def\centerchfopen #1{%
4213 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4214                        \parindent=0pt
4215                        \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4216 }
4217
4218 \def\CHAPFopen{%
4219 \global\let\chapmacro=\chfopen
4220 \global\let\centerchapmacro=\centerchfopen}
4221
4222
4223 % Section titles.  These macros combine the section number parts and
4224 % call the generic \sectionheading to do the printing.
4225
4226 \newskip\secheadingskip
4227 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4228
4229 % Subsection titles.
4230 \newskip\subsecheadingskip
4231 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4232
4233 % Subsubsection titles.
4234 \def\subsubsecheadingskip{\subsecheadingskip}
4235 \def\subsubsecheadingbreak{\subsecheadingbreak}
4236
4237
4238 % Print any size, any type, section title.
4239
4240 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4241 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4242 % section number.
4243
4244 \def\sectionheading#1#2#3#4{%
4245   {%
4246     % Switch to the right set of fonts.
4247     \csname #2fonts\endcsname \rm
4248     %
4249     % Insert space above the heading.
4250     \csname #2headingbreak\endcsname
4251     %
4252     % Only insert the space after the number if we have a section number.
4253     \def\sectionlevel{#2}%
4254     \def\temptype{#3}%
4255     %
4256     \ifx\temptype\Ynothingkeyword
4257       \setbox0 = \hbox{}%
4258       \def\toctype{unn}%
4259       \gdef\thissection{#1}%
4260     \else\ifx\temptype\Yomitfromtockeyword
4261       % for @headings -- no section number, don't include in toc,
4262       % and don't redefine \thissection.
4263       \setbox0 = \hbox{}%
4264       \def\toctype{omit}%
4265       \let\sectionlevel=\empty
4266     \else\ifx\temptype\Yappendixkeyword
4267       \setbox0 = \hbox{#4\enspace}%
4268       \def\toctype{app}%
4269       \gdef\thissection{#1}%
4270     \else
4271       \setbox0 = \hbox{#4\enspace}%
4272       \def\toctype{num}%
4273       \gdef\thissection{#1}%
4274     \fi\fi\fi
4275     %
4276     % Write the toc entry (before \donoderef).  See comments in \chfplain.
4277     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4278     %
4279     % Write the node reference (= pdf destination for pdftex).
4280     % Again, see comments in \chfplain.
4281     \donoderef{#3}%
4282     %
4283     % Output the actual section heading.
4284     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4285           \hangindent=\wd0  % zero if no section number
4286           \unhbox0 #1}%
4287   }%
4288   % Add extra space after the heading -- half of whatever came above it.
4289   % Don't allow stretch, though.
4290   \kern .5 \csname #2headingskip\endcsname
4291   %
4292   % Do not let the kern be a potential breakpoint, as it would be if it
4293   % was followed by glue.
4294   \nobreak
4295   %
4296   % We'll almost certainly start a paragraph next, so don't let that
4297   % glue accumulate.  (Not a breakpoint because it's preceded by a
4298   % discardable item.)
4299   \vskip-\parskip
4300   %
4301   % This \nobreak is purely so the last item on the list is a \penalty
4302   % of 10000.  This is so other code, for instance \parsebodycommon, can
4303   % check for and avoid allowing breakpoints.  Otherwise, it would
4304   % insert a valid breakpoint between:
4305   %   @section sec-whatever
4306   %   @deffn def-whatever
4307   \nobreak
4308 }
4309
4310
4311 \message{toc,}
4312 % Table of contents.
4313 \newwrite\tocfile
4314
4315 % Write an entry to the toc file, opening it if necessary.
4316 % Called from @chapter, etc.  
4317
4318 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4319 % We append the current node name (if any) and page number as additional
4320 % arguments for the \{chap,sec,...}entry macros which will eventually
4321 % read this.  The node name is used in the pdf outlines as the
4322 % destination to jump to.
4323
4324 % We open the .toc file for writing here instead of at @setfilename (or
4325 % any other fixed time) so that @contents can be anywhere in the document.
4326 % But if #1 is `omit', then we don't do anything.  This is used for the
4327 % table of contents chapter openings themselves.
4328 %
4329 \newif\iftocfileopened
4330 \def\omitkeyword{omit}%
4331 %
4332 \def\writetocentry#1#2#3{%
4333   \edef\writetoctype{#1}%
4334   \ifx\writetoctype\omitkeyword \else
4335     \iftocfileopened\else
4336       \immediate\openout\tocfile = \jobname.toc
4337       \global\tocfileopenedtrue
4338     \fi
4339     %
4340     \iflinks
4341       \toks0 = {#2}%
4342       \toks2 = \expandafter{\lastnode}%
4343       \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4344                                {\the\toks2}{\noexpand\folio}}}%
4345       \temp
4346     \fi
4347   \fi
4348   %
4349   % Tell \shipout to create a pdf destination on each page, if we're
4350   % writing pdf.  These are used in the table of contents.  We can't
4351   % just write one on every page because the title pages are numbered
4352   % 1 and 2 (the page numbers aren't printed), and so are the first
4353   % two pages of the document.  Thus, we'd have two destinations named
4354   % `1', and two named `2'.
4355   \ifpdf \global\pdfmakepagedesttrue \fi
4356 }
4357
4358 \newskip\contentsrightmargin \contentsrightmargin=1in
4359 \newcount\savepageno
4360 \newcount\lastnegativepageno \lastnegativepageno = -1
4361
4362 % Prepare to read what we've written to \tocfile.
4363 %
4364 \def\startcontents#1{%
4365   % If @setchapternewpage on, and @headings double, the contents should
4366   % start on an odd page, unlike chapters.  Thus, we maintain
4367   % \contentsalignmacro in parallel with \pagealignmacro.
4368   % From: Torbjorn Granlund <tege@matematik.su.se>
4369   \contentsalignmacro
4370   \immediate\closeout\tocfile
4371   %
4372   % Don't need to put `Contents' or `Short Contents' in the headline.
4373   % It is abundantly clear what they are.
4374   \def\thischapter{}%
4375   \chapmacro{#1}{Yomitfromtoc}{}%
4376   %
4377   \savepageno = \pageno
4378   \begingroup                  % Set up to handle contents files properly.
4379     \catcode`\\=0  \catcode`\{=1  \catcode`\}=2  \catcode`\@=11
4380     % We can't do this, because then an actual ^ in a section
4381     % title fails, e.g., @chapter ^ -- exponentiation.  --karl, 9jul97.
4382     %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4383     \raggedbottom             % Worry more about breakpoints than the bottom.
4384     \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4385     %
4386     % Roman numerals for page numbers.
4387     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4388 }
4389
4390
4391 % Normal (long) toc.
4392 \def\contents{%
4393   \startcontents{\putwordTOC}%
4394     \openin 1 \jobname.toc
4395     \ifeof 1 \else
4396       \input \jobname.toc
4397     \fi
4398     \vfill \eject
4399     \contentsalignmacro % in case @setchapternewpage odd is in effect
4400     \ifeof 1 \else
4401       \pdfmakeoutlines
4402     \fi
4403     \closein 1
4404   \endgroup
4405   \lastnegativepageno = \pageno
4406   \global\pageno = \savepageno
4407 }
4408
4409 % And just the chapters.
4410 \def\summarycontents{%
4411   \startcontents{\putwordShortTOC}%
4412     %
4413     \let\numchapentry = \shortchapentry
4414     \let\appentry = \shortchapentry
4415     \let\unnchapentry = \shortunnchapentry
4416     % We want a true roman here for the page numbers.
4417     \secfonts
4418     \let\rm=\shortcontrm \let\bf=\shortcontbf
4419     \let\sl=\shortcontsl \let\tt=\shortconttt
4420     \rm
4421     \hyphenpenalty = 10000
4422     \advance\baselineskip by 1pt % Open it up a little.
4423     \def\numsecentry##1##2##3##4{}
4424     \let\appsecentry = \numsecentry
4425     \let\unnsecentry = \numsecentry
4426     \let\numsubsecentry = \numsecentry
4427     \let\appsubsecentry = \numsecentry
4428     \let\unnsubsecentry = \numsecentry
4429     \let\numsubsubsecentry = \numsecentry
4430     \let\appsubsubsecentry = \numsecentry
4431     \let\unnsubsubsecentry = \numsecentry
4432     \openin 1 \jobname.toc
4433     \ifeof 1 \else
4434       \input \jobname.toc
4435     \fi
4436     \closein 1
4437     \vfill \eject
4438     \contentsalignmacro % in case @setchapternewpage odd is in effect
4439   \endgroup
4440   \lastnegativepageno = \pageno
4441   \global\pageno = \savepageno
4442 }
4443 \let\shortcontents = \summarycontents
4444
4445 % Typeset the label for a chapter or appendix for the short contents.
4446 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4447 %
4448 \def\shortchaplabel#1{%
4449   % This space should be enough, since a single number is .5em, and the
4450   % widest letter (M) is 1em, at least in the Computer Modern fonts.
4451   % But use \hss just in case.
4452   % (This space doesn't include the extra space that gets added after
4453   % the label; that gets put in by \shortchapentry above.)
4454   % 
4455   % We'd like to right-justify chapter numbers, but that looks strange
4456   % with appendix letters.  And right-justifying numbers and
4457   % left-justifying letters looks strange when there is less than 10
4458   % chapters.  Have to read the whole toc once to know how many chapters
4459   % there are before deciding ...
4460   \hbox to 1em{#1\hss}%
4461 }
4462
4463 % These macros generate individual entries in the table of contents.
4464 % The first argument is the chapter or section name.
4465 % The last argument is the page number.
4466 % The arguments in between are the chapter number, section number, ...
4467
4468 % Chapters, in the main contents.
4469 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4470 %
4471 % Chapters, in the short toc.
4472 % See comments in \dochapentry re vbox and related settings.
4473 \def\shortchapentry#1#2#3#4{%
4474   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4475 }
4476
4477 % Appendices, in the main contents.
4478 % Need the word Appendix, and a fixed-size box.
4479
4480 \def\appendixbox#1{%
4481   % We use M since it's probably the widest letter.
4482   \setbox0 = \hbox{\putwordAppendix{} M}%
4483   \hbox to \wd0{\putwordAppendix{} #1\hss}}
4484 %
4485 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4486
4487 % Unnumbered chapters.
4488 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4489 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4490
4491 % Sections.
4492 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4493 \let\appsecentry=\numsecentry
4494 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4495
4496 % Subsections.
4497 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4498 \let\appsubsecentry=\numsubsecentry
4499 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4500
4501 % And subsubsections.
4502 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4503 \let\appsubsubsecentry=\numsubsubsecentry
4504 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4505
4506 % This parameter controls the indentation of the various levels.
4507 % Same as \defaultparindent.
4508 \newdimen\tocindent \tocindent = 15pt
4509
4510 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4511 % page number.
4512 %
4513 % If the toc has to be broken over pages, we want it to be at chapters
4514 % if at all possible; hence the \penalty.
4515 \def\dochapentry#1#2{%
4516    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4517    \begingroup
4518      \chapentryfonts
4519      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4520    \endgroup
4521    \nobreak\vskip .25\baselineskip plus.1\baselineskip
4522 }
4523
4524 \def\dosecentry#1#2{\begingroup
4525   \secentryfonts \leftskip=\tocindent
4526   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4527 \endgroup}
4528
4529 \def\dosubsecentry#1#2{\begingroup
4530   \subsecentryfonts \leftskip=2\tocindent
4531   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4532 \endgroup}
4533
4534 \def\dosubsubsecentry#1#2{\begingroup
4535   \subsubsecentryfonts \leftskip=3\tocindent
4536   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4537 \endgroup}
4538
4539 % We use the same \entry macro as for the index entries.
4540 \let\tocentry = \entry
4541
4542 % Space between chapter (or whatever) number and the title.
4543 \def\labelspace{\hskip1em \relax}
4544
4545 \def\dopageno#1{{\rm #1}}
4546 \def\doshortpageno#1{{\rm #1}}
4547
4548 \def\chapentryfonts{\secfonts \rm}
4549 \def\secentryfonts{\textfonts}
4550 \def\subsecentryfonts{\textfonts}
4551 \def\subsubsecentryfonts{\textfonts}
4552
4553
4554 \message{environments,}
4555 % @foo ... @end foo.
4556
4557 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4558 %
4559 % Since these characters are used in examples, it should be an even number of
4560 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4561 %
4562 \def\point{$\star$}
4563 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4564 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4565 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4566 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4567
4568 % The @error{} command.
4569 % Adapted from the TeXbook's \boxit.
4570 %
4571 \newbox\errorbox
4572 %
4573 {\tentt \global\dimen0 = 3em}% Width of the box.
4574 \dimen2 = .55pt % Thickness of rules
4575 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4576 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4577 %
4578 \setbox\errorbox=\hbox to \dimen0{\hfil
4579    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4580    \advance\hsize by -2\dimen2 % Rules.
4581    \vbox{%
4582       \hrule height\dimen2
4583       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
4584          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4585          \kern3pt\vrule width\dimen2}% Space to right.
4586       \hrule height\dimen2}
4587     \hfil}
4588 %
4589 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4590
4591 % @tex ... @end tex    escapes into raw Tex temporarily.
4592 % One exception: @ is still an escape character, so that @end tex works.
4593 % But \@ or @@ will get a plain tex @ character.
4594
4595 \envdef\tex{%
4596   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4597   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4598   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4599   \catcode `\%=14
4600   \catcode `\+=\other
4601   \catcode `\"=\other
4602   \catcode `\|=\other
4603   \catcode `\<=\other
4604   \catcode `\>=\other
4605   \escapechar=`\\
4606   %
4607   \let\b=\ptexb
4608   \let\bullet=\ptexbullet
4609   \let\c=\ptexc
4610   \let\,=\ptexcomma
4611   \let\.=\ptexdot
4612   \let\dots=\ptexdots
4613   \let\equiv=\ptexequiv
4614   \let\!=\ptexexclam
4615   \let\i=\ptexi
4616   \let\indent=\ptexindent
4617   \let\noindent=\ptexnoindent
4618   \let\{=\ptexlbrace
4619   \let\+=\tabalign
4620   \let\}=\ptexrbrace
4621   \let\/=\ptexslash
4622   \let\*=\ptexstar
4623   \let\t=\ptext
4624   %
4625   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4626   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4627   \def\@{@}%
4628 }
4629 % There is no need to define \Etex.
4630
4631 % Define @lisp ... @end lisp.
4632 % @lisp environment forms a group so it can rebind things,
4633 % including the definition of @end lisp (which normally is erroneous).
4634
4635 % Amount to narrow the margins by for @lisp.
4636 \newskip\lispnarrowing \lispnarrowing=0.4in
4637
4638 % This is the definition that ^^M gets inside @lisp, @example, and other
4639 % such environments.  \null is better than a space, since it doesn't
4640 % have any width.
4641 \def\lisppar{\null\endgraf}
4642
4643 % This space is always present above and below environments.
4644 \newskip\envskipamount \envskipamount = 0pt
4645
4646 % Make spacing and below environment symmetrical.  We use \parskip here
4647 % to help in doing that, since in @example-like environments \parskip
4648 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4649 % start of the next paragraph will insert \parskip.
4650 %
4651 \def\aboveenvbreak{{%
4652   % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4653   \ifnum \lastpenalty=10000 \else
4654     \advance\envskipamount by \parskip
4655     \endgraf
4656     \ifdim\lastskip<\envskipamount
4657       \removelastskip
4658       % it's not a good place to break if the last penalty was \nobreak
4659       % or better ...
4660       \ifnum\lastpenalty<10000 \penalty-50 \fi
4661       \vskip\envskipamount
4662     \fi
4663   \fi
4664 }}
4665
4666 \let\afterenvbreak = \aboveenvbreak
4667
4668 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
4669 \let\nonarrowing=\relax
4670
4671 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4672 % environment contents.
4673 \font\circle=lcircle10
4674 \newdimen\circthick
4675 \newdimen\cartouter\newdimen\cartinner
4676 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4677 \circthick=\fontdimen8\circle
4678 %
4679 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4680 \def\ctr{{\hskip 6pt\circle\char'010}}
4681 \def\cbl{{\circle\char'012\hskip -6pt}}
4682 \def\cbr{{\hskip 6pt\circle\char'011}}
4683 \def\carttop{\hbox to \cartouter{\hskip\lskip
4684         \ctl\leaders\hrule height\circthick\hfil\ctr
4685         \hskip\rskip}}
4686 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4687         \cbl\leaders\hrule height\circthick\hfil\cbr
4688         \hskip\rskip}}
4689 %
4690 \newskip\lskip\newskip\rskip
4691
4692 \envdef\cartouche{%
4693   \ifhmode\par\fi  % can't be in the midst of a paragraph.
4694   \startsavinginserts
4695   \lskip=\leftskip \rskip=\rightskip
4696   \leftskip=0pt\rightskip=0pt % we want these *outside*.
4697   \cartinner=\hsize \advance\cartinner by-\lskip
4698   \advance\cartinner by-\rskip
4699   \cartouter=\hsize
4700   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
4701                                 % side, and for 6pt waste from
4702                                 % each corner char, and rule thickness
4703   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4704   % Flag to tell @lisp, etc., not to narrow margin.
4705   \let\nonarrowing=\comment
4706   \vbox\bgroup
4707       \baselineskip=0pt\parskip=0pt\lineskip=0pt
4708       \carttop
4709       \hbox\bgroup
4710           \hskip\lskip
4711           \vrule\kern3pt
4712           \vbox\bgroup
4713               \kern3pt
4714               \hsize=\cartinner
4715               \baselineskip=\normbskip
4716               \lineskip=\normlskip
4717               \parskip=\normpskip
4718               \vskip -\parskip
4719               \comment % For explanation, see the end of \def\group.
4720 }
4721 \def\Ecartouche{%
4722               \ifhmode\par\fi
4723               \kern3pt
4724           \egroup
4725           \kern3pt\vrule
4726           \hskip\rskip
4727       \egroup
4728       \cartbot
4729   \egroup
4730   \checkinserts
4731 }
4732
4733
4734 % This macro is called at the beginning of all the @example variants,
4735 % inside a group.
4736 \def\nonfillstart{%
4737   \aboveenvbreak
4738   \hfuzz = 12pt % Don't be fussy
4739   \sepspaces % Make spaces be word-separators rather than space tokens.
4740   \let\par = \lisppar % don't ignore blank lines
4741   \obeylines % each line of input is a line of output
4742   \parskip = 0pt
4743   \parindent = 0pt
4744   \emergencystretch = 0pt % don't try to avoid overfull boxes
4745   % @cartouche defines \nonarrowing to inhibit narrowing
4746   % at next level down.
4747   \ifx\nonarrowing\relax
4748     \advance \leftskip by \lispnarrowing
4749     \exdentamount=\lispnarrowing
4750   \fi
4751   \let\exdent=\nofillexdent
4752 }
4753
4754 % If you want all examples etc. small: @set dispenvsize small.
4755 % If you want even small examples the full size: @set dispenvsize nosmall.
4756 % This affects the following displayed environments:
4757 %    @example, @display, @format, @lisp
4758 %
4759 \def\smallword{small}
4760 \def\nosmallword{nosmall}
4761 \let\SETdispenvsize\relax
4762 \def\setnormaldispenv{%
4763   \ifx\SETdispenvsize\smallword
4764     \smallexamplefonts \rm
4765   \fi
4766 }
4767 \def\setsmalldispenv{%
4768   \ifx\SETdispenvsize\nosmallword
4769   \else
4770     \smallexamplefonts \rm
4771   \fi
4772 }
4773
4774 % We often define two environments, @foo and @smallfoo.
4775 % Let's do it by one command:
4776 \def\makedispenv #1#2{
4777   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4778   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
4779   \expandafter\let\csname E#1\endcsname \afterenvbreak
4780   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
4781 }
4782
4783 % Define two synonyms:
4784 \def\maketwodispenvs #1#2#3{
4785   \makedispenv{#1}{#3}
4786   \makedispenv{#2}{#3}
4787 }
4788
4789 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4790 %
4791 % @smallexample and @smalllisp: use smaller fonts.
4792 % Originally contributed by Pavel@xerox.
4793 %
4794 \maketwodispenvs {lisp}{example}{%
4795   \nonfillstart
4796   \tt
4797   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4798   \gobble       % eat return
4799 }
4800
4801 % @display/@smalldisplay: same as @lisp except keep current font.
4802 %
4803 \makedispenv {display}{%
4804   \nonfillstart
4805   \gobble
4806 }
4807
4808 % @format/@smallformat: same as @display except don't narrow margins.
4809 %
4810 \makedispenv{format}{%
4811   \let\nonarrowing = t%
4812   \nonfillstart
4813   \gobble
4814 }
4815
4816 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4817 \envdef\flushleft{%
4818   \let\nonarrowing = t%
4819   \nonfillstart
4820   \gobble
4821 }
4822 \let\Eflushleft = \afterenvbreak
4823
4824 % @flushright.
4825 %
4826 \envdef\flushright{%
4827   \let\nonarrowing = t%
4828   \nonfillstart
4829   \advance\leftskip by 0pt plus 1fill
4830   \gobble
4831 }
4832 \let\Eflushright = \afterenvbreak
4833
4834
4835 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4836 % and narrows the margins.
4837 %
4838 \envdef\quotation{%
4839   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4840   \parindent=0pt
4841   %
4842   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4843   \ifx\nonarrowing\relax
4844     \advance\leftskip by \lispnarrowing
4845     \advance\rightskip by \lispnarrowing
4846     \exdentamount = \lispnarrowing
4847     \let\nonarrowing = \relax
4848   \fi
4849   \parsearg\quotationlabel
4850 }
4851
4852 % We have retained a nonzero parskip for the environment, since we're
4853 % doing normal filling. So to avoid extra space below the environment...
4854 \def\Equotation{\parskip = 0pt \afterenvbreak}
4855
4856 % If we're given an argument, typeset it in bold with a colon after.
4857 \def\quotationlabel#1{%
4858   \def\temp{#1}%
4859   \ifx\temp\empty \else
4860     {\bf #1: }%
4861   \fi
4862 }
4863
4864
4865 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4866 % If we want to allow any <char> as delimiter,
4867 % we need the curly braces so that makeinfo sees the @verb command, eg:
4868 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
4869 %
4870 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
4871 %
4872 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4873 % active too.  Otherwise, they get lost as the first character on a
4874 % verbatim line.
4875 \def\dospecials{%
4876   \do\ \do\\\do\{\do\}\do\$\do\&%
4877   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4878   \do\<\do\>\do\|\do\@\do+\do\"%
4879 }
4880 %
4881 % [Knuth] p. 380
4882 \def\uncatcodespecials{%
4883   \def\do##1{\catcode`##1=\other}\dospecials}
4884 %
4885 % [Knuth] pp. 380,381,391
4886 % Disable Spanish ligatures ?` and !` of \tt font
4887 \begingroup
4888   \catcode`\`=\active\gdef`{\relax\lq}
4889 \endgroup
4890 %
4891 % Setup for the @verb command.
4892 %
4893 % Eight spaces for a tab
4894 \begingroup
4895   \catcode`\^^I=\active
4896   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4897 \endgroup
4898 %
4899 \def\setupverb{%
4900   \tt  % easiest (and conventionally used) font for verbatim
4901   \def\par{\leavevmode\endgraf}%
4902   \catcode`\`=\active
4903   \tabeightspaces
4904   % Respect line breaks,
4905   % print special symbols as themselves, and
4906   % make each space count
4907   % must do in this order:
4908   \obeylines \uncatcodespecials \sepspaces
4909 }
4910
4911 % Setup for the @verbatim environment
4912 %
4913 % Real tab expansion
4914 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4915 %
4916 \def\starttabbox{\setbox0=\hbox\bgroup}
4917 \begingroup
4918   \catcode`\^^I=\active
4919   \gdef\tabexpand{%
4920     \catcode`\^^I=\active
4921     \def^^I{\leavevmode\egroup
4922       \dimen0=\wd0 % the width so far, or since the previous tab
4923       \divide\dimen0 by\tabw
4924       \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4925       \advance\dimen0 by\tabw  % advance to next multiple of \tabw
4926       \wd0=\dimen0 \box0 \starttabbox
4927     }%
4928   }
4929 \endgroup
4930 \def\setupverbatim{%
4931   \nonfillstart
4932   \advance\leftskip by -\defbodyindent
4933   % Easiest (and conventionally used) font for verbatim
4934   \tt
4935   \def\par{\leavevmode\egroup\box0\endgraf}%
4936   \catcode`\`=\active
4937   \tabexpand
4938   % Respect line breaks,
4939   % print special symbols as themselves, and
4940   % make each space count
4941   % must do in this order:
4942   \obeylines \uncatcodespecials \sepspaces
4943   \everypar{\starttabbox}%
4944 }
4945
4946 % Do the @verb magic: verbatim text is quoted by unique
4947 % delimiter characters.  Before first delimiter expect a
4948 % right brace, after last delimiter expect closing brace:
4949 %
4950 %    \def\doverb'{'<char>#1<char>'}'{#1}
4951 %
4952 % [Knuth] p. 382; only eat outer {}
4953 \begingroup
4954   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
4955   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4956 \endgroup
4957 %
4958 \def\verb{\begingroup\setupverb\doverb}
4959 %
4960 %
4961 % Do the @verbatim magic: define the macro \doverbatim so that
4962 % the (first) argument ends when '@end verbatim' is reached, ie:
4963 %
4964 %     \def\doverbatim#1@end verbatim{#1}
4965 %
4966 % For Texinfo it's a lot easier than for LaTeX,
4967 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4968 % we need not redefine '\', '{' and '}'.
4969 %
4970 % Inspired by LaTeX's verbatim command set [latex.ltx]
4971 %
4972 \begingroup
4973   \catcode`\ =\active
4974   \obeylines %
4975   % ignore everything up to the first ^^M, that's the newline at the end
4976   % of the @verbatim input line itself.  Otherwise we get an extra blank
4977   % line in the output.
4978   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
4979   % We really want {...\end verbatim} in the body of the macro, but
4980   % without the active space; thus we have to use \xdef and \gobble.
4981 \endgroup
4982 %
4983 \envdef\verbatim{%
4984     \setupverbatim\doverbatim
4985 }
4986 \let\Everbatim = \afterenvbreak
4987
4988
4989 % @verbatiminclude FILE - insert text of file in verbatim environment.
4990 %
4991 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
4992 %
4993 \def\doverbatiminclude#1{%
4994   {%
4995     \makevalueexpandable
4996     \setupverbatim
4997     \input #1
4998     \afterenvbreak
4999   }%
5000 }
5001
5002 % @copying ... @end copying.
5003 % Save the text away for @insertcopying later.  Many commands won't be
5004 % allowed in this context, but that's ok.
5005 %
5006 % We save the uninterpreted tokens, rather than creating a box.
5007 % Saving the text in a box would be much easier, but then all the
5008 % typesetting commands (@smallbook, font changes, etc.) have to be done
5009 % beforehand -- and a) we want @copying to be done first in the source
5010 % file; b) letting users define the frontmatter in as flexible order as
5011 % possible is very desirable.
5012 %
5013 \def\copying{\begingroup
5014   % Define a command to swallow text until we reach `@end copying'.
5015   % \ is the escape char in this texinfo.tex file, so it is the
5016   % delimiter for the command; @ will be the escape char when we read
5017   % it, but that doesn't matter.
5018   \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
5019   %
5020   % We must preserve ^^M's in the input file; see \insertcopying below.
5021   \catcode`\^^M = \active
5022   \docopying
5023 }
5024
5025 % What we do to finish off the copying text.
5026 %
5027 \def\enddocopying{\endgroup\ignorespaces}
5028
5029 % @insertcopying.  Here we must play games with ^^M's.  On the one hand,
5030 % we need them to delimit commands such as `@end quotation', so they
5031 % must be active.  On the other hand, we certainly don't want every
5032 % end-of-line to be a \par, as would happen with the normal active
5033 % definition of ^^M.  On the third hand, two ^^M's in a row should still
5034 % generate a \par.
5035 %
5036 % Our approach is to make ^^M insert a space and a penalty1 normally;
5037 % then it can also check if \lastpenalty=1.  If it does, then manually
5038 % do \par.
5039 %
5040 % This messes up the normal definitions of @c[omment], so we redefine
5041 % it.  Similarly for @ignore.  (These commands are used in the gcc
5042 % manual for man page generation.)
5043 %
5044 % Seems pretty fragile, most line-oriented commands will presumably
5045 % fail, but for the limited use of getting the copying text (which
5046 % should be quite simple) inserted, we can hope it's ok.
5047 %
5048 {\catcode`\^^M=\active %
5049 \gdef\insertcopying{\begingroup %
5050   \parindent = 0pt  % looks wrong on title page
5051   \def^^M{%
5052     \ifnum \lastpenalty=1 %
5053       \par %
5054     \else %
5055       \space \penalty 1 %
5056     \fi %
5057   }%
5058   %
5059   % Fix @c[omment] for catcode 13 ^^M's.
5060   \def\c##1^^M{\ignorespaces}%
5061   \let\comment = \c %
5062   %
5063   % Don't bother jumping through all the hoops that \doignore does, it
5064   % would be very hard since the catcodes are already set.
5065   \long\def\ignore##1\end ignore{\ignorespaces}%
5066   %
5067   \copyingtext %
5068 \endgroup}%
5069 }
5070
5071 \message{defuns,}
5072 % @defun etc.
5073
5074 \newskip\defbodyindent \defbodyindent=.4in
5075 \newskip\defargsindent \defargsindent=50pt
5076 \newskip\deflastargmargin \deflastargmargin=18pt
5077
5078 % Start the processing of @deffn:
5079 \def\startdefun{%
5080   \ifnum\lastpenalty<10000
5081     \medbreak
5082   \else
5083     % If there are two @def commands in a row, we'll have a \nobreak,
5084     % which is there to keep the function description together with its
5085     % header.  But if there's nothing but headers, we need to allow a
5086     % break somewhere.  Check for penalty 10002 (inserted by
5087     % \defargscommonending) instead of 10000, since the sectioning
5088     % commands insert a \penalty10000, and we don't want to allow a break
5089     % between a section heading and a defun.
5090     \ifnum\lastpenalty=10002 \penalty2000 \fi
5091     %
5092     % Similarly, after a section heading, do not allow a break.
5093     % But do insert the glue.
5094     \medskip  % preceded by discardable penalty, so not a breakpoint
5095   \fi
5096   %
5097   \parindent=0in
5098   \advance\leftskip by \defbodyindent
5099   \exdentamount=\defbodyindent
5100 }
5101
5102 \def\dodefunx#1{%
5103   % First, check whether we are in the right environment:
5104   \checkenv#1%
5105   %
5106   % As above, allow line break if we have multiple x headers in a row.
5107   % It's not a great place, though.
5108   \ifnum\lastpenalty=10002 \penalty3000 \fi
5109   %
5110   % And now, it's time to reuse the body of the original defun:
5111   \expandafter\gobbledefun#1%
5112 }
5113 \def\gobbledefun#1\startdefun{}
5114
5115 % \printdefunline \deffnheader{text}
5116 %
5117 \def\printdefunline#1#2{%
5118   \begingroup
5119     % call \deffnheader:
5120     #1#2 \endheader
5121     % common ending:
5122     \interlinepenalty = 10000
5123     \advance\rightskip by 0pt plus 1fil
5124     \endgraf
5125     \nobreak\vskip -\parskip
5126     \penalty 10002  % signal to \startdefun and \dodefunx
5127     % Some of the @defun-type tags do not enable magic parentheses,
5128     % rendering the following check redundant.  But we don't optimize.
5129     \checkparencounts
5130   \endgroup
5131 }
5132
5133 \def\Edefun{\endgraf\medbreak}
5134
5135 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5136 % the only thing remainnig is to define \deffnheader.
5137 %
5138 \def\makedefun#1{%
5139   \expandafter\let\csname E#1\endcsname = \Edefun
5140   \edef\temp{\noexpand\domakedefun
5141     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5142   \temp
5143 }
5144
5145 % \domakedefun \deffn \deffnx \deffnheader
5146 %
5147 % Define \deffn and \deffnx, without parameters.
5148 % \deffnheader has to be defined explicitly.
5149 %
5150 \def\domakedefun#1#2#3{%
5151   \envdef#1{%
5152     \startdefun
5153     \parseargusing\activeparens{\printdefunline#3}%
5154   }%
5155   \def#2{\dodefunx#1}%
5156   \def#3%
5157 }
5158
5159 %%% Untyped functions:
5160
5161 % @deffn category name args
5162 \makedefun{deffn}{\deffngeneral{}}
5163
5164 % @deffn category class name args
5165 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5166
5167 % \defopon {category on}class name args
5168 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5169
5170 % \deffngeneral {subind}category name args
5171 %
5172 \def\deffngeneral#1#2 #3 #4\endheader{%
5173   % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5174   \dosubind{fn}{\code{#3}}{#1}%
5175   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5176 }
5177
5178 %%% Typed functions:
5179
5180 % @deftypefn category type name args
5181 \makedefun{deftypefn}{\deftypefngeneral{}}
5182
5183 % @deftypeop category class type name args
5184 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5185
5186 % \deftypeopon {category on}class type name args
5187 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5188
5189 % \deftypefngeneral {subind}category type name args
5190 %
5191 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5192   \dosubind{fn}{\code{#4}}{#1}%
5193   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5194 }
5195
5196 %%% Typed variables:
5197
5198 % @deftypevr category type var args
5199 \makedefun{deftypevr}{\deftypecvgeneral{}}
5200
5201 % @deftypecv category class type var args
5202 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5203
5204 % \deftypecvof {category of}class type var args
5205 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5206
5207 % \deftypecvgeneral {subind}category type var args
5208 %
5209 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5210   \dosubind{vr}{\code{#4}}{#1}%
5211   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5212 }
5213
5214 %%% Untyped variables:
5215
5216 % @defvr category var args
5217 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5218
5219 % @defcv category class var args
5220 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5221
5222 % \defcvof {category of}class var args
5223 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5224
5225 %%% Type:
5226 % @deftp category name args
5227 \makedefun{deftp}#1 #2 #3\endheader{%
5228   \doind{tp}{\code{#2}}%
5229   \defname{#1}{}{#2}\defunargs{#3\unskip}%
5230 }
5231
5232 % Remaining @defun-like shortcuts:
5233 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5234 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5235 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5236 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5237 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5238 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5239 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5240 \makedefun{defmethod}{\defopon\putwordMethodon}
5241 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5242 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5243 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5244
5245 % \defname, which formats the name of the @def (not the args).
5246 % #1 is the category, such as "Function".
5247 % #2 is the return type, if any.
5248 % #3 is the function name.
5249
5250 % We are followed by (but not passed) the arguments, if any.
5251 %
5252 \def\defname#1#2#3{%
5253   % Get the values of \leftskip and \rightskip as they were outside the @def...
5254   \advance\leftskip by -\defbodyindent
5255   %
5256   % How we'll format the type name.  Putting it in brackets helps
5257   % distinguish it from the body text that may end up on the next line
5258   % just below it.
5259   \def\temp{#1}%
5260   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5261   %
5262   % Figure out line sizes for the paragraph shape.
5263   % The first line needs space for \box0; but if \rightskip is nonzero,
5264   % we need only space for the part of \box0 which exceeds it:
5265   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
5266   % The continuations:
5267   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
5268   % (plain.tex says that \dimen1 should be used only as global.)
5269   \parshape 2 0in \dimen0 \defargsindent \dimen2
5270   %
5271   % Put the type name to the right margin.
5272   \noindent
5273   \hbox to 0pt{%
5274     \hfil\box0 \kern-\hsize
5275     % \hsize has to be shortened this way:
5276     \kern\leftskip
5277     % Intentionally do not respect \rightskip, since we need the space.
5278   }%
5279   %
5280   % Allow all lines to be underfull without complaint:
5281   \tolerance=10000 \hbadness=10000
5282   \exdentamount=\defbodyindent
5283   {%
5284     % defun fonts. We use typewriter by default (used to be bold) because:
5285     % . we're printing identifiers, they should be in tt in principle.
5286     % . in languages with many accents, such as Czech or French, it's
5287     %   common to leave accents off identifiers.  The result looks ok in
5288     %   tt, but exceedingly strange in rm.
5289     % . we don't want -- and --- to be treated as ligatures.
5290     % . this still does not fix the ?` and !` ligatures, but so far no
5291     %   one has made identifiers using them :).
5292     \df \tt
5293     \def\temp{#2}% return value type
5294     \ifx\temp\empty\else \tclose{\temp} \fi
5295     #3% output function name
5296   }%
5297   {\rm\enskip}% hskip 0.5 em of \tenrm
5298   %
5299   \boldbrax
5300   % arguments will be output next, if any.
5301 }
5302
5303 % Print arguments in slanted typewriter, prevent hyphenation at `-' chars.
5304
5305 \def\defunargs#1{%
5306   % use sl by default (not ttsl), inconsistently with using tt for the
5307   % name.  This is because literal text is sometimes needed in the
5308   % argument list (groff manual), and ttsl and tt are not very
5309   % distinguishable.
5310   % tt for the names.
5311   \df \sl \hyphenchar\font=0
5312   % On the other hand, if an argument has two dashes (for instance), we
5313   % want a way to get ttsl.  Let's try @var for that.
5314   \let\var=\ttslanted
5315   #1%
5316   \sl\hyphenchar\font=45
5317 }
5318
5319 % We want ()&[] to print specially on the defun line.
5320 %
5321 \def\activeparens{%
5322   \catcode`\(=\active \catcode`\)=\active
5323   \catcode`\[=\active \catcode`\]=\active
5324   \catcode`\&=\active
5325 }
5326
5327 % Make control sequences which act like normal parenthesis chars.
5328 \let\lparen = ( \let\rparen = )
5329
5330 % Be sure that we always have a definition for `(', etc.  For example,
5331 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5332 % so TeX would otherwise complain about undefined control sequence.
5333 {
5334   \activeparens
5335   \global\let(=\lparen \global\let)=\rparen
5336   \global\let[=\lbrack \global\let]=\rbrack
5337   \global\let& = \&
5338
5339   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5340   \gdef\magicamp{\let&=\amprm}
5341 }
5342
5343 \newcount\parencount
5344
5345 % If we encounter &foo, then turn on ()-hacking afterwards
5346 \newif\ifampseen
5347 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
5348
5349 \def\parenfont{%
5350   \ifampseen
5351     % At the first level, print parens in roman,
5352     % otherwise use the default font.
5353     \ifnum \parencount=1 \rm \fi
5354   \else
5355     % The \sf parens (in \boldbrax) actually are a little bolder than
5356     % the contained text.  This is especially needed for [ and ] .
5357     \sf
5358   \fi
5359 }
5360 \def\infirstlevel#1{%
5361   \ifampseen
5362     \ifnum\parencount=1
5363       #1%
5364     \fi
5365   \fi
5366 }
5367 \def\bfafterword#1 {#1 \bf}
5368
5369 \def\opnr{%
5370   \global\advance\parencount by 1
5371   {\parenfont(}%
5372   \infirstlevel \bfafterword
5373 }
5374 \def\clnr{%
5375   {\parenfont)}%
5376   \infirstlevel \sl
5377   \global\advance\parencount by -1
5378 }
5379
5380 \newcount\brackcount
5381 \def\lbrb{%
5382   \global\advance\brackcount by 1
5383   {\bf[}%
5384 }
5385 \def\rbrb{%
5386   {\bf]}%
5387   \global\advance\brackcount by -1
5388 }
5389
5390 \def\checkparencounts{%
5391   \ifnum\parencount=0 \else \badparencount \fi
5392   \ifnum\brackcount=0 \else \badbrackcount \fi
5393 }
5394 \def\badparencount{%
5395   \errmessage{Unbalanced parentheses in @def}%
5396   \global\parencount=0
5397 }
5398 \def\badbrackcount{%
5399   \errmessage{Unbalanced square braces in @def}%
5400   \global\brackcount=0
5401 }
5402
5403
5404 \message{macros,}
5405 % @macro.
5406
5407 % To do this right we need a feature of e-TeX, \scantokens,
5408 % which we arrange to emulate with a temporary file in ordinary TeX.
5409 \ifx\eTeXversion\undefined
5410   \newwrite\macscribble
5411   \def\scantokens#1{%
5412     \toks0={#1\endinput}%
5413     \immediate\openout\macscribble=\jobname.tmp
5414     \immediate\write\macscribble{\the\toks0}%
5415     \immediate\closeout\macscribble
5416     \input \jobname.tmp
5417   }
5418 \fi
5419
5420 \def\scanmacro#1{%
5421   \begingroup
5422     \newlinechar`\^^M
5423     \let\xeatspaces\eatspaces
5424     % Undo catcode changes of \startcontents and \doprintindex
5425     \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5426     % ... and \example
5427     \spaceisspace
5428     %
5429     % Append \endinput to make sure that TeX does not see the ending newline.
5430     %
5431     % I've verified that it is necessary both for e-TeX and for ordinary TeX
5432     %                                                   --kasal, 29nov03
5433     \scantokens{#1\endinput}%
5434   \endgroup
5435 }
5436
5437 \newcount\paramno   % Count of parameters
5438 \newtoks\macname    % Macro name
5439 \newif\ifrecursive  % Is it recursive?
5440 \def\macrolist{}    % List of all defined macros in the form
5441                     % \do\macro1\do\macro2...
5442
5443 % Utility routines.
5444 % This does \let #1 = #2, except with \csnames.
5445 \def\cslet#1#2{%
5446 \expandafter\expandafter
5447 \expandafter\let
5448 \expandafter\expandafter
5449 \csname#1\endcsname
5450 \csname#2\endcsname}
5451
5452 % Trim leading and trailing spaces off a string.
5453 % Concepts from aro-bend problem 15 (see CTAN).
5454 {\catcode`\@=11
5455 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5456 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5457 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5458 \def\unbrace#1{#1}
5459 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5460 }
5461
5462 % Trim a single trailing ^^M off a string.
5463 {\catcode`\^^M=\other \catcode`\Q=3%
5464 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5465 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5466 \gdef\eatcrb#1Q#2Q{#1}%
5467 }
5468
5469 % Macro bodies are absorbed as an argument in a context where
5470 % all characters are catcode 10, 11 or 12, except \ which is active
5471 % (as in normal texinfo). It is necessary to change the definition of \.
5472
5473 % It's necessary to have hard CRs when the macro is executed. This is
5474 % done by  making ^^M (\endlinechar) catcode 12 when reading the macro
5475 % body, and then making it the \newlinechar in \scanmacro.
5476
5477 \def\macrobodyctxt{%
5478   \catcode`\~=\other
5479   \catcode`\^=\other
5480   \catcode`\_=\other
5481   \catcode`\|=\other
5482   \catcode`\<=\other
5483   \catcode`\>=\other
5484   \catcode`\+=\other
5485   \catcode`\{=\other
5486   \catcode`\}=\other
5487   \catcode`\@=\other
5488   \catcode`\^^M=\other
5489   \usembodybackslash}
5490
5491 \def\macroargctxt{%
5492   \catcode`\~=\other
5493   \catcode`\^=\other
5494   \catcode`\_=\other
5495   \catcode`\|=\other
5496   \catcode`\<=\other
5497   \catcode`\>=\other
5498   \catcode`\+=\other
5499   \catcode`\@=\other
5500   \catcode`\\=\other}
5501
5502 % \mbodybackslash is the definition of \ in @macro bodies.
5503 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5504 % where N is the macro parameter number.
5505 % We define \csname macarg.\endcsname to be \realbackslash, so
5506 % \\ in macro replacement text gets you a backslash.
5507
5508 {\catcode`@=0 @catcode`@\=@active
5509  @gdef@usembodybackslash{@let\=@mbodybackslash}
5510  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5511 }
5512 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5513
5514 \def\macro{\recursivefalse\parsearg\macroxxx}
5515 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5516
5517 \def\macroxxx#1{%
5518   \getargs{#1}%           now \macname is the macname and \argl the arglist
5519   \ifx\argl\empty       % no arguments
5520      \paramno=0%
5521   \else
5522      \expandafter\parsemargdef \argl;%
5523   \fi
5524   \if1\csname ismacro.\the\macname\endcsname
5525      \message{Warning: redefining \the\macname}%
5526   \else
5527      \expandafter\ifx\csname \the\macname\endcsname \relax
5528      \else \errmessage{Macro name \the\macname\space already defined}\fi
5529      \global\cslet{macsave.\the\macname}{\the\macname}%
5530      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5531      % Add the macroname to \macrolist
5532      \toks0 = \expandafter{\macrolist\do}%
5533      \xdef\macrolist{\the\toks0
5534        \expandafter\noexpand\csname\the\macname\endcsname}%
5535   \fi
5536   \begingroup \macrobodyctxt
5537   \ifrecursive \expandafter\parsermacbody
5538   \else \expandafter\parsemacbody
5539   \fi}
5540
5541 \parseargdef\unmacro{%
5542   \if1\csname ismacro.#1\endcsname
5543     \global\cslet{#1}{macsave.#1}%
5544     \global\expandafter\let \csname ismacro.#1\endcsname=0%
5545     % Remove the macro name from \macrolist:
5546     \begingroup
5547       \expandafter\let\csname#1\endcsname \relax
5548       \let\do\unmacrodo
5549       \xdef\macrolist{\macrolist}%
5550     \endgroup
5551   \else
5552     \errmessage{Macro #1 not defined}%
5553   \fi
5554 }
5555
5556 % Called by \do from \dounmacro on each macro.  The idea is to omit any
5557 % macro definitions that have been changed to \relax.
5558 %
5559 \def\unmacrodo#1{%
5560   \ifx#1\relax
5561     % remove this
5562   \else
5563     \noexpand\do \noexpand #1%
5564   \fi
5565 }
5566
5567 % This makes use of the obscure feature that if the last token of a
5568 % <parameter list> is #, then the preceding argument is delimited by
5569 % an opening brace, and that opening brace is not consumed.
5570 \def\getargs#1{\getargsxxx#1{}}
5571 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5572 \def\getmacname #1 #2\relax{\macname={#1}}
5573 \def\getmacargs#1{\def\argl{#1}}
5574
5575 % Parse the optional {params} list.  Set up \paramno and \paramlist
5576 % so \defmacro knows what to do.  Define \macarg.blah for each blah
5577 % in the params list, to be ##N where N is the position in that list.
5578 % That gets used by \mbodybackslash (above).
5579
5580 % We need to get `macro parameter char #' into several definitions.
5581 % The technique used is stolen from LaTeX:  let \hash be something
5582 % unexpandable, insert that wherever you need a #, and then redefine
5583 % it to # just before using the token list produced.
5584 %
5585 % The same technique is used to protect \eatspaces till just before
5586 % the macro is used.
5587
5588 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5589         \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5590 \def\parsemargdefxxx#1,{%
5591   \if#1;\let\next=\relax
5592   \else \let\next=\parsemargdefxxx
5593     \advance\paramno by 1%
5594     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5595         {\xeatspaces{\hash\the\paramno}}%
5596     \edef\paramlist{\paramlist\hash\the\paramno,}%
5597   \fi\next}
5598
5599 % These two commands read recursive and nonrecursive macro bodies.
5600 % (They're different since rec and nonrec macros end differently.)
5601
5602 \long\def\parsemacbody#1@end macro%
5603 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5604 \long\def\parsermacbody#1@end rmacro%
5605 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5606
5607 % This defines the macro itself. There are six cases: recursive and
5608 % nonrecursive macros of zero, one, and many arguments.
5609 % Much magic with \expandafter here.
5610 % \xdef is used so that macro definitions will survive the file
5611 % they're defined in; @include reads the file inside a group.
5612 \def\defmacro{%
5613   \let\hash=##% convert placeholders to macro parameter chars
5614   \ifrecursive
5615     \ifcase\paramno
5616     % 0
5617       \expandafter\xdef\csname\the\macname\endcsname{%
5618         \noexpand\scanmacro{\temp}}%
5619     \or % 1
5620       \expandafter\xdef\csname\the\macname\endcsname{%
5621          \bgroup\noexpand\macroargctxt
5622          \noexpand\braceorline
5623          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5624       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5625          \egroup\noexpand\scanmacro{\temp}}%
5626     \else % many
5627       \expandafter\xdef\csname\the\macname\endcsname{%
5628          \bgroup\noexpand\macroargctxt
5629          \noexpand\csname\the\macname xx\endcsname}%
5630       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5631           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5632       \expandafter\expandafter
5633       \expandafter\xdef
5634       \expandafter\expandafter
5635         \csname\the\macname xxx\endcsname
5636           \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5637     \fi
5638   \else
5639     \ifcase\paramno
5640     % 0
5641       \expandafter\xdef\csname\the\macname\endcsname{%
5642         \noexpand\norecurse{\the\macname}%
5643         \noexpand\scanmacro{\temp}\egroup}%
5644     \or % 1
5645       \expandafter\xdef\csname\the\macname\endcsname{%
5646          \bgroup\noexpand\macroargctxt
5647          \noexpand\braceorline
5648          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5649       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5650         \egroup
5651         \noexpand\norecurse{\the\macname}%
5652         \noexpand\scanmacro{\temp}\egroup}%
5653     \else % many
5654       \expandafter\xdef\csname\the\macname\endcsname{%
5655          \bgroup\noexpand\macroargctxt
5656          \expandafter\noexpand\csname\the\macname xx\endcsname}%
5657       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5658           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5659       \expandafter\expandafter
5660       \expandafter\xdef
5661       \expandafter\expandafter
5662       \csname\the\macname xxx\endcsname
5663       \paramlist{%
5664           \egroup
5665           \noexpand\norecurse{\the\macname}%
5666           \noexpand\scanmacro{\temp}\egroup}%
5667     \fi
5668   \fi}
5669
5670 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5671
5672 % \braceorline decides whether the next nonwhitespace character is a
5673 % {.  If so it reads up to the closing }, if not, it reads the whole
5674 % line.  Whatever was read is then fed to the next control sequence
5675 % as an argument (by \parsebrace or \parsearg)
5676 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5677 \def\braceorlinexxx{%
5678   \ifx\nchar\bgroup\else
5679     \expandafter\parsearg
5680   \fi \next}
5681
5682 % We mant to disable all macros during \shipout so that they are not
5683 % expanded by \write.
5684 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5685   \edef\next{\macrolist}\expandafter\endgroup\next}
5686
5687
5688 % @alias.
5689 % We need some trickery to remove the optional spaces around the equal
5690 % sign.  Just make them active and then expand them all to nothing.
5691 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5692 \def\aliasxxx #1{\aliasyyy#1\relax}
5693 \def\aliasyyy #1=#2\relax{%
5694   {%
5695     \expandafter\let\obeyedspace=\empty
5696     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5697   }%
5698   \next
5699 }
5700
5701
5702 \message{cross references,}
5703
5704 \newwrite\auxfile
5705
5706 \newif\ifhavexrefs    % True if xref values are known.
5707 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
5708
5709 % @inforef is relatively simple.
5710 \def\inforef #1{\inforefzzz #1,,,,**}
5711 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5712   node \samp{\ignorespaces#1{}}}
5713
5714 % @node's only job in TeX is to define \lastnode, which is used in
5715 % cross-references.
5716 \parseargdef\node{\checkenv{}\nodexxx #1,\finishnodeparse}
5717 \def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5718 \let\nwnode=\node
5719 \let\lastnode=\empty
5720
5721 % Write a cross-reference definition for the current node.  #1 is the
5722 % type (Ynumbered, Yappendix, Ynothing).
5723
5724 \def\donoderef#1{%
5725   \ifx\lastnode\empty\else
5726     \setref{\lastnode}{#1}%
5727     \global\let\lastnode=\empty
5728   \fi
5729 }
5730
5731 % @anchor{NAME} -- define xref target at arbitrary point.
5732 %
5733 \newcount\savesfregister
5734 %
5735 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5736 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5737 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5738
5739 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5740 % anchor), which consists of three parts:
5741 % 1) NAME-title - the current sectioning name taken from \thissection,
5742 %                 or the anchor name.
5743 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
5744 %                 empty for anchors.
5745 % 3) NAME-pg    - the page number.
5746
5747 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
5748 % floats, there is an additional part, which is not written here:
5749 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
5750
5751 \def\setref#1#2{%
5752   \pdfmkdest{#1}%
5753   \iflinks
5754     {%
5755       \atdummies  % preserve commands, but don't expand them
5756       \turnoffactive
5757       \otherbackslash
5758       \edef\writexrdef##1##2{%
5759         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5760           ##1}{##2}}% these are parameters of \writexrdef
5761       }%
5762       \toks0 = \expandafter{\thissection}%
5763       \immediate \writexrdef{title}{\the\toks0 }%
5764       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5765       \writexrdef{pg}{\folio}% will be written later, during \shipout
5766     }%
5767   \fi
5768 }
5769
5770 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
5771 % the node name, #2 the name of the Info cross-reference, #3 the printed
5772 % node name, #4 the name of the Info file, #5 the name of the printed
5773 % manual.  All but the node name can be omitted.
5774 %
5775 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5776 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5777 \def\ref#1{\xrefX[#1,,,,,,,]}
5778 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5779   \unsepspaces
5780   \def\printedmanual{\ignorespaces #5}%
5781   \def\printedrefname{\ignorespaces #3}%
5782   \setbox1=\hbox{\printedmanual\unskip}%
5783   \setbox0=\hbox{\printedrefname\unskip}%
5784   \ifdim \wd0 = 0pt
5785     % No printed node name was explicitly given.
5786     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5787       % Use the node name inside the square brackets.
5788       \def\printedrefname{\ignorespaces #1}%
5789     \else
5790       % Use the actual chapter/section title appear inside
5791       % the square brackets.  Use the real section title if we have it.
5792       \ifdim \wd1 > 0pt
5793         % It is in another manual, so we don't have it.
5794         \def\printedrefname{\ignorespaces #1}%
5795       \else
5796         \ifhavexrefs
5797           % We know the real title if we have the xref values.
5798           \def\printedrefname{\refx{#1-title}{}}%
5799         \else
5800           % Otherwise just copy the Info node name.
5801           \def\printedrefname{\ignorespaces #1}%
5802         \fi%
5803       \fi
5804     \fi
5805   \fi
5806   %
5807   % Make link in pdf output.
5808   \ifpdf
5809     \leavevmode
5810     \getfilename{#4}%
5811     {\turnoffactive \otherbackslash
5812      \ifnum\filenamelength>0
5813        \startlink attr{/Border [0 0 0]}%
5814          goto file{\the\filename.pdf} name{#1}%
5815      \else
5816        \startlink attr{/Border [0 0 0]}%
5817          goto name{\pdfmkpgn{#1}}%
5818      \fi
5819     }%
5820     \linkcolor
5821   \fi
5822   %
5823   % Float references are printed completely differently: "Figure 1.2"
5824   % instead of "[somenode], p.3".  We distinguish them by the
5825   % LABEL-title being set to a magic string.
5826   {%
5827     % Have to otherify everything special to allow the \csname to
5828     % include an _ in the xref name, etc.
5829     \indexnofonts
5830     \turnoffactive
5831     \otherbackslash
5832     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5833       \csname XR#1-title\endcsname
5834   }%
5835   \iffloat\Xthisreftitle
5836     % If the user specified the print name (third arg) to the ref,
5837     % print it instead of our usual "Figure 1.2".
5838     \ifdim\wd0 = 0pt
5839       \refx{#1-snt}%
5840     \else
5841       \printedrefname
5842     \fi
5843     %
5844     % if the user also gave the printed manual name (fifth arg), append
5845     % "in MANUALNAME". 
5846     \ifdim \wd1 > 0pt
5847       \space \putwordin{} \cite{\printedmanual}%
5848     \fi
5849   \else
5850     % node/anchor (non-float) references.
5851     % 
5852     % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5853     % insert empty discretionaries after hyphens, which means that it will
5854     % not find a line break at a hyphen in a node names.  Since some manuals
5855     % are best written with fairly long node names, containing hyphens, this
5856     % is a loss.  Therefore, we give the text of the node name again, so it
5857     % is as if TeX is seeing it for the first time.
5858     \ifdim \wd1 > 0pt
5859       \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
5860     \else
5861       % _ (for example) has to be the character _ for the purposes of the
5862       % control sequence corresponding to the node, but it has to expand
5863       % into the usual \leavevmode...\vrule stuff for purposes of
5864       % printing. So we \turnoffactive for the \refx-snt, back on for the
5865       % printing, back off for the \refx-pg.
5866       {\turnoffactive \otherbackslash
5867        % Only output a following space if the -snt ref is nonempty; for
5868        % @unnumbered and @anchor, it won't be.
5869        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5870        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5871       }%
5872       % output the `[mynode]' via a macro so it can be overridden.
5873       \xrefprintnodename\printedrefname
5874       %
5875       % But we always want a comma and a space:
5876       ,\space
5877       %
5878       % output the `page 3'.
5879       \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5880     \fi
5881   \fi
5882   \endlink
5883 \endgroup}
5884
5885 % This macro is called from \xrefX for the `[nodename]' part of xref
5886 % output.  It's a separate macro only so it can be changed more easily,
5887 % since square brackets don't work well in some documents.  Particularly
5888 % one that Bob is working on :).
5889 %
5890 \def\xrefprintnodename#1{[#1]}
5891
5892 % Things referred to by \setref.
5893 %
5894 \def\Ynothing{}
5895 \def\Yomitfromtoc{}
5896 \def\Ynumbered{%
5897   \ifnum\secno=0
5898     \putwordChapter@tie \the\chapno
5899   \else \ifnum\subsecno=0
5900     \putwordSection@tie \the\chapno.\the\secno
5901   \else \ifnum\subsubsecno=0
5902     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5903   \else
5904     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5905   \fi\fi\fi
5906 }
5907 \def\Yappendix{%
5908   \ifnum\secno=0
5909      \putwordAppendix@tie @char\the\appendixno{}%
5910   \else \ifnum\subsecno=0
5911      \putwordSection@tie @char\the\appendixno.\the\secno
5912   \else \ifnum\subsubsecno=0
5913     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5914   \else
5915     \putwordSection@tie
5916       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5917   \fi\fi\fi
5918 }
5919
5920 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5921 % If its value is nonempty, SUFFIX is output afterward.
5922 %
5923 \def\refx#1#2{%
5924   {%
5925     \indexnofonts
5926     \otherbackslash
5927     \expandafter\global\expandafter\let\expandafter\thisrefX
5928       \csname XR#1\endcsname
5929   }%
5930   \ifx\thisrefX\relax
5931     % If not defined, say something at least.
5932     \angleleft un\-de\-fined\angleright
5933     \iflinks
5934       \ifhavexrefs
5935         \message{\linenumber Undefined cross reference `#1'.}%
5936       \else
5937         \ifwarnedxrefs\else
5938           \global\warnedxrefstrue
5939           \message{Cross reference values unknown; you must run TeX again.}%
5940         \fi
5941       \fi
5942     \fi
5943   \else
5944     % It's defined, so just use it.
5945     \thisrefX
5946   \fi
5947   #2% Output the suffix in any case.
5948 }
5949
5950 % This is the macro invoked by entries in the aux file.  Usually it's
5951 % just a \def (we prepend XR to the control sequence name to avoid
5952 % collisions).  But if this is a float type, we have more work to do.
5953 %
5954 \def\xrdef#1#2{%
5955   \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
5956   %
5957   % Was that xref control sequence that we just defined for a float?
5958   \expandafter\iffloat\csname XR#1\endcsname
5959     % it was a float, and we have the (safe) float type in \iffloattype.
5960     \expandafter\let\expandafter\floatlist
5961       \csname floatlist\iffloattype\endcsname
5962     % 
5963     % Is this the first time we've seen this float type?
5964     \expandafter\ifx\floatlist\relax
5965       \toks0 = {\do}% yes, so just \do
5966     \else
5967       % had it before, so preserve previous elements in list.
5968       \toks0 = \expandafter{\floatlist\do}%
5969     \fi
5970     %
5971     % Remember this xref in the control sequence \floatlistFLOATTYPE,
5972     % for later use in \listoffloats.
5973     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
5974   \fi
5975 }
5976
5977 % Read the last existing aux file, if any.  No error if none exists.
5978
5979 \def\tryauxfile{%
5980   \openin 1 \jobname.aux
5981   \ifeof 1 \else
5982     \readauxfile
5983     \global\havexrefstrue
5984   \fi
5985   \closein 1
5986 }
5987
5988 \def\readauxfile{\begingroup
5989   \catcode`\^^@=\other
5990   \catcode`\^^A=\other
5991   \catcode`\^^B=\other
5992   \catcode`\^^C=\other
5993   \catcode`\^^D=\other
5994   \catcode`\^^E=\other
5995   \catcode`\^^F=\other
5996   \catcode`\^^G=\other
5997   \catcode`\^^H=\other
5998   \catcode`\^^K=\other
5999   \catcode`\^^L=\other
6000   \catcode`\^^N=\other
6001   \catcode`\^^P=\other
6002   \catcode`\^^Q=\other
6003   \catcode`\^^R=\other
6004   \catcode`\^^S=\other
6005   \catcode`\^^T=\other
6006   \catcode`\^^U=\other
6007   \catcode`\^^V=\other
6008   \catcode`\^^W=\other
6009   \catcode`\^^X=\other
6010   \catcode`\^^Z=\other
6011   \catcode`\^^[=\other
6012   \catcode`\^^\=\other
6013   \catcode`\^^]=\other
6014   \catcode`\^^^=\other
6015   \catcode`\^^_=\other
6016   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6017   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
6018   % supported in the main text, it doesn't seem desirable.  Furthermore,
6019   % that is not enough: for node names that actually contain a ^
6020   % character, we would end up writing a line like this: 'xrdef {'hat
6021   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6022   % argument, and \hat is not an expandable control sequence.  It could
6023   % all be worked out, but why?  Either we support ^^ or we don't.
6024   %
6025   % The other change necessary for this was to define \auxhat:
6026   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6027   % and then to call \auxhat in \setq.
6028   %
6029   \catcode`\^=\other
6030   %
6031   % Special characters.  Should be turned off anyway, but...
6032   \catcode`\~=\other
6033   \catcode`\[=\other
6034   \catcode`\]=\other
6035   \catcode`\"=\other
6036   \catcode`\_=\other
6037   \catcode`\|=\other
6038   \catcode`\<=\other
6039   \catcode`\>=\other
6040   \catcode`\$=\other
6041   \catcode`\#=\other
6042   \catcode`\&=\other
6043   \catcode`\%=\other
6044   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6045   %
6046   % This is to support \ in node names and titles, since the \
6047   % characters end up in a \csname.  It's easier than
6048   % leaving it active and making its active definition an actual \
6049   % character.  What I don't understand is why it works in the *value*
6050   % of the xrdef.  Seems like it should be a catcode12 \, and that
6051   % should not typeset properly.  But it works, so I'm moving on for
6052   % now.  --karl, 15jan04.
6053   \catcode`\\=\other
6054   %
6055   % Make the characters 128-255 be printing characters.
6056   {%
6057     \count 1=128
6058     \def\loop{%
6059       \catcode\count 1=\other
6060       \advance\count 1 by 1
6061       \ifnum \count 1<256 \loop \fi
6062     }%
6063   }%
6064   %
6065   % @ is our escape character in .aux files, and we need braces.
6066   \catcode`\{=1
6067   \catcode`\}=2
6068   \catcode`\@=0
6069   %
6070   \input \jobname.aux
6071 \endgroup}
6072
6073
6074 \message{insertions,}
6075 % including footnotes.
6076
6077 \newcount \footnoteno
6078
6079 % The trailing space in the following definition for supereject is
6080 % vital for proper filling; pages come out unaligned when you do a
6081 % pagealignmacro call if that space before the closing brace is
6082 % removed. (Generally, numeric constants should always be followed by a
6083 % space to prevent strange expansion errors.)
6084 \def\supereject{\par\penalty -20000\footnoteno =0 }
6085
6086 % @footnotestyle is meaningful for info output only.
6087 \let\footnotestyle=\comment
6088
6089 {\catcode `\@=11
6090 %
6091 % Auto-number footnotes.  Otherwise like plain.
6092 \gdef\footnote{%
6093   \let\indent=\ptexindent
6094   \let\noindent=\ptexnoindent
6095   \global\advance\footnoteno by \@ne
6096   \edef\thisfootno{$^{\the\footnoteno}$}%
6097   %
6098   % In case the footnote comes at the end of a sentence, preserve the
6099   % extra spacing after we do the footnote number.
6100   \let\@sf\empty
6101   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6102   %
6103   % Remove inadvertent blank space before typesetting the footnote number.
6104   \unskip
6105   \thisfootno\@sf
6106   \dofootnote
6107 }%
6108
6109 % Don't bother with the trickery in plain.tex to not require the
6110 % footnote text as a parameter.  Our footnotes don't need to be so general.
6111 %
6112 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6113 % \parseargline) fails inside footnotes because the tokens are fixed when
6114 % the footnote is read.  --karl, 16nov96.
6115 %
6116 \gdef\dofootnote{%
6117   \insert\footins\bgroup
6118   % We want to typeset this text as a normal paragraph, even if the
6119   % footnote reference occurs in (for example) a display environment.
6120   % So reset some parameters.
6121   \hsize=\pagewidth
6122   \interlinepenalty\interfootnotelinepenalty
6123   \splittopskip\ht\strutbox % top baseline for broken footnotes
6124   \splitmaxdepth\dp\strutbox
6125   \floatingpenalty\@MM
6126   \leftskip\z@skip
6127   \rightskip\z@skip
6128   \spaceskip\z@skip
6129   \xspaceskip\z@skip
6130   \parindent\defaultparindent
6131   %
6132   \smallfonts \rm
6133   %
6134   % Because we use hanging indentation in footnotes, a @noindent appears
6135   % to exdent this text, so make it be a no-op.  makeinfo does not use
6136   % hanging indentation so @noindent can still be needed within footnote
6137   % text after an @example or the like (not that this is good style).
6138   \let\noindent = \relax
6139   %
6140   % Hang the footnote text off the number.  Use \everypar in case the
6141   % footnote extends for more than one paragraph.
6142   \everypar = {\hang}%
6143   \textindent{\thisfootno}%
6144   %
6145   % Don't crash into the line above the footnote text.  Since this
6146   % expands into a box, it must come within the paragraph, lest it
6147   % provide a place where TeX can split the footnote.
6148   \footstrut
6149   \futurelet\next\fo@t
6150 }
6151 }%end \catcode `\@=11
6152
6153 % In case a @footnote appears in a vbox, save the footnote text and create
6154 % the real \insert just after the vbox finished.  Otherwise, the insertion
6155 % would be lost.
6156 % Similarily, if a @footnote appears inside an alignment, save the footnote
6157 % text to a box and make the \insert when a row of the table is finished.
6158 % And the same can be done for other insert classes.  --kasal, 16nov03.
6159
6160 % Replace the \insert primitive by a cheating macro.
6161 % Deeper inside, just make sure that the saved insertions are not spilled
6162 % out prematurely.
6163 %
6164 \def\startsavinginserts{%
6165   \ifx \insert\ptexinsert
6166     \let\insert\saveinsert
6167   \else
6168     \let\checkinserts\relax
6169   \fi
6170 }
6171
6172 % This \insert replacement works for both \insert\footins{foo} and
6173 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6174 %
6175 \def\saveinsert#1{%
6176   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6177   \afterassignment\next
6178   % swallow the left brace
6179   \let\temp =
6180 }
6181 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6182 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6183
6184 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6185
6186 \def\placesaveins#1{%
6187   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6188     {\box#1}%
6189 }
6190
6191 % eat @SAVE -- beware, all of them have catcode \other:
6192 {
6193   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
6194   \gdef\gobblesave @SAVE{}
6195 }
6196
6197 % initialization:
6198 \def\newsaveins #1{%
6199   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6200   \next
6201 }
6202 \def\newsaveinsX #1{%
6203   \csname newbox\endcsname #1%
6204   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6205     \checksaveins #1}%
6206 }
6207
6208 % initialize:
6209 \let\checkinserts\empty
6210 \newsaveins\footins
6211 \newsaveins\margin
6212
6213
6214 % @image.  We use the macros from epsf.tex to support this.
6215 % If epsf.tex is not installed and @image is used, we complain.
6216 %
6217 % Check for and read epsf.tex up front.  If we read it only at @image
6218 % time, we might be inside a group, and then its definitions would get
6219 % undone and the next image would fail.
6220 \openin 1 = epsf.tex
6221 \ifeof 1 \else
6222   % Do not bother showing banner with epsf.tex v2.7k (available in
6223   % doc/epsf.tex and on ctan).
6224   \def\epsfannounce{\toks0 = }%
6225   \input epsf.tex
6226 \fi
6227 \closein 1
6228 %
6229 % We will only complain once about lack of epsf.tex.
6230 \newif\ifwarnednoepsf
6231 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6232   work.  It is also included in the Texinfo distribution, or you can get
6233   it from ftp://tug.org/tex/epsf.tex.}
6234 %
6235 \def\image#1{%
6236   \ifx\epsfbox\undefined
6237     \ifwarnednoepsf \else
6238       \errhelp = \noepsfhelp
6239       \errmessage{epsf.tex not found, images will be ignored}%
6240       \global\warnednoepsftrue
6241     \fi
6242   \else
6243     \imagexxx #1,,,,,\finish
6244   \fi
6245 }
6246 %
6247 % Arguments to @image:
6248 % #1 is (mandatory) image filename; we tack on .eps extension.
6249 % #2 is (optional) width, #3 is (optional) height.
6250 % #4 is (ignored optional) html alt text.
6251 % #5 is (ignored optional) extension.
6252 % #6 is just the usual extra ignored arg for parsing this stuff.
6253 \newif\ifimagevmode
6254 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6255   \catcode`\^^M = 5     % in case we're inside an example
6256   \normalturnoffactive  % allow _ et al. in names
6257   % If the image is by itself, center it.
6258   \ifvmode
6259     \imagevmodetrue
6260     \nobreak\bigskip
6261     % Usually we'll have text after the image which will insert
6262     % \parskip glue, so insert it here too to equalize the space
6263     % above and below.
6264     \nobreak\vskip\parskip
6265     \nobreak
6266     \line\bgroup\hss
6267   \fi
6268   %
6269   % Output the image.
6270   \ifpdf
6271     \dopdfimage{#1}{#2}{#3}%
6272   \else
6273     % \epsfbox itself resets \epsf?size at each figure.
6274     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6275     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6276     \epsfbox{#1.eps}%
6277   \fi
6278   %
6279   \ifimagevmode \hss \egroup \bigbreak \fi  % space after the image
6280 \endgroup}
6281
6282
6283 % @float FLOATTYPE,LOC ... @end float for displayed figures, tables, etc.
6284 % We don't actually implement floating yet, we just plop the float "here".
6285 % But it seemed the best name for the future.
6286
6287 \envparseargdef\float{\dofloat #1,,,\finish}
6288
6289 % #1 is the optional FLOATTYPE, the text label for this float, typically
6290 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
6291 % this float will not be numbered and cannot be referred to.
6292
6293 % #2 is the optional xref label.  Also must be present for the float to
6294 % be referable.
6295
6296 % #3 is the optional positioning argument; for now, it is ignored.  It
6297 % will somehow specify the positions allowed to float to (here, top, bottom).
6298
6299 % We keep a separate counter for each FLOATTYPE, which we reset at each
6300 % chapter-level command.
6301 \let\resetallfloatnos=\empty
6302 %
6303 \def\dofloat#1,#2,#3,#4\finish{%
6304   \let\thiscaption=\empty
6305   \let\thisshortcaption=\empty
6306   %
6307   % don't lose footnotes inside @float.
6308   \startsavinginserts
6309   %
6310   \vtop\bgroup
6311     \def\floattype{#1}%
6312     \def\floatlabel{#2}%
6313     \def\floatloc{#3}% we do nothing with this yet.
6314     %
6315     \ifx\floattype\empty
6316       \let\safefloattype=\empty
6317     \else
6318       {%
6319         % the floattype might have accents or other special characters,
6320         % but we need to use it in a control sequence name.
6321         \indexnofonts
6322         \turnoffactive
6323         \xdef\safefloattype{\floattype}%
6324       }%
6325     \fi
6326     %
6327     % If label is given but no type, we handle that as the empty type.
6328     \ifx\floatlabel\empty \else
6329       % We want each FLOATTYPE to be numbered separately (Figure 1,
6330       % Table 1, Figure 2, ...).  (And if no label, no number.)
6331       % 
6332       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6333       \global\advance\floatno by 1
6334       %
6335       {%
6336         % This magic value for \thissection is output by \setref as the
6337         % XREFLABEL-title value.  \xrefX uses it to distinguish float
6338         % labels (which have a completely different output format) from
6339         % node and anchor labels.  And \xrdef uses it to construct the
6340         % lists of floats.
6341         % 
6342         \edef\thissection{\floatmagic=\safefloattype}%
6343         \setref{\floatlabel}{Yfloat}%
6344       }%
6345     \fi
6346     %
6347     % start with \parskip glue, I guess.
6348     \vskip\parskip
6349     %
6350     % Don't suppress indentation if a float happens to start a section.
6351     \restorefirstparagraphindent
6352 }
6353
6354 % we have these possibilities:
6355 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6356 % @float Foo,lbl & no caption:    Foo 1.1
6357 % @float Foo & @caption{Cap}:     Foo: Cap
6358 % @float Foo & no caption:        Foo
6359 % @float ,lbl & Caption{Cap}:     1.1: Cap
6360 % @float ,lbl & no caption:       1.1
6361 % @float & @caption{Cap}:         Cap
6362 % @float & no caption:
6363 %
6364 \def\Efloat{%
6365     \let\floatident = \empty
6366     %
6367     % In all cases, if we have a float type, it comes first.
6368     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6369     %
6370     % If we have an xref label, the number comes next.
6371     \ifx\floatlabel\empty \else
6372       \ifx\floattype\empty \else % if also had float type, need tie first.
6373         \appendtomacro\floatident{\tie}%
6374       \fi
6375       % the number.
6376       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6377     \fi
6378     %
6379     % Start the printed caption with what we've constructed in
6380     % \floatident, but keep it separate; we need \floatident again.
6381     \let\captionline = \floatident
6382     %
6383     \ifx\thiscaption\empty \else
6384       \ifx\floatident\empty \else
6385         \appendtomacro\captionline{: }% had ident, so need a colon between
6386       \fi
6387       %
6388       % caption text.
6389       \appendtomacro\captionline\thiscaption
6390     \fi
6391     %
6392     % If we have anything to print, print it, with space before.
6393     % Eventually this needs to become an \insert.
6394     \ifx\captionline\empty \else
6395       \vskip.5\parskip
6396       \captionline
6397     \fi
6398     %
6399     % If have an xref label, write the list of floats info.  Do this
6400     % after the caption, to avoid chance of it being a breakpoint.
6401     \ifx\floatlabel\empty \else
6402       % Write the text that goes in the lof to the aux file as
6403       % \floatlabel-lof.  Besides \floatident, we include the short
6404       % caption if specified, else the full caption if specified, else nothing.
6405       {%
6406         \atdummies \turnoffactive \otherbackslash
6407         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{%
6408           \floatident
6409           \ifx\thisshortcaption\empty
6410             \ifx\thiscaption\empty \else : \thiscaption \fi
6411           \else
6412             : \thisshortcaption
6413           \fi
6414         }}%
6415       }%
6416     \fi
6417     %
6418     % Space below caption, if we printed anything.
6419     \ifx\printedsomething\empty \else \vskip\parskip \fi
6420   \egroup  % end of \vtop
6421   \checkinserts
6422 }
6423
6424 % Append the tokens #2 to the definition of macro #1, not expanding either.
6425
6426 \newtoks\appendtomacroAtoks
6427 \newtoks\appendtomacroBtoks
6428 \def\appendtomacro#1#2{%
6429   \appendtomacroAtoks = \expandafter{#1}%
6430   \appendtomacroBtoks = {#2}%
6431   \edef#1{\the\appendtomacroAtoks \the\appendtomacroBtoks}%
6432 }
6433
6434 % @caption, @shortcaption are easy.
6435
6436 \long\def\caption#1{\checkenv\float \def\thiscaption{#1}}
6437 \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
6438
6439 % The parameter is the control sequence identifying the counter we are
6440 % going to use.  Create it if it doesn't exist and assign it to \floatno.
6441 \def\getfloatno#1{%
6442   \ifx#1\relax
6443       % Haven't seen this figure type before.
6444       \csname newcount\endcsname #1%
6445       %
6446       % Remember to reset this floatno at the next chap.
6447       \expandafter\gdef\expandafter\resetallfloatnos
6448         \expandafter{\resetallfloatnos #1=0 }%
6449   \fi
6450   \let\floatno#1%
6451 }
6452
6453 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
6454 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
6455 % first read the @float command.
6456
6457 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6458
6459 % Magic string used for the XREFLABEL-title value, so \xrefX can
6460 % distinguish floats from other xref types.
6461 \def\floatmagic{!!float!!}
6462
6463 % #1 is the control sequence we are passed; we expand into a conditional
6464 % which is true if #1 represents a float ref.  That is, the magic
6465 % \thissection value which we \setref above.
6466
6467 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6468 %
6469 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
6470 % (safe) float type for this float.  We set \iffloattype to #2.
6471
6472 \def\doiffloat#1=#2=#3\finish{%
6473   \def\temp{#1}%
6474   \def\iffloattype{#2}%
6475   \ifx\temp\floatmagic
6476 }
6477
6478 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6479
6480 \parseargdef\listoffloats{%
6481   \def\floattype{#1}% floattype
6482   {%
6483     % the floattype might have accents or other special characters,
6484     % but we need to use it in a control sequence name.
6485     \indexnofonts
6486     \turnoffactive
6487     \xdef\safefloattype{\floattype}%
6488   }%
6489   %
6490   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6491   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6492     \ifhavexrefs
6493       % if the user said @listoffloats foo but never @float foo.
6494       \message{\linenumber No `\safefloattype' floats to list.}%
6495     \fi
6496   \else
6497     \begingroup
6498       \leftskip=\tocindent  % indent these entries like a toc
6499       \let\do=\listoffloatsdo
6500       \csname floatlist\safefloattype\endcsname
6501     \endgroup
6502   \fi
6503 }
6504
6505 % This is called on each entry in a list of floats.  We're passed the
6506 % xref label, in the form LABEL-title, which is how we save it in the
6507 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
6508 % has the text we're supposed to typeset here.
6509
6510 % Figures without xref labels will not be included in the list (since
6511 % they won't appear in the aux file).
6512
6513 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6514 \def\listoffloatsdoentry#1-title\finish{{%
6515   % Can't fully expand XR#1-lof because it can contain anything.  Just
6516   % pass the control sequence.  On the other hand, XR#1-pg is just the
6517   % page number, and we want to fully expand that so we can get a link
6518   % in pdf output.
6519   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6520   %
6521   % use the same \entry macro we use to generate the TOC and index.
6522   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6523   \writeentry
6524 }}
6525
6526 \message{localization,}
6527 % and i18n.
6528
6529 % @documentlanguage is usually given very early, just after
6530 % @setfilename.  If done too late, it may not override everything
6531 % properly.  Single argument is the language abbreviation.
6532 % It would be nice if we could set up a hyphenation file here.
6533 %
6534 \parseargdef\documentlanguage{%
6535   \tex % read txi-??.tex file in plain TeX.
6536     % Read the file if it exists.
6537     \openin 1 txi-#1.tex
6538     \ifeof 1
6539       \errhelp = \nolanghelp
6540       \errmessage{Cannot read language file txi-#1.tex}%
6541     \else
6542       \input txi-#1.tex
6543     \fi
6544     \closein 1
6545   \endgroup
6546 }
6547 \newhelp\nolanghelp{The given language definition file cannot be found or
6548 is empty.  Maybe you need to install it?  In the current directory
6549 should work if nowhere else does.}
6550
6551
6552 % @documentencoding should change something in TeX eventually, most
6553 % likely, but for now just recognize it.
6554 \let\documentencoding = \comment
6555
6556
6557 % Page size parameters.
6558 %
6559 \newdimen\defaultparindent \defaultparindent = 15pt
6560
6561 \chapheadingskip = 15pt plus 4pt minus 2pt
6562 \secheadingskip = 12pt plus 3pt minus 2pt
6563 \subsecheadingskip = 9pt plus 2pt minus 2pt
6564
6565 % Prevent underfull vbox error messages.
6566 \vbadness = 10000
6567
6568 % Don't be so finicky about underfull hboxes, either.
6569 \hbadness = 2000
6570
6571 % Following George Bush, just get rid of widows and orphans.
6572 \widowpenalty=10000
6573 \clubpenalty=10000
6574
6575 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6576 % using an old version of TeX, don't do anything.  We want the amount of
6577 % stretch added to depend on the line length, hence the dependence on
6578 % \hsize.  We call this whenever the paper size is set.
6579 %
6580 \def\setemergencystretch{%
6581   \ifx\emergencystretch\thisisundefined
6582     % Allow us to assign to \emergencystretch anyway.
6583     \def\emergencystretch{\dimen0}%
6584   \else
6585     \emergencystretch = .15\hsize
6586   \fi
6587 }
6588
6589 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6590 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6591 % physical page width.
6592 %
6593 % We also call \setleading{\textleading}, so the caller should define
6594 % \textleading.  The caller should also set \parskip.
6595 %
6596 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6597   \voffset = #3\relax
6598   \topskip = #6\relax
6599   \splittopskip = \topskip
6600   %
6601   \vsize = #1\relax
6602   \advance\vsize by \topskip
6603   \outervsize = \vsize
6604   \advance\outervsize by 2\topandbottommargin
6605   \pageheight = \vsize
6606   %
6607   \hsize = #2\relax
6608   \outerhsize = \hsize
6609   \advance\outerhsize by 0.5in
6610   \pagewidth = \hsize
6611   %
6612   \normaloffset = #4\relax
6613   \bindingoffset = #5\relax
6614   %
6615   \ifpdf
6616     \pdfpageheight #7\relax
6617     \pdfpagewidth #8\relax
6618   \fi
6619   %
6620   \setleading{\textleading}
6621   %
6622   \parindent = \defaultparindent
6623   \setemergencystretch
6624 }
6625
6626 % @letterpaper (the default).
6627 \def\letterpaper{{\globaldefs = 1
6628   \parskip = 3pt plus 2pt minus 1pt
6629   \textleading = 13.2pt
6630   %
6631   % If page is nothing but text, make it come out even.
6632   \internalpagesizes{46\baselineskip}{6in}%
6633                     {\voffset}{.25in}%
6634                     {\bindingoffset}{36pt}%
6635                     {11in}{8.5in}%
6636 }}
6637
6638 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6639 \def\smallbook{{\globaldefs = 1
6640   \parskip = 2pt plus 1pt
6641   \textleading = 12pt
6642   %
6643   \internalpagesizes{7.5in}{5in}%
6644                     {\voffset}{.25in}%
6645                     {\bindingoffset}{16pt}%
6646                     {9.25in}{7in}%
6647   %
6648   \lispnarrowing = 0.3in
6649   \tolerance = 700
6650   \hfuzz = 1pt
6651   \contentsrightmargin = 0pt
6652   \defbodyindent = .5cm
6653 }}
6654
6655 % Use @afourpaper to print on European A4 paper.
6656 \def\afourpaper{{\globaldefs = 1
6657   \parskip = 3pt plus 2pt minus 1pt
6658   \textleading = 13.2pt
6659   %
6660   % Double-side printing via postscript on Laserjet 4050
6661   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6662   % To change the settings for a different printer or situation, adjust
6663   % \normaloffset until the front-side and back-side texts align.  Then
6664   % do the same for \bindingoffset.  You can set these for testing in
6665   % your texinfo source file like this:
6666   % @tex
6667   % \global\normaloffset = -6mm
6668   % \global\bindingoffset = 10mm
6669   % @end tex
6670   \internalpagesizes{51\baselineskip}{160mm}
6671                     {\voffset}{\hoffset}%
6672                     {\bindingoffset}{44pt}%
6673                     {297mm}{210mm}%
6674   %
6675   \tolerance = 700
6676   \hfuzz = 1pt
6677   \contentsrightmargin = 0pt
6678   \defbodyindent = 5mm
6679 }}
6680
6681 % Use @afivepaper to print on European A5 paper.
6682 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6683 % He also recommends making @example and @lisp be small.
6684 \def\afivepaper{{\globaldefs = 1
6685   \parskip = 2pt plus 1pt minus 0.1pt
6686   \textleading = 12.5pt
6687   %
6688   \internalpagesizes{160mm}{120mm}%
6689                     {\voffset}{\hoffset}%
6690                     {\bindingoffset}{8pt}%
6691                     {210mm}{148mm}%
6692   %
6693   \lispnarrowing = 0.2in
6694   \tolerance = 800
6695   \hfuzz = 1.2pt
6696   \contentsrightmargin = 0pt
6697   \defbodyindent = 2mm
6698   \tableindent = 12mm
6699 }}
6700
6701 % A specific text layout, 24x15cm overall, intended for A4 paper.
6702 \def\afourlatex{{\globaldefs = 1
6703   \afourpaper
6704   \internalpagesizes{237mm}{150mm}%
6705                     {\voffset}{4.6mm}%
6706                     {\bindingoffset}{7mm}%
6707                     {297mm}{210mm}%
6708   %
6709   % Must explicitly reset to 0 because we call \afourpaper.
6710   \globaldefs = 0
6711 }}
6712
6713 % Use @afourwide to print on A4 paper in landscape format.
6714 \def\afourwide{{\globaldefs = 1
6715   \afourpaper
6716   \internalpagesizes{241mm}{165mm}%
6717                     {\voffset}{-2.95mm}%
6718                     {\bindingoffset}{7mm}%
6719                     {297mm}{210mm}%
6720   \globaldefs = 0
6721 }}
6722
6723 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6724 % Perhaps we should allow setting the margins, \topskip, \parskip,
6725 % and/or leading, also. Or perhaps we should compute them somehow.
6726 %
6727 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
6728 \def\pagesizesyyy#1,#2,#3\finish{{%
6729   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6730   \globaldefs = 1
6731   %
6732   \parskip = 3pt plus 2pt minus 1pt
6733   \setleading{\textleading}%
6734   %
6735   \dimen0 = #1
6736   \advance\dimen0 by \voffset
6737   %
6738   \dimen2 = \hsize
6739   \advance\dimen2 by \normaloffset
6740   %
6741   \internalpagesizes{#1}{\hsize}%
6742                     {\voffset}{\normaloffset}%
6743                     {\bindingoffset}{44pt}%
6744                     {\dimen0}{\dimen2}%
6745 }}
6746
6747 % Set default to letter.
6748 %
6749 \letterpaper
6750
6751
6752 \message{and turning on texinfo input format.}
6753
6754 % Define macros to output various characters with catcode for normal text.
6755 \catcode`\"=\other
6756 \catcode`\~=\other
6757 \catcode`\^=\other
6758 \catcode`\_=\other
6759 \catcode`\|=\other
6760 \catcode`\<=\other
6761 \catcode`\>=\other
6762 \catcode`\+=\other
6763 \catcode`\$=\other
6764 \def\normaldoublequote{"}
6765 \def\normaltilde{~}
6766 \def\normalcaret{^}
6767 \def\normalunderscore{_}
6768 \def\normalverticalbar{|}
6769 \def\normalless{<}
6770 \def\normalgreater{>}
6771 \def\normalplus{+}
6772 \def\normaldollar{$}%$ font-lock fix
6773
6774 % This macro is used to make a character print one way in \tt
6775 % (where it can probably be output as-is), and another way in other fonts,
6776 % where something hairier probably needs to be done.
6777 %
6778 % #1 is what to print if we are indeed using \tt; #2 is what to print
6779 % otherwise.  Since all the Computer Modern typewriter fonts have zero
6780 % interword stretch (and shrink), and it is reasonable to expect all
6781 % typewriter fonts to have this, we can check that font parameter.
6782 %
6783 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6784
6785 % Same as above, but check for italic font.  Actually this also catches
6786 % non-italic slanted fonts since it is impossible to distinguish them from
6787 % italic fonts.  But since this is only used by $ and it uses \sl anyway
6788 % this is not a problem.
6789 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6790
6791 % Turn off all special characters except @
6792 % (and those which the user can use as if they were ordinary).
6793 % Most of these we simply print from the \tt font, but for some, we can
6794 % use math or other variants that look better in normal text.
6795
6796 \catcode`\"=\active
6797 \def\activedoublequote{{\tt\char34}}
6798 \let"=\activedoublequote
6799 \catcode`\~=\active
6800 \def~{{\tt\char126}}
6801 \chardef\hat=`\^
6802 \catcode`\^=\active
6803 \def^{{\tt \hat}}
6804
6805 \catcode`\_=\active
6806 \def_{\ifusingtt\normalunderscore\_}
6807 % Subroutine for the previous macro.
6808 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6809
6810 \catcode`\|=\active
6811 \def|{{\tt\char124}}
6812 \chardef \less=`\<
6813 \catcode`\<=\active
6814 \def<{{\tt \less}}
6815 \chardef \gtr=`\>
6816 \catcode`\>=\active
6817 \def>{{\tt \gtr}}
6818 \catcode`\+=\active
6819 \def+{{\tt \char 43}}
6820 \catcode`\$=\active
6821 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6822
6823 % If a .fmt file is being used, characters that might appear in a file
6824 % name cannot be active until we have parsed the command line.
6825 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6826 % \otherifyactive is called near the end of this file.
6827 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6828
6829 \catcode`\@=0
6830
6831 % \backslashcurfont outputs one backslash character in current font,
6832 % as in \char`\\.
6833 \global\chardef\backslashcurfont=`\\
6834 \global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
6835
6836 % \rawbackslash defines an active \ to do \backslashcurfont.
6837 % \otherbackslash defines an active \ to be a literal `\' character with
6838 % catcode other.
6839 {\catcode`\\=\active
6840  @gdef@rawbackslash{@let\=@backslashcurfont}
6841  @gdef@otherbackslash{@let\=@realbackslash}
6842 }
6843
6844 % \realbackslash is an actual character `\' with catcode other.
6845 {\catcode`\\=\other @gdef@realbackslash{\}}
6846
6847 % \normalbackslash outputs one backslash in fixed width font.
6848 \def\normalbackslash{{\tt\backslashcurfont}}
6849
6850 \catcode`\\=\active
6851
6852 % Used sometimes to turn off (effectively) the active characters
6853 % even after parsing them.
6854 @def@turnoffactive{%
6855   @let"=@normaldoublequote
6856   @let\=@realbackslash
6857   @let~=@normaltilde
6858   @let^=@normalcaret
6859   @let_=@normalunderscore
6860   @let|=@normalverticalbar
6861   @let<=@normalless
6862   @let>=@normalgreater
6863   @let+=@normalplus
6864   @let$=@normaldollar %$ font-lock fix
6865   @unsepspaces
6866 }
6867
6868 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6869 % the literal character `\'.  (Thus, \ is not expandable when this is in
6870 % effect.)
6871 %
6872 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6873
6874 % Make _ and + \other characters, temporarily.
6875 % This is canceled by @fixbackslash.
6876 @otherifyactive
6877
6878 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6879 % That is what \eatinput is for; after that, the `\' should revert to printing
6880 % a backslash.
6881 %
6882 @gdef@eatinput input texinfo{@fixbackslash}
6883 @global@let\ = @eatinput
6884
6885 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6886 % the first `\{ in the file would cause an error. This macro tries to fix
6887 % that, assuming it is called before the first `\' could plausibly occur.
6888 % Also back turn on active characters that might appear in the input
6889 % file name, in case not using a pre-dumped format.
6890 %
6891 @gdef@fixbackslash{%
6892   @ifx\@eatinput @let\ = @normalbackslash @fi
6893   @catcode`+=@active
6894   @catcode`@_=@active
6895 }
6896
6897 % Say @foo, not \foo, in error messages.
6898 @escapechar = `@@
6899
6900 % These look ok in all fonts, so just make them not special.
6901 @catcode`@& = @other
6902 @catcode`@# = @other
6903 @catcode`@% = @other
6904
6905
6906 @c Local variables:
6907 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6908 @c page-delimiter: "^\\\\message"
6909 @c time-stamp-start: "def\\\\texinfoversion{"
6910 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6911 @c time-stamp-end: "}"
6912 @c End:
6913
6914 @c vim:sw=2:
6915
6916 @ignore
6917    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
6918 @end ignore