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