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