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