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