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