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