]> git.donarmstrong.com Git - lilypond.git/blob - tex/texinfo.tex
Add '-dcrop' option to ps and svg backends
[lilypond.git] / tex / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2017-01-14.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, 2014, 2015, 2016
11 % Free Software Foundation, Inc.
12 %
13 % This texinfo.tex file is free software: you can redistribute it and/or
14 % modify it under the terms of the GNU General Public License as
15 % published by the Free Software Foundation, either version 3 of the
16 % License, or (at your option) any later version.
17 %
18 % This texinfo.tex file is distributed in the hope that it will be
19 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
20 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 % General Public License for more details.
22 %
23 % You should have received a copy of the GNU General Public License
24 % along with this program.  If not, see <http://www.gnu.org/licenses/>.
25 %
26 % As a special exception, when this file is read by TeX when processing
27 % a Texinfo source document, you may use the result without
28 % restriction. This Exception is an additional permission under section 7
29 % of the GNU General Public License, version 3 ("GPLv3").
30 %
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 %   http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
34 %   http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
35 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page)
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
38 %
39 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem.  Patches are, of course, greatly appreciated.
42 %
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution.  For a simple
45 % manual foo.texi, however, you can get away with this:
46 %   tex foo.texi
47 %   texindex foo.??
48 %   tex foo.texi
49 %   tex foo.texi
50 %   dvips foo.dvi -o  # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
54 %
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent.  You can get the existing language-specific files from the
57 % full Texinfo distribution.
58 %
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60
61
62 \message{Loading texinfo [version \texinfoversion]:}
63
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68   \catcode`+=\active \catcode`\_=\active}
69
70 % LaTeX's \typeout.  This ensures that the messages it is used for
71 % are identical in format to the corresponding ones from latex/pdflatex.
72 \def\typeout{\immediate\write17}%
73
74 \chardef\other=12
75
76 % We never want plain's \outer definition of \+ in Texinfo.
77 % For @tex, we can use \tabalign.
78 \let\+ = \relax
79
80 % Save some plain tex macros whose names we will redefine.
81 \let\ptexb=\b
82 \let\ptexbullet=\bullet
83 \let\ptexc=\c
84 \let\ptexcomma=\,
85 \let\ptexdot=\.
86 \let\ptexdots=\dots
87 \let\ptexend=\end
88 \let\ptexequiv=\equiv
89 \let\ptexexclam=\!
90 \let\ptexfootnote=\footnote
91 \let\ptexgtr=>
92 \let\ptexhat=^
93 \let\ptexi=\i
94 \let\ptexindent=\indent
95 \let\ptexinsert=\insert
96 \let\ptexlbrace=\{
97 \let\ptexless=<
98 \let\ptexnewwrite\newwrite
99 \let\ptexnoindent=\noindent
100 \let\ptexplus=+
101 \let\ptexraggedright=\raggedright
102 \let\ptexrbrace=\}
103 \let\ptexslash=\/
104 \let\ptexsp=\sp
105 \let\ptexstar=\*
106 \let\ptexsup=\sup
107 \let\ptext=\t
108 \let\ptextop=\top
109 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
110
111 % If this character appears in an error message or help string, it
112 % starts a new line in the output.
113 \newlinechar = `^^J
114
115 % Use TeX 3.0's \inputlineno to get the line number, for better error
116 % messages, but if we're using an old version of TeX, don't do anything.
117 %
118 \ifx\inputlineno\thisisundefined
119   \let\linenumber = \empty % Pre-3.0.
120 \else
121   \def\linenumber{l.\the\inputlineno:\space}
122 \fi
123
124 % Set up fixed words for English if not already set.
125 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
126 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
127 \ifx\putworderror\undefined     \gdef\putworderror{error}\fi
128 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
129 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
130 \ifx\putwordIndexIsEmpty\undefined       \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
131 \ifx\putwordIndexNonexistent\undefined   \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
132 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
133 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
134 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
135 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
136 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
137 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
138 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
139 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
140 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
141 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
142 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
143 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
144 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
145 %
146 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
147 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
148 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
149 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
150 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
151 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
152 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
153 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
154 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
155 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
156 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
157 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
158 %
159 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
160 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
161 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
162 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
163 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
164
165 % Give the space character the catcode for a space.
166 \def\spaceisspace{\catcode`\ =10\relax}
167
168 % Likewise for ^^M, the end of line character.
169 \def\endlineisspace{\catcode13=10\relax}
170
171 \chardef\dashChar  = `\-
172 \chardef\slashChar = `\/
173 \chardef\underChar = `\_
174
175 % Ignore a token.
176 %
177 \def\gobble#1{}
178
179 % The following is used inside several \edef's.
180 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
181
182 % Hyphenation fixes.
183 \hyphenation{
184   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
185   ap-pen-dix bit-map bit-maps
186   data-base data-bases eshell fall-ing half-way long-est man-u-script
187   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
188   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
189   spell-ing spell-ings
190   stand-alone strong-est time-stamp time-stamps which-ever white-space
191   wide-spread wrap-around
192 }
193
194 % Sometimes it is convenient to have everything in the transcript file
195 % and nothing on the terminal.  We don't just call \tracingall here,
196 % since that produces some useless output on the terminal.  We also make
197 % some effort to order the tracing commands to reduce output in the log
198 % file; cf. trace.sty in LaTeX.
199 %
200 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
201 \def\loggingall{%
202   \tracingstats2
203   \tracingpages1
204   \tracinglostchars2  % 2 gives us more in etex
205   \tracingparagraphs1
206   \tracingoutput1
207   \tracingmacros2
208   \tracingrestores1
209   \showboxbreadth\maxdimen \showboxdepth\maxdimen
210   \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
211     \tracingscantokens1
212     \tracingifs1
213     \tracinggroups1
214     \tracingnesting2
215     \tracingassigns1
216   \fi
217   \tracingcommands3  % 3 gives us more in etex
218   \errorcontextlines16
219 }%
220
221 % @errormsg{MSG}.  Do the index-like expansions on MSG, but if things
222 % aren't perfect, it's not the end of the world, being an error message,
223 % after all.
224
225 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
226 \def\doerrormsg#1{\errmessage{#1}}
227
228 % add check for \lastpenalty to plain's definitions.  If the last thing
229 % we did was a \nobreak, we don't want to insert more space.
230 %
231 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
232   \removelastskip\penalty-50\smallskip\fi\fi}
233 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
234   \removelastskip\penalty-100\medskip\fi\fi}
235 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
236   \removelastskip\penalty-200\bigskip\fi\fi}
237
238 %\f Output routine
239 %
240
241 % For a final copy, take out the rectangles
242 % that mark overfull boxes (in case you have decided
243 % that the text looks ok even though it passes the margin).
244 %
245 \def\finalout{\overfullrule=0pt }
246
247 % Do @cropmarks to get crop marks.
248 %
249 \newif\ifcropmarks
250 \let\cropmarks = \cropmarkstrue
251 %
252 % Dimensions to add cropmarks at corners.
253 % Added by P. A. MacKay, 12 Nov. 1986
254 %
255 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
256 \newdimen\cornerlong  \cornerlong=1pc
257 \newdimen\cornerthick \cornerthick=.3pt
258 \newdimen\topandbottommargin \topandbottommargin=.75in
259
260 % Output a mark which sets \thischapter, \thissection and \thiscolor.
261 % We dump everything together because we only have one kind of mark.
262 % This works because we only use \botmark / \topmark, not \firstmark.
263 %
264 % A mark contains a subexpression of the \ifcase ... \fi construct.
265 % \get*marks macros below extract the needed part using \ifcase.
266 %
267 % Another complication is to let the user choose whether \thischapter
268 % (\thissection) refers to the chapter (section) in effect at the top
269 % of a page, or that at the bottom of a page.
270
271 % \domark is called twice inside \chapmacro, to add one
272 % mark before the section break, and one after.
273 %   In the second call \prevchapterdefs is the same as \lastchapterdefs,
274 % and \prevsectiondefs is the same as \lastsectiondefs.
275 %   Then if the page is not broken at the mark, some of the previous
276 % section appears on the page, and we can get the name of this section
277 % from \firstmark for @everyheadingmarks top.
278 %   @everyheadingmarks bottom uses \botmark.
279 %
280 % See page 260 of The TeXbook.
281 \def\domark{%
282   \toks0=\expandafter{\lastchapterdefs}%
283   \toks2=\expandafter{\lastsectiondefs}%
284   \toks4=\expandafter{\prevchapterdefs}%
285   \toks6=\expandafter{\prevsectiondefs}%
286   \toks8=\expandafter{\lastcolordefs}%
287   \mark{%
288                    \the\toks0 \the\toks2  % 0: marks for @everyheadingmarks top
289       \noexpand\or \the\toks4 \the\toks6  % 1: for @everyheadingmarks bottom
290     \noexpand\else \the\toks8             % 2: color marks
291   }%
292 }
293
294 % \gettopheadingmarks, \getbottomheadingmarks,
295 % \getcolormarks - extract needed part of mark.
296 %
297 % \topmark doesn't work for the very first chapter (after the title
298 % page or the contents), so we use \firstmark there -- this gets us
299 % the mark with the chapter defs, unless the user sneaks in, e.g.,
300 % @setcolor (or @url, or @link, etc.) between @contents and the very
301 % first @chapter.
302 \def\gettopheadingmarks{%
303   \ifcase0\topmark\fi
304   \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
305 }
306 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
307 \def\getcolormarks{\ifcase2\topmark\fi}
308
309 % Avoid "undefined control sequence" errors.
310 \def\lastchapterdefs{}
311 \def\lastsectiondefs{}
312 \def\lastsection{}
313 \def\prevchapterdefs{}
314 \def\prevsectiondefs{}
315 \def\lastcolordefs{}
316
317 % Margin to add to right of even pages, to left of odd pages.
318 \newdimen\bindingoffset
319 \newdimen\normaloffset
320 \newdimen\txipagewidth \newdimen\txipageheight
321
322 % Main output routine.
323 %
324 \chardef\PAGE = 255
325 \output = {\onepageout{\pagecontents\PAGE}}
326
327 \newbox\headlinebox
328 \newbox\footlinebox
329
330 % \onepageout takes a vbox as an argument.
331 % \shipout a vbox for a single page, adding an optional header, footer,
332 % cropmarks, and footnote.  This also causes index entries for this page
333 % to be written to the auxiliary files.
334 %
335 \def\onepageout#1{%
336   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
337   %
338   \ifodd\pageno  \advance\hoffset by \bindingoffset
339   \else \advance\hoffset by -\bindingoffset\fi
340   %
341   % Common context changes for both heading and footing.
342   % Do this outside of the \shipout so @code etc. will be expanded in
343   % the headline as they should be, not taken literally (outputting ''code).
344   \def\commmonheadfootline{\let\hsize=\txipagewidth \texinfochars}
345   %
346   % Retrieve the information for the headings from the marks in the page,
347   % and call Plain TeX's \makeheadline and \makefootline, which use the
348   % values in \headline and \footline.
349   %
350   % This is used to check if we are on the first page of a chapter.
351   \ifcase1\topmark\fi
352   \let\prevchaptername\thischaptername
353   \ifcase0\firstmark\fi
354   \let\curchaptername\thischaptername
355   %
356   \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
357   \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
358   %
359   \ifx\curchaptername\prevchaptername
360     \let\thischapterheading\thischapter
361   \else
362     % \thischapterheading is the same as \thischapter except it is blank
363     % for the first page of a chapter.  This is to prevent the chapter name 
364     % being shown twice.
365     \def\thischapterheading{}%
366   \fi
367   %
368   \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
369   \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
370   %
371   {%
372     % Set context for writing to auxiliary files like index files.
373     % Have to do this stuff outside the \shipout because we want it to
374     % take effect in \write's, yet the group defined by the \vbox ends
375     % before the \shipout runs.
376     %
377     \indexdummies         % don't expand commands in the output.
378     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
379                % the page break happens to be in the middle of an example.
380                % We don't want .vr (or whatever) entries like this:
381                % \entry{{\indexbackslash }acronym}{32}{\code {\acronym}}
382                % "\acronym" won't work when it's read back in;
383                % it needs to be
384                % {\code {{\backslashcurfont }acronym}
385     \shipout\vbox{%
386       % Do this early so pdf references go to the beginning of the page.
387       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
388       %
389       \ifcropmarks \vbox to \outervsize\bgroup
390         \hsize = \outerhsize
391         \vskip-\topandbottommargin
392         \vtop to0pt{%
393           \line{\ewtop\hfil\ewtop}%
394           \nointerlineskip
395           \line{%
396             \vbox{\moveleft\cornerthick\nstop}%
397             \hfill
398             \vbox{\moveright\cornerthick\nstop}%
399           }%
400           \vss}%
401         \vskip\topandbottommargin
402         \line\bgroup
403           \hfil % center the page within the outer (page) hsize.
404           \ifodd\pageno\hskip\bindingoffset\fi
405           \vbox\bgroup
406       \fi
407       %
408       \unvbox\headlinebox
409       \pagebody{#1}%
410       \ifdim\ht\footlinebox > 0pt
411         % Only leave this space if the footline is nonempty.
412         % (We lessened \vsize for it in \oddfootingyyy.)
413         % The \baselineskip=24pt in plain's \makefootline has no effect.
414         \vskip 24pt
415         \unvbox\footlinebox
416       \fi
417       %
418       \ifcropmarks
419           \egroup % end of \vbox\bgroup
420         \hfil\egroup % end of (centering) \line\bgroup
421         \vskip\topandbottommargin plus1fill minus1fill
422         \boxmaxdepth = \cornerthick
423         \vbox to0pt{\vss
424           \line{%
425             \vbox{\moveleft\cornerthick\nsbot}%
426             \hfill
427             \vbox{\moveright\cornerthick\nsbot}%
428           }%
429           \nointerlineskip
430           \line{\ewbot\hfil\ewbot}%
431         }%
432       \egroup % \vbox from first cropmarks clause
433       \fi
434     }% end of \shipout\vbox
435   }% end of group with \indexdummies
436   \advancepageno
437   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
438 }
439
440 \newinsert\margin \dimen\margin=\maxdimen
441
442 % Main part of page, including any footnotes
443 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
444 {\catcode`\@ =11
445 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
446 % marginal hacks, juha@viisa.uucp (Juha Takala)
447 \ifvoid\margin\else % marginal info is present
448   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
449 \dimen@=\dp#1\relax \unvbox#1\relax
450 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
451 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
452 }
453
454 % Here are the rules for the cropmarks.  Note that they are
455 % offset so that the space between them is truly \outerhsize or \outervsize
456 % (P. A. MacKay, 12 November, 1986)
457 %
458 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
459 \def\nstop{\vbox
460   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
461 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
462 \def\nsbot{\vbox
463   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
464
465
466 % Argument parsing
467
468 % Parse an argument, then pass it to #1.  The argument is the rest of
469 % the input line (except we remove a trailing comment).  #1 should be a
470 % macro which expects an ordinary undelimited TeX argument.
471 % For example, \def\foo{\parsearg\fooxxx}.
472 %
473 \def\parsearg{\parseargusing{}}
474 \def\parseargusing#1#2{%
475   \def\argtorun{#2}%
476   \begingroup
477     \obeylines
478     \spaceisspace
479     #1%
480     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
481 }
482
483 {\obeylines %
484   \gdef\parseargline#1^^M{%
485     \endgroup % End of the group started in \parsearg.
486     \argremovecomment #1\comment\ArgTerm%
487   }%
488 }
489
490 % First remove any @comment, then any @c comment.  Also remove a @texinfoc
491 % comment (see \scanmacro for details).  Pass the result on to \argcheckspaces.
492 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
493 \def\argremovec#1\c#2\ArgTerm{\argremovetexinfoc #1\texinfoc\ArgTerm}
494 \def\argremovetexinfoc#1\texinfoc#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
495
496 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
497 %
498 % \argremovec might leave us with trailing space, e.g.,
499 %    @end itemize  @c foo
500 % This space token undergoes the same procedure and is eventually removed
501 % by \finishparsearg.
502 %
503 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
504 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
505 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
506   \def\temp{#3}%
507   \ifx\temp\empty
508     % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
509     \let\temp\finishparsearg
510   \else
511     \let\temp\argcheckspaces
512   \fi
513   % Put the space token in:
514   \temp#1 #3\ArgTerm
515 }
516
517 % If a _delimited_ argument is enclosed in braces, they get stripped; so
518 % to get _exactly_ the rest of the line, we had to prevent such situation.
519 % We prepended an \empty token at the very beginning and we expand it now,
520 % just before passing the control to \argtorun.
521 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
522 % either the null string, or it ends with \^^M---thus there is no danger
523 % that a pair of braces would be stripped.
524 %
525 % But first, we have to remove the trailing space token.
526 %
527 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
528
529
530 % \parseargdef - define a command taking an argument on the line
531 %
532 % \parseargdef\foo{...}
533 %       is roughly equivalent to
534 % \def\foo{\parsearg\Xfoo}
535 % \def\Xfoo#1{...}
536 \def\parseargdef#1{%
537   \expandafter \doparseargdef \csname\string#1\endcsname #1%
538 }
539 \def\doparseargdef#1#2{%
540   \def#2{\parsearg#1}%
541   \def#1##1%
542 }
543
544 % Several utility definitions with active space:
545 {
546   \obeyspaces
547   \gdef\obeyedspace{ }
548
549   % Make each space character in the input produce a normal interword
550   % space in the output.  Don't allow a line break at this space, as this
551   % is used only in environments like @example, where each line of input
552   % should produce a line of output anyway.
553   %
554   \gdef\sepspaces{\obeyspaces\let =\tie}
555
556   % If an index command is used in an @example environment, any spaces
557   % therein should become regular spaces in the raw index file, not the
558   % expansion of \tie (\leavevmode \penalty \@M \ ).
559   \gdef\unsepspaces{\let =\space}
560 }
561
562
563 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
564
565 % Define the framework for environments in texinfo.tex.  It's used like this:
566 %
567 %   \envdef\foo{...}
568 %   \def\Efoo{...}
569 %
570 % It's the responsibility of \envdef to insert \begingroup before the
571 % actual body; @end closes the group after calling \Efoo.  \envdef also
572 % defines \thisenv, so the current environment is known; @end checks
573 % whether the environment name matches.  The \checkenv macro can also be
574 % used to check whether the current environment is the one expected.
575 %
576 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
577 % are not treated as environments; they don't open a group.  (The
578 % implementation of @end takes care not to call \endgroup in this
579 % special case.)
580
581
582 % At run-time, environments start with this:
583 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
584 % initialize
585 \let\thisenv\empty
586
587 % ... but they get defined via ``\envdef\foo{...}'':
588 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
589 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
590
591 % Check whether we're in the right environment:
592 \def\checkenv#1{%
593   \def\temp{#1}%
594   \ifx\thisenv\temp
595   \else
596     \badenverr
597   \fi
598 }
599
600 % Environment mismatch, #1 expected:
601 \def\badenverr{%
602   \errhelp = \EMsimple
603   \errmessage{This command can appear only \inenvironment\temp,
604     not \inenvironment\thisenv}%
605 }
606 \def\inenvironment#1{%
607   \ifx#1\empty
608     outside of any environment%
609   \else
610     in environment \expandafter\string#1%
611   \fi
612 }
613
614 % @end foo executes the definition of \Efoo.
615 % But first, it executes a specialized version of \checkenv
616 %
617 \parseargdef\end{%
618   \if 1\csname iscond.#1\endcsname
619   \else
620     % The general wording of \badenverr may not be ideal.
621     \expandafter\checkenv\csname#1\endcsname
622     \csname E#1\endcsname
623     \endgroup
624   \fi
625 }
626
627 \newhelp\EMsimple{Press RETURN to continue.}
628
629
630 % Be sure we're in horizontal mode when doing a tie, since we make space
631 % equivalent to this in @example-like environments. Otherwise, a space
632 % at the beginning of a line will start with \penalty -- and
633 % since \penalty is valid in vertical mode, we'd end up putting the
634 % penalty on the vertical list instead of in the new paragraph.
635 {\catcode`@ = 11
636  % Avoid using \@M directly, because that causes trouble
637  % if the definition is written into an index file.
638  \global\let\tiepenalty = \@M
639  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
640 }
641
642 % @: forces normal size whitespace following.
643 \def\:{\spacefactor=1000 }
644
645 % @* forces a line break.
646 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
647
648 % @/ allows a line break.
649 \let\/=\allowbreak
650
651 % @. is an end-of-sentence period.
652 \def\.{.\spacefactor=\endofsentencespacefactor\space}
653
654 % @! is an end-of-sentence bang.
655 \def\!{!\spacefactor=\endofsentencespacefactor\space}
656
657 % @? is an end-of-sentence query.
658 \def\?{?\spacefactor=\endofsentencespacefactor\space}
659
660 % @frenchspacing on|off  says whether to put extra space after punctuation.
661 %
662 \def\onword{on}
663 \def\offword{off}
664 %
665 \parseargdef\frenchspacing{%
666   \def\temp{#1}%
667   \ifx\temp\onword \plainfrenchspacing
668   \else\ifx\temp\offword \plainnonfrenchspacing
669   \else
670     \errhelp = \EMsimple
671     \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
672   \fi\fi
673 }
674
675 % @w prevents a word break.  Without the \leavevmode, @w at the
676 % beginning of a paragraph, when TeX is still in vertical mode, would
677 % produce a whole line of output instead of starting the paragraph.
678 \def\w#1{\leavevmode\hbox{#1}}
679
680 % @group ... @end group forces ... to be all on one page, by enclosing
681 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
682 % to keep its height that of a normal line.  According to the rules for
683 % \topskip (p.114 of the TeXbook), the glue inserted is
684 % max (\topskip - \ht (first item), 0).  If that height is large,
685 % therefore, no glue is inserted, and the space between the headline and
686 % the text is small, which looks bad.
687 %
688 % Another complication is that the group might be very large.  This can
689 % cause the glue on the previous page to be unduly stretched, because it
690 % does not have much material.  In this case, it's better to add an
691 % explicit \vfill so that the extra space is at the bottom.  The
692 % threshold for doing this is if the group is more than \vfilllimit
693 % percent of a page (\vfilllimit can be changed inside of @tex).
694 %
695 \newbox\groupbox
696 \def\vfilllimit{0.7}
697 %
698 \envdef\group{%
699   \ifnum\catcode`\^^M=\active \else
700     \errhelp = \groupinvalidhelp
701     \errmessage{@group invalid in context where filling is enabled}%
702   \fi
703   \startsavinginserts
704   %
705   \setbox\groupbox = \vtop\bgroup
706     % Do @comment since we are called inside an environment such as
707     % @example, where each end-of-line in the input causes an
708     % end-of-line in the output.  We don't want the end-of-line after
709     % the `@group' to put extra space in the output.  Since @group
710     % should appear on a line by itself (according to the Texinfo
711     % manual), we don't worry about eating any user text.
712     \comment
713 }
714 %
715 % The \vtop produces a box with normal height and large depth; thus, TeX puts
716 % \baselineskip glue before it, and (when the next line of text is done)
717 % \lineskip glue after it.  Thus, space below is not quite equal to space
718 % above.  But it's pretty close.
719 \def\Egroup{%
720     % To get correct interline space between the last line of the group
721     % and the first line afterwards, we have to propagate \prevdepth.
722     \endgraf % Not \par, as it may have been set to \lisppar.
723     \global\dimen1 = \prevdepth
724   \egroup           % End the \vtop.
725   \addgroupbox
726   \prevdepth = \dimen1
727   \checkinserts
728 }
729
730 \def\addgroupbox{
731   % \dimen0 is the vertical size of the group's box.
732   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
733   % \dimen2 is how much space is left on the page (more or less).
734   \dimen2 = \txipageheight   \advance\dimen2 by -\pagetotal
735   % if the group doesn't fit on the current page, and it's a big big
736   % group, force a page break.
737   \ifdim \dimen0 > \dimen2
738     \ifdim \pagetotal < \vfilllimit\txipageheight
739       \page
740     \fi
741   \fi
742   \box\groupbox
743 }
744
745 %
746 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
747 % message, so this ends up printing `@group can only ...'.
748 %
749 \newhelp\groupinvalidhelp{%
750 group can only be used in environments such as @example,^^J%
751 where each line of input produces a line of output.}
752
753 % @need space-in-mils
754 % forces a page break if there is not space-in-mils remaining.
755
756 \newdimen\mil  \mil=0.001in
757
758 \parseargdef\need{%
759   % Ensure vertical mode, so we don't make a big box in the middle of a
760   % paragraph.
761   \par
762   %
763   % If the @need value is less than one line space, it's useless.
764   \dimen0 = #1\mil
765   \dimen2 = \ht\strutbox
766   \advance\dimen2 by \dp\strutbox
767   \ifdim\dimen0 > \dimen2
768     %
769     % Do a \strut just to make the height of this box be normal, so the
770     % normal leading is inserted relative to the preceding line.
771     % And a page break here is fine.
772     \vtop to #1\mil{\strut\vfil}%
773     %
774     % TeX does not even consider page breaks if a penalty added to the
775     % main vertical list is 10000 or more.  But in order to see if the
776     % empty box we just added fits on the page, we must make it consider
777     % page breaks.  On the other hand, we don't want to actually break the
778     % page after the empty box.  So we use a penalty of 9999.
779     %
780     % There is an extremely small chance that TeX will actually break the
781     % page at this \penalty, if there are no other feasible breakpoints in
782     % sight.  (If the user is using lots of big @group commands, which
783     % almost-but-not-quite fill up a page, TeX will have a hard time doing
784     % good page breaking, for example.)  However, I could not construct an
785     % example where a page broke at this \penalty; if it happens in a real
786     % document, then we can reconsider our strategy.
787     \penalty9999
788     %
789     % Back up by the size of the box, whether we did a page break or not.
790     \kern -#1\mil
791     %
792     % Do not allow a page break right after this kern.
793     \nobreak
794   \fi
795 }
796
797 % @br   forces paragraph break (and is undocumented).
798
799 \let\br = \par
800
801 % @page forces the start of a new page.
802 %
803 \def\page{\par\vfill\supereject}
804
805 % @exdent text....
806 % outputs text on separate line in roman font, starting at standard page margin
807
808 % This records the amount of indent in the innermost environment.
809 % That's how much \exdent should take out.
810 \newskip\exdentamount
811
812 % This defn is used inside fill environments such as @defun.
813 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
814
815 % This defn is used inside nofill environments such as @example.
816 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
817   \leftline{\hskip\leftskip{\rm#1}}}}
818
819 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
820 % paragraph.  For more general purposes, use the \margin insertion
821 % class.  WHICH is `l' or `r'.  Not documented, written for gawk manual.
822 %
823 \newskip\inmarginspacing \inmarginspacing=1cm
824 \def\strutdepth{\dp\strutbox}
825 %
826 \def\doinmargin#1#2{\strut\vadjust{%
827   \nobreak
828   \kern-\strutdepth
829   \vtop to \strutdepth{%
830     \baselineskip=\strutdepth
831     \vss
832     % if you have multiple lines of stuff to put here, you'll need to
833     % make the vbox yourself of the appropriate size.
834     \ifx#1l%
835       \llap{\ignorespaces #2\hskip\inmarginspacing}%
836     \else
837       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
838     \fi
839     \null
840   }%
841 }}
842 \def\inleftmargin{\doinmargin l}
843 \def\inrightmargin{\doinmargin r}
844 %
845 % @inmargin{TEXT [, RIGHT-TEXT]}
846 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
847 % else use TEXT for both).
848 %
849 \def\inmargin#1{\parseinmargin #1,,\finish}
850 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
851   \setbox0 = \hbox{\ignorespaces #2}%
852   \ifdim\wd0 > 0pt
853     \def\lefttext{#1}%  have both texts
854     \def\righttext{#2}%
855   \else
856     \def\lefttext{#1}%  have only one text
857     \def\righttext{#1}%
858   \fi
859   %
860   \ifodd\pageno
861     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
862   \else
863     \def\temp{\inleftmargin\lefttext}%
864   \fi
865   \temp
866 }
867
868 % @include FILE -- \input text of FILE.
869 %
870 \def\include{\parseargusing\filenamecatcodes\includezzz}
871 \def\includezzz#1{%
872   \pushthisfilestack
873   \def\thisfile{#1}%
874   {%
875     \makevalueexpandable  % we want to expand any @value in FILE.
876     \turnoffactive        % and allow special characters in the expansion
877     \indexnofonts         % Allow `@@' and other weird things in file names.
878     \wlog{texinfo.tex: doing @include of #1^^J}%
879     \edef\temp{\noexpand\input #1 }%
880     %
881     % This trickery is to read FILE outside of a group, in case it makes
882     % definitions, etc.
883     \expandafter
884   }\temp
885   \popthisfilestack
886 }
887 \def\filenamecatcodes{%
888   \catcode`\\=\other
889   \catcode`~=\other
890   \catcode`^=\other
891   \catcode`_=\other
892   \catcode`|=\other
893   \catcode`<=\other
894   \catcode`>=\other
895   \catcode`+=\other
896   \catcode`-=\other
897   \catcode`\`=\other
898   \catcode`\'=\other
899 }
900
901 \def\pushthisfilestack{%
902   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
903 }
904 \def\pushthisfilestackX{%
905   \expandafter\pushthisfilestackY\thisfile\StackTerm
906 }
907 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
908   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
909 }
910
911 \def\popthisfilestack{\errthisfilestackempty}
912 \def\errthisfilestackempty{\errmessage{Internal error:
913   the stack of filenames is empty.}}
914 %
915 \def\thisfile{}
916
917 % @center line
918 % outputs that line, centered.
919 %
920 \parseargdef\center{%
921   \ifhmode
922     \let\centersub\centerH
923   \else
924     \let\centersub\centerV
925   \fi
926   \centersub{\hfil \ignorespaces#1\unskip \hfil}%
927   \let\centersub\relax % don't let the definition persist, just in case
928 }
929 \def\centerH#1{{%
930   \hfil\break
931   \advance\hsize by -\leftskip
932   \advance\hsize by -\rightskip
933   \line{#1}%
934   \break
935 }}
936 %
937 \newcount\centerpenalty
938 \def\centerV#1{%
939   % The idea here is the same as in \startdefun, \cartouche, etc.: if
940   % @center is the first thing after a section heading, we need to wipe
941   % out the negative parskip inserted by \sectionheading, but still
942   % prevent a page break here.
943   \centerpenalty = \lastpenalty
944   \ifnum\centerpenalty>10000 \vskip\parskip \fi
945   \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
946   \line{\kern\leftskip #1\kern\rightskip}%
947 }
948
949 % @sp n   outputs n lines of vertical space
950 %
951 \parseargdef\sp{\vskip #1\baselineskip}
952
953 % @comment ...line which is ignored...
954 % @c is the same as @comment
955 % @ignore ... @end ignore  is another way to write a comment
956
957
958 \def\c{\begingroup \catcode`\^^M=\active%
959 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
960 \cxxx}
961 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
962 %
963 \let\comment\c
964
965 % @paragraphindent NCHARS
966 % We'll use ems for NCHARS, close enough.
967 % NCHARS can also be the word `asis' or `none'.
968 % We cannot feasibly implement @paragraphindent asis, though.
969 %
970 \def\asisword{asis} % no translation, these are keywords
971 \def\noneword{none}
972 %
973 \parseargdef\paragraphindent{%
974   \def\temp{#1}%
975   \ifx\temp\asisword
976   \else
977     \ifx\temp\noneword
978       \defaultparindent = 0pt
979     \else
980       \defaultparindent = #1em
981     \fi
982   \fi
983   \parindent = \defaultparindent
984 }
985
986 % @exampleindent NCHARS
987 % We'll use ems for NCHARS like @paragraphindent.
988 % It seems @exampleindent asis isn't necessary, but
989 % I preserve it to make it similar to @paragraphindent.
990 \parseargdef\exampleindent{%
991   \def\temp{#1}%
992   \ifx\temp\asisword
993   \else
994     \ifx\temp\noneword
995       \lispnarrowing = 0pt
996     \else
997       \lispnarrowing = #1em
998     \fi
999   \fi
1000 }
1001
1002 % @firstparagraphindent WORD
1003 % If WORD is `none', then suppress indentation of the first paragraph
1004 % after a section heading.  If WORD is `insert', then do indent at such
1005 % paragraphs.
1006 %
1007 % The paragraph indentation is suppressed or not by calling
1008 % \suppressfirstparagraphindent, which the sectioning commands do.
1009 % We switch the definition of this back and forth according to WORD.
1010 % By default, we suppress indentation.
1011 %
1012 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1013 \def\insertword{insert}
1014 %
1015 \parseargdef\firstparagraphindent{%
1016   \def\temp{#1}%
1017   \ifx\temp\noneword
1018     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1019   \else\ifx\temp\insertword
1020     \let\suppressfirstparagraphindent = \relax
1021   \else
1022     \errhelp = \EMsimple
1023     \errmessage{Unknown @firstparagraphindent option `\temp'}%
1024   \fi\fi
1025 }
1026
1027 % Here is how we actually suppress indentation.  Redefine \everypar to
1028 % \kern backwards by \parindent, and then reset itself to empty.
1029 %
1030 % We also make \indent itself not actually do anything until the next
1031 % paragraph.
1032 %
1033 \gdef\dosuppressfirstparagraphindent{%
1034   \gdef\indent  {\restorefirstparagraphindent \indent}%
1035   \gdef\noindent{\restorefirstparagraphindent \noindent}%
1036   \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
1037 }
1038 %
1039 \gdef\restorefirstparagraphindent{%
1040   \global\let\indent = \ptexindent
1041   \global\let\noindent = \ptexnoindent
1042   \global\everypar = {}%
1043 }
1044
1045
1046 % @refill is a no-op.
1047 \let\refill=\relax
1048
1049 % @setfilename INFO-FILENAME - ignored
1050 \let\setfilename=\comment
1051
1052 % @bye.
1053 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1054
1055
1056 \message{pdf,}
1057 % adobe `portable' document format
1058 \newcount\tempnum
1059 \newcount\lnkcount
1060 \newtoks\filename
1061 \newcount\filenamelength
1062 \newcount\pgn
1063 \newtoks\toksA
1064 \newtoks\toksB
1065 \newtoks\toksC
1066 \newtoks\toksD
1067 \newbox\boxA
1068 \newbox\boxB
1069 \newcount\countA
1070 \newif\ifpdf
1071 \newif\ifpdfmakepagedest
1072
1073 %
1074 % For LuaTeX
1075 %
1076
1077 \newif\iftxiuseunicodedestname
1078 \txiuseunicodedestnamefalse % For pdfTeX etc.
1079
1080 \ifx\luatexversion\thisisundefined
1081 \else
1082   % Use Unicode destination names
1083   \txiuseunicodedestnametrue
1084   % Escape PDF strings with converting UTF-16 from UTF-8
1085   \begingroup
1086     \catcode`\%=12
1087     \directlua{
1088       function UTF16oct(str)
1089         tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
1090         for c in string.utfvalues(str) do
1091           if c < 0x10000 then
1092             tex.sprint(
1093               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1094                             string.char(0x5c) .. string.char(0x25) .. '03o',
1095                             (c / 256), (c % 256)))
1096           else
1097             c = c - 0x10000
1098             local c_hi = c / 1024 + 0xd800
1099             local c_lo = c % 1024 + 0xdc00
1100             tex.sprint(
1101               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1102                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
1103                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
1104                             string.char(0x5c) .. string.char(0x25) .. '03o',
1105                             (c_hi / 256), (c_hi % 256),
1106                             (c_lo / 256), (c_lo % 256)))
1107           end
1108         end
1109       end
1110     }
1111   \endgroup
1112   \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
1113   % Escape PDF strings without converting
1114   \begingroup
1115     \directlua{
1116       function PDFescstr(str)
1117         for c in string.bytes(str) do
1118           if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
1119             tex.sprint(
1120               string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
1121                             c))
1122           else
1123             tex.sprint(string.char(c))
1124           end
1125         end
1126       end
1127     }
1128   \endgroup
1129   \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
1130   \ifnum\luatexversion>84
1131     % For LuaTeX >= 0.85
1132     \def\pdfdest{\pdfextension dest}
1133     \let\pdfoutput\outputmode
1134     \def\pdfliteral{\pdfextension literal}
1135     \def\pdfcatalog{\pdfextension catalog}
1136     \def\pdftexversion{\numexpr\pdffeedback version\relax}
1137     \let\pdfximage\saveimageresource
1138     \let\pdfrefximage\useimageresource
1139     \let\pdflastximage\lastsavedimageresourceindex
1140     \def\pdfendlink{\pdfextension endlink\relax}
1141     \def\pdfoutline{\pdfextension outline}
1142     \def\pdfstartlink{\pdfextension startlink}
1143     \def\pdffontattr{\pdfextension fontattr}
1144     \def\pdfobj{\pdfextension obj}
1145     \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
1146     \let\pdfpagewidth\pagewidth
1147     \let\pdfpageheight\pageheight
1148     \edef\pdfhorigin{\pdfvariable horigin}
1149     \edef\pdfvorigin{\pdfvariable vorigin}
1150   \fi
1151 \fi
1152
1153 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1154 % can be set).  So we test for \relax and 0 as well as being undefined.
1155 \ifx\pdfoutput\thisisundefined
1156 \else
1157   \ifx\pdfoutput\relax
1158   \else
1159     \ifcase\pdfoutput
1160     \else
1161       \pdftrue
1162     \fi
1163   \fi
1164 \fi
1165
1166 % PDF uses PostScript string constants for the names of xref targets,
1167 % for display in the outlines, and in other places.  Thus, we have to
1168 % double any backslashes.  Otherwise, a name like "\node" will be
1169 % interpreted as a newline (\n), followed by o, d, e.  Not good.
1170
1171 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1172 % related messages.  The final outcome is that it is up to the TeX user
1173 % to double the backslashes and otherwise make the string valid, so
1174 % that's what we do.  pdftex 1.30.0 (ca.2005) introduced a primitive to
1175 % do this reliably, so we use it.
1176
1177 % #1 is a control sequence in which to do the replacements,
1178 % which we \xdef.
1179 \def\txiescapepdf#1{%
1180   \ifx\pdfescapestring\thisisundefined
1181     % No primitive available; should we give a warning or log?
1182     % Many times it won't matter.
1183     \xdef#1{#1}%
1184   \else
1185     % The expandable \pdfescapestring primitive escapes parentheses,
1186     % backslashes, and other special chars.
1187     \xdef#1{\pdfescapestring{#1}}%
1188   \fi
1189 }
1190 \def\txiescapepdfutfsixteen#1{%
1191   \ifx\pdfescapestrutfsixteen\thisisundefined
1192     % No UTF-16 converting macro available.
1193     \txiescapepdf{#1}%
1194   \else
1195     \xdef#1{\pdfescapestrutfsixteen{#1}}%
1196   \fi
1197 }
1198
1199 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1200 with PDF output, and none of those formats could be found.  (.eps cannot
1201 be supported due to the design of the PDF format; use regular TeX (DVI
1202 output) for that.)}
1203
1204 \ifpdf
1205   %
1206   % Color manipulation macros using ideas from pdfcolor.tex,
1207   % except using rgb instead of cmyk; the latter is said to render as a
1208   % very dark gray on-screen and a very dark halftone in print, instead
1209   % of actual black. The dark red here is dark enough to print on paper as
1210   % nearly black, but still distinguishable for online viewing.  We use
1211   % black by default, though.
1212   \def\rgbDarkRed{0.50 0.09 0.12}
1213   \def\rgbBlack{0 0 0}
1214   %
1215   % rg sets the color for filling (usual text, etc.);
1216   % RG sets the color for stroking (thin rules, e.g., normal _'s).
1217   \def\pdfsetcolor#1{\pdfliteral{#1 rg  #1 RG}}
1218   %
1219   % Set color, and create a mark which defines \thiscolor accordingly,
1220   % so that \makeheadline knows which color to restore.
1221   \def\setcolor#1{%
1222     \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1223     \domark
1224     \pdfsetcolor{#1}%
1225   }
1226   %
1227   \def\maincolor{\rgbBlack}
1228   \pdfsetcolor{\maincolor}
1229   \edef\thiscolor{\maincolor}
1230   \def\lastcolordefs{}
1231   %
1232   \def\makefootline{%
1233     \baselineskip24pt
1234     \line{\pdfsetcolor{\maincolor}\the\footline}%
1235   }
1236   %
1237   \def\makeheadline{%
1238     \vbox to 0pt{%
1239       \vskip-22.5pt
1240       \line{%
1241         \vbox to8.5pt{}%
1242         % Extract \thiscolor definition from the marks.
1243         \getcolormarks
1244         % Typeset the headline with \maincolor, then restore the color.
1245         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1246       }%
1247       \vss
1248     }%
1249     \nointerlineskip
1250   }
1251   %
1252   %
1253   \pdfcatalog{/PageMode /UseOutlines}
1254   %
1255   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1256   \def\dopdfimage#1#2#3{%
1257     \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1258     \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1259     %
1260     % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1261     % others).  Let's try in that order, PDF first since if
1262     % someone has a scalable image, presumably better to use that than a
1263     % bitmap.
1264     \let\pdfimgext=\empty
1265     \begingroup
1266       \openin 1 #1.pdf \ifeof 1
1267         \openin 1 #1.PDF \ifeof 1
1268           \openin 1 #1.png \ifeof 1
1269             \openin 1 #1.jpg \ifeof 1
1270               \openin 1 #1.jpeg \ifeof 1
1271                 \openin 1 #1.JPG \ifeof 1
1272                   \errhelp = \nopdfimagehelp
1273                   \errmessage{Could not find image file #1 for pdf}%
1274                 \else \gdef\pdfimgext{JPG}%
1275                 \fi
1276               \else \gdef\pdfimgext{jpeg}%
1277               \fi
1278             \else \gdef\pdfimgext{jpg}%
1279             \fi
1280           \else \gdef\pdfimgext{png}%
1281           \fi
1282         \else \gdef\pdfimgext{PDF}%
1283         \fi
1284       \else \gdef\pdfimgext{pdf}%
1285       \fi
1286       \closein 1
1287     \endgroup
1288     %
1289     % without \immediate, ancient pdftex seg faults when the same image is
1290     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1291     \ifnum\pdftexversion < 14
1292       \immediate\pdfimage
1293     \else
1294       \immediate\pdfximage
1295     \fi
1296       \ifdim \wd0 >0pt width \pdfimagewidth \fi
1297       \ifdim \wd2 >0pt height \pdfimageheight \fi
1298       \ifnum\pdftexversion<13
1299          #1.\pdfimgext
1300        \else
1301          {#1.\pdfimgext}%
1302        \fi
1303     \ifnum\pdftexversion < 14 \else
1304       \pdfrefximage \pdflastximage
1305     \fi}
1306   %
1307   \def\setpdfdestname#1{{%
1308     % We have to set dummies so commands such as @code, and characters
1309     % such as \, aren't expanded when present in a section title.
1310     \indexnofonts
1311     \makevalueexpandable
1312     \turnoffactive
1313     \iftxiuseunicodedestname
1314       \ifx \declaredencoding \latone
1315         % Pass through Latin-1 characters.
1316         % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
1317       \else
1318         \ifx \declaredencoding \utfeight
1319           % Pass through Unicode characters.
1320         \else
1321           % Use ASCII approximations in destination names.
1322           \passthroughcharsfalse
1323         \fi
1324       \fi
1325     \else
1326       % Use ASCII approximations in destination names.
1327       \passthroughcharsfalse
1328     \fi
1329     \def\pdfdestname{#1}%
1330     \txiescapepdf\pdfdestname
1331   }}
1332   %
1333   \def\setpdfoutlinetext#1{{%
1334     \indexnofonts
1335     \makevalueexpandable
1336     \turnoffactive
1337     \ifx \declaredencoding \latone
1338       % The PDF format can use an extended form of Latin-1 in bookmark
1339       % strings.  See Appendix D of the PDF Reference, Sixth Edition, for
1340       % the "PDFDocEncoding".
1341       \passthroughcharstrue
1342       % Pass through Latin-1 characters.
1343       %   LuaTeX: Convert to Unicode
1344       %   pdfTeX: Use Latin-1 as PDFDocEncoding
1345       \def\pdfoutlinetext{#1}%
1346     \else
1347       \ifx \declaredencoding \utfeight
1348         \ifx\luatexversion\thisisundefined
1349           % For pdfTeX  with UTF-8.
1350           % TODO: the PDF format can use UTF-16 in bookmark strings,
1351           % but the code for this isn't done yet.
1352           % Use ASCII approximations.
1353           \passthroughcharsfalse
1354           \def\pdfoutlinetext{#1}%
1355         \else
1356           % For LuaTeX with UTF-8.
1357           % Pass through Unicode characters for title texts.
1358           \passthroughcharstrue
1359           \def\pdfoutlinetext{#1}%
1360         \fi
1361       \else
1362         % For non-Latin-1 or non-UTF-8 encodings.
1363         % Use ASCII approximations.
1364         \passthroughcharsfalse
1365         \def\pdfoutlinetext{#1}%
1366       \fi
1367     \fi
1368     % LuaTeX: Convert to UTF-16
1369     % pdfTeX: Use Latin-1 as PDFDocEncoding
1370     \txiescapepdfutfsixteen\pdfoutlinetext
1371   }}
1372   %
1373   \def\pdfmkdest#1{%
1374     \setpdfdestname{#1}%
1375     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1376   }
1377   %
1378   % used to mark target names; must be expandable.
1379   \def\pdfmkpgn#1{#1}
1380   %
1381   % by default, use black for everything.
1382   \def\urlcolor{\rgbBlack}
1383   \def\linkcolor{\rgbBlack}
1384   \def\endlink{\setcolor{\maincolor}\pdfendlink}
1385   %
1386   % Adding outlines to PDF; macros for calculating structure of outlines
1387   % come from Petr Olsak
1388   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1389     \else \csname#1\endcsname \fi}
1390   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1391     \advance\tempnum by 1
1392     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1393   %
1394   % #1 is the section text, which is what will be displayed in the
1395   % outline by the pdf viewer.  #2 is the pdf expression for the number
1396   % of subentries (or empty, for subsubsections).  #3 is the node text,
1397   % which might be empty if this toc entry had no corresponding node.
1398   % #4 is the page number
1399   %
1400   \def\dopdfoutline#1#2#3#4{%
1401     % Generate a link to the node text if that exists; else, use the
1402     % page number.  We could generate a destination for the section
1403     % text in the case where a section has no node, but it doesn't
1404     % seem worth the trouble, since most documents are normally structured.
1405     \setpdfoutlinetext{#1}
1406     \setpdfdestname{#3}
1407     \ifx\pdfdestname\empty
1408       \def\pdfdestname{#4}%
1409     \fi
1410     %
1411     \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
1412   }
1413   %
1414   \def\pdfmakeoutlines{%
1415     \begingroup
1416       % Read toc silently, to get counts of subentries for \pdfoutline.
1417       \def\partentry##1##2##3##4{}% ignore parts in the outlines
1418       \def\numchapentry##1##2##3##4{%
1419         \def\thischapnum{##2}%
1420         \def\thissecnum{0}%
1421         \def\thissubsecnum{0}%
1422       }%
1423       \def\numsecentry##1##2##3##4{%
1424         \advancenumber{chap\thischapnum}%
1425         \def\thissecnum{##2}%
1426         \def\thissubsecnum{0}%
1427       }%
1428       \def\numsubsecentry##1##2##3##4{%
1429         \advancenumber{sec\thissecnum}%
1430         \def\thissubsecnum{##2}%
1431       }%
1432       \def\numsubsubsecentry##1##2##3##4{%
1433         \advancenumber{subsec\thissubsecnum}%
1434       }%
1435       \def\thischapnum{0}%
1436       \def\thissecnum{0}%
1437       \def\thissubsecnum{0}%
1438       %
1439       % use \def rather than \let here because we redefine \chapentry et
1440       % al. a second time, below.
1441       \def\appentry{\numchapentry}%
1442       \def\appsecentry{\numsecentry}%
1443       \def\appsubsecentry{\numsubsecentry}%
1444       \def\appsubsubsecentry{\numsubsubsecentry}%
1445       \def\unnchapentry{\numchapentry}%
1446       \def\unnsecentry{\numsecentry}%
1447       \def\unnsubsecentry{\numsubsecentry}%
1448       \def\unnsubsubsecentry{\numsubsubsecentry}%
1449       \readdatafile{toc}%
1450       %
1451       % Read toc second time, this time actually producing the outlines.
1452       % The `-' means take the \expnumber as the absolute number of
1453       % subentries, which we calculated on our first read of the .toc above.
1454       %
1455       % We use the node names as the destinations.
1456       \def\numchapentry##1##2##3##4{%
1457         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1458       \def\numsecentry##1##2##3##4{%
1459         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1460       \def\numsubsecentry##1##2##3##4{%
1461         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1462       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1463         \dopdfoutline{##1}{}{##3}{##4}}%
1464       %
1465       % PDF outlines are displayed using system fonts, instead of
1466       % document fonts.  Therefore we cannot use special characters,
1467       % since the encoding is unknown.  For example, the eogonek from
1468       % Latin 2 (0xea) gets translated to a | character.  Info from
1469       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1470       %
1471       % TODO this right, we have to translate 8-bit characters to
1472       % their "best" equivalent, based on the @documentencoding.  Too
1473       % much work for too little return.  Just use the ASCII equivalents
1474       % we use for the index sort strings.
1475       % 
1476       \indexnofonts
1477       \setupdatafile
1478       % We can have normal brace characters in the PDF outlines, unlike
1479       % Texinfo index files.  So set that up.
1480       \def\{{\lbracecharliteral}%
1481       \def\}{\rbracecharliteral}%
1482       \catcode`\\=\active \otherbackslash
1483       \input \tocreadfilename
1484     \endgroup
1485   }
1486   {\catcode`[=1 \catcode`]=2
1487    \catcode`{=\other \catcode`}=\other
1488    \gdef\lbracecharliteral[{]%
1489    \gdef\rbracecharliteral[}]%
1490   ]
1491   %
1492   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1493     \ifx\PP\D\let\nextsp\relax
1494     \else\let\nextsp\skipspaces
1495       \addtokens{\filename}{\PP}%
1496       \advance\filenamelength by 1
1497     \fi
1498     \nextsp}
1499   \def\getfilename#1{%
1500     \filenamelength=0
1501     % If we don't expand the argument now, \skipspaces will get
1502     % snagged on things like "@value{foo}".
1503     \edef\temp{#1}%
1504     \expandafter\skipspaces\temp|\relax
1505   }
1506   \ifnum\pdftexversion < 14
1507     \let \startlink \pdfannotlink
1508   \else
1509     \let \startlink \pdfstartlink
1510   \fi
1511   % make a live url in pdf output.
1512   \def\pdfurl#1{%
1513     \begingroup
1514       % it seems we really need yet another set of dummies; have not
1515       % tried to figure out what each command should do in the context
1516       % of @url.  for now, just make @/ a no-op, that's the only one
1517       % people have actually reported a problem with.
1518       %
1519       \normalturnoffactive
1520       \def\@{@}%
1521       \let\/=\empty
1522       \makevalueexpandable
1523       % do we want to go so far as to use \indexnofonts instead of just
1524       % special-casing \var here?
1525       \def\var##1{##1}%
1526       %
1527       \leavevmode\setcolor{\urlcolor}%
1528       \startlink attr{/Border [0 0 0]}%
1529         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1530     \endgroup}
1531   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1532   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1533   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1534   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1535   \def\maketoks{%
1536     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1537     \ifx\first0\adn0
1538     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1539     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1540     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1541     \else
1542       \ifnum0=\countA\else\makelink\fi
1543       \ifx\first.\let\next=\done\else
1544         \let\next=\maketoks
1545         \addtokens{\toksB}{\the\toksD}
1546         \ifx\first,\addtokens{\toksB}{\space}\fi
1547       \fi
1548     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1549     \next}
1550   \def\makelink{\addtokens{\toksB}%
1551     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1552   \def\pdflink#1{%
1553     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1554     \setcolor{\linkcolor}#1\endlink}
1555   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1556 \else
1557   % non-pdf mode
1558   \let\pdfmkdest = \gobble
1559   \let\pdfurl = \gobble
1560   \let\endlink = \relax
1561   \let\setcolor = \gobble
1562   \let\pdfsetcolor = \gobble
1563   \let\pdfmakeoutlines = \relax
1564 \fi  % \ifx\pdfoutput
1565
1566 %
1567 % For XeTeX
1568 %
1569 \ifx\XeTeXrevision\thisisundefined
1570 \else
1571   %
1572   % XeTeX version check
1573   %
1574   \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
1575     % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
1576     % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
1577     % For avoiding PDF destination name replacement, we use this special
1578     % instead of xdvipdfmx's command line option `-C 0x0010'.
1579     \special{dvipdfmx:config C 0x0010}
1580     % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
1581     % It can handle Unicode destination names for PDF.
1582     \txiuseunicodedestnametrue
1583   \else
1584     % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
1585     % `dvipdfmx:config' special.
1586     % So for avoiding PDF destination name replacement,
1587     % xdvipdfmx's command line option `-C 0x0010' is necessary.
1588     %
1589     % XeTeX < 0.99995 can not handle Unicode destination names for PDF
1590     % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
1591     % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1592     \txiuseunicodedestnamefalse
1593   \fi
1594   %
1595   % Color support
1596   %
1597   \def\rgbDarkRed{0.50 0.09 0.12}
1598   \def\rgbBlack{0 0 0}
1599   %
1600   \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
1601   %
1602   % Set color, and create a mark which defines \thiscolor accordingly,
1603   % so that \makeheadline knows which color to restore.
1604   \def\setcolor#1{%
1605     \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1606     \domark
1607     \pdfsetcolor{#1}%
1608   }
1609   %
1610   \def\maincolor{\rgbBlack}
1611   \pdfsetcolor{\maincolor}
1612   \edef\thiscolor{\maincolor}
1613   \def\lastcolordefs{}
1614   %
1615   \def\makefootline{%
1616     \baselineskip24pt
1617     \line{\pdfsetcolor{\maincolor}\the\footline}%
1618   }
1619   %
1620   \def\makeheadline{%
1621     \vbox to 0pt{%
1622       \vskip-22.5pt
1623       \line{%
1624         \vbox to8.5pt{}%
1625         % Extract \thiscolor definition from the marks.
1626         \getcolormarks
1627         % Typeset the headline with \maincolor, then restore the color.
1628         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1629       }%
1630       \vss
1631     }%
1632     \nointerlineskip
1633   }
1634   %
1635   % PDF outline support
1636   %
1637   % Emulate pdfTeX primitive
1638   \def\pdfdest name#1 xyz{%
1639     \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
1640   }
1641   %
1642   \def\setpdfdestname#1{{%
1643     % We have to set dummies so commands such as @code, and characters
1644     % such as \, aren't expanded when present in a section title.
1645     \indexnofonts
1646     \makevalueexpandable
1647     \turnoffactive
1648     \iftxiuseunicodedestname
1649       % Pass through Unicode characters.
1650     \else
1651       % Use ASCII approximations in destination names.
1652       \passthroughcharsfalse
1653     \fi
1654     \def\pdfdestname{#1}%
1655     \txiescapepdf\pdfdestname
1656   }}
1657   %
1658   \def\setpdfoutlinetext#1{{%
1659     \turnoffactive
1660     % Always use Unicode characters in title texts.
1661     \def\pdfoutlinetext{#1}%
1662     % For XeTeX, xdvipdfmx converts to UTF-16.
1663     % So we do not convert.
1664     \txiescapepdf\pdfoutlinetext
1665   }}
1666   %
1667   \def\pdfmkdest#1{%
1668     \setpdfdestname{#1}%
1669     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1670   }
1671   %
1672   % by default, use black for everything.
1673   \def\urlcolor{\rgbBlack}
1674   \def\linkcolor{\rgbBlack}
1675   \def\endlink{\setcolor{\maincolor}\pdfendlink}
1676   %
1677   \def\dopdfoutline#1#2#3#4{%
1678     \setpdfoutlinetext{#1}
1679     \setpdfdestname{#3}
1680     \ifx\pdfdestname\empty
1681       \def\pdfdestname{#4}%
1682     \fi
1683     %
1684     \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1685       << /S /GoTo /D (\pdfdestname) >> >> }%
1686   }
1687   %
1688   \def\pdfmakeoutlines{%
1689     \begingroup
1690       %
1691       % For XeTeX, counts of subentries are not necessary.
1692       % Therefore, we read toc only once.
1693       %
1694       % We use node names as destinations.
1695       \def\partentry##1##2##3##4{}% ignore parts in the outlines
1696       \def\numchapentry##1##2##3##4{%
1697         \dopdfoutline{##1}{1}{##3}{##4}}%
1698       \def\numsecentry##1##2##3##4{%
1699         \dopdfoutline{##1}{2}{##3}{##4}}%
1700       \def\numsubsecentry##1##2##3##4{%
1701         \dopdfoutline{##1}{3}{##3}{##4}}%
1702       \def\numsubsubsecentry##1##2##3##4{%
1703         \dopdfoutline{##1}{4}{##3}{##4}}%
1704       %
1705       \let\appentry\numchapentry%
1706       \let\appsecentry\numsecentry%
1707       \let\appsubsecentry\numsubsecentry%
1708       \let\appsubsubsecentry\numsubsubsecentry%
1709       \let\unnchapentry\numchapentry%
1710       \let\unnsecentry\numsecentry%
1711       \let\unnsubsecentry\numsubsecentry%
1712       \let\unnsubsubsecentry\numsubsubsecentry%
1713       %
1714       % For XeTeX, xdvipdfmx converts strings to UTF-16.
1715       % Therefore, the encoding and the language may not be considered.
1716       %
1717       \indexnofonts
1718       \setupdatafile
1719       % We can have normal brace characters in the PDF outlines, unlike
1720       % Texinfo index files.  So set that up.
1721       \def\{{\lbracecharliteral}%
1722       \def\}{\rbracecharliteral}%
1723       \catcode`\\=\active \otherbackslash
1724       \input \tocreadfilename
1725     \endgroup
1726   }
1727   {\catcode`[=1 \catcode`]=2
1728    \catcode`{=\other \catcode`}=\other
1729    \gdef\lbracecharliteral[{]%
1730    \gdef\rbracecharliteral[}]%
1731   ]
1732
1733   \special{pdf:docview << /PageMode /UseOutlines >> }
1734   % ``\special{pdf:tounicode ...}'' is not necessary
1735   % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1736   % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
1737   % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
1738   % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1739 %
1740   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1741     \ifx\PP\D\let\nextsp\relax
1742     \else\let\nextsp\skipspaces
1743       \addtokens{\filename}{\PP}%
1744       \advance\filenamelength by 1
1745     \fi
1746     \nextsp}
1747   \def\getfilename#1{%
1748     \filenamelength=0
1749     % If we don't expand the argument now, \skipspaces will get
1750     % snagged on things like "@value{foo}".
1751     \edef\temp{#1}%
1752     \expandafter\skipspaces\temp|\relax
1753   }
1754   % make a live url in pdf output.
1755   \def\pdfurl#1{%
1756     \begingroup
1757       % it seems we really need yet another set of dummies; have not
1758       % tried to figure out what each command should do in the context
1759       % of @url.  for now, just make @/ a no-op, that's the only one
1760       % people have actually reported a problem with.
1761       %
1762       \normalturnoffactive
1763       \def\@{@}%
1764       \let\/=\empty
1765       \makevalueexpandable
1766       % do we want to go so far as to use \indexnofonts instead of just
1767       % special-casing \var here?
1768       \def\var##1{##1}%
1769       %
1770       \leavevmode\setcolor{\urlcolor}%
1771       \special{pdf:bann << /Border [0 0 0]
1772         /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
1773     \endgroup}
1774   \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
1775   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1776   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1777   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1778   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1779   \def\maketoks{%
1780     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1781     \ifx\first0\adn0
1782     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1783     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1784     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1785     \else
1786       \ifnum0=\countA\else\makelink\fi
1787       \ifx\first.\let\next=\done\else
1788         \let\next=\maketoks
1789         \addtokens{\toksB}{\the\toksD}
1790         \ifx\first,\addtokens{\toksB}{\space}\fi
1791       \fi
1792     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1793     \next}
1794   \def\makelink{\addtokens{\toksB}%
1795     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1796   \def\pdflink#1{%
1797     \special{pdf:bann << /Border [0 0 0]
1798       /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
1799     \setcolor{\linkcolor}#1\endlink}
1800   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1801 %
1802   %
1803   % @image support
1804   %
1805   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1806   \def\doxeteximage#1#2#3{%
1807     \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1808     \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1809     %
1810     % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
1811     % others).  Let's try in that order, PDF first since if
1812     % someone has a scalable image, presumably better to use that than a
1813     % bitmap.
1814     \let\xeteximgext=\empty
1815     \begingroup
1816       \openin 1 #1.pdf \ifeof 1
1817         \openin 1 #1.PDF \ifeof 1
1818           \openin 1 #1.png \ifeof 1
1819             \openin 1 #1.jpg \ifeof 1
1820               \openin 1 #1.jpeg \ifeof 1
1821                 \openin 1 #1.JPG \ifeof 1
1822                   \errmessage{Could not find image file #1 for XeTeX}%
1823                 \else \gdef\xeteximgext{JPG}%
1824                 \fi
1825               \else \gdef\xeteximgext{jpeg}%
1826               \fi
1827             \else \gdef\xeteximgext{jpg}%
1828             \fi
1829           \else \gdef\xeteximgext{png}%
1830           \fi
1831         \else \gdef\xeteximgext{PDF}%
1832         \fi
1833       \else \gdef\xeteximgext{pdf}%
1834       \fi
1835       \closein 1
1836     \endgroup
1837     %
1838     \def\xetexpdfext{pdf}%
1839     \ifx\xeteximgext\xetexpdfext
1840       \XeTeXpdffile "#1".\xeteximgext ""
1841     \else
1842       \def\xetexpdfext{PDF}%
1843       \ifx\xeteximgext\xetexpdfext
1844         \XeTeXpdffile "#1".\xeteximgext ""
1845       \else
1846         \XeTeXpicfile "#1".\xeteximgext ""
1847       \fi
1848     \fi
1849     \ifdim \wd0 >0pt width \xeteximagewidth \fi
1850     \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
1851   }
1852 \fi
1853
1854
1855 %
1856 \message{fonts,}
1857
1858 % Set the baselineskip to #1, and the lineskip and strut size
1859 % correspondingly.  There is no deep meaning behind these magic numbers
1860 % used as factors; they just match (closely enough) what Knuth defined.
1861 %
1862 \def\lineskipfactor{.08333}
1863 \def\strutheightpercent{.70833}
1864 \def\strutdepthpercent {.29167}
1865 %
1866 % can get a sort of poor man's double spacing by redefining this.
1867 \def\baselinefactor{1}
1868 %
1869 \newdimen\textleading
1870 \def\setleading#1{%
1871   \dimen0 = #1\relax
1872   \normalbaselineskip = \baselinefactor\dimen0
1873   \normallineskip = \lineskipfactor\normalbaselineskip
1874   \normalbaselines
1875   \setbox\strutbox =\hbox{%
1876     \vrule width0pt height\strutheightpercent\baselineskip
1877                     depth \strutdepthpercent \baselineskip
1878   }%
1879 }
1880
1881 % PDF CMaps.  See also LaTeX's t1.cmap.
1882 %
1883 % do nothing with this by default.
1884 \expandafter\let\csname cmapOT1\endcsname\gobble
1885 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1886 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1887
1888 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1889 % (\pdffontattr was introduced many years ago, but people still run
1890 % older pdftex's; it's easy to conditionalize, so we do.)
1891 \ifpdf \ifx\pdffontattr\thisisundefined \else
1892   \begingroup
1893     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1894     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1895 %%DocumentNeededResources: ProcSet (CIDInit)
1896 %%IncludeResource: ProcSet (CIDInit)
1897 %%BeginResource: CMap (TeX-OT1-0)
1898 %%Title: (TeX-OT1-0 TeX OT1 0)
1899 %%Version: 1.000
1900 %%EndComments
1901 /CIDInit /ProcSet findresource begin
1902 12 dict begin
1903 begincmap
1904 /CIDSystemInfo
1905 << /Registry (TeX)
1906 /Ordering (OT1)
1907 /Supplement 0
1908 >> def
1909 /CMapName /TeX-OT1-0 def
1910 /CMapType 2 def
1911 1 begincodespacerange
1912 <00> <7F>
1913 endcodespacerange
1914 8 beginbfrange
1915 <00> <01> <0393>
1916 <09> <0A> <03A8>
1917 <23> <26> <0023>
1918 <28> <3B> <0028>
1919 <3F> <5B> <003F>
1920 <5D> <5E> <005D>
1921 <61> <7A> <0061>
1922 <7B> <7C> <2013>
1923 endbfrange
1924 40 beginbfchar
1925 <02> <0398>
1926 <03> <039B>
1927 <04> <039E>
1928 <05> <03A0>
1929 <06> <03A3>
1930 <07> <03D2>
1931 <08> <03A6>
1932 <0B> <00660066>
1933 <0C> <00660069>
1934 <0D> <0066006C>
1935 <0E> <006600660069>
1936 <0F> <00660066006C>
1937 <10> <0131>
1938 <11> <0237>
1939 <12> <0060>
1940 <13> <00B4>
1941 <14> <02C7>
1942 <15> <02D8>
1943 <16> <00AF>
1944 <17> <02DA>
1945 <18> <00B8>
1946 <19> <00DF>
1947 <1A> <00E6>
1948 <1B> <0153>
1949 <1C> <00F8>
1950 <1D> <00C6>
1951 <1E> <0152>
1952 <1F> <00D8>
1953 <21> <0021>
1954 <22> <201D>
1955 <27> <2019>
1956 <3C> <00A1>
1957 <3D> <003D>
1958 <3E> <00BF>
1959 <5C> <201C>
1960 <5F> <02D9>
1961 <60> <2018>
1962 <7D> <02DD>
1963 <7E> <007E>
1964 <7F> <00A8>
1965 endbfchar
1966 endcmap
1967 CMapName currentdict /CMap defineresource pop
1968 end
1969 end
1970 %%EndResource
1971 %%EOF
1972     }\endgroup
1973   \expandafter\edef\csname cmapOT1\endcsname#1{%
1974     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1975   }%
1976 %
1977 % \cmapOT1IT
1978   \begingroup
1979     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1980     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1981 %%DocumentNeededResources: ProcSet (CIDInit)
1982 %%IncludeResource: ProcSet (CIDInit)
1983 %%BeginResource: CMap (TeX-OT1IT-0)
1984 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1985 %%Version: 1.000
1986 %%EndComments
1987 /CIDInit /ProcSet findresource begin
1988 12 dict begin
1989 begincmap
1990 /CIDSystemInfo
1991 << /Registry (TeX)
1992 /Ordering (OT1IT)
1993 /Supplement 0
1994 >> def
1995 /CMapName /TeX-OT1IT-0 def
1996 /CMapType 2 def
1997 1 begincodespacerange
1998 <00> <7F>
1999 endcodespacerange
2000 8 beginbfrange
2001 <00> <01> <0393>
2002 <09> <0A> <03A8>
2003 <25> <26> <0025>
2004 <28> <3B> <0028>
2005 <3F> <5B> <003F>
2006 <5D> <5E> <005D>
2007 <61> <7A> <0061>
2008 <7B> <7C> <2013>
2009 endbfrange
2010 42 beginbfchar
2011 <02> <0398>
2012 <03> <039B>
2013 <04> <039E>
2014 <05> <03A0>
2015 <06> <03A3>
2016 <07> <03D2>
2017 <08> <03A6>
2018 <0B> <00660066>
2019 <0C> <00660069>
2020 <0D> <0066006C>
2021 <0E> <006600660069>
2022 <0F> <00660066006C>
2023 <10> <0131>
2024 <11> <0237>
2025 <12> <0060>
2026 <13> <00B4>
2027 <14> <02C7>
2028 <15> <02D8>
2029 <16> <00AF>
2030 <17> <02DA>
2031 <18> <00B8>
2032 <19> <00DF>
2033 <1A> <00E6>
2034 <1B> <0153>
2035 <1C> <00F8>
2036 <1D> <00C6>
2037 <1E> <0152>
2038 <1F> <00D8>
2039 <21> <0021>
2040 <22> <201D>
2041 <23> <0023>
2042 <24> <00A3>
2043 <27> <2019>
2044 <3C> <00A1>
2045 <3D> <003D>
2046 <3E> <00BF>
2047 <5C> <201C>
2048 <5F> <02D9>
2049 <60> <2018>
2050 <7D> <02DD>
2051 <7E> <007E>
2052 <7F> <00A8>
2053 endbfchar
2054 endcmap
2055 CMapName currentdict /CMap defineresource pop
2056 end
2057 end
2058 %%EndResource
2059 %%EOF
2060     }\endgroup
2061   \expandafter\edef\csname cmapOT1IT\endcsname#1{%
2062     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2063   }%
2064 %
2065 % \cmapOT1TT
2066   \begingroup
2067     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2068     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2069 %%DocumentNeededResources: ProcSet (CIDInit)
2070 %%IncludeResource: ProcSet (CIDInit)
2071 %%BeginResource: CMap (TeX-OT1TT-0)
2072 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
2073 %%Version: 1.000
2074 %%EndComments
2075 /CIDInit /ProcSet findresource begin
2076 12 dict begin
2077 begincmap
2078 /CIDSystemInfo
2079 << /Registry (TeX)
2080 /Ordering (OT1TT)
2081 /Supplement 0
2082 >> def
2083 /CMapName /TeX-OT1TT-0 def
2084 /CMapType 2 def
2085 1 begincodespacerange
2086 <00> <7F>
2087 endcodespacerange
2088 5 beginbfrange
2089 <00> <01> <0393>
2090 <09> <0A> <03A8>
2091 <21> <26> <0021>
2092 <28> <5F> <0028>
2093 <61> <7E> <0061>
2094 endbfrange
2095 32 beginbfchar
2096 <02> <0398>
2097 <03> <039B>
2098 <04> <039E>
2099 <05> <03A0>
2100 <06> <03A3>
2101 <07> <03D2>
2102 <08> <03A6>
2103 <0B> <2191>
2104 <0C> <2193>
2105 <0D> <0027>
2106 <0E> <00A1>
2107 <0F> <00BF>
2108 <10> <0131>
2109 <11> <0237>
2110 <12> <0060>
2111 <13> <00B4>
2112 <14> <02C7>
2113 <15> <02D8>
2114 <16> <00AF>
2115 <17> <02DA>
2116 <18> <00B8>
2117 <19> <00DF>
2118 <1A> <00E6>
2119 <1B> <0153>
2120 <1C> <00F8>
2121 <1D> <00C6>
2122 <1E> <0152>
2123 <1F> <00D8>
2124 <20> <2423>
2125 <27> <2019>
2126 <60> <2018>
2127 <7F> <00A8>
2128 endbfchar
2129 endcmap
2130 CMapName currentdict /CMap defineresource pop
2131 end
2132 end
2133 %%EndResource
2134 %%EOF
2135     }\endgroup
2136   \expandafter\edef\csname cmapOT1TT\endcsname#1{%
2137     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2138   }%
2139 \fi\fi
2140
2141
2142 % Set the font macro #1 to the font named \fontprefix#2.
2143 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2144 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2145 % Example:
2146 % #1 = \textrm
2147 % #2 = \rmshape
2148 % #3 = 10
2149 % #4 = \mainmagstep
2150 % #5 = OT1
2151 %
2152 \def\setfont#1#2#3#4#5{%
2153   \font#1=\fontprefix#2#3 scaled #4
2154   \csname cmap#5\endcsname#1%
2155 }
2156 % This is what gets called when #5 of \setfont is empty.
2157 \let\cmap\gobble
2158 %
2159 % (end of cmaps)
2160
2161 % Use cm as the default font prefix.
2162 % To specify the font prefix, you must define \fontprefix
2163 % before you read in texinfo.tex.
2164 \ifx\fontprefix\thisisundefined
2165 \def\fontprefix{cm}
2166 \fi
2167 % Support font families that don't use the same naming scheme as CM.
2168 \def\rmshape{r}
2169 \def\rmbshape{bx}               % where the normal face is bold
2170 \def\bfshape{b}
2171 \def\bxshape{bx}
2172 \def\ttshape{tt}
2173 \def\ttbshape{tt}
2174 \def\ttslshape{sltt}
2175 \def\itshape{ti}
2176 \def\itbshape{bxti}
2177 \def\slshape{sl}
2178 \def\slbshape{bxsl}
2179 \def\sfshape{ss}
2180 \def\sfbshape{ss}
2181 \def\scshape{csc}
2182 \def\scbshape{csc}
2183
2184 % Definitions for a main text size of 11pt.  (The default in Texinfo.)
2185 %
2186 \def\definetextfontsizexi{%
2187 % Text fonts (11.2pt, magstep1).
2188 \def\textnominalsize{11pt}
2189 \edef\mainmagstep{\magstephalf}
2190 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2191 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2192 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2193 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2194 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2195 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2196 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2197 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2198 \font\texti=cmmi10 scaled \mainmagstep
2199 \font\textsy=cmsy10 scaled \mainmagstep
2200 \def\textecsize{1095}
2201
2202 % A few fonts for @defun names and args.
2203 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2204 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2205 \setfont\defsl\slshape{10}{\magstep1}{OT1TT}
2206 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2207 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2208 \let\ttslfont=\defttsl \let\slfont=\defsl \bf}
2209
2210 % Fonts for indices, footnotes, small examples (9pt).
2211 \def\smallnominalsize{9pt}
2212 \setfont\smallrm\rmshape{9}{1000}{OT1}
2213 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2214 \setfont\smallbf\bfshape{10}{900}{OT1}
2215 \setfont\smallit\itshape{9}{1000}{OT1IT}
2216 \setfont\smallsl\slshape{9}{1000}{OT1}
2217 \setfont\smallsf\sfshape{9}{1000}{OT1}
2218 \setfont\smallsc\scshape{10}{900}{OT1}
2219 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2220 \font\smalli=cmmi9
2221 \font\smallsy=cmsy9
2222 \def\smallecsize{0900}
2223
2224 % Fonts for small examples (8pt).
2225 \def\smallernominalsize{8pt}
2226 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2227 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2228 \setfont\smallerbf\bfshape{10}{800}{OT1}
2229 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2230 \setfont\smallersl\slshape{8}{1000}{OT1}
2231 \setfont\smallersf\sfshape{8}{1000}{OT1}
2232 \setfont\smallersc\scshape{10}{800}{OT1}
2233 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2234 \font\smalleri=cmmi8
2235 \font\smallersy=cmsy8
2236 \def\smallerecsize{0800}
2237
2238 % Fonts for title page (20.4pt):
2239 \def\titlenominalsize{20pt}
2240 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2241 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2242 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2243 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2244 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2245 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2246 \let\titlebf=\titlerm
2247 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2248 \font\titlei=cmmi12 scaled \magstep3
2249 \font\titlesy=cmsy10 scaled \magstep4
2250 \def\titleecsize{2074}
2251
2252 % Chapter (and unnumbered) fonts (17.28pt).
2253 \def\chapnominalsize{17pt}
2254 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2255 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2256 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2257 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2258 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2259 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2260 \let\chapbf=\chaprm
2261 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2262 \font\chapi=cmmi12 scaled \magstep2
2263 \font\chapsy=cmsy10 scaled \magstep3
2264 \def\chapecsize{1728}
2265
2266 % Section fonts (14.4pt).
2267 \def\secnominalsize{14pt}
2268 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2269 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
2270 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2271 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2272 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2273 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2274 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2275 \let\secbf\secrm
2276 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2277 \font\seci=cmmi12 scaled \magstep1
2278 \font\secsy=cmsy10 scaled \magstep2
2279 \def\sececsize{1440}
2280
2281 % Subsection fonts (13.15pt).
2282 \def\ssecnominalsize{13pt}
2283 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2284 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2285 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2286 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2287 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2288 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2289 \let\ssecbf\ssecrm
2290 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2291 \font\sseci=cmmi12 scaled \magstephalf
2292 \font\ssecsy=cmsy10 scaled 1315
2293 \def\ssececsize{1200}
2294
2295 % Reduced fonts for @acronym in text (10pt).
2296 \def\reducednominalsize{10pt}
2297 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2298 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2299 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2300 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2301 \setfont\reducedsl\slshape{10}{1000}{OT1}
2302 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2303 \setfont\reducedsc\scshape{10}{1000}{OT1}
2304 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2305 \font\reducedi=cmmi10
2306 \font\reducedsy=cmsy10
2307 \def\reducedecsize{1000}
2308
2309 \textleading = 13.2pt % line spacing for 11pt CM
2310 \textfonts            % reset the current fonts
2311 \rm
2312 } % end of 11pt text font size definitions, \definetextfontsizexi
2313
2314
2315 % Definitions to make the main text be 10pt Computer Modern, with
2316 % section, chapter, etc., sizes following suit.  This is for the GNU
2317 % Press printing of the Emacs 22 manual.  Maybe other manuals in the
2318 % future.  Used with @smallbook, which sets the leading to 12pt.
2319 %
2320 \def\definetextfontsizex{%
2321 % Text fonts (10pt).
2322 \def\textnominalsize{10pt}
2323 \edef\mainmagstep{1000}
2324 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2325 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2326 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2327 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2328 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2329 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2330 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2331 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2332 \font\texti=cmmi10 scaled \mainmagstep
2333 \font\textsy=cmsy10 scaled \mainmagstep
2334 \def\textecsize{1000}
2335
2336 % A few fonts for @defun names and args.
2337 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2338 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2339 \setfont\defsl\slshape{10}{\magstephalf}{OT1TT}
2340 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2341 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2342 \let\slfont=\defsl \let\ttslfont=\defttsl \bf}
2343
2344 % Fonts for indices, footnotes, small examples (9pt).
2345 \def\smallnominalsize{9pt}
2346 \setfont\smallrm\rmshape{9}{1000}{OT1}
2347 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2348 \setfont\smallbf\bfshape{10}{900}{OT1}
2349 \setfont\smallit\itshape{9}{1000}{OT1IT}
2350 \setfont\smallsl\slshape{9}{1000}{OT1}
2351 \setfont\smallsf\sfshape{9}{1000}{OT1}
2352 \setfont\smallsc\scshape{10}{900}{OT1}
2353 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2354 \font\smalli=cmmi9
2355 \font\smallsy=cmsy9
2356 \def\smallecsize{0900}
2357
2358 % Fonts for small examples (8pt).
2359 \def\smallernominalsize{8pt}
2360 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2361 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2362 \setfont\smallerbf\bfshape{10}{800}{OT1}
2363 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2364 \setfont\smallersl\slshape{8}{1000}{OT1}
2365 \setfont\smallersf\sfshape{8}{1000}{OT1}
2366 \setfont\smallersc\scshape{10}{800}{OT1}
2367 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2368 \font\smalleri=cmmi8
2369 \font\smallersy=cmsy8
2370 \def\smallerecsize{0800}
2371
2372 % Fonts for title page (20.4pt):
2373 \def\titlenominalsize{20pt}
2374 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2375 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2376 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2377 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2378 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2379 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2380 \let\titlebf=\titlerm
2381 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2382 \font\titlei=cmmi12 scaled \magstep3
2383 \font\titlesy=cmsy10 scaled \magstep4
2384 \def\titleecsize{2074}
2385
2386 % Chapter fonts (14.4pt).
2387 \def\chapnominalsize{14pt}
2388 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2389 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2390 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2391 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2392 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2393 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2394 \let\chapbf\chaprm
2395 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2396 \font\chapi=cmmi12 scaled \magstep1
2397 \font\chapsy=cmsy10 scaled \magstep2
2398 \def\chapecsize{1440}
2399
2400 % Section fonts (12pt).
2401 \def\secnominalsize{12pt}
2402 \setfont\secrm\rmbshape{12}{1000}{OT1}
2403 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2404 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2405 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2406 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2407 \setfont\secsf\sfbshape{12}{1000}{OT1}
2408 \let\secbf\secrm
2409 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2410 \font\seci=cmmi12
2411 \font\secsy=cmsy10 scaled \magstep1
2412 \def\sececsize{1200}
2413
2414 % Subsection fonts (10pt).
2415 \def\ssecnominalsize{10pt}
2416 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2417 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2418 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2419 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2420 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2421 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2422 \let\ssecbf\ssecrm
2423 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2424 \font\sseci=cmmi10
2425 \font\ssecsy=cmsy10
2426 \def\ssececsize{1000}
2427
2428 % Reduced fonts for @acronym in text (9pt).
2429 \def\reducednominalsize{9pt}
2430 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2431 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2432 \setfont\reducedbf\bfshape{10}{900}{OT1}
2433 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2434 \setfont\reducedsl\slshape{9}{1000}{OT1}
2435 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2436 \setfont\reducedsc\scshape{10}{900}{OT1}
2437 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2438 \font\reducedi=cmmi9
2439 \font\reducedsy=cmsy9
2440 \def\reducedecsize{0900}
2441
2442 \divide\parskip by 2  % reduce space between paragraphs
2443 \textleading = 12pt   % line spacing for 10pt CM
2444 \textfonts            % reset the current fonts
2445 \rm
2446 } % end of 10pt text font size definitions, \definetextfontsizex
2447
2448 % Fonts for short table of contents.
2449 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2450 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1}  % no cmb12
2451 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2452 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2453
2454
2455 % We provide the user-level command
2456 %   @fonttextsize 10
2457 % (or 11) to redefine the text font size.  pt is assumed.
2458 %
2459 \def\xiword{11}
2460 \def\xword{10}
2461 \def\xwordpt{10pt}
2462 %
2463 \parseargdef\fonttextsize{%
2464   \def\textsizearg{#1}%
2465   %\wlog{doing @fonttextsize \textsizearg}%
2466   %
2467   % Set \globaldefs so that documents can use this inside @tex, since
2468   % makeinfo 4.8 does not support it, but we need it nonetheless.
2469   %
2470  \begingroup \globaldefs=1
2471   \ifx\textsizearg\xword \definetextfontsizex
2472   \else \ifx\textsizearg\xiword \definetextfontsizexi
2473   \else
2474     \errhelp=\EMsimple
2475     \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2476   \fi\fi
2477  \endgroup
2478 }
2479
2480 %
2481 % Change the current font style to #1, remembering it in \curfontstyle.
2482 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
2483 % italics, not bold italics.
2484 %
2485 \def\setfontstyle#1{%
2486   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
2487   \csname #1font\endcsname  % change the current font
2488 }
2489
2490 \def\rm{\fam=0 \setfontstyle{rm}}
2491 \def\it{\fam=\itfam \setfontstyle{it}}
2492 \def\sl{\fam=\slfam \setfontstyle{sl}}
2493 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
2494 \def\tt{\fam=\ttfam \setfontstyle{tt}}
2495
2496 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
2497 % So we set up a \sf.
2498 \newfam\sffam
2499 \def\sf{\fam=\sffam \setfontstyle{sf}}
2500
2501 % We don't need math for this font style.
2502 \def\ttsl{\setfontstyle{ttsl}}
2503
2504
2505 % In order for the font changes to affect most math symbols and letters,
2506 % we have to define the \textfont of the standard families.  We don't
2507 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2508 %
2509 \def\resetmathfonts{%
2510   \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
2511   \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
2512   \textfont\ttfam=\ttfont \textfont\sffam=\sffont
2513 }
2514
2515 %
2516
2517 % The font-changing commands (all called \...fonts) redefine the meanings
2518 % of \STYLEfont, instead of just \STYLE.  We do this because \STYLE needs
2519 % to also set the current \fam for math mode.  Our \STYLE (e.g., \rm)
2520 % commands hardwire \STYLEfont to set the current font.
2521 %
2522 % Each font-changing command also sets the names \lsize (one size lower)
2523 % and \lllsize (three sizes lower).  These relative commands are used
2524 % in, e.g., the LaTeX logo and acronyms.
2525 %
2526 % This all needs generalizing, badly.
2527 %
2528
2529 \def\assignfonts#1{%
2530   \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
2531   \expandafter\let\expandafter\itfont\csname #1it\endcsname
2532   \expandafter\let\expandafter\slfont\csname #1sl\endcsname
2533   \expandafter\let\expandafter\bffont\csname #1bf\endcsname
2534   \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
2535   \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
2536   \expandafter\let\expandafter\sffont  \csname #1sf\endcsname
2537   \expandafter\let\expandafter\ifont   \csname #1i\endcsname
2538   \expandafter\let\expandafter\syfont  \csname #1sy\endcsname
2539   \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
2540 }
2541
2542 \newif\ifrmisbold
2543
2544 % Select smaller font size with the current style.  Used to change font size
2545 % in, e.g., the LaTeX logo and acronyms.  If we are using bold fonts for
2546 % normal roman text, also use bold fonts for roman text in the smaller size.
2547 \def\switchtolllsize{%
2548    \expandafter\assignfonts\expandafter{\lllsize}%
2549    \ifrmisbold
2550      \let\rmfont\bffont
2551    \fi
2552    \csname\curfontstyle\endcsname
2553 }%
2554
2555 \def\switchtolsize{%
2556    \expandafter\assignfonts\expandafter{\lsize}%
2557    \ifrmisbold
2558      \let\rmfont\bffont
2559    \fi
2560    \csname\curfontstyle\endcsname
2561 }%
2562
2563 \def\definefontsetatsize#1#2#3#4#5{%
2564 \expandafter\def\csname #1fonts\endcsname{%
2565   \def\curfontsize{#1}%
2566   \def\lsize{#2}\def\lllsize{#3}%
2567   \csname rmisbold#5\endcsname
2568   \assignfonts{#1}%
2569   \resetmathfonts
2570   \setleading{#4}%
2571 }}
2572
2573 \definefontsetatsize{text}   {reduced}{smaller}{\textleading}{false}
2574 \definefontsetatsize{title}  {chap}   {subsec} {27pt}  {true}
2575 \definefontsetatsize{chap}   {sec}    {text}   {19pt}  {true}
2576 \definefontsetatsize{sec}    {subsec} {reduced}{17pt}  {true}
2577 \definefontsetatsize{ssec}   {text}   {small}  {15pt}  {true}
2578 \definefontsetatsize{reduced}{small}  {smaller}{10.5pt}{false}
2579 \definefontsetatsize{small}  {smaller}{smaller}{10.5pt}{false}
2580 \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
2581
2582 \def\titlefont#1{{\titlefonts\rm #1}}
2583 \let\subsecfonts = \ssecfonts
2584 \let\subsubsecfonts = \ssecfonts
2585
2586 % Define these just so they can be easily changed for other fonts.
2587 \def\angleleft{$\langle$}
2588 \def\angleright{$\rangle$}
2589
2590 % Set the fonts to use with the @small... environments.
2591 \let\smallexamplefonts = \smallfonts
2592
2593 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
2594 % can fit this many characters:
2595 %   8.5x11=86   smallbook=72  a4=90  a5=69
2596 % If we use \scriptfonts (8pt), then we can fit this many characters:
2597 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
2598 % For me, subjectively, the few extra characters that fit aren't worth
2599 % the additional smallness of 8pt.  So I'm making the default 9pt.
2600 %
2601 % By the way, for comparison, here's what fits with @example (10pt):
2602 %   8.5x11=71  smallbook=60  a4=75  a5=58
2603 % --karl, 24jan03.
2604
2605 % Set up the default fonts, so we can use them for creating boxes.
2606 %
2607 \definetextfontsizexi
2608
2609
2610 \message{markup,}
2611
2612 % Check if we are currently using a typewriter font.  Since all the
2613 % Computer Modern typewriter fonts have zero interword stretch (and
2614 % shrink), and it is reasonable to expect all typewriter fonts to have
2615 % this property, we can check that font parameter.
2616 %
2617 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2618
2619 % Markup style infrastructure.  \defmarkupstylesetup\INITMACRO will
2620 % define and register \INITMACRO to be called on markup style changes.
2621 % \INITMACRO can check \currentmarkupstyle for the innermost
2622 % style and the set of \ifmarkupSTYLE switches for all styles
2623 % currently in effect.
2624 \newif\ifmarkupvar
2625 \newif\ifmarkupsamp
2626 \newif\ifmarkupkey
2627 %\newif\ifmarkupfile % @file == @samp.
2628 %\newif\ifmarkupoption % @option == @samp.
2629 \newif\ifmarkupcode
2630 \newif\ifmarkupkbd
2631 %\newif\ifmarkupenv % @env == @code.
2632 %\newif\ifmarkupcommand % @command == @code.
2633 \newif\ifmarkuptex % @tex (and part of @math, for now).
2634 \newif\ifmarkupexample
2635 \newif\ifmarkupverb
2636 \newif\ifmarkupverbatim
2637
2638 \let\currentmarkupstyle\empty
2639
2640 \def\setupmarkupstyle#1{%
2641   \csname markup#1true\endcsname
2642   \def\currentmarkupstyle{#1}%
2643   \markupstylesetup
2644 }
2645
2646 \let\markupstylesetup\empty
2647
2648 \def\defmarkupstylesetup#1{%
2649   \expandafter\def\expandafter\markupstylesetup
2650     \expandafter{\markupstylesetup #1}%
2651   \def#1%
2652 }
2653
2654 % Markup style setup for left and right quotes.
2655 \defmarkupstylesetup\markupsetuplq{%
2656   \expandafter\let\expandafter \temp
2657     \csname markupsetuplq\currentmarkupstyle\endcsname
2658   \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2659 }
2660
2661 \defmarkupstylesetup\markupsetuprq{%
2662   \expandafter\let\expandafter \temp
2663     \csname markupsetuprq\currentmarkupstyle\endcsname
2664   \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2665 }
2666
2667 {
2668 \catcode`\'=\active
2669 \catcode`\`=\active
2670
2671 \gdef\markupsetuplqdefault{\let`\lq}
2672 \gdef\markupsetuprqdefault{\let'\rq}
2673
2674 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2675 \gdef\markupsetcodequoteright{\let'\codequoteright}
2676 }
2677
2678 \let\markupsetuplqcode \markupsetcodequoteleft
2679 \let\markupsetuprqcode \markupsetcodequoteright
2680 %
2681 \let\markupsetuplqexample \markupsetcodequoteleft
2682 \let\markupsetuprqexample \markupsetcodequoteright
2683 %
2684 \let\markupsetuplqkbd     \markupsetcodequoteleft
2685 \let\markupsetuprqkbd     \markupsetcodequoteright
2686 %
2687 \let\markupsetuplqsamp \markupsetcodequoteleft
2688 \let\markupsetuprqsamp \markupsetcodequoteright
2689 %
2690 \let\markupsetuplqverb \markupsetcodequoteleft
2691 \let\markupsetuprqverb \markupsetcodequoteright
2692 %
2693 \let\markupsetuplqverbatim \markupsetcodequoteleft
2694 \let\markupsetuprqverbatim \markupsetcodequoteright
2695
2696 % Allow an option to not use regular directed right quote/apostrophe
2697 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2698 % The undirected quote is ugly, so don't make it the default, but it
2699 % works for pasting with more pdf viewers (at least evince), the
2700 % lilypond developers report.  xpdf does work with the regular 0x27.
2701 %
2702 \def\codequoteright{%
2703   \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2704     \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2705       '%
2706     \else \char'15 \fi
2707   \else \char'15 \fi
2708 }
2709 %
2710 % and a similar option for the left quote char vs. a grave accent.
2711 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2712 % the code environments to do likewise.
2713 %
2714 \def\codequoteleft{%
2715   \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2716     \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2717       % [Knuth] pp. 380,381,391
2718       % \relax disables Spanish ligatures ?` and !` of \tt font.
2719       \relax`%
2720     \else \char'22 \fi
2721   \else \char'22 \fi
2722 }
2723
2724 % Commands to set the quote options.
2725
2726 \parseargdef\codequoteundirected{%
2727   \def\temp{#1}%
2728   \ifx\temp\onword
2729     \expandafter\let\csname SETtxicodequoteundirected\endcsname
2730       = t%
2731   \else\ifx\temp\offword
2732     \expandafter\let\csname SETtxicodequoteundirected\endcsname
2733       = \relax
2734   \else
2735     \errhelp = \EMsimple
2736     \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2737   \fi\fi
2738 }
2739 %
2740 \parseargdef\codequotebacktick{%
2741   \def\temp{#1}%
2742   \ifx\temp\onword
2743     \expandafter\let\csname SETtxicodequotebacktick\endcsname
2744       = t%
2745   \else\ifx\temp\offword
2746     \expandafter\let\csname SETtxicodequotebacktick\endcsname
2747       = \relax
2748   \else
2749     \errhelp = \EMsimple
2750     \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2751   \fi\fi
2752 }
2753
2754 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2755 \def\noligaturesquoteleft{\relax\lq}
2756
2757 % Count depth in font-changes, for error checks
2758 \newcount\fontdepth \fontdepth=0
2759
2760 % Font commands.
2761
2762 % #1 is the font command (\sl or \it), #2 is the text to slant.
2763 % If we are in a monospaced environment, however, 1) always use \ttsl,
2764 % and 2) do not add an italic correction.
2765 \def\dosmartslant#1#2{%
2766   \ifusingtt 
2767     {{\ttsl #2}\let\next=\relax}%
2768     {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2769   \next
2770 }
2771 \def\smartslanted{\dosmartslant\sl}
2772 \def\smartitalic{\dosmartslant\it}
2773
2774 % Output an italic correction unless \next (presumed to be the following
2775 % character) is such as not to need one.
2776 \def\smartitaliccorrection{%
2777   \ifx\next,%
2778   \else\ifx\next-%
2779   \else\ifx\next.%
2780   \else\ifx\next\.%
2781   \else\ifx\next\comma%
2782   \else\ptexslash
2783   \fi\fi\fi\fi\fi
2784   \aftersmartic
2785 }
2786
2787 % Unconditional use \ttsl, and no ic.  @var is set to this for defuns.
2788 \def\ttslanted#1{{\ttsl #1}}
2789
2790 % @cite is like \smartslanted except unconditionally use \sl.  We never want
2791 % ttsl for book titles, do we?
2792 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2793
2794 \def\aftersmartic{}
2795 \def\var#1{%
2796   \let\saveaftersmartic = \aftersmartic
2797   \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2798   \smartslanted{#1}%
2799 }
2800
2801 \let\i=\smartitalic
2802 \let\slanted=\smartslanted
2803 \let\dfn=\smartslanted
2804 \let\emph=\smartitalic
2805
2806 % Explicit font changes: @r, @sc, undocumented @ii.
2807 \def\r#1{{\rm #1}}              % roman font
2808 \def\sc#1{{\smallcaps#1}}       % smallcaps font
2809 \def\ii#1{{\it #1}}             % italic font
2810
2811 % @b, explicit bold.  Also @strong.
2812 \def\b#1{{\bf #1}}
2813 \let\strong=\b
2814
2815 % @sansserif, explicit sans.
2816 \def\sansserif#1{{\sf #1}}
2817
2818 % We can't just use \exhyphenpenalty, because that only has effect at
2819 % the end of a paragraph.  Restore normal hyphenation at the end of the
2820 % group within which \nohyphenation is presumably called.
2821 %
2822 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
2823 \def\restorehyphenation{\hyphenchar\font = `- }
2824
2825 % Set sfcode to normal for the chars that usually have another value.
2826 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2827 % sometimes \x has an active definition that messes things up.
2828 %
2829 \catcode`@=11
2830   \def\plainfrenchspacing{%
2831     \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
2832     \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
2833     \def\endofsentencespacefactor{1000}% for @. and friends
2834   }
2835   \def\plainnonfrenchspacing{%
2836     \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2837     \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2838     \def\endofsentencespacefactor{3000}% for @. and friends
2839   }
2840 \catcode`@=\other
2841 \def\endofsentencespacefactor{3000}% default
2842
2843 % @t, explicit typewriter.
2844 \def\t#1{%
2845   {\tt \rawbackslash \plainfrenchspacing #1}%
2846   \null
2847 }
2848
2849 % @samp.
2850 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2851
2852 % @indicateurl is \samp, that is, with quotes.
2853 \let\indicateurl=\samp
2854
2855 % @code (and similar) prints in typewriter, but with spaces the same
2856 % size as normal in the surrounding text, without hyphenation, etc.
2857 % This is a subroutine for that.
2858 \def\tclose#1{%
2859   {%
2860     % Change normal interword space to be same as for the current font.
2861     \spaceskip = \fontdimen2\font
2862     %
2863     % Switch to typewriter.
2864     \tt
2865     %
2866     % But `\ ' produces the large typewriter interword space.
2867     \def\ {{\spaceskip = 0pt{} }}%
2868     %
2869     % Turn off hyphenation.
2870     \nohyphenation
2871     %
2872     \rawbackslash
2873     \plainfrenchspacing
2874     #1%
2875   }%
2876   \null % reset spacefactor to 1000
2877 }
2878
2879 % We *must* turn on hyphenation at `-' and `_' in @code.
2880 % (But see \codedashfinish below.)
2881 % Otherwise, it is too hard to avoid overfull hboxes
2882 % in the Emacs manual, the Library manual, etc.
2883 %
2884 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2885 % both hyphenation at - and hyphenation within words.
2886 % We must therefore turn them both off (\tclose does that)
2887 % and arrange explicitly to hyphenate at a dash. -- rms.
2888 {
2889   \catcode`\-=\active \catcode`\_=\active
2890   \catcode`\'=\active \catcode`\`=\active
2891   \global\let'=\rq \global\let`=\lq  % default definitions
2892   %
2893   \global\def\code{\begingroup
2894     \setupmarkupstyle{code}%
2895     % The following should really be moved into \setupmarkupstyle handlers.
2896     \catcode\dashChar=\active  \catcode\underChar=\active
2897     \ifallowcodebreaks
2898      \let-\codedash
2899      \let_\codeunder
2900     \else
2901      \let-\normaldash
2902      \let_\realunder
2903     \fi
2904     % Given -foo (with a single dash), we do not want to allow a break
2905     % after the hyphen.
2906     \global\let\codedashprev=\codedash
2907     %
2908     \codex
2909   }
2910   %
2911   \gdef\codedash{\futurelet\next\codedashfinish}
2912   \gdef\codedashfinish{%
2913     \normaldash % always output the dash character itself.
2914     % 
2915     % Now, output a discretionary to allow a line break, unless
2916     % (a) the next character is a -, or
2917     % (b) the preceding character is a -.
2918     % E.g., given --posix, we do not want to allow a break after either -.
2919     % Given --foo-bar, we do want to allow a break between the - and the b.
2920     \ifx\next\codedash \else
2921       \ifx\codedashprev\codedash 
2922       \else \discretionary{}{}{}\fi
2923     \fi
2924     % we need the space after the = for the case when \next itself is a
2925     % space token; it would get swallowed otherwise.  As in @code{- a}.
2926     \global\let\codedashprev= \next
2927   }
2928 }
2929 \def\normaldash{-}
2930 %
2931 \def\codex #1{\tclose{#1}\endgroup}
2932
2933 \def\codeunder{%
2934   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
2935   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2936   % will therefore expand the active definition of _, which is us
2937   % (inside @code that is), therefore an endless loop.
2938   \ifusingtt{\ifmmode
2939                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2940              \else\normalunderscore \fi
2941              \discretionary{}{}{}}%
2942             {\_}%
2943 }
2944
2945 % An additional complication: the above will allow breaks after, e.g.,
2946 % each of the four underscores in __typeof__.  This is bad.
2947 % @allowcodebreaks provides a document-level way to turn breaking at -
2948 % and _ on and off.
2949 %
2950 \newif\ifallowcodebreaks  \allowcodebreakstrue
2951
2952 \def\keywordtrue{true}
2953 \def\keywordfalse{false}
2954
2955 \parseargdef\allowcodebreaks{%
2956   \def\txiarg{#1}%
2957   \ifx\txiarg\keywordtrue
2958     \allowcodebreakstrue
2959   \else\ifx\txiarg\keywordfalse
2960     \allowcodebreaksfalse
2961   \else
2962     \errhelp = \EMsimple
2963     \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2964   \fi\fi
2965 }
2966
2967 % For @command, @env, @file, @option quotes seem unnecessary,
2968 % so use \code rather than \samp.
2969 \let\command=\code
2970 \let\env=\code
2971 \let\file=\code
2972 \let\option=\code
2973
2974 % @uref (abbreviation for `urlref') aka @url takes an optional
2975 % (comma-separated) second argument specifying the text to display and
2976 % an optional third arg as text to display instead of (rather than in
2977 % addition to) the url itself.  First (mandatory) arg is the url.
2978
2979 % TeX-only option to allow changing PDF output to show only the second
2980 % arg (if given), and not the url (which is then just the link target).
2981 \newif\ifurefurlonlylink
2982
2983 % The main macro is \urefbreak, which allows breaking at expected
2984 % places within the url.  (There used to be another version, which
2985 % didn't support automatic breaking.)
2986 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2987 \let\uref=\urefbreak
2988 %
2989 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2990 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2991   \unsepspaces
2992   \pdfurl{#1}%
2993   \setbox0 = \hbox{\ignorespaces #3}%
2994   \ifdim\wd0 > 0pt
2995     \unhbox0 % third arg given, show only that
2996   \else
2997     \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2998     \ifdim\wd0 > 0pt
2999       \ifpdf
3000         % For pdfTeX and LuaTeX
3001         \ifurefurlonlylink
3002           % PDF plus option to not display url, show just arg
3003           \unhbox0             
3004         \else
3005           % PDF, normally display both arg and url for consistency,
3006           % visibility, if the pdf is eventually used to print, etc.
3007           \unhbox0\ (\urefcode{#1})%
3008         \fi
3009       \else
3010         \ifx\XeTeXrevision\thisisundefined
3011           \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
3012         \else
3013           % For XeTeX
3014           \ifurefurlonlylink
3015             % PDF plus option to not display url, show just arg
3016             \unhbox0             
3017           \else
3018             % PDF, normally display both arg and url for consistency,
3019             % visibility, if the pdf is eventually used to print, etc.
3020             \unhbox0\ (\urefcode{#1})%
3021           \fi
3022         \fi
3023       \fi
3024     \else
3025       \urefcode{#1}% only url given, so show it
3026     \fi
3027   \fi
3028   \endlink
3029 \endgroup}
3030
3031 % Allow line breaks around only a few characters (only).
3032 \def\urefcatcodes{%
3033   \catcode`\&=\active \catcode`\.=\active
3034   \catcode`\#=\active \catcode`\?=\active
3035   \catcode`\/=\active
3036 }
3037 {
3038   \urefcatcodes
3039   %
3040   \global\def\urefcode{\begingroup
3041     \setupmarkupstyle{code}%
3042     \urefcatcodes
3043     \let&\urefcodeamp
3044     \let.\urefcodedot
3045     \let#\urefcodehash
3046     \let?\urefcodequest
3047     \let/\urefcodeslash
3048     \codex
3049   }
3050   %
3051   % By default, they are just regular characters.
3052   \global\def&{\normalamp}
3053   \global\def.{\normaldot}
3054   \global\def#{\normalhash}
3055   \global\def?{\normalquest}
3056   \global\def/{\normalslash}
3057 }
3058
3059 % we put a little stretch before and after the breakable chars, to help
3060 % line breaking of long url's.  The unequal skips make look better in
3061 % cmtt at least, especially for dots.
3062 \def\urefprestretchamount{.13em}
3063 \def\urefpoststretchamount{.1em}
3064 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
3065 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
3066 %
3067 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
3068 \def\urefcodedot{\urefprestretch .\urefpoststretch}
3069 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
3070 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
3071 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
3072 {
3073   \catcode`\/=\active
3074   \global\def\urefcodeslashfinish{%
3075     \urefprestretch \slashChar
3076     % Allow line break only after the final / in a sequence of
3077     % slashes, to avoid line break between the slashes in http://.
3078     \ifx\next/\else \urefpoststretch \fi
3079   }
3080 }
3081
3082 % One more complication: by default we'll break after the special
3083 % characters, but some people like to break before the special chars, so
3084 % allow that.  Also allow no breaking at all, for manual control.
3085
3086 \parseargdef\urefbreakstyle{%
3087   \def\txiarg{#1}%
3088   \ifx\txiarg\wordnone
3089     \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
3090   \else\ifx\txiarg\wordbefore
3091     \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
3092   \else\ifx\txiarg\wordafter
3093     \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
3094   \else
3095     \errhelp = \EMsimple
3096     \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
3097   \fi\fi\fi
3098 }
3099 \def\wordafter{after}
3100 \def\wordbefore{before}
3101 \def\wordnone{none}
3102
3103 \urefbreakstyle after
3104
3105 % @url synonym for @uref, since that's how everyone uses it.
3106 %
3107 \let\url=\uref
3108
3109 % rms does not like angle brackets --karl, 17may97.
3110 % So now @email is just like @uref, unless we are pdf.
3111 %
3112 %\def\email#1{\angleleft{\tt #1}\angleright}
3113 \ifpdf
3114   \def\email#1{\doemail#1,,\finish}
3115   \def\doemail#1,#2,#3\finish{\begingroup
3116     \unsepspaces
3117     \pdfurl{mailto:#1}%
3118     \setbox0 = \hbox{\ignorespaces #2}%
3119     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3120     \endlink
3121   \endgroup}
3122 \else
3123   \ifx\XeTeXrevision\thisisundefined
3124     \let\email=\uref
3125   \else
3126     \def\email#1{\doemail#1,,\finish}
3127     \def\doemail#1,#2,#3\finish{\begingroup
3128       \unsepspaces
3129       \pdfurl{mailto:#1}%
3130       \setbox0 = \hbox{\ignorespaces #2}%
3131       \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3132       \endlink
3133     \endgroup}
3134   \fi
3135 \fi
3136
3137 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3138 %   `example' (@kbd uses ttsl only inside of @example and friends),
3139 %   or `code' (@kbd uses normal tty font always).
3140 \parseargdef\kbdinputstyle{%
3141   \def\txiarg{#1}%
3142   \ifx\txiarg\worddistinct
3143     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
3144   \else\ifx\txiarg\wordexample
3145     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
3146   \else\ifx\txiarg\wordcode
3147     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
3148   \else
3149     \errhelp = \EMsimple
3150     \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
3151   \fi\fi\fi
3152 }
3153 \def\worddistinct{distinct}
3154 \def\wordexample{example}
3155 \def\wordcode{code}
3156
3157 % Default is `distinct'.
3158 \kbdinputstyle distinct
3159
3160 % @kbd is like @code, except that if the argument is just one @key command,
3161 % then @kbd has no effect.
3162 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
3163
3164 \def\xkey{\key}
3165 \def\kbdsub#1#2#3\par{%
3166   \def\one{#1}\def\three{#3}\def\threex{??}%
3167   \ifx\one\xkey\ifx\threex\three \key{#2}%
3168   \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
3169   \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
3170 }
3171
3172 % definition of @key that produces a lozenge.  Doesn't adjust to text size.
3173 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3174 %\font\keysy=cmsy9
3175 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3176 %  \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3177 %    \vbox{\hrule\kern-0.4pt
3178 %     \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3179 %    \kern-0.4pt\hrule}%
3180 %  \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3181
3182 % definition of @key with no lozenge.  If the current font is already
3183 % monospace, don't change it; that way, we respect @kbdinputstyle.  But
3184 % if it isn't monospace, then use \tt.
3185 %
3186 \def\key#1{{\setupmarkupstyle{key}%
3187   \nohyphenation
3188   \ifmonospace\else\tt\fi
3189   #1}\null}
3190
3191 % @clicksequence{File @click{} Open ...}
3192 \def\clicksequence#1{\begingroup #1\endgroup}
3193
3194 % @clickstyle @arrow   (by default)
3195 \parseargdef\clickstyle{\def\click{#1}}
3196 \def\click{\arrow}
3197
3198 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
3199 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
3200 %
3201 \def\dmn#1{\thinspace #1}
3202
3203 % @acronym for "FBI", "NATO", and the like.
3204 % We print this one point size smaller, since it's intended for
3205 % all-uppercase.
3206 %
3207 \def\acronym#1{\doacronym #1,,\finish}
3208 \def\doacronym#1,#2,#3\finish{%
3209   {\switchtolsize #1}%
3210   \def\temp{#2}%
3211   \ifx\temp\empty \else
3212     \space ({\unsepspaces \ignorespaces \temp \unskip})%
3213   \fi
3214   \null % reset \spacefactor=1000
3215 }
3216
3217 % @abbr for "Comput. J." and the like.
3218 % No font change, but don't do end-of-sentence spacing.
3219 %
3220 \def\abbr#1{\doabbr #1,,\finish}
3221 \def\doabbr#1,#2,#3\finish{%
3222   {\plainfrenchspacing #1}%
3223   \def\temp{#2}%
3224   \ifx\temp\empty \else
3225     \space ({\unsepspaces \ignorespaces \temp \unskip})%
3226   \fi
3227   \null % reset \spacefactor=1000
3228 }
3229
3230 % @asis just yields its argument.  Used with @table, for example.
3231 %
3232 \def\asis#1{#1}
3233
3234 % @math outputs its argument in math mode.
3235 %
3236 % One complication: _ usually means subscripts, but it could also mean
3237 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
3238 % _ active, and distinguish by seeing if the current family is \slfam,
3239 % which is what @var uses.
3240 {
3241   \catcode`\_ = \active
3242   \gdef\mathunderscore{%
3243     \catcode`\_=\active
3244     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
3245   }
3246 }
3247 % Another complication: we want \\ (and @\) to output a math (or tt) \.
3248 % FYI, plain.tex uses \\ as a temporary control sequence (for no
3249 % particular reason), but this is not advertised and we don't care.
3250 %
3251 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
3252 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
3253 %
3254 \def\math{%
3255   \ifmmode\else % only go into math if not in math mode already
3256     \tex
3257     \mathunderscore
3258     \let\\ = \mathbackslash
3259     \mathactive
3260     % make the texinfo accent commands work in math mode
3261     \let\"=\ddot
3262     \let\'=\acute
3263     \let\==\bar
3264     \let\^=\hat
3265     \let\`=\grave
3266     \let\u=\breve
3267     \let\v=\check
3268     \let\~=\tilde
3269     \let\dotaccent=\dot
3270     % have to provide another name for sup operator
3271     \let\mathopsup=\sup
3272   $\expandafter\finishmath\fi
3273 }
3274 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
3275
3276 % Some active characters (such as <) are spaced differently in math.
3277 % We have to reset their definitions in case the @math was an argument
3278 % to a command which sets the catcodes (such as @item or @section).
3279 %
3280 {
3281   \catcode`^ = \active
3282   \catcode`< = \active
3283   \catcode`> = \active
3284   \catcode`+ = \active
3285   \catcode`' = \active
3286   \gdef\mathactive{%
3287     \let^ = \ptexhat
3288     \let< = \ptexless
3289     \let> = \ptexgtr
3290     \let+ = \ptexplus
3291     \let' = \ptexquoteright
3292   }
3293 }
3294
3295 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
3296 % If in text, use math to place as sub/superscript, but switch
3297 % into text mode, with smaller fonts.  This is a different font than the
3298 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
3299 % fix it (significant additions to font machinery) until someone notices.
3300 %
3301 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
3302 \def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
3303 %
3304 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
3305 \def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
3306
3307 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3308 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3309 % except specified as a normal braced arg, so no newlines to worry about.
3310
3311 \def\outfmtnametex{tex}
3312 %
3313 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
3314 \long\def\doinlinefmt#1,#2,\finish{%
3315   \def\inlinefmtname{#1}%
3316   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
3317 }
3318
3319 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3320 % FMTNAME is tex, else ELSE-TEXT.
3321 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
3322 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
3323   \def\inlinefmtname{#1}%
3324   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
3325 }
3326 %
3327 % For raw, must switch into @tex before parsing the argument, to avoid
3328 % setting catcodes prematurely.  Doing it this way means that, for
3329 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3330 % ignored.  But this isn't important because if people want a literal
3331 % *right* brace they would have to use a command anyway, so they may as
3332 % well use a command to get a left brace too.  We could re-use the
3333 % delimiter character idea from \verb, but it seems like overkill.
3334
3335 \long\def\inlineraw{\tex \doinlineraw}
3336 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
3337 \def\doinlinerawtwo#1,#2,\finish{%
3338   \def\inlinerawname{#1}%
3339   \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
3340   \endgroup % close group opened by \tex.
3341 }
3342
3343 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3344 %
3345 \long\def\inlineifset#1{\doinlineifset #1,\finish}
3346 \long\def\doinlineifset#1,#2,\finish{%
3347   \def\inlinevarname{#1}%
3348   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
3349   \else\ignorespaces#2\fi
3350 }
3351
3352 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3353 %
3354 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
3355 \long\def\doinlineifclear#1,#2,\finish{%
3356   \def\inlinevarname{#1}%
3357   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
3358 }
3359
3360
3361 \message{glyphs,}
3362 % and logos.
3363
3364 % @@ prints an @, as does @atchar{}.
3365 \def\@{\char64 }
3366 \let\atchar=\@
3367
3368 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3369 \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
3370 \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
3371 \let\{=\lbracechar
3372 \let\}=\rbracechar
3373
3374 % @comma{} to avoid , parsing problems.
3375 \let\comma = ,
3376
3377 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3378 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3379 \let\, = \ptexc
3380 \let\dotaccent = \ptexdot
3381 \def\ringaccent#1{{\accent23 #1}}
3382 \let\tieaccent = \ptext
3383 \let\ubaraccent = \ptexb
3384 \let\udotaccent = \d
3385
3386 % Other special characters: @questiondown @exclamdown @ordf @ordm
3387 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3388 \def\questiondown{?`}
3389 \def\exclamdown{!`}
3390 \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
3391 \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
3392
3393 % Dotless i and dotless j, used for accents.
3394 \def\imacro{i}
3395 \def\jmacro{j}
3396 \def\dotless#1{%
3397   \def\temp{#1}%
3398   \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3399   \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3400   \else \errmessage{@dotless can be used only with i or j}%
3401   \fi\fi
3402 }
3403
3404 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3405 % period following counts as ending a sentence.  (Idea found in latex.)
3406 %
3407 \edef\TeX{\TeX \spacefactor=1000 }
3408
3409 % @LaTeX{} logo.  Not quite the same results as the definition in
3410 % latex.ltx, since we use a different font for the raised A; it's most
3411 % convenient for us to use an explicitly smaller font, rather than using
3412 % the \scriptstyle font (since we don't reset \scriptstyle and
3413 % \scriptscriptstyle).
3414 %
3415 \def\LaTeX{%
3416   L\kern-.36em
3417   {\setbox0=\hbox{T}%
3418    \vbox to \ht0{\hbox{%
3419      \ifx\textnominalsize\xwordpt
3420        % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
3421        % Revert to plain's \scriptsize, which is 7pt.
3422        \count255=\the\fam $\fam\count255 \scriptstyle A$%
3423      \else
3424        % For 11pt, we can use our lllsize.
3425        \switchtolllsize A%
3426      \fi
3427      }%
3428      \vss
3429   }}%
3430   \kern-.15em
3431   \TeX
3432 }
3433
3434 % Some math mode symbols.  Define \ensuremath to switch into math mode
3435 % unless we are already there.  Expansion tricks may not be needed here,
3436 % but safer, and can't hurt.
3437 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3438 \def\ensuredmath#1{$\relax#1$}
3439 %
3440 \def\bullet{\ensuremath\ptexbullet}
3441 \def\geq{\ensuremath\ge}
3442 \def\leq{\ensuremath\le}
3443 \def\minus{\ensuremath-}
3444
3445 % @dots{} outputs an ellipsis using the current font.
3446 % We do .5em per period so that it has the same spacing in the cm
3447 % typewriter fonts as three actual period characters; on the other hand,
3448 % in other typewriter fonts three periods are wider than 1.5em.  So do
3449 % whichever is larger.
3450 %
3451 \def\dots{%
3452   \leavevmode
3453   \setbox0=\hbox{...}% get width of three periods
3454   \ifdim\wd0 > 1.5em
3455     \dimen0 = \wd0
3456   \else
3457     \dimen0 = 1.5em
3458   \fi
3459   \hbox to \dimen0{%
3460     \hskip 0pt plus.25fil
3461     .\hskip 0pt plus1fil
3462     .\hskip 0pt plus1fil
3463     .\hskip 0pt plus.5fil
3464   }%
3465 }
3466
3467 % @enddots{} is an end-of-sentence ellipsis.
3468 %
3469 \def\enddots{%
3470   \dots
3471   \spacefactor=\endofsentencespacefactor
3472 }
3473
3474 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3475 %
3476 % Since these characters are used in examples, they should be an even number of
3477 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3478 %
3479 \def\point{$\star$}
3480 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3481 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3482 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3483 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3484 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3485
3486 % The @error{} command.
3487 % Adapted from the TeXbook's \boxit.
3488 %
3489 \newbox\errorbox
3490 %
3491 {\ttfont \global\dimen0 = 3em}% Width of the box.
3492 \dimen2 = .55pt % Thickness of rules
3493 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3494 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3495 %
3496 \setbox\errorbox=\hbox to \dimen0{\hfil
3497    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3498    \advance\hsize by -2\dimen2 % Rules.
3499    \vbox{%
3500       \hrule height\dimen2
3501       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
3502          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3503          \kern3pt\vrule width\dimen2}% Space to right.
3504       \hrule height\dimen2}
3505     \hfil}
3506 %
3507 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3508
3509 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3510 %
3511 \def\pounds{{\it\$}}
3512
3513 % @euro{} comes from a separate font, depending on the current style.
3514 % We use the free feym* fonts from the eurosym package by Henrik
3515 % Theiling, which support regular, slanted, bold and bold slanted (and
3516 % "outlined" (blackboard board, sort of) versions, which we don't need).
3517 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3518 %
3519 % Although only regular is the truly official Euro symbol, we ignore
3520 % that.  The Euro is designed to be slightly taller than the regular
3521 % font height.
3522 %
3523 % feymr - regular
3524 % feymo - slanted
3525 % feybr - bold
3526 % feybo - bold slanted
3527 %
3528 % There is no good (free) typewriter version, to my knowledge.
3529 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3530 % Hmm.
3531 %
3532 % Also doesn't work in math.  Do we need to do math with euro symbols?
3533 % Hope not.
3534 %
3535 %
3536 \def\euro{{\eurofont e}}
3537 \def\eurofont{%
3538   % We set the font at each command, rather than predefining it in
3539   % \textfonts and the other font-switching commands, so that
3540   % installations which never need the symbol don't have to have the
3541   % font installed.
3542   %
3543   % There is only one designed size (nominal 10pt), so we always scale
3544   % that to the current nominal size.
3545   %
3546   % By the way, simply using "at 1em" works for cmr10 and the like, but
3547   % does not work for cmbx10 and other extended/shrunken fonts.
3548   %
3549   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3550   %
3551   \ifx\curfontstyle\bfstylename
3552     % bold:
3553     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3554   \else
3555     % regular:
3556     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3557   \fi
3558   \thiseurofont
3559 }
3560
3561 % Glyphs from the EC fonts.  We don't use \let for the aliases, because
3562 % sometimes we redefine the original macro, and the alias should reflect
3563 % the redefinition.
3564 %
3565 % Use LaTeX names for the Icelandic letters.
3566 \def\DH{{\ecfont \char"D0}} % Eth
3567 \def\dh{{\ecfont \char"F0}} % eth
3568 \def\TH{{\ecfont \char"DE}} % Thorn
3569 \def\th{{\ecfont \char"FE}} % thorn
3570 %
3571 \def\guillemetleft{{\ecfont \char"13}}
3572 \def\guillemotleft{\guillemetleft}
3573 \def\guillemetright{{\ecfont \char"14}}
3574 \def\guillemotright{\guillemetright}
3575 \def\guilsinglleft{{\ecfont \char"0E}}
3576 \def\guilsinglright{{\ecfont \char"0F}}
3577 \def\quotedblbase{{\ecfont \char"12}}
3578 \def\quotesinglbase{{\ecfont \char"0D}}
3579 %
3580 % This positioning is not perfect (see the ogonek LaTeX package), but
3581 % we have the precomposed glyphs for the most common cases.  We put the
3582 % tests to use those glyphs in the single \ogonek macro so we have fewer
3583 % dummy definitions to worry about for index entries, etc.
3584 %
3585 % ogonek is also used with other letters in Lithuanian (IOU), but using
3586 % the precomposed glyphs for those is not so easy since they aren't in
3587 % the same EC font.
3588 \def\ogonek#1{{%
3589   \def\temp{#1}%
3590   \ifx\temp\macrocharA\Aogonek
3591   \else\ifx\temp\macrochara\aogonek
3592   \else\ifx\temp\macrocharE\Eogonek
3593   \else\ifx\temp\macrochare\eogonek
3594   \else
3595     \ecfont \setbox0=\hbox{#1}%
3596     \ifdim\ht0=1ex\accent"0C #1%
3597     \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3598     \fi
3599   \fi\fi\fi\fi
3600   }%
3601 }
3602 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3603 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3604 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3605 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3606 %
3607 % Use the European Computer Modern fonts (cm-super in outline format)
3608 % for non-CM glyphs.  That is ec* for regular text and tc* for the text
3609 % companion symbols (LaTeX TS1 encoding).  Both are part of the ec
3610 % package and follow the same conventions.
3611
3612 \def\ecfont{\etcfont{e}}
3613 \def\tcfont{\etcfont{t}}
3614 %
3615 \def\etcfont#1{%
3616   % We can't distinguish serif/sans and italic/slanted, but this
3617   % is used for crude hacks anyway (like adding French and German
3618   % quotes to documents typeset with CM, where we lose kerning), so
3619   % hopefully nobody will notice/care.
3620   \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3621   \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3622   \ifmonospace
3623     % typewriter:
3624     \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3625   \else
3626     \ifx\curfontstyle\bfstylename
3627       % bold:
3628       \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3629     \else
3630       % regular:
3631       \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3632     \fi
3633   \fi
3634   \thisecfont
3635 }
3636
3637 % @registeredsymbol - R in a circle.  The font for the R should really
3638 % be smaller yet, but lllsize is the best we can do for now.
3639 % Adapted from the plain.tex definition of \copyright.
3640 %
3641 \def\registeredsymbol{%
3642   $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
3643                \hfil\crcr\Orb}}%
3644     }$%
3645 }
3646
3647 % @textdegree - the normal degrees sign.
3648 %
3649 \def\textdegree{$^\circ$}
3650
3651 % Laurent Siebenmann reports \Orb undefined with:
3652 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
3653 % so we'll define it if necessary.
3654 %
3655 \ifx\Orb\thisisundefined
3656 \def\Orb{\mathhexbox20D}
3657 \fi
3658
3659 % Quotes.
3660 \chardef\quotedblleft="5C
3661 \chardef\quotedblright=`\"
3662 \chardef\quoteleft=`\`
3663 \chardef\quoteright=`\'
3664
3665
3666 \message{page headings,}
3667
3668 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3669 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3670
3671 % First the title page.  Must do @settitle before @titlepage.
3672 \newif\ifseenauthor
3673 \newif\iffinishedtitlepage
3674
3675 % @setcontentsaftertitlepage used to do an implicit @contents or
3676 % @shortcontents after @end titlepage, but it is now obsolete.
3677 \def\setcontentsaftertitlepage{%
3678   \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
3679               command; move your @contents command if you want the contents
3680               after the title page.}}%
3681 \def\setshortcontentsaftertitlepage{%
3682   \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
3683               command; move your @shortcontents and @contents commands if you 
3684               want the contents after the title page.}}%
3685
3686 \parseargdef\shorttitlepage{%
3687   \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3688   \endgroup\page\hbox{}\page}
3689
3690 \envdef\titlepage{%
3691   % Open one extra group, as we want to close it in the middle of \Etitlepage.
3692   \begingroup
3693     \parindent=0pt \textfonts
3694     % Leave some space at the very top of the page.
3695     \vglue\titlepagetopglue
3696     % No rule at page bottom unless we print one at the top with @title.
3697     \finishedtitlepagetrue
3698     %
3699     % Most title ``pages'' are actually two pages long, with space
3700     % at the top of the second.  We don't want the ragged left on the second.
3701     \let\oldpage = \page
3702     \def\page{%
3703       \iffinishedtitlepage\else
3704          \finishtitlepage
3705       \fi
3706       \let\page = \oldpage
3707       \page
3708       \null
3709     }%
3710 }
3711
3712 \def\Etitlepage{%
3713     \iffinishedtitlepage\else
3714         \finishtitlepage
3715     \fi
3716     % It is important to do the page break before ending the group,
3717     % because the headline and footline are only empty inside the group.
3718     % If we use the new definition of \page, we always get a blank page
3719     % after the title page, which we certainly don't want.
3720     \oldpage
3721   \endgroup
3722   %
3723   % Need this before the \...aftertitlepage checks so that if they are
3724   % in effect the toc pages will come out with page numbers.
3725   \HEADINGSon
3726 }
3727
3728 \def\finishtitlepage{%
3729   \vskip4pt \hrule height 2pt width \hsize
3730   \vskip\titlepagebottomglue
3731   \finishedtitlepagetrue
3732 }
3733
3734 % Settings used for typesetting titles: no hyphenation, no indentation,
3735 % don't worry much about spacing, ragged right.  This should be used
3736 % inside a \vbox, and fonts need to be set appropriately first. \par should
3737 % be specified before the end of the \vbox, since a vbox is a group.
3738
3739 \def\raggedtitlesettings{%
3740   \rm
3741   \hyphenpenalty=10000
3742   \parindent=0pt
3743   \tolerance=5000
3744   \ptexraggedright
3745 }
3746
3747 % Macros to be used within @titlepage:
3748
3749 \let\subtitlerm=\rmfont
3750 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3751
3752 \parseargdef\title{%
3753   \checkenv\titlepage
3754   \vbox{\titlefonts \raggedtitlesettings #1\par}%
3755   % print a rule at the page bottom also.
3756   \finishedtitlepagefalse
3757   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3758 }
3759
3760 \parseargdef\subtitle{%
3761   \checkenv\titlepage
3762   {\subtitlefont \rightline{#1}}%
3763 }
3764
3765 % @author should come last, but may come many times.
3766 % It can also be used inside @quotation.
3767 %
3768 \parseargdef\author{%
3769   \def\temp{\quotation}%
3770   \ifx\thisenv\temp
3771     \def\quotationauthor{#1}% printed in \Equotation.
3772   \else
3773     \checkenv\titlepage
3774     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3775     {\secfonts\rm \leftline{#1}}%
3776   \fi
3777 }
3778
3779
3780 % Set up page headings and footings.
3781
3782 \let\thispage=\folio
3783
3784 \newtoks\evenheadline    % headline on even pages
3785 \newtoks\oddheadline     % headline on odd pages
3786 \newtoks\evenfootline    % footline on even pages
3787 \newtoks\oddfootline     % footline on odd pages
3788
3789 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3790 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3791                             \else \the\evenheadline \fi}}
3792 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3793                             \else \the\evenfootline \fi}\HEADINGShook}
3794 \let\HEADINGShook=\relax
3795
3796 % Commands to set those variables.
3797 % For example, this is what  @headings on  does
3798 % @evenheading @thistitle|@thispage|@thischapter
3799 % @oddheading @thischapter|@thispage|@thistitle
3800 % @evenfooting @thisfile||
3801 % @oddfooting ||@thisfile
3802
3803
3804 \def\evenheading{\parsearg\evenheadingxxx}
3805 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3806 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3807 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3808
3809 \def\oddheading{\parsearg\oddheadingxxx}
3810 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3811 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3812 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3813
3814 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3815
3816 \def\evenfooting{\parsearg\evenfootingxxx}
3817 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3818 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3819 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3820
3821 \def\oddfooting{\parsearg\oddfootingxxx}
3822 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3823 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3824   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3825   %
3826   % Leave some space for the footline.  Hopefully ok to assume
3827   % @evenfooting will not be used by itself.
3828   \global\advance\txipageheight by -12pt
3829   \global\advance\vsize by -12pt
3830 }
3831
3832 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3833
3834 % @evenheadingmarks top     \thischapter <- chapter at the top of a page
3835 % @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
3836 %
3837 % The same set of arguments for:
3838 %
3839 % @oddheadingmarks
3840 % @evenfootingmarks
3841 % @oddfootingmarks
3842 % @everyheadingmarks
3843 % @everyfootingmarks
3844
3845 % These define \getoddheadingmarks, \getevenheadingmarks,
3846 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3847 % \gettopheadingmarks, \getbottomheadingmarks.
3848 %
3849 \def\evenheadingmarks{\headingmarks{even}{heading}}
3850 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3851 \def\evenfootingmarks{\headingmarks{even}{footing}}
3852 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3853 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
3854                           \headingmarks{odd}{heading}{#1} }
3855 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
3856                           \headingmarks{odd}{footing}{#1} }
3857 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3858 \def\headingmarks#1#2#3 {%
3859   \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3860   \global\expandafter\let\csname get#1#2marks\endcsname \temp
3861 }
3862
3863 \everyheadingmarks bottom
3864 \everyfootingmarks bottom
3865
3866 % @headings double      turns headings on for double-sided printing.
3867 % @headings single      turns headings on for single-sided printing.
3868 % @headings off         turns them off.
3869 % @headings on          same as @headings double, retained for compatibility.
3870 % @headings after       turns on double-sided headings after this page.
3871 % @headings doubleafter turns on double-sided headings after this page.
3872 % @headings singleafter turns on single-sided headings after this page.
3873 % By default, they are off at the start of a document,
3874 % and turned `on' after @end titlepage.
3875
3876 \parseargdef\headings{\csname HEADINGS#1\endcsname}
3877
3878 \def\headingsoff{% non-global headings elimination
3879   \evenheadline={\hfil}\evenfootline={\hfil}%
3880    \oddheadline={\hfil}\oddfootline={\hfil}%
3881 }
3882
3883 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3884 \HEADINGSoff  % it's the default
3885
3886 % When we turn headings on, set the page number to 1.
3887 % For double-sided printing, put current file name in lower left corner,
3888 % chapter name on inside top of right hand pages, document
3889 % title on inside top of left hand pages, and page numbers on outside top
3890 % edge of all pages.
3891 \def\HEADINGSdouble{%
3892 \global\pageno=1
3893 \global\evenfootline={\hfil}
3894 \global\oddfootline={\hfil}
3895 \global\evenheadline={\line{\folio\hfil\thistitle}}
3896 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3897 \global\let\contentsalignmacro = \chapoddpage
3898 }
3899 \let\contentsalignmacro = \chappager
3900
3901 % For single-sided printing, chapter title goes across top left of page,
3902 % page number on top right.
3903 \def\HEADINGSsingle{%
3904 \global\pageno=1
3905 \global\evenfootline={\hfil}
3906 \global\oddfootline={\hfil}
3907 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
3908 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3909 \global\let\contentsalignmacro = \chappager
3910 }
3911 \def\HEADINGSon{\HEADINGSdouble}
3912
3913 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3914 \let\HEADINGSdoubleafter=\HEADINGSafter
3915 \def\HEADINGSdoublex{%
3916 \global\evenfootline={\hfil}
3917 \global\oddfootline={\hfil}
3918 \global\evenheadline={\line{\folio\hfil\thistitle}}
3919 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3920 \global\let\contentsalignmacro = \chapoddpage
3921 }
3922
3923 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3924 \def\HEADINGSsinglex{%
3925 \global\evenfootline={\hfil}
3926 \global\oddfootline={\hfil}
3927 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
3928 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3929 \global\let\contentsalignmacro = \chappager
3930 }
3931
3932 % Subroutines used in generating headings
3933 % This produces Day Month Year style of output.
3934 % Only define if not already defined, in case a txi-??.tex file has set
3935 % up a different format (e.g., txi-cs.tex does this).
3936 \ifx\today\thisisundefined
3937 \def\today{%
3938   \number\day\space
3939   \ifcase\month
3940   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3941   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3942   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3943   \fi
3944   \space\number\year}
3945 \fi
3946
3947 % @settitle line...  specifies the title of the document, for headings.
3948 % It generates no output of its own.
3949 \def\thistitle{\putwordNoTitle}
3950 \def\settitle{\parsearg{\gdef\thistitle}}
3951
3952
3953 \message{tables,}
3954 % Tables -- @table, @ftable, @vtable, @item(x).
3955
3956 % default indentation of table text
3957 \newdimen\tableindent \tableindent=.8in
3958 % default indentation of @itemize and @enumerate text
3959 \newdimen\itemindent  \itemindent=.3in
3960 % margin between end of table item and start of table text.
3961 \newdimen\itemmargin  \itemmargin=.1in
3962
3963 % used internally for \itemindent minus \itemmargin
3964 \newdimen\itemmax
3965
3966 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3967 % these defs.
3968 % They also define \itemindex
3969 % to index the item name in whatever manner is desired (perhaps none).
3970
3971 \newif\ifitemxneedsnegativevskip
3972
3973 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3974
3975 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3976 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3977
3978 \def\itemzzz #1{\begingroup %
3979   \advance\hsize by -\rightskip
3980   \advance\hsize by -\tableindent
3981   \setbox0=\hbox{\itemindicate{#1}}%
3982   \itemindex{#1}%
3983   \nobreak % This prevents a break before @itemx.
3984   %
3985   % If the item text does not fit in the space we have, put it on a line
3986   % by itself, and do not allow a page break either before or after that
3987   % line.  We do not start a paragraph here because then if the next
3988   % command is, e.g., @kindex, the whatsit would get put into the
3989   % horizontal list on a line by itself, resulting in extra blank space.
3990   \ifdim \wd0>\itemmax
3991     %
3992     % Make this a paragraph so we get the \parskip glue and wrapping,
3993     % but leave it ragged-right.
3994     \begingroup
3995       \advance\leftskip by-\tableindent
3996       \advance\hsize by\tableindent
3997       \advance\rightskip by0pt plus1fil\relax
3998       \leavevmode\unhbox0\par
3999     \endgroup
4000     %
4001     % We're going to be starting a paragraph, but we don't want the
4002     % \parskip glue -- logically it's part of the @item we just started.
4003     \nobreak \vskip-\parskip
4004     %
4005     % Stop a page break at the \parskip glue coming up.  However, if
4006     % what follows is an environment such as @example, there will be no
4007     % \parskip glue; then the negative vskip we just inserted would
4008     % cause the example and the item to crash together.  So we use this
4009     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
4010     % \parskip glue after all.  Section titles are handled this way also.
4011     %
4012     \penalty 10001
4013     \endgroup
4014     \itemxneedsnegativevskipfalse
4015   \else
4016     % The item text fits into the space.  Start a paragraph, so that the
4017     % following text (if any) will end up on the same line.
4018     \noindent
4019     % Do this with kerns and \unhbox so that if there is a footnote in
4020     % the item text, it can migrate to the main vertical list and
4021     % eventually be printed.
4022     \nobreak\kern-\tableindent
4023     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
4024     \unhbox0
4025     \nobreak\kern\dimen0
4026     \endgroup
4027     \itemxneedsnegativevskiptrue
4028   \fi
4029 }
4030
4031 \def\item{\errmessage{@item while not in a list environment}}
4032 \def\itemx{\errmessage{@itemx while not in a list environment}}
4033
4034 % @table, @ftable, @vtable.
4035 \envdef\table{%
4036   \let\itemindex\gobble
4037   \tablecheck{table}%
4038 }
4039 \envdef\ftable{%
4040   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
4041   \tablecheck{ftable}%
4042 }
4043 \envdef\vtable{%
4044   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
4045   \tablecheck{vtable}%
4046 }
4047 \def\tablecheck#1{%
4048   \ifnum \the\catcode`\^^M=\active
4049     \endgroup
4050     \errmessage{This command won't work in this context; perhaps the problem is
4051       that we are \inenvironment\thisenv}%
4052     \def\next{\doignore{#1}}%
4053   \else
4054     \let\next\tablex
4055   \fi
4056   \next
4057 }
4058 \def\tablex#1{%
4059   \def\itemindicate{#1}%
4060   \parsearg\tabley
4061 }
4062 \def\tabley#1{%
4063   {%
4064     \makevalueexpandable
4065     \edef\temp{\noexpand\tablez #1\space\space\space}%
4066     \expandafter
4067   }\temp \endtablez
4068 }
4069 \def\tablez #1 #2 #3 #4\endtablez{%
4070   \aboveenvbreak
4071   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
4072   \ifnum 0#2>0 \tableindent=#2\mil \fi
4073   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
4074   \itemmax=\tableindent
4075   \advance \itemmax by -\itemmargin
4076   \advance \leftskip by \tableindent
4077   \exdentamount=\tableindent
4078   \parindent = 0pt
4079   \parskip = \smallskipamount
4080   \ifdim \parskip=0pt \parskip=2pt \fi
4081   \let\item = \internalBitem
4082   \let\itemx = \internalBitemx
4083 }
4084 \def\Etable{\endgraf\afterenvbreak}
4085 \let\Eftable\Etable
4086 \let\Evtable\Etable
4087 \let\Eitemize\Etable
4088 \let\Eenumerate\Etable
4089
4090 % This is the counter used by @enumerate, which is really @itemize
4091
4092 \newcount \itemno
4093
4094 \envdef\itemize{\parsearg\doitemize}
4095
4096 \def\doitemize#1{%
4097   \aboveenvbreak
4098   \itemmax=\itemindent
4099   \advance\itemmax by -\itemmargin
4100   \advance\leftskip by \itemindent
4101   \exdentamount=\itemindent
4102   \parindent=0pt
4103   \parskip=\smallskipamount
4104   \ifdim\parskip=0pt \parskip=2pt \fi
4105   %
4106   % Try typesetting the item mark so that if the document erroneously says
4107   % something like @itemize @samp (intending @table), there's an error
4108   % right away at the @itemize.  It's not the best error message in the
4109   % world, but it's better than leaving it to the @item.  This means if
4110   % the user wants an empty mark, they have to say @w{} not just @w.
4111   \def\itemcontents{#1}%
4112   \setbox0 = \hbox{\itemcontents}%
4113   %
4114   % @itemize with no arg is equivalent to @itemize @bullet.
4115   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
4116   %
4117   \let\item=\itemizeitem
4118 }
4119
4120 % Definition of @item while inside @itemize and @enumerate.
4121 %
4122 \def\itemizeitem{%
4123   \advance\itemno by 1  % for enumerations
4124   {\let\par=\endgraf \smallbreak}% reasonable place to break
4125   {%
4126    % If the document has an @itemize directly after a section title, a
4127    % \nobreak will be last on the list, and \sectionheading will have
4128    % done a \vskip-\parskip.  In that case, we don't want to zero
4129    % parskip, or the item text will crash with the heading.  On the
4130    % other hand, when there is normal text preceding the item (as there
4131    % usually is), we do want to zero parskip, or there would be too much
4132    % space.  In that case, we won't have a \nobreak before.  At least
4133    % that's the theory.
4134    \ifnum\lastpenalty<10000 \parskip=0in \fi
4135    \noindent
4136    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
4137    %
4138    \ifinner\else
4139      \vadjust{\penalty 1200}% not good to break after first line of item.
4140    \fi
4141    % We can be in inner vertical mode in a footnote, although an
4142    % @itemize looks awful there.
4143   }%
4144   \flushcr
4145 }
4146
4147 % \splitoff TOKENS\endmark defines \first to be the first token in
4148 % TOKENS, and \rest to be the remainder.
4149 %
4150 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
4151
4152 % Allow an optional argument of an uppercase letter, lowercase letter,
4153 % or number, to specify the first label in the enumerated list.  No
4154 % argument is the same as `1'.
4155 %
4156 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
4157 \def\enumeratey #1 #2\endenumeratey{%
4158   % If we were given no argument, pretend we were given `1'.
4159   \def\thearg{#1}%
4160   \ifx\thearg\empty \def\thearg{1}\fi
4161   %
4162   % Detect if the argument is a single token.  If so, it might be a
4163   % letter.  Otherwise, the only valid thing it can be is a number.
4164   % (We will always have one token, because of the test we just made.
4165   % This is a good thing, since \splitoff doesn't work given nothing at
4166   % all -- the first parameter is undelimited.)
4167   \expandafter\splitoff\thearg\endmark
4168   \ifx\rest\empty
4169     % Only one token in the argument.  It could still be anything.
4170     % A ``lowercase letter'' is one whose \lccode is nonzero.
4171     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4172     %   not equal to itself.
4173     % Otherwise, we assume it's a number.
4174     %
4175     % We need the \relax at the end of the \ifnum lines to stop TeX from
4176     % continuing to look for a <number>.
4177     %
4178     \ifnum\lccode\expandafter`\thearg=0\relax
4179       \numericenumerate % a number (we hope)
4180     \else
4181       % It's a letter.
4182       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
4183         \lowercaseenumerate % lowercase letter
4184       \else
4185         \uppercaseenumerate % uppercase letter
4186       \fi
4187     \fi
4188   \else
4189     % Multiple tokens in the argument.  We hope it's a number.
4190     \numericenumerate
4191   \fi
4192 }
4193
4194 % An @enumerate whose labels are integers.  The starting integer is
4195 % given in \thearg.
4196 %
4197 \def\numericenumerate{%
4198   \itemno = \thearg
4199   \startenumeration{\the\itemno}%
4200 }
4201
4202 % The starting (lowercase) letter is in \thearg.
4203 \def\lowercaseenumerate{%
4204   \itemno = \expandafter`\thearg
4205   \startenumeration{%
4206     % Be sure we're not beyond the end of the alphabet.
4207     \ifnum\itemno=0
4208       \errmessage{No more lowercase letters in @enumerate; get a bigger
4209                   alphabet}%
4210     \fi
4211     \char\lccode\itemno
4212   }%
4213 }
4214
4215 % The starting (uppercase) letter is in \thearg.
4216 \def\uppercaseenumerate{%
4217   \itemno = \expandafter`\thearg
4218   \startenumeration{%
4219     % Be sure we're not beyond the end of the alphabet.
4220     \ifnum\itemno=0
4221       \errmessage{No more uppercase letters in @enumerate; get a bigger
4222                   alphabet}
4223     \fi
4224     \char\uccode\itemno
4225   }%
4226 }
4227
4228 % Call \doitemize, adding a period to the first argument and supplying the
4229 % common last two arguments.  Also subtract one from the initial value in
4230 % \itemno, since @item increments \itemno.
4231 %
4232 \def\startenumeration#1{%
4233   \advance\itemno by -1
4234   \doitemize{#1.}\flushcr
4235 }
4236
4237 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
4238 % to @enumerate.
4239 %
4240 \def\alphaenumerate{\enumerate{a}}
4241 \def\capsenumerate{\enumerate{A}}
4242 \def\Ealphaenumerate{\Eenumerate}
4243 \def\Ecapsenumerate{\Eenumerate}
4244
4245
4246 % @multitable macros
4247 % Amy Hendrickson, 8/18/94, 3/6/96
4248 %
4249 % @multitable ... @end multitable will make as many columns as desired.
4250 % Contents of each column will wrap at width given in preamble.  Width
4251 % can be specified either with sample text given in a template line,
4252 % or in percent of \hsize, the current width of text on page.
4253
4254 % Table can continue over pages but will only break between lines.
4255
4256 % To make preamble:
4257 %
4258 % Either define widths of columns in terms of percent of \hsize:
4259 %   @multitable @columnfractions .25 .3 .45
4260 %   @item ...
4261 %
4262 %   Numbers following @columnfractions are the percent of the total
4263 %   current hsize to be used for each column. You may use as many
4264 %   columns as desired.
4265
4266
4267 % Or use a template:
4268 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
4269 %   @item ...
4270 %   using the widest term desired in each column.
4271
4272 % Each new table line starts with @item, each subsequent new column
4273 % starts with @tab. Empty columns may be produced by supplying @tab's
4274 % with nothing between them for as many times as empty columns are needed,
4275 % ie, @tab@tab@tab will produce two empty columns.
4276
4277 % @item, @tab do not need to be on their own lines, but it will not hurt
4278 % if they are.
4279
4280 % Sample multitable:
4281
4282 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
4283 %   @item first col stuff @tab second col stuff @tab third col
4284 %   @item
4285 %   first col stuff
4286 %   @tab
4287 %   second col stuff
4288 %   @tab
4289 %   third col
4290 %   @item first col stuff @tab second col stuff
4291 %   @tab Many paragraphs of text may be used in any column.
4292 %
4293 %         They will wrap at the width determined by the template.
4294 %   @item@tab@tab This will be in third column.
4295 %   @end multitable
4296
4297 % Default dimensions may be reset by user.
4298 % @multitableparskip is vertical space between paragraphs in table.
4299 % @multitableparindent is paragraph indent in table.
4300 % @multitablecolmargin is horizontal space to be left between columns.
4301 % @multitablelinespace is space to leave between table items, baseline
4302 %                                                            to baseline.
4303 %   0pt means it depends on current normal line spacing.
4304 %
4305 \newskip\multitableparskip
4306 \newskip\multitableparindent
4307 \newdimen\multitablecolspace
4308 \newskip\multitablelinespace
4309 \multitableparskip=0pt
4310 \multitableparindent=6pt
4311 \multitablecolspace=12pt
4312 \multitablelinespace=0pt
4313
4314 % Macros used to set up halign preamble:
4315 %
4316 \let\endsetuptable\relax
4317 \def\xendsetuptable{\endsetuptable}
4318 \let\columnfractions\relax
4319 \def\xcolumnfractions{\columnfractions}
4320 \newif\ifsetpercent
4321
4322 % #1 is the @columnfraction, usually a decimal number like .5, but might
4323 % be just 1.  We just use it, whatever it is.
4324 %
4325 \def\pickupwholefraction#1 {%
4326   \global\advance\colcount by 1
4327   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
4328   \setuptable
4329 }
4330
4331 \newcount\colcount
4332 \def\setuptable#1{%
4333   \def\firstarg{#1}%
4334   \ifx\firstarg\xendsetuptable
4335     \let\go = \relax
4336   \else
4337     \ifx\firstarg\xcolumnfractions
4338       \global\setpercenttrue
4339     \else
4340       \ifsetpercent
4341          \let\go\pickupwholefraction
4342       \else
4343          \global\advance\colcount by 1
4344          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
4345                    % separator; typically that is always in the input, anyway.
4346          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
4347       \fi
4348     \fi
4349     \ifx\go\pickupwholefraction
4350       % Put the argument back for the \pickupwholefraction call, so
4351       % we'll always have a period there to be parsed.
4352       \def\go{\pickupwholefraction#1}%
4353     \else
4354       \let\go = \setuptable
4355     \fi%
4356   \fi
4357   \go
4358 }
4359
4360 % multitable-only commands.
4361
4362 % @headitem starts a heading row, which we typeset in bold.  Assignments
4363 % have to be global since we are inside the implicit group of an
4364 % alignment entry.  \everycr below resets \everytab so we don't have to
4365 % undo it ourselves.
4366 \def\headitemfont{\b}% for people to use in the template row; not changeable
4367 \def\headitem{%
4368   \checkenv\multitable
4369   \crcr
4370   \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
4371   \global\everytab={\bf}% can't use \headitemfont since the parsing differs
4372   \the\everytab % for the first item
4373 }%
4374 %
4375 % default for tables with no headings.
4376 \let\headitemcrhook=\relax
4377 %
4378 % A \tab used to include \hskip1sp.  But then the space in a template
4379 % line is not enough.  That is bad.  So let's go back to just `&' until
4380 % we again encounter the problem the 1sp was intended to solve.
4381 %                                       --karl, nathan@acm.org, 20apr99.
4382 \def\tab{\checkenv\multitable &\the\everytab}%
4383
4384 % @multitable ... @end multitable definitions:
4385 %
4386 \newtoks\everytab  % insert after every tab.
4387 %
4388 \envdef\multitable{%
4389   \vskip\parskip
4390   \startsavinginserts
4391   %
4392   % @item within a multitable starts a normal row.
4393   % We use \def instead of \let so that if one of the multitable entries
4394   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4395   % \endtemplate) expanding \doitemize.
4396   \def\item{\crcr}%
4397   %
4398   \tolerance=9500
4399   \hbadness=9500
4400   \setmultitablespacing
4401   \parskip=\multitableparskip
4402   \parindent=\multitableparindent
4403   \overfullrule=0pt
4404   \global\colcount=0
4405   %
4406   \everycr = {%
4407     \noalign{%
4408       \global\everytab={}% Reset from possible headitem.
4409       \global\colcount=0 % Reset the column counter.
4410       %
4411       % Check for saved footnotes, etc.:
4412       \checkinserts
4413       %
4414       % Perhaps a \nobreak, then reset:
4415       \headitemcrhook
4416       \global\let\headitemcrhook=\relax
4417     }%
4418   }%
4419   %
4420   \parsearg\domultitable
4421 }
4422 \def\domultitable#1{%
4423   % To parse everything between @multitable and @item:
4424   \setuptable#1 \endsetuptable
4425   %
4426   % This preamble sets up a generic column definition, which will
4427   % be used as many times as user calls for columns.
4428   % \vtop will set a single line and will also let text wrap and
4429   % continue for many paragraphs if desired.
4430   \halign\bgroup &%
4431     \global\advance\colcount by 1
4432     \multistrut
4433     \vtop{%
4434       % Use the current \colcount to find the correct column width:
4435       \hsize=\expandafter\csname col\the\colcount\endcsname
4436       %
4437       % In order to keep entries from bumping into each other
4438       % we will add a \leftskip of \multitablecolspace to all columns after
4439       % the first one.
4440       %
4441       % If a template has been used, we will add \multitablecolspace
4442       % to the width of each template entry.
4443       %
4444       % If the user has set preamble in terms of percent of \hsize we will
4445       % use that dimension as the width of the column, and the \leftskip
4446       % will keep entries from bumping into each other.  Table will start at
4447       % left margin and final column will justify at right margin.
4448       %
4449       % Make sure we don't inherit \rightskip from the outer environment.
4450       \rightskip=0pt
4451       \ifnum\colcount=1
4452         % The first column will be indented with the surrounding text.
4453         \advance\hsize by\leftskip
4454       \else
4455         \ifsetpercent \else
4456           % If user has not set preamble in terms of percent of \hsize
4457           % we will advance \hsize by \multitablecolspace.
4458           \advance\hsize by \multitablecolspace
4459         \fi
4460        % In either case we will make \leftskip=\multitablecolspace:
4461       \leftskip=\multitablecolspace
4462       \fi
4463       % Ignoring space at the beginning and end avoids an occasional spurious
4464       % blank line, when TeX decides to break the line at the space before the
4465       % box from the multistrut, so the strut ends up on a line by itself.
4466       % For example:
4467       % @multitable @columnfractions .11 .89
4468       % @item @code{#}
4469       % @tab Legal holiday which is valid in major parts of the whole country.
4470       % Is automatically provided with highlighting sequences respectively
4471       % marking characters.
4472       \noindent\ignorespaces##\unskip\multistrut
4473     }\cr
4474 }
4475 \def\Emultitable{%
4476   \crcr
4477   \egroup % end the \halign
4478   \global\setpercentfalse
4479 }
4480
4481 \def\setmultitablespacing{%
4482   \def\multistrut{\strut}% just use the standard line spacing
4483   %
4484   % Compute \multitablelinespace (if not defined by user) for use in
4485   % \multitableparskip calculation.  We used define \multistrut based on
4486   % this, but (ironically) that caused the spacing to be off.
4487   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4488 \ifdim\multitablelinespace=0pt
4489 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4490 \global\advance\multitablelinespace by-\ht0
4491 \fi
4492 % Test to see if parskip is larger than space between lines of
4493 % table. If not, do nothing.
4494 %        If so, set to same dimension as multitablelinespace.
4495 \ifdim\multitableparskip>\multitablelinespace
4496 \global\multitableparskip=\multitablelinespace
4497 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4498                                       % than skip between lines in the table.
4499 \fi%
4500 \ifdim\multitableparskip=0pt
4501 \global\multitableparskip=\multitablelinespace
4502 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4503                                       % than skip between lines in the table.
4504 \fi}
4505
4506
4507 \message{conditionals,}
4508
4509 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4510 % @ifnotxml always succeed.  They currently do nothing; we don't
4511 % attempt to check whether the conditionals are properly nested.  But we
4512 % have to remember that they are conditionals, so that @end doesn't
4513 % attempt to close an environment group.
4514 %
4515 \def\makecond#1{%
4516   \expandafter\let\csname #1\endcsname = \relax
4517   \expandafter\let\csname iscond.#1\endcsname = 1
4518 }
4519 \makecond{iftex}
4520 \makecond{ifnotdocbook}
4521 \makecond{ifnothtml}
4522 \makecond{ifnotinfo}
4523 \makecond{ifnotplaintext}
4524 \makecond{ifnotxml}
4525
4526 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4527 %
4528 \def\direntry{\doignore{direntry}}
4529 \def\documentdescription{\doignore{documentdescription}}
4530 \def\docbook{\doignore{docbook}}
4531 \def\html{\doignore{html}}
4532 \def\ifdocbook{\doignore{ifdocbook}}
4533 \def\ifhtml{\doignore{ifhtml}}
4534 \def\ifinfo{\doignore{ifinfo}}
4535 \def\ifnottex{\doignore{ifnottex}}
4536 \def\ifplaintext{\doignore{ifplaintext}}
4537 \def\ifxml{\doignore{ifxml}}
4538 \def\ignore{\doignore{ignore}}
4539 \def\menu{\doignore{menu}}
4540 \def\xml{\doignore{xml}}
4541
4542 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4543 %
4544 % A count to remember the depth of nesting.
4545 \newcount\doignorecount
4546
4547 \def\doignore#1{\begingroup
4548   % Scan in ``verbatim'' mode:
4549   \obeylines
4550   \catcode`\@ = \other
4551   \catcode`\{ = \other
4552   \catcode`\} = \other
4553   %
4554   % Make sure that spaces turn into tokens that match what \doignoretext wants.
4555   \spaceisspace
4556   %
4557   % Count number of #1's that we've seen.
4558   \doignorecount = 0
4559   %
4560   % Swallow text until we reach the matching `@end #1'.
4561   \dodoignore{#1}%
4562 }
4563
4564 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4565   \obeylines %
4566   %
4567   \gdef\dodoignore#1{%
4568     % #1 contains the command name as a string, e.g., `ifinfo'.
4569     %
4570     % Define a command to find the next `@end #1'.
4571     \long\def\doignoretext##1^^M@end #1{%
4572       \doignoretextyyy##1^^M@#1\_STOP_}%
4573     %
4574     % And this command to find another #1 command, at the beginning of a
4575     % line.  (Otherwise, we would consider a line `@c @ifset', for
4576     % example, to count as an @ifset for nesting.)
4577     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4578     %
4579     % And now expand that command.
4580     \doignoretext ^^M%
4581   }%
4582 }
4583
4584 \def\doignoreyyy#1{%
4585   \def\temp{#1}%
4586   \ifx\temp\empty                       % Nothing found.
4587     \let\next\doignoretextzzz
4588   \else                                 % Found a nested condition, ...
4589     \advance\doignorecount by 1
4590     \let\next\doignoretextyyy           % ..., look for another.
4591     % If we're here, #1 ends with ^^M\ifinfo (for example).
4592   \fi
4593   \next #1% the token \_STOP_ is present just after this macro.
4594 }
4595
4596 % We have to swallow the remaining "\_STOP_".
4597 %
4598 \def\doignoretextzzz#1{%
4599   \ifnum\doignorecount = 0      % We have just found the outermost @end.
4600     \let\next\enddoignore
4601   \else                         % Still inside a nested condition.
4602     \advance\doignorecount by -1
4603     \let\next\doignoretext      % Look for the next @end.
4604   \fi
4605   \next
4606 }
4607
4608 % Finish off ignored text.
4609 { \obeylines%
4610   % Ignore anything after the last `@end #1'; this matters in verbatim
4611   % environments, where otherwise the newline after an ignored conditional
4612   % would result in a blank line in the output.
4613   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4614 }
4615
4616
4617 % @set VAR sets the variable VAR to an empty value.
4618 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4619 %
4620 % Since we want to separate VAR from REST-OF-LINE (which might be
4621 % empty), we can't just use \parsearg; we have to insert a space of our
4622 % own to delimit the rest of the line, and then take it out again if we
4623 % didn't need it.
4624 % We rely on the fact that \parsearg sets \catcode`\ =10.
4625 %
4626 \parseargdef\set{\setyyy#1 \endsetyyy}
4627 \def\setyyy#1 #2\endsetyyy{%
4628   {%
4629     \makevalueexpandable
4630     \def\temp{#2}%
4631     \edef\next{\gdef\makecsname{SET#1}}%
4632     \ifx\temp\empty
4633       \next{}%
4634     \else
4635       \setzzz#2\endsetzzz
4636     \fi
4637   }%
4638 }
4639 % Remove the trailing space \setxxx inserted.
4640 \def\setzzz#1 \endsetzzz{\next{#1}}
4641
4642 % @clear VAR clears (i.e., unsets) the variable VAR.
4643 %
4644 \parseargdef\clear{%
4645   {%
4646     \makevalueexpandable
4647     \global\expandafter\let\csname SET#1\endcsname=\relax
4648   }%
4649 }
4650
4651 % @value{foo} gets the text saved in variable foo.
4652 \def\value{\begingroup\makevalueexpandable\valuexxx}
4653 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4654 {
4655   \catcode`\-=\active \catcode`\_=\active
4656   %
4657   \gdef\makevalueexpandable{%
4658     \let\value = \expandablevalue
4659     % We don't want these characters active, ...
4660     \catcode`\-=\other \catcode`\_=\other
4661     % ..., but we might end up with active ones in the argument if
4662     % we're called from @code, as @code{@value{foo-bar_}}, though.
4663     % So \let them to their normal equivalents.
4664     \let-\normaldash \let_\normalunderscore
4665   }
4666 }
4667
4668 % We have this subroutine so that we can handle at least some @value's
4669 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4670 % The command has to be fully expandable (if the variable is set), since
4671 % the result winds up in the index file.  This means that if the
4672 % variable's value contains other Texinfo commands, it's almost certain
4673 % it will fail (although perhaps we could fix that with sufficient work
4674 % to do a one-level expansion on the result, instead of complete).
4675
4676 % Unfortunately, this has the consequence that when _ is in the *value*
4677 % of an @set, it does not print properly in the roman fonts (get the cmr
4678 % dot accent at position 126 instead).  No fix comes to mind, and it's
4679 % been this way since 2003 or earlier, so just ignore it.
4680
4681 \def\expandablevalue#1{%
4682   \expandafter\ifx\csname SET#1\endcsname\relax
4683     {[No value for ``#1'']}%
4684     \message{Variable `#1', used in @value, is not set.}%
4685   \else
4686     \csname SET#1\endcsname
4687   \fi
4688 }
4689
4690 % Like \expandablevalue, but completely expandable (the \message in the
4691 % definition above operates at the execution level of TeX).  Used when
4692 % writing to auxiliary files, due to the expansion that \write does.
4693 % If flag is undefined, pass through an unexpanded @value command: maybe it 
4694 % will be set by the time it is read back in.
4695 %
4696 % NB flag names containing - or _ may not work here.
4697 \def\dummyvalue#1{%
4698   \expandafter\ifx\csname SET#1\endcsname\relax
4699     \noexpand\value{#1}%
4700   \else
4701     \csname SET#1\endcsname
4702   \fi
4703 }
4704
4705 % Used for @value's in index entries to form the sort key: expand the @value
4706 % if possible, otherwise sort late.
4707 \def\indexnofontsvalue#1{%
4708   \expandafter\ifx\csname SET#1\endcsname\relax
4709     ZZZZZZZ
4710   \else
4711     \csname SET#1\endcsname
4712   \fi
4713 }
4714
4715 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4716 % with @set.
4717
4718 % To get the special treatment we need for `@end ifset,' we call
4719 % \makecond and then redefine.
4720 %
4721 \makecond{ifset}
4722 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4723 \def\doifset#1#2{%
4724   {%
4725     \makevalueexpandable
4726     \let\next=\empty
4727     \expandafter\ifx\csname SET#2\endcsname\relax
4728       #1% If not set, redefine \next.
4729     \fi
4730     \expandafter
4731   }\next
4732 }
4733 \def\ifsetfail{\doignore{ifset}}
4734
4735 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4736 % defined with @set, or has been undefined with @clear.
4737 %
4738 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4739 % above code: if the variable is not set, do nothing, if it is set,
4740 % then redefine \next to \ifclearfail.
4741 %
4742 \makecond{ifclear}
4743 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4744 \def\ifclearfail{\doignore{ifclear}}
4745
4746 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4747 % without the @) is in fact defined.  We can only feasibly check at the
4748 % TeX level, so something like `mathcode' is going to considered
4749 % defined even though it is not a Texinfo command.
4750
4751 \makecond{ifcommanddefined}
4752 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4753 %
4754 \def\doifcmddefined#1#2{{%
4755     \makevalueexpandable
4756     \let\next=\empty
4757     \expandafter\ifx\csname #2\endcsname\relax
4758       #1% If not defined, \let\next as above.
4759     \fi
4760     \expandafter
4761   }\next
4762 }
4763 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4764
4765 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4766 \makecond{ifcommandnotdefined}
4767 \def\ifcommandnotdefined{%
4768   \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4769 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4770
4771 % Set the `txicommandconditionals' variable, so documents have a way to
4772 % test if the @ifcommand...defined conditionals are available.
4773 \set txicommandconditionals
4774
4775 % @dircategory CATEGORY  -- specify a category of the dir file
4776 % which this file should belong to.  Ignore this in TeX.
4777 \let\dircategory=\comment
4778
4779 % @defininfoenclose.
4780 \let\definfoenclose=\comment
4781
4782
4783 \message{indexing,}
4784 % Index generation facilities
4785
4786 % Define \newwrite to be identical to plain tex's \newwrite
4787 % except not \outer, so it can be used within macros and \if's.
4788 \edef\newwrite{\makecsname{ptexnewwrite}}
4789
4790 % \newindex {foo} defines an index named IX.
4791 % It automatically defines \IXindex such that
4792 % \IXindex ...rest of line... puts an entry in the index IX.
4793 % It also defines \IXindfile to be the number of the output channel for
4794 % the file that accumulates this index.  The file's extension is IX.
4795 % The name of an index should be no more than 2 characters long
4796 % for the sake of vms.
4797 %
4798 \def\newindex#1{%
4799   \expandafter\chardef\csname#1indfile\endcsname=0
4800   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
4801     \noexpand\doindex{#1}}
4802 }
4803
4804 % @defindex foo  ==  \newindex{foo}
4805 %
4806 \def\defindex{\parsearg\newindex}
4807
4808 % Define @defcodeindex, like @defindex except put all entries in @code.
4809 %
4810 \def\defcodeindex{\parsearg\newcodeindex}
4811 %
4812 \def\newcodeindex#1{%
4813   \expandafter\chardef\csname#1indfile\endcsname=0
4814   \expandafter\xdef\csname#1index\endcsname{%
4815     \noexpand\docodeindex{#1}}%
4816 }
4817
4818 % The default indices:
4819 \newindex{cp}%      concepts,
4820 \newcodeindex{fn}%  functions,
4821 \newcodeindex{vr}%  variables,
4822 \newcodeindex{tp}%  types,
4823 \newcodeindex{ky}%  keys
4824 \newcodeindex{pg}%  and programs.
4825
4826
4827 % @synindex foo bar    makes index foo feed into index bar.
4828 % Do this instead of @defindex foo if you don't want it as a separate index.
4829 %
4830 % @syncodeindex foo bar   similar, but put all entries made for index foo
4831 % inside @code.
4832 %
4833 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4834 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4835
4836 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4837 % #3 the target index (bar).
4838 \def\dosynindex#1#2#3{%
4839   \requireopenindexfile{#3}%
4840   % redefine \fooindfile:
4841   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4842   \expandafter\let\csname#2indfile\endcsname=\temp
4843   % redefine \fooindex:
4844   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4845 }
4846
4847 % Define \doindex, the driver for all index macros.
4848 % Argument #1 is generated by the calling \fooindex macro,
4849 % and it is the two-letter name of the index.
4850
4851 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4852 \def\doindexxxx #1{\doind{\indexname}{#1}}
4853
4854 % like the previous two, but they put @code around the argument.
4855 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4856 \def\docodeindexxxx #1{\doind{\indexname}{\code{#1}}}
4857
4858 \f
4859 % Used when writing an index entry out to an index file to prevent
4860 % expansion of Texinfo commands that can appear in an index entry.
4861 %
4862 \def\indexdummies{%
4863   \escapechar = `\\     % use backslash in output files.
4864   \definedummyletter\@%
4865   \definedummyletter\ %
4866   %
4867   % For texindex which always views { and } as separators.
4868   \def\{{\lbracechar{}}%
4869   \def\}{\rbracechar{}}%
4870   %
4871   % Do the redefinitions.
4872   \definedummies
4873 }
4874
4875 % Used for the aux and toc files, where @ is the escape character.
4876 %
4877 \def\atdummies{%
4878   \definedummyletter\@%
4879   \definedummyletter\ %
4880   \definedummyletter\{%
4881   \definedummyletter\}%
4882   %
4883   % Do the redefinitions.
4884   \definedummies
4885   \otherbackslash
4886 }
4887
4888 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4889 % preventing its expansion.  This is used only for control words,
4890 % not control letters, because the \space would be incorrect for
4891 % control characters, but is needed to separate the control word
4892 % from whatever follows.
4893 %
4894 % These can be used both for control words that take an argument and
4895 % those that do not.  If it is followed by {arg} in the input, then
4896 % that will dutifully get written to the index (or wherever).
4897 %
4898 % For control letters, we have \definedummyletter, which omits the
4899 % space.
4900 %
4901 \def\definedummyword  #1{\def#1{\string#1\space}}%
4902 \def\definedummyletter#1{\def#1{\string#1}}%
4903 \let\definedummyaccent\definedummyletter
4904
4905 % Called from \indexdummies and \atdummies, to effectively prevent
4906 % the expansion of commands.
4907 %
4908 \def\definedummies{%
4909   %
4910   \let\commondummyword\definedummyword
4911   \let\commondummyletter\definedummyletter
4912   \let\commondummyaccent\definedummyaccent
4913   \commondummiesnofonts
4914   %
4915   \definedummyletter\_%
4916   \definedummyletter\-%
4917   %
4918   % Non-English letters.
4919   \definedummyword\AA
4920   \definedummyword\AE
4921   \definedummyword\DH
4922   \definedummyword\L
4923   \definedummyword\O
4924   \definedummyword\OE
4925   \definedummyword\TH
4926   \definedummyword\aa
4927   \definedummyword\ae
4928   \definedummyword\dh
4929   \definedummyword\exclamdown
4930   \definedummyword\l
4931   \definedummyword\o
4932   \definedummyword\oe
4933   \definedummyword\ordf
4934   \definedummyword\ordm
4935   \definedummyword\questiondown
4936   \definedummyword\ss
4937   \definedummyword\th
4938   %
4939   % Although these internal commands shouldn't show up, sometimes they do.
4940   \definedummyword\bf
4941   \definedummyword\gtr
4942   \definedummyword\hat
4943   \definedummyword\less
4944   \definedummyword\sf
4945   \definedummyword\sl
4946   \definedummyword\tclose
4947   \definedummyword\tt
4948   %
4949   \definedummyword\LaTeX
4950   \definedummyword\TeX
4951   %
4952   % Assorted special characters.
4953   \definedummyword\atchar
4954   \definedummyword\arrow
4955   \definedummyword\bullet
4956   \definedummyword\comma
4957   \definedummyword\copyright
4958   \definedummyword\registeredsymbol
4959   \definedummyword\dots
4960   \definedummyword\enddots
4961   \definedummyword\entrybreak
4962   \definedummyword\equiv
4963   \definedummyword\error
4964   \definedummyword\euro
4965   \definedummyword\expansion
4966   \definedummyword\geq
4967   \definedummyword\guillemetleft
4968   \definedummyword\guillemetright
4969   \definedummyword\guilsinglleft
4970   \definedummyword\guilsinglright
4971   \definedummyword\lbracechar
4972   \definedummyword\leq
4973   \definedummyword\mathopsup
4974   \definedummyword\minus
4975   \definedummyword\ogonek
4976   \definedummyword\pounds
4977   \definedummyword\point
4978   \definedummyword\print
4979   \definedummyword\quotedblbase
4980   \definedummyword\quotedblleft
4981   \definedummyword\quotedblright
4982   \definedummyword\quoteleft
4983   \definedummyword\quoteright
4984   \definedummyword\quotesinglbase
4985   \definedummyword\rbracechar
4986   \definedummyword\result
4987   \definedummyword\sub
4988   \definedummyword\sup
4989   \definedummyword\textdegree
4990   %
4991   % We want to disable all macros so that they are not expanded by \write.
4992   \macrolist
4993   \let\value\dummyvalue
4994   %
4995   \normalturnoffactive
4996 }
4997
4998 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
4999 % Define \commondummyletter, \commondummyaccent and \commondummyword before
5000 % using.  Used for accents, font commands, and various control letters.
5001 %
5002 \def\commondummiesnofonts{%
5003   % Control letters and accents.
5004   \commondummyletter\!%
5005   \commondummyaccent\"%
5006   \commondummyaccent\'%
5007   \commondummyletter\*%
5008   \commondummyaccent\,%
5009   \commondummyletter\.%
5010   \commondummyletter\/%
5011   \commondummyletter\:%
5012   \commondummyaccent\=%
5013   \commondummyletter\?%
5014   \commondummyaccent\^%
5015   \commondummyaccent\`%
5016   \commondummyaccent\~%
5017   \commondummyword\u
5018   \commondummyword\v
5019   \commondummyword\H
5020   \commondummyword\dotaccent
5021   \commondummyword\ogonek
5022   \commondummyword\ringaccent
5023   \commondummyword\tieaccent
5024   \commondummyword\ubaraccent
5025   \commondummyword\udotaccent
5026   \commondummyword\dotless
5027   %
5028   % Texinfo font commands.
5029   \commondummyword\b
5030   \commondummyword\i
5031   \commondummyword\r
5032   \commondummyword\sansserif
5033   \commondummyword\sc
5034   \commondummyword\slanted
5035   \commondummyword\t
5036   %
5037   % Commands that take arguments.
5038   \commondummyword\abbr
5039   \commondummyword\acronym
5040   \commondummyword\anchor
5041   \commondummyword\cite
5042   \commondummyword\code
5043   \commondummyword\command
5044   \commondummyword\dfn
5045   \commondummyword\dmn
5046   \commondummyword\email
5047   \commondummyword\emph
5048   \commondummyword\env
5049   \commondummyword\file
5050   \commondummyword\image
5051   \commondummyword\indicateurl
5052   \commondummyword\inforef
5053   \commondummyword\kbd
5054   \commondummyword\key
5055   \commondummyword\math
5056   \commondummyword\option
5057   \commondummyword\pxref
5058   \commondummyword\ref
5059   \commondummyword\samp
5060   \commondummyword\strong
5061   \commondummyword\tie
5062   \commondummyword\U
5063   \commondummyword\uref
5064   \commondummyword\url
5065   \commondummyword\var
5066   \commondummyword\verb
5067   \commondummyword\w
5068   \commondummyword\xref
5069 }
5070
5071 % For testing: output @{ and @} in index sort strings as \{ and \}.
5072 \newif\ifusebracesinindexes
5073
5074 \let\indexlbrace\relax
5075 \let\indexrbrace\relax
5076
5077 {\catcode`\@=0
5078 \catcode`\\=13
5079   @gdef@backslashdisappear{@def\{}}
5080 }
5081
5082 {
5083 \catcode`\<=13
5084 \catcode`\-=13
5085 \catcode`\`=13
5086   \gdef\indexnonalnumdisappear{%
5087     \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
5088       % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
5089       % (Introduced for FSFS 2nd ed.)
5090       \let`=\empty
5091     \fi
5092     %
5093     \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
5094       \backslashdisappear
5095     \fi
5096     %
5097     \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
5098       \def-{}%
5099     \fi
5100     \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
5101       \def<{}%
5102     \fi
5103     \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
5104       \def\@{}%
5105     \fi
5106   }
5107
5108   \gdef\indexnonalnumreappear{%
5109     \useindexbackslash
5110     \let-\normaldash
5111     \let<\normalless
5112     \def\@{@}%
5113   }
5114 }
5115
5116
5117 % \indexnofonts is used when outputting the strings to sort the index
5118 % by, and when constructing control sequence names.  It eliminates all
5119 % control sequences and just writes whatever the best ASCII sort string
5120 % would be for a given command (usually its argument).
5121 %
5122 \def\indexnofonts{%
5123   % Accent commands should become @asis.
5124   \def\commondummyaccent##1{\let##1\asis}%
5125   % We can just ignore other control letters.
5126   \def\commondummyletter##1{\let##1\empty}%
5127   % All control words become @asis by default; overrides below.
5128   \let\commondummyword\commondummyaccent
5129   \commondummiesnofonts
5130   %
5131   % Don't no-op \tt, since it isn't a user-level command
5132   % and is used in the definitions of the active chars like <, >, |, etc.
5133   % Likewise with the other plain tex font commands.
5134   %\let\tt=\asis
5135   %
5136   \def\ { }%
5137   \def\@{@}%
5138   \def\_{\normalunderscore}%
5139   \def\-{}% @- shouldn't affect sorting
5140   %
5141   \uccode`\1=`\{ \uppercase{\def\{{1}}%
5142   \uccode`\1=`\} \uppercase{\def\}{1}}%
5143   \let\lbracechar\{%
5144   \let\rbracechar\}%
5145   %
5146   % Non-English letters.
5147   \def\AA{AA}%
5148   \def\AE{AE}%
5149   \def\DH{DZZ}%
5150   \def\L{L}%
5151   \def\OE{OE}%
5152   \def\O{O}%
5153   \def\TH{TH}%
5154   \def\aa{aa}%
5155   \def\ae{ae}%
5156   \def\dh{dzz}%
5157   \def\exclamdown{!}%
5158   \def\l{l}%
5159   \def\oe{oe}%
5160   \def\ordf{a}%
5161   \def\ordm{o}%
5162   \def\o{o}%
5163   \def\questiondown{?}%
5164   \def\ss{ss}%
5165   \def\th{th}%
5166   %
5167   \def\LaTeX{LaTeX}%
5168   \def\TeX{TeX}%
5169   %
5170   % Assorted special characters.  \defglyph gives the control sequence a
5171   % definition that removes the {} that follows its use.
5172   \defglyph\atchar{@}%
5173   \defglyph\arrow{->}%
5174   \defglyph\bullet{bullet}%
5175   \defglyph\comma{,}%
5176   \defglyph\copyright{copyright}%
5177   \defglyph\dots{...}%
5178   \defglyph\enddots{...}%
5179   \defglyph\equiv{==}%
5180   \defglyph\error{error}%
5181   \defglyph\euro{euro}%
5182   \defglyph\expansion{==>}%
5183   \defglyph\geq{>=}%
5184   \defglyph\guillemetleft{<<}%
5185   \defglyph\guillemetright{>>}%
5186   \defglyph\guilsinglleft{<}%
5187   \defglyph\guilsinglright{>}%
5188   \defglyph\leq{<=}%
5189   \defglyph\lbracechar{\{}%
5190   \defglyph\minus{-}%
5191   \defglyph\point{.}%
5192   \defglyph\pounds{pounds}%
5193   \defglyph\print{-|}%
5194   \defglyph\quotedblbase{"}%
5195   \defglyph\quotedblleft{"}%
5196   \defglyph\quotedblright{"}%
5197   \defglyph\quoteleft{`}%
5198   \defglyph\quoteright{'}%
5199   \defglyph\quotesinglbase{,}%
5200   \defglyph\rbracechar{\}}%
5201   \defglyph\registeredsymbol{R}%
5202   \defglyph\result{=>}%
5203   \defglyph\textdegree{o}%
5204   %
5205   % We need to get rid of all macros, leaving only the arguments (if present).
5206   % Of course this is not nearly correct, but it is the best we can do for now.
5207   % makeinfo does not expand macros in the argument to @deffn, which ends up
5208   % writing an index entry, and texindex isn't prepared for an index sort entry
5209   % that starts with \.
5210   %
5211   % Since macro invocations are followed by braces, we can just redefine them
5212   % to take a single TeX argument.  The case of a macro invocation that
5213   % goes to end-of-line is not handled.
5214   %
5215   \macrolist
5216   \let\value\indexnofontsvalue
5217 }
5218 \def\defglyph#1#2{\def#1##1{#2}} % see above
5219
5220 \f
5221
5222
5223 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
5224
5225 % Most index entries go through here, but \dosubind is the general case.
5226 % #1 is the index name, #2 is the entry text.
5227 \def\doind#1#2{\dosubind{#1}{#2}{}}
5228
5229 % There is also \dosubind {index}{topic}{subtopic}
5230 % which makes an entry in a two-level index such as the operation index.
5231 % TODO: Two-level index?  Operation index?
5232
5233 % Workhorse for all indexes.
5234 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
5235 % empty if called from \doind, as we usually are (the main exception
5236 % is with most defuns, which call us directly).
5237 %
5238 \def\dosubind#1#2#3{%
5239   \iflinks
5240   {%
5241     \requireopenindexfile{#1}%
5242     % Store the main index entry text (including the third arg).
5243     \toks0 = {#2}%
5244     % If third arg is present, precede it with a space.
5245     \def\thirdarg{#3}%
5246     \ifx\thirdarg\empty \else
5247       \toks0 = \expandafter{\the\toks0 \space #3}%
5248     \fi
5249     %
5250     \edef\writeto{\csname#1indfile\endcsname}%
5251     %
5252     \safewhatsit\dosubindwrite
5253   }%
5254   \fi
5255 }
5256
5257 % Check if an index file has been opened, and if not, open it.
5258 \def\requireopenindexfile#1{%
5259 \ifnum\csname #1indfile\endcsname=0
5260   \expandafter\newwrite \csname#1indfile\endcsname
5261   \edef\suffix{#1}%
5262   % A .fls suffix would conflict with the file extension for the output
5263   % of -recorder, so use .f1s instead.
5264   \ifx\suffix\indexisfl\def\suffix{f1}\fi
5265   % Open the file
5266   \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
5267   % Using \immediate above here prevents an object entering into the current 
5268   % box, which could confound checks such as those in \safewhatsit for
5269   % preceding skips.
5270   \typeout{Writing index file \jobname.\suffix}%
5271 \fi}
5272 \def\indexisfl{fl}
5273
5274 % Output \ as {\indexbackslash}, because \ is an escape character in
5275 % the index files.
5276 \let\indexbackslash=\relax
5277 {\catcode`\@=0 \catcode`\\=\active
5278   @gdef@useindexbackslash{@def\{{@indexbackslash}}}
5279 }
5280
5281 % Definition for writing index entry text.
5282 \def\sortas#1{\ignorespaces}%
5283
5284 % Definition for writing index entry sort key.  Should occur at the at
5285 % the beginning of the index entry, like
5286 %     @cindex @sortas{september} \september
5287 % The \ignorespaces takes care of following space, but there's no way
5288 % to remove space before it.
5289 {
5290 \catcode`\-=13
5291 \gdef\indexwritesortas{%
5292   \begingroup
5293   \indexnonalnumreappear
5294   \indexwritesortasxxx}
5295 \gdef\indexwritesortasxxx#1{%
5296   \xdef\indexsortkey{#1}\endgroup}
5297 }
5298
5299
5300 % Write the entry in \toks0 to the index file.
5301 %
5302 \def\dosubindwrite{%
5303   % Put the index entry in the margin if desired.
5304   \ifx\SETmarginindex\relax\else
5305     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
5306   \fi
5307   %
5308   % Remember, we are within a group.
5309   \indexdummies % Must do this here, since \bf, etc expand at this stage
5310   \useindexbackslash % \indexbackslash isn't defined now so it will be output 
5311                      % as is; and it will print as backslash.
5312   % The braces around \indexbrace are recognized by texindex.
5313   %
5314   % Get the string to sort by, by processing the index entry with all
5315   % font commands turned off.
5316   {\indexnofonts
5317    \def\lbracechar{{\indexlbrace}}%
5318    \def\rbracechar{{\indexrbrace}}%
5319    \let\{=\lbracechar
5320    \let\}=\rbracechar
5321    \indexnonalnumdisappear
5322    \xdef\indexsortkey{}%
5323    \let\sortas=\indexwritesortas
5324    \edef\temp{\the\toks0}%
5325    \setbox\dummybox = \hbox{\temp}% Make sure to execute any \sortas
5326    \ifx\indexsortkey\empty
5327      \xdef\indexsortkey{\temp}%
5328      \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
5329    \fi
5330   }%
5331   %
5332   % Set up the complete index entry, with both the sort key and
5333   % the original text, including any font commands.  We write
5334   % three arguments to \entry to the .?? file (four in the
5335   % subentry case), texindex reduces to two when writing the .??s
5336   % sorted result.
5337   \edef\temp{%
5338     \write\writeto{%
5339       \string\entry{\indexsortkey}{\noexpand\folio}{\the\toks0}}%
5340   }%
5341   \temp
5342 }
5343 \newbox\dummybox % used above
5344
5345 % Take care of unwanted page breaks/skips around a whatsit:
5346 %
5347 % If a skip is the last thing on the list now, preserve it
5348 % by backing up by \lastskip, doing the \write, then inserting
5349 % the skip again.  Otherwise, the whatsit generated by the
5350 % \write or \pdfdest will make \lastskip zero.  The result is that
5351 % sequences like this:
5352 % @end defun
5353 % @tindex whatever
5354 % @defun ...
5355 % will have extra space inserted, because the \medbreak in the
5356 % start of the @defun won't see the skip inserted by the @end of
5357 % the previous defun.
5358 %
5359 % But don't do any of this if we're not in vertical mode.  We
5360 % don't want to do a \vskip and prematurely end a paragraph.
5361 %
5362 % Avoid page breaks due to these extra skips, too.
5363 %
5364 % But wait, there is a catch there:
5365 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
5366 % sufficient for this purpose, as it ignores stretch and shrink parts
5367 % of the skip.  The only way seems to be to check the textual
5368 % representation of the skip.
5369 %
5370 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5371 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5372 %
5373 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
5374 %
5375 \newskip\whatsitskip
5376 \newcount\whatsitpenalty
5377 %
5378 % ..., ready, GO:
5379 %
5380 \def\safewhatsit#1{\ifhmode
5381   #1%
5382  \else
5383   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5384   \whatsitskip = \lastskip
5385   \edef\lastskipmacro{\the\lastskip}%
5386   \whatsitpenalty = \lastpenalty
5387   %
5388   % If \lastskip is nonzero, that means the last item was a
5389   % skip.  And since a skip is discardable, that means this
5390   % -\whatsitskip glue we're inserting is preceded by a
5391   % non-discardable item, therefore it is not a potential
5392   % breakpoint, therefore no \nobreak needed.
5393   \ifx\lastskipmacro\zeroskipmacro
5394   \else
5395     \vskip-\whatsitskip
5396   \fi
5397   %
5398   #1%
5399   %
5400   \ifx\lastskipmacro\zeroskipmacro
5401     % If \lastskip was zero, perhaps the last item was a penalty, and
5402     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
5403     % to re-insert the same penalty (values >10000 are used for various
5404     % signals); since we just inserted a non-discardable item, any
5405     % following glue (such as a \parskip) would be a breakpoint.  For example:
5406     %   @deffn deffn-whatever
5407     %   @vindex index-whatever
5408     %   Description.
5409     % would allow a break between the index-whatever whatsit
5410     % and the "Description." paragraph.
5411     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
5412   \else
5413     % On the other hand, if we had a nonzero \lastskip,
5414     % this make-up glue would be preceded by a non-discardable item
5415     % (the whatsit from the \write), so we must insert a \nobreak.
5416     \nobreak\vskip\whatsitskip
5417   \fi
5418 \fi}
5419
5420 % The index entry written in the file actually looks like
5421 %  \entry {sortstring}{page}{topic}
5422 % or
5423 %  \entry {sortstring}{page}{topic}{subtopic}
5424 % The texindex program reads in these files and writes files
5425 % containing these kinds of lines:
5426 %  \initial {c}
5427 %     before the first topic whose initial is c
5428 %  \entry {topic}{pagelist}
5429 %     for a topic that is used without subtopics
5430 %  \primary {topic}
5431 %     for the beginning of a topic that is used with subtopics
5432 %  \secondary {subtopic}{pagelist}
5433 %     for each subtopic.
5434
5435 % Define the user-accessible indexing commands
5436 % @findex, @vindex, @kindex, @cindex.
5437
5438 \def\findex {\fnindex}
5439 \def\kindex {\kyindex}
5440 \def\cindex {\cpindex}
5441 \def\vindex {\vrindex}
5442 \def\tindex {\tpindex}
5443 \def\pindex {\pgindex}
5444
5445 \def\cindexsub {\begingroup\obeylines\cindexsub}
5446 {\obeylines %
5447 \gdef\cindexsub "#1" #2^^M{\endgroup %
5448 \dosubind{cp}{#2}{#1}}}
5449
5450 % Define the macros used in formatting output of the sorted index material.
5451
5452 % @printindex causes a particular index (the ??s file) to get printed.
5453 % It does not print any chapter heading (usually an @unnumbered).
5454 %
5455 \parseargdef\printindex{\begingroup
5456   \dobreak \chapheadingskip{10000}%
5457   %
5458   \smallfonts \rm
5459   \tolerance = 9500
5460   \plainfrenchspacing
5461   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
5462   %
5463   % See if the index file exists and is nonempty.
5464   % Change catcode of @ here so that if the index file contains
5465   % \initial {@}
5466   % as its first line, TeX doesn't complain about mismatched braces
5467   % (because it thinks @} is a control sequence).
5468   \catcode`\@ = 12
5469   % See comment in \requireopenindexfile.
5470   \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
5471   \openin 1 \jobname.\indexname s
5472   \ifeof 1
5473     % \enddoublecolumns gets confused if there is no text in the index,
5474     % and it loses the chapter title and the aux file entries for the
5475     % index.  The easiest way to prevent this problem is to make sure
5476     % there is some text.
5477     \putwordIndexNonexistent
5478     \typeout{No file \jobname.\indexname s.}%
5479   \else
5480     \catcode`\\ = 0
5481     %
5482     % If the index file exists but is empty, then \openin leaves \ifeof
5483     % false.  We have to make TeX try to read something from the file, so
5484     % it can discover if there is anything in it.
5485     \read 1 to \thisline
5486     \ifeof 1
5487       \putwordIndexIsEmpty
5488     \else
5489       % Index files are almost Texinfo source, but we use \ as the escape
5490       % character.  It would be better to use @, but that's too big a change
5491       % to make right now.
5492       \def\indexbackslash{\ttbackslash}%
5493       \let\indexlbrace\{   % Likewise, set these sequences for braces
5494       \let\indexrbrace\}   % used in the sort key.
5495       \begindoublecolumns
5496       \let\entrywidowpenalty=\indexwidowpenalty
5497       %
5498       % Read input from the index file line by line.
5499       \loopdo
5500         \ifeof1
5501           \let\firsttoken\relax
5502         \else
5503           \read 1 to \nextline
5504           \edef\act{\gdef\noexpand\firsttoken{\getfirsttoken\nextline}}%
5505           \act
5506         \fi
5507         \thisline
5508         %
5509         \ifeof1\else
5510         \let\thisline\nextline
5511       \repeat
5512       %%
5513       \enddoublecolumns
5514     \fi
5515   \fi
5516   \closein 1
5517 \endgroup}
5518
5519 \def\getfirsttoken#1{\expandafter\getfirsttokenx#1\endfirsttoken}
5520 \long\def\getfirsttokenx#1#2\endfirsttoken{\noexpand#1}
5521
5522 \def\loopdo#1\repeat{\def\body{#1}\loopdoxxx}
5523 \def\loopdoxxx{\let\next=\relax\body\let\next=\loopdoxxx\fi\next}
5524
5525 % These macros are used by the sorted index file itself.
5526 % Change them to control the appearance of the index.
5527
5528 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5529 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5530 \catcode`\$=3
5531 \gdef\initialglyphs{%
5532   % Some changes for non-alphabetic characters.  Using the glyphs from the
5533   % math fonts looks more consistent than the typewriter font used elsewhere
5534   % for these characters.
5535   \def\indexbackslash{\math{\backslash}}%
5536   \let\\=\indexbackslash
5537   %
5538   % Can't get bold backslash so don't use bold forward slash
5539   \catcode`\/=13
5540   \def/{{\secrmnotbold \normalslash}}%
5541   \def-{{\normaldash\normaldash}}% en dash `--'
5542   \def^{{\chapbf \normalcaret}}%
5543   \def~{{\chapbf \normaltilde}}%
5544   \def\_{%
5545      \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
5546   \def|{$\vert$}%
5547   \def<{$\less$}%
5548   \def>{$\gtr$}%
5549   \def+{$\normalplus$}%
5550 }}
5551
5552 \def\initial{%
5553   \bgroup
5554   \initialglyphs
5555   \initialx
5556 }
5557
5558 \def\initialx#1{%
5559   % Remove any glue we may have, we'll be inserting our own.
5560   \removelastskip
5561   %
5562   % We like breaks before the index initials, so insert a bonus.
5563   % The glue before the bonus allows a little bit of space at the
5564   % bottom of a column to reduce an increase in inter-line spacing.
5565   \nobreak
5566   \vskip 0pt plus 5\baselineskip
5567   \penalty -300 
5568   \vskip 0pt plus -5\baselineskip
5569   %
5570   % Typeset the initial.  Making this add up to a whole number of
5571   % baselineskips increases the chance of the dots lining up from column
5572   % to column.  It still won't often be perfect, because of the stretch
5573   % we need before each entry, but it's better.
5574   %
5575   % No shrink because it confuses \balancecolumns.
5576   \vskip 1.67\baselineskip plus 1\baselineskip
5577   \leftline{\secfonts \kern-0.05em \secbf #1}%
5578   % \secfonts is inside the argument of \leftline so that the change of
5579   % \baselineskip will not affect any glue inserted before the vbox that
5580   % \leftline creates.
5581   % Do our best not to break after the initial.
5582   \nobreak
5583   \vskip .33\baselineskip plus .1\baselineskip
5584   \egroup % \initialglyphs
5585 }
5586
5587 \newdimen\entryrightmargin
5588 \entryrightmargin=0pt
5589
5590 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5591 % then page number (#2) flushed to the right margin.  It is used for index
5592 % and table of contents entries.  The paragraph is indented by \leftskip.
5593 %
5594 \def\entry{%
5595   \begingroup
5596     %
5597     % For pdfTeX and XeTeX.
5598     % The redefinition of \domark stops marks being added in \pdflink to 
5599     % preserve coloured links across page boundaries.  Otherwise the marks
5600     % would get in the way of \lastbox in \insertindexentrybox.
5601     \let\domark\relax
5602     %
5603     % Start a new paragraph if necessary, so our assignments below can't
5604     % affect previous text.
5605     \par
5606     %
5607     % No extra space above this paragraph.
5608     \parskip = 0in
5609     %
5610     % When reading the text of entry, convert explicit line breaks
5611     % from @* into spaces.  The user might give these in long section
5612     % titles, for instance.
5613     \def\*{\unskip\space\ignorespaces}%
5614     \def\entrybreak{\hfil\break}% An undocumented command
5615     %
5616     % Swallow the left brace of the text (first parameter):
5617     \afterassignment\doentry
5618     \let\temp =
5619 }
5620 \def\entrybreak{\unskip\space\ignorespaces}%
5621 \def\doentry{%
5622     % Save the text of the entry
5623     \global\setbox\boxA=\hbox\bgroup
5624     \bgroup % Instead of the swallowed brace.
5625       \noindent
5626       \aftergroup\finishentry
5627       % And now comes the text of the entry.
5628       % Not absorbing as a macro argument reduces the chance of problems
5629       % with catcodes occurring.
5630 }
5631 {\catcode`\@=11
5632 \gdef\finishentry#1{%
5633     \egroup % end box A
5634     \dimen@ = \wd\boxA % Length of text of entry
5635     \global\setbox\boxA=\hbox\bgroup\unhbox\boxA
5636     % #1 is the page number.
5637     %
5638     % Get the width of the page numbers, and only use
5639     % leaders if they are present.
5640     \global\setbox\boxB = \hbox{#1}%
5641     \ifdim\wd\boxB = 0pt
5642       \null\nobreak\hfill\ %
5643     \else
5644       %
5645       \null\nobreak\indexdotfill % Have leaders before the page number.
5646       %
5647       \ifpdf
5648         \pdfgettoks#1.%
5649         \hskip\skip\thinshrinkable\the\toksA
5650       \else
5651         \ifx\XeTeXrevision\thisisundefined
5652           \hskip\skip\thinshrinkable #1%
5653         \else
5654           \pdfgettoks#1.%
5655           \hskip\skip\thinshrinkable\the\toksA
5656         \fi
5657       \fi
5658     \fi
5659     \egroup % end \boxA
5660     \ifdim\wd\boxB = 0pt
5661       \global\setbox\entryindexbox=\vbox{\unhbox\boxA}%
5662     \else
5663     \global\setbox\entryindexbox=\vbox\bgroup
5664       % We want the text of the entries to be aligned to the left, and the
5665       % page numbers to be aligned to the right.
5666       %
5667       \parindent = 0pt
5668       \advance\leftskip by 0pt plus 1fil
5669       \advance\leftskip by 0pt plus -1fill
5670       \rightskip = 0pt plus -1fil
5671       \advance\rightskip by 0pt plus 1fill
5672       % Cause last line, which could consist of page numbers on their own
5673       % if the list of page numbers is long, to be aligned to the right.
5674       \parfillskip=0pt plus -1fill
5675       %
5676       \advance\rightskip by \entryrightmargin
5677       % Determine how far we can stretch into the margin.
5678       % This allows, e.g., "Appendix H  GNU Free Documentation License" to
5679       % fit on one line in @letterpaper format.
5680       \ifdim\entryrightmargin>2.1em
5681         \dimen@i=2.1em
5682       \else
5683         \dimen@i=0em
5684       \fi
5685       \advance \parfillskip by 0pt minus 1\dimen@i
5686       %
5687       \dimen@ii = \hsize
5688       \advance\dimen@ii by -1\leftskip
5689       \advance\dimen@ii by -1\entryrightmargin
5690       \advance\dimen@ii by 1\dimen@i
5691       \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
5692       \ifdim\dimen@ > 0.8\dimen@ii   % due to long index text
5693         \dimen@ = 0.7\dimen@ % Try to split the text roughly evenly
5694         \dimen@ii = \hsize
5695         \ifnum\dimen@>\dimen@ii
5696           % If the entry is too long, use the whole line
5697           \dimen@ = \dimen@ii
5698         \fi
5699         \advance\leftskip by 0pt plus 1fill % ragged right
5700         \advance \dimen@ by 1\rightskip
5701         \parshape = 2 0pt \dimen@ 0em \dimen@ii
5702         % Ideally we'd add a finite glue at the end of the first line only,
5703         % instead of using \parshape with explicit line lengths, but TeX
5704         % doesn't seem to provide a way to do such a thing.
5705         %
5706         \leftskip = 1em
5707         \parindent = -1em
5708       \fi\fi
5709       \indent % start paragraph
5710       \unhbox\boxA
5711       %
5712       % Do not prefer a separate line ending with a hyphen to fewer lines.
5713       \finalhyphendemerits = 0
5714       %
5715       % Word spacing - no stretch
5716       \spaceskip=\fontdimen2\font minus \fontdimen4\font
5717       %
5718       \linepenalty=1000  % Discourage line breaks.
5719       \hyphenpenalty=5000  % Discourage hyphenation.
5720       %
5721       \par % format the paragraph
5722     \egroup % The \vbox
5723     \fi
5724   \endgroup
5725   % delay text of entry until after penalty
5726   \bgroup\aftergroup\insertindexentrybox
5727   \entrywidowpenalty
5728 }}
5729
5730 \newskip\thinshrinkable
5731 \skip\thinshrinkable=.15em minus .15em
5732
5733 \newbox\entryindexbox
5734 \def\insertindexentrybox{%
5735   \ourunvbox\entryindexbox
5736 }
5737
5738 % Use \lastbox to take apart vbox box by box, and add each sub-box
5739 % to the current vertical list.
5740 \def\ourunvbox#1{%
5741 \bgroup % for local binding of \delayedbox
5742   % Remove the last box from box #1
5743   \global\setbox#1=\vbox{%
5744     \unvbox#1%
5745     \unskip % remove any glue
5746     \unpenalty
5747     \global\setbox\interbox=\lastbox
5748   }%
5749   \setbox\delayedbox=\box\interbox
5750   \ifdim\ht#1=0pt\else
5751     \ourunvbox#1 % Repeat on what's left of the box
5752     \nobreak
5753   \fi
5754   \box\delayedbox
5755 \egroup
5756 }
5757 \newbox\delayedbox
5758 \newbox\interbox
5759
5760 % Default is no penalty
5761 \let\entrywidowpenalty\egroup
5762
5763 % Used from \printindex.  \firsttoken should be the first token
5764 % after the \entry.  If it's not another \entry, we are at the last
5765 % line of a group of index entries, so insert a penalty to discourage
5766 % widowed index entries.
5767 \long\def\indexwidowpenalty{%
5768   \def\isentry{\entry}%
5769   \ifx\firsttoken\isentry
5770   \else
5771     \penalty 9000
5772   \fi
5773   \egroup % now comes the box added with \aftergroup
5774 }
5775
5776 % Like plain.tex's \dotfill, except uses up at least 1 em.
5777 % The filll stretch here overpowers both the fil and fill stretch to push
5778 % the page number to the right.
5779 \def\indexdotfill{\cleaders
5780   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
5781
5782
5783 \def\primary #1{\line{#1\hfil}}
5784
5785 \newskip\secondaryindent \secondaryindent=0.5cm
5786 \def\secondary#1#2{{%
5787   \parfillskip=0in
5788   \parskip=0in
5789   \hangindent=1in
5790   \hangafter=1
5791   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5792   \ifpdf
5793     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5794   \else
5795     \ifx\XeTeXrevision\thisisundefined
5796       #2
5797     \else
5798       \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5799     \fi
5800   \fi
5801   \par
5802 }}
5803
5804 % Define two-column mode, which we use to typeset indexes.
5805 % Adapted from the TeXbook, page 416, which is to say,
5806 % the manmac.tex format used to print the TeXbook itself.
5807 \catcode`\@=11  % private names
5808
5809 \newbox\partialpage
5810 \newdimen\doublecolumnhsize
5811
5812 % Use inside an output routine to save \topmark and \firstmark
5813 \def\savemarks{%
5814   \global\savedtopmark=\expandafter{\topmark }%
5815   \global\savedfirstmark=\expandafter{\firstmark }%
5816 }
5817 \newtoks\savedtopmark
5818 \newtoks\savedfirstmark
5819
5820 % Set \topmark and \firstmark for next time \output runs.
5821 % Can't be run from withinside \output (because any material
5822 % added while an output routine is active, including 
5823 % penalties, is saved for after it finishes).  The page so far
5824 % should be empty, otherwise what's on it will be thrown away.
5825 \def\restoremarks{%
5826   \mark{\the\savedtopmark}%
5827   \bgroup\output = {%
5828     \setbox\dummybox=\box\PAGE
5829   }abc\eject\egroup
5830   % "abc" because output routine doesn't fire for a completely empty page.
5831   \mark{\the\savedfirstmark}%
5832 }
5833
5834 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5835   % If not much space left on page, start a new page.
5836   \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
5837   %
5838   % Grab any single-column material above us.
5839   \output = {%
5840     %
5841     % Here is a possibility not foreseen in manmac: if we accumulate a
5842     % whole lot of material, we might end up calling this \output
5843     % routine twice in a row (see the doublecol-lose test, which is
5844     % essentially a couple of indexes with @setchapternewpage off).  In
5845     % that case we just ship out what is in \partialpage with the normal
5846     % output routine.  Generally, \partialpage will be empty when this
5847     % runs and this will be a no-op.  See the indexspread.tex test case.
5848     \ifvoid\partialpage \else
5849       \onepageout{\pagecontents\partialpage}%
5850     \fi
5851     %
5852     \global\setbox\partialpage = \vbox{%
5853       % Unvbox the main output page.
5854       \unvbox\PAGE
5855       \kern-\topskip \kern\baselineskip
5856     }%
5857     \savemarks
5858   }%
5859   \eject % run that output routine to set \partialpage
5860   \restoremarks
5861   %
5862   % We recover the two marks that the last output routine saved in order
5863   % to propagate the information in marks added around a chapter heading,
5864   % which could be otherwise be lost by the time the final page is output.
5865   %
5866   %
5867   % Use the double-column output routine for subsequent pages.
5868   \output = {\doublecolumnout}%
5869   %
5870   % Change the page size parameters.  We could do this once outside this
5871   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5872   % format, but then we repeat the same computation.  Repeating a couple
5873   % of assignments once per index is clearly meaningless for the
5874   % execution time, so we may as well do it in one place.
5875   %
5876   % First we halve the line length, less a little for the gutter between
5877   % the columns.  We compute the gutter based on the line length, so it
5878   % changes automatically with the paper format.  The magic constant
5879   % below is chosen so that the gutter has the same value (well, +-<1pt)
5880   % as it did when we hard-coded it.
5881   %
5882   % We put the result in a separate register, \doublecolumhsize, so we
5883   % can restore it in \pagesofar, after \hsize itself has (potentially)
5884   % been clobbered.
5885   %
5886   \doublecolumnhsize = \hsize
5887     \advance\doublecolumnhsize by -.04154\hsize
5888     \divide\doublecolumnhsize by 2
5889   \hsize = \doublecolumnhsize
5890   %
5891   % Double the \vsize as well.  (We don't need a separate register here,
5892   % since nobody clobbers \vsize.)
5893   \vsize = 2\vsize
5894   %
5895   % For the benefit of balancing columns
5896   \advance\baselineskip by 0pt plus 0.5pt
5897 }
5898
5899 % The double-column output routine for all double-column pages except
5900 % the last, which is done by \balancecolumns.
5901 %
5902 \def\doublecolumnout{%
5903   %
5904   \splittopskip=\topskip \splitmaxdepth=\maxdepth
5905   % Get the available space for the double columns -- the normal
5906   % (undoubled) page height minus any material left over from the
5907   % previous page.
5908   \dimen@ = \vsize
5909   \divide\dimen@ by 2
5910   \advance\dimen@ by -\ht\partialpage
5911   %
5912   % box0 will be the left-hand column, box2 the right.
5913   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5914   \onepageout\pagesofar
5915   \unvbox255
5916   \penalty\outputpenalty
5917 }
5918 %
5919 % Re-output the contents of the output page -- any previous material,
5920 % followed by the two boxes we just split, in box0 and box2.
5921 \def\pagesofar{%
5922   \unvbox\partialpage
5923   %
5924   \hsize = \doublecolumnhsize
5925   \wd0=\hsize \wd2=\hsize
5926   \hbox to\txipagewidth{\box0\hfil\box2}%
5927 }
5928
5929
5930 % Finished with with double columns.
5931 \def\enddoublecolumns{%
5932   % The following penalty ensures that the page builder is exercised
5933   % _before_ we change the output routine.  This is necessary in the
5934   % following situation:
5935   %
5936   % The last section of the index consists only of a single entry.
5937   % Before this section, \pagetotal is less than \pagegoal, so no
5938   % break occurs before the last section starts.  However, the last
5939   % section, consisting of \initial and the single \entry, does not
5940   % fit on the page and has to be broken off.  Without the following
5941   % penalty the page builder will not be exercised until \eject
5942   % below, and by that time we'll already have changed the output
5943   % routine to the \balancecolumns version, so the next-to-last
5944   % double-column page will be processed with \balancecolumns, which
5945   % is wrong:  The two columns will go to the main vertical list, with
5946   % the broken-off section in the recent contributions.  As soon as
5947   % the output routine finishes, TeX starts reconsidering the page
5948   % break.  The two columns and the broken-off section both fit on the
5949   % page, because the two columns now take up only half of the page
5950   % goal.  When TeX sees \eject from below which follows the final
5951   % section, it invokes the new output routine that we've set after
5952   % \balancecolumns below; \onepageout will try to fit the two columns
5953   % and the final section into the vbox of \txipageheight (see
5954   % \pagebody), causing an overfull box.
5955   %
5956   % Note that glue won't work here, because glue does not exercise the
5957   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5958   \penalty0
5959   %
5960   \output = {%
5961     % Split the last of the double-column material.
5962     \savemarks
5963     \balancecolumns
5964     %
5965     % Having called \balancecolumns once, we do not
5966     % want to call it again.  Therefore, reset \output to its normal
5967     % definition right away.
5968     \global\output = {\onepageout{\pagecontents\PAGE}}%
5969   }%
5970   \eject
5971   \endgroup % started in \begindoublecolumns
5972   \restoremarks
5973   % Leave the double-column material on the current page, no automatic
5974   % page break.
5975   \box\balancedcolumns
5976   %
5977   % \pagegoal was set to the doubled \vsize above, since we restarted
5978   % the current page.  We're now back to normal single-column
5979   % typesetting, so reset \pagegoal to the normal \vsize (after the
5980   % \endgroup where \vsize got restored).
5981   \pagegoal = \vsize
5982 }
5983 \newbox\balancedcolumns
5984 \setbox\balancedcolumns=\vbox{shouldnt see this}%
5985 %
5986 % Only called for the last of the double column material.  \doublecolumnout 
5987 % does the others.
5988 \def\balancecolumns{%
5989   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5990   \dimen@ = \ht0
5991   \advance\dimen@ by \topskip
5992   \advance\dimen@ by-\baselineskip
5993   \ifdim\dimen@<5\baselineskip
5994     % Don't split a short final column in two.
5995     \setbox2=\vbox{}%
5996   \else
5997     \divide\dimen@ by 2 % target to split to
5998     \dimen@ii = \dimen@
5999     \splittopskip = \topskip
6000     % Loop until left column is at least as high as the right column.
6001     {%
6002       \vbadness = 10000
6003       \loop
6004         \global\setbox3 = \copy0
6005         \global\setbox1 = \vsplit3 to \dimen@
6006       \ifdim\ht1<\ht3
6007         \global\advance\dimen@ by 1pt
6008       \repeat
6009     }%
6010     % Now the left column is in box 1, and the right column in box 3.
6011     % Check whether the left column has come out higher than the page itself.  
6012     % (Note that we have doubled \vsize for the double columns, so
6013     % the actual height of the page is 0.5\vsize).
6014     \ifdim2\ht1>\vsize
6015       % Just split the last of the double column material roughly in half.
6016       \setbox2=\box0
6017       \setbox0 = \vsplit2 to \dimen@ii
6018       \setbox0=\vbox to \dimen@ii {\unvbox0\vfill}%
6019       \setbox2=\vbox to \dimen@ii {\unvbox2\vfill}%
6020     \else
6021       % Compare the heights of the two columns.
6022       \ifdim4\ht1>5\ht3
6023         % Column heights are too different, so don't make their bottoms
6024         % flush with each other.
6025         \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
6026         \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
6027       \else
6028         % Make column bottoms flush with each other.
6029         \setbox2=\vbox to\ht1{\unvbox3\unskip}%
6030         \setbox0=\vbox to\ht1{\unvbox1\unskip}%
6031       \fi
6032     \fi
6033   \fi
6034   %
6035   \global\setbox\balancedcolumns=\vbox{\pagesofar}%
6036 }
6037 \catcode`\@ = \other
6038
6039
6040 \message{sectioning,}
6041 % Chapters, sections, etc.
6042
6043 % Let's start with @part.
6044 \outer\parseargdef\part{\partzzz{#1}}
6045 \def\partzzz#1{%
6046   \chapoddpage
6047   \null
6048   \vskip.3\vsize  % move it down on the page a bit
6049   \begingroup
6050     \noindent \titlefonts\rm #1\par % the text
6051     \let\lastnode=\empty      % no node to associate with
6052     \writetocentry{part}{#1}{}% but put it in the toc
6053     \headingsoff              % no headline or footline on the part page
6054     % This outputs a mark at the end of the page that clears \thischapter
6055     % and \thissection, as is done in \startcontents.
6056     \let\pchapsepmacro\relax
6057     \chapmacro{}{Yomitfromtoc}{}%
6058     \chapoddpage
6059   \endgroup
6060 }
6061
6062 % \unnumberedno is an oxymoron.  But we count the unnumbered
6063 % sections so that we can refer to them unambiguously in the pdf
6064 % outlines by their "section number".  We avoid collisions with chapter
6065 % numbers by starting them at 10000.  (If a document ever has 10000
6066 % chapters, we're in trouble anyway, I'm sure.)
6067 \newcount\unnumberedno \unnumberedno = 10000
6068 \newcount\chapno
6069 \newcount\secno        \secno=0
6070 \newcount\subsecno     \subsecno=0
6071 \newcount\subsubsecno  \subsubsecno=0
6072
6073 % This counter is funny since it counts through charcodes of letters A, B, ...
6074 \newcount\appendixno  \appendixno = `\@
6075 %
6076 % \def\appendixletter{\char\the\appendixno}
6077 % We do the following ugly conditional instead of the above simple
6078 % construct for the sake of pdftex, which needs the actual
6079 % letter in the expansion, not just typeset.
6080 %
6081 \def\appendixletter{%
6082   \ifnum\appendixno=`A A%
6083   \else\ifnum\appendixno=`B B%
6084   \else\ifnum\appendixno=`C C%
6085   \else\ifnum\appendixno=`D D%
6086   \else\ifnum\appendixno=`E E%
6087   \else\ifnum\appendixno=`F F%
6088   \else\ifnum\appendixno=`G G%
6089   \else\ifnum\appendixno=`H H%
6090   \else\ifnum\appendixno=`I I%
6091   \else\ifnum\appendixno=`J J%
6092   \else\ifnum\appendixno=`K K%
6093   \else\ifnum\appendixno=`L L%
6094   \else\ifnum\appendixno=`M M%
6095   \else\ifnum\appendixno=`N N%
6096   \else\ifnum\appendixno=`O O%
6097   \else\ifnum\appendixno=`P P%
6098   \else\ifnum\appendixno=`Q Q%
6099   \else\ifnum\appendixno=`R R%
6100   \else\ifnum\appendixno=`S S%
6101   \else\ifnum\appendixno=`T T%
6102   \else\ifnum\appendixno=`U U%
6103   \else\ifnum\appendixno=`V V%
6104   \else\ifnum\appendixno=`W W%
6105   \else\ifnum\appendixno=`X X%
6106   \else\ifnum\appendixno=`Y Y%
6107   \else\ifnum\appendixno=`Z Z%
6108   % The \the is necessary, despite appearances, because \appendixletter is
6109   % expanded while writing the .toc file.  \char\appendixno is not
6110   % expandable, thus it is written literally, thus all appendixes come out
6111   % with the same letter (or @) in the toc without it.
6112   \else\char\the\appendixno
6113   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6114   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
6115
6116 % Each @chapter defines these (using marks) as the number+name, number
6117 % and name of the chapter.  Page headings and footings can use
6118 % these.  @section does likewise.
6119 \def\thischapter{}
6120 \def\thischapternum{}
6121 \def\thischaptername{}
6122 \def\thissection{}
6123 \def\thissectionnum{}
6124 \def\thissectionname{}
6125
6126 \newcount\absseclevel % used to calculate proper heading level
6127 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
6128
6129 % @raisesections: treat @section as chapter, @subsection as section, etc.
6130 \def\raisesections{\global\advance\secbase by -1}
6131 \let\up=\raisesections % original BFox name
6132
6133 % @lowersections: treat @chapter as section, @section as subsection, etc.
6134 \def\lowersections{\global\advance\secbase by 1}
6135 \let\down=\lowersections % original BFox name
6136
6137 % we only have subsub.
6138 \chardef\maxseclevel = 3
6139 %
6140 % A numbered section within an unnumbered changes to unnumbered too.
6141 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6142 \chardef\unnlevel = \maxseclevel
6143 %
6144 % Trace whether the current chapter is an appendix or not:
6145 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6146 \def\chapheadtype{N}
6147
6148 % Choose a heading macro
6149 % #1 is heading type
6150 % #2 is heading level
6151 % #3 is text for heading
6152 \def\genhead#1#2#3{%
6153   % Compute the abs. sec. level:
6154   \absseclevel=#2
6155   \advance\absseclevel by \secbase
6156   % Make sure \absseclevel doesn't fall outside the range:
6157   \ifnum \absseclevel < 0
6158     \absseclevel = 0
6159   \else
6160     \ifnum \absseclevel > 3
6161       \absseclevel = 3
6162     \fi
6163   \fi
6164   % The heading type:
6165   \def\headtype{#1}%
6166   \if \headtype U%
6167     \ifnum \absseclevel < \unnlevel
6168       \chardef\unnlevel = \absseclevel
6169     \fi
6170   \else
6171     % Check for appendix sections:
6172     \ifnum \absseclevel = 0
6173       \edef\chapheadtype{\headtype}%
6174     \else
6175       \if \headtype A\if \chapheadtype N%
6176         \errmessage{@appendix... within a non-appendix chapter}%
6177       \fi\fi
6178     \fi
6179     % Check for numbered within unnumbered:
6180     \ifnum \absseclevel > \unnlevel
6181       \def\headtype{U}%
6182     \else
6183       \chardef\unnlevel = 3
6184     \fi
6185   \fi
6186   % Now print the heading:
6187   \if \headtype U%
6188     \ifcase\absseclevel
6189         \unnumberedzzz{#3}%
6190     \or \unnumberedseczzz{#3}%
6191     \or \unnumberedsubseczzz{#3}%
6192     \or \unnumberedsubsubseczzz{#3}%
6193     \fi
6194   \else
6195     \if \headtype A%
6196       \ifcase\absseclevel
6197           \appendixzzz{#3}%
6198       \or \appendixsectionzzz{#3}%
6199       \or \appendixsubseczzz{#3}%
6200       \or \appendixsubsubseczzz{#3}%
6201       \fi
6202     \else
6203       \ifcase\absseclevel
6204           \chapterzzz{#3}%
6205       \or \seczzz{#3}%
6206       \or \numberedsubseczzz{#3}%
6207       \or \numberedsubsubseczzz{#3}%
6208       \fi
6209     \fi
6210   \fi
6211   \suppressfirstparagraphindent
6212 }
6213
6214 % an interface:
6215 \def\numhead{\genhead N}
6216 \def\apphead{\genhead A}
6217 \def\unnmhead{\genhead U}
6218
6219 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
6220 % all lower-level sectioning counters to zero.
6221 %
6222 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6223 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
6224 \let\chaplevelprefix = \empty
6225 %
6226 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
6227 \def\chapterzzz#1{%
6228   % section resetting is \global in case the chapter is in a group, such
6229   % as an @include file.
6230   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6231     \global\advance\chapno by 1
6232   %
6233   % Used for \float.
6234   \gdef\chaplevelprefix{\the\chapno.}%
6235   \resetallfloatnos
6236   %
6237   % \putwordChapter can contain complex things in translations.
6238   \toks0=\expandafter{\putwordChapter}%
6239   \message{\the\toks0 \space \the\chapno}%
6240   %
6241   % Write the actual heading.
6242   \chapmacro{#1}{Ynumbered}{\the\chapno}%
6243   %
6244   % So @section and the like are numbered underneath this chapter.
6245   \global\let\section = \numberedsec
6246   \global\let\subsection = \numberedsubsec
6247   \global\let\subsubsection = \numberedsubsubsec
6248 }
6249
6250 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
6251 %
6252 \def\appendixzzz#1{%
6253   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6254     \global\advance\appendixno by 1
6255   \gdef\chaplevelprefix{\appendixletter.}%
6256   \resetallfloatnos
6257   %
6258   % \putwordAppendix can contain complex things in translations.
6259   \toks0=\expandafter{\putwordAppendix}%
6260   \message{\the\toks0 \space \appendixletter}%
6261   %
6262   \chapmacro{#1}{Yappendix}{\appendixletter}%
6263   %
6264   \global\let\section = \appendixsec
6265   \global\let\subsection = \appendixsubsec
6266   \global\let\subsubsection = \appendixsubsubsec
6267 }
6268
6269 % normally unnmhead0 calls unnumberedzzz:
6270 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
6271 \def\unnumberedzzz#1{%
6272   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6273     \global\advance\unnumberedno by 1
6274   %
6275   % Since an unnumbered has no number, no prefix for figures.
6276   \global\let\chaplevelprefix = \empty
6277   \resetallfloatnos
6278   %
6279   % This used to be simply \message{#1}, but TeX fully expands the
6280   % argument to \message.  Therefore, if #1 contained @-commands, TeX
6281   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
6282   % expanded @cite (which turns out to cause errors because \cite is meant
6283   % to be executed, not expanded).
6284   %
6285   % Anyway, we don't want the fully-expanded definition of @cite to appear
6286   % as a result of the \message, we just want `@cite' itself.  We use
6287   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6288   % simply yielding the contents of <toks register>.  (We also do this for
6289   % the toc entries.)
6290   \toks0 = {#1}%
6291   \message{(\the\toks0)}%
6292   %
6293   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
6294   %
6295   \global\let\section = \unnumberedsec
6296   \global\let\subsection = \unnumberedsubsec
6297   \global\let\subsubsection = \unnumberedsubsubsec
6298 }
6299
6300 % @centerchap is like @unnumbered, but the heading is centered.
6301 \outer\parseargdef\centerchap{%
6302   \let\centerparametersmaybe = \centerparameters
6303   \unnmhead0{#1}%
6304   \let\centerparametersmaybe = \relax
6305 }
6306
6307 % @top is like @unnumbered.
6308 \let\top\unnumbered
6309
6310 % Sections.
6311
6312 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
6313 \def\seczzz#1{%
6314   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6315   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
6316 }
6317
6318 % normally calls appendixsectionzzz:
6319 \outer\parseargdef\appendixsection{\apphead1{#1}}
6320 \def\appendixsectionzzz#1{%
6321   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6322   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
6323 }
6324 \let\appendixsec\appendixsection
6325
6326 % normally calls unnumberedseczzz:
6327 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
6328 \def\unnumberedseczzz#1{%
6329   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6330   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
6331 }
6332
6333 % Subsections.
6334
6335 % normally calls numberedsubseczzz:
6336 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
6337 \def\numberedsubseczzz#1{%
6338   \global\subsubsecno=0  \global\advance\subsecno by 1
6339   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
6340 }
6341
6342 % normally calls appendixsubseczzz:
6343 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
6344 \def\appendixsubseczzz#1{%
6345   \global\subsubsecno=0  \global\advance\subsecno by 1
6346   \sectionheading{#1}{subsec}{Yappendix}%
6347                  {\appendixletter.\the\secno.\the\subsecno}%
6348 }
6349
6350 % normally calls unnumberedsubseczzz:
6351 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
6352 \def\unnumberedsubseczzz#1{%
6353   \global\subsubsecno=0  \global\advance\subsecno by 1
6354   \sectionheading{#1}{subsec}{Ynothing}%
6355                  {\the\unnumberedno.\the\secno.\the\subsecno}%
6356 }
6357
6358 % Subsubsections.
6359
6360 % normally numberedsubsubseczzz:
6361 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
6362 \def\numberedsubsubseczzz#1{%
6363   \global\advance\subsubsecno by 1
6364   \sectionheading{#1}{subsubsec}{Ynumbered}%
6365                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
6366 }
6367
6368 % normally appendixsubsubseczzz:
6369 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
6370 \def\appendixsubsubseczzz#1{%
6371   \global\advance\subsubsecno by 1
6372   \sectionheading{#1}{subsubsec}{Yappendix}%
6373                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
6374 }
6375
6376 % normally unnumberedsubsubseczzz:
6377 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
6378 \def\unnumberedsubsubseczzz#1{%
6379   \global\advance\subsubsecno by 1
6380   \sectionheading{#1}{subsubsec}{Ynothing}%
6381                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
6382 }
6383
6384 % These macros control what the section commands do, according
6385 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
6386 % Define them by default for a numbered chapter.
6387 \let\section = \numberedsec
6388 \let\subsection = \numberedsubsec
6389 \let\subsubsection = \numberedsubsubsec
6390
6391 % Define @majorheading, @heading and @subheading
6392
6393 \def\majorheading{%
6394   {\advance\chapheadingskip by 10pt \chapbreak }%
6395   \parsearg\chapheadingzzz
6396 }
6397
6398 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
6399 \def\chapheadingzzz#1{%
6400   \vbox{\chapfonts \raggedtitlesettings #1\par}%
6401   \nobreak\bigskip \nobreak
6402   \suppressfirstparagraphindent
6403 }
6404
6405 % @heading, @subheading, @subsubheading.
6406 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
6407   \suppressfirstparagraphindent}
6408 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
6409   \suppressfirstparagraphindent}
6410 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
6411   \suppressfirstparagraphindent}
6412
6413 % These macros generate a chapter, section, etc. heading only
6414 % (including whitespace, linebreaking, etc. around it),
6415 % given all the information in convenient, parsed form.
6416
6417 % Args are the skip and penalty (usually negative)
6418 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
6419
6420 % Parameter controlling skip before chapter headings (if needed)
6421 \newskip\chapheadingskip
6422
6423 % Define plain chapter starts, and page on/off switching for it.
6424 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
6425
6426 % Start a new page
6427 \def\chappager{\par\vfill\supereject}
6428
6429 % \chapoddpage - start on an odd page for a new chapter
6430 % Because \domark is called before \chapoddpage, the filler page will
6431 % get the headings for the next chapter, which is wrong.  But we don't
6432 % care -- we just disable all headings on the filler page.
6433 \def\chapoddpage{%
6434   \chappager
6435   \ifodd\pageno \else
6436     \begingroup
6437       \headingsoff
6438       \null
6439       \chappager
6440     \endgroup
6441   \fi
6442 }
6443
6444 \parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname}
6445
6446 \def\CHAPPAGoff{%
6447 \global\let\contentsalignmacro = \chappager
6448 \global\let\pchapsepmacro=\chapbreak
6449 \global\let\pagealignmacro=\chappager}
6450
6451 \def\CHAPPAGon{%
6452 \global\let\contentsalignmacro = \chappager
6453 \global\let\pchapsepmacro=\chappager
6454 \global\let\pagealignmacro=\chappager
6455 \global\def\HEADINGSon{\HEADINGSsingle}}
6456
6457 \def\CHAPPAGodd{%
6458 \global\let\contentsalignmacro = \chapoddpage
6459 \global\let\pchapsepmacro=\chapoddpage
6460 \global\let\pagealignmacro=\chapoddpage
6461 \global\def\HEADINGSon{\HEADINGSdouble}}
6462
6463 \CHAPPAGon
6464
6465 % \chapmacro - Chapter opening.
6466 %
6467 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
6468 % Yappendix, Yomitfromtoc), #3 the chapter number.
6469 % Not used for @heading series.
6470 %
6471 % To test against our argument.
6472 \def\Ynothingkeyword{Ynothing}
6473 \def\Yappendixkeyword{Yappendix}
6474 \def\Yomitfromtockeyword{Yomitfromtoc}
6475 %
6476 \def\chapmacro#1#2#3{%
6477   \expandafter\ifx\thisenv\titlepage\else
6478     \checkenv{}% chapters, etc., should not start inside an environment.
6479   \fi
6480   % FIXME: \chapmacro is currently called from inside \titlepage when
6481   % \setcontentsaftertitlepage to print the "Table of Contents" heading, but
6482   % this should probably be done by \sectionheading with an option to print
6483   % in chapter size.
6484   %
6485   % Insert the first mark before the heading break (see notes for \domark).
6486   \let\prevchapterdefs=\lastchapterdefs
6487   \let\prevsectiondefs=\lastsectiondefs
6488   \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
6489                         \gdef\thissection{}}%
6490   %
6491   \def\temptype{#2}%
6492   \ifx\temptype\Ynothingkeyword
6493     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6494                           \gdef\thischapter{\thischaptername}}%
6495   \else\ifx\temptype\Yomitfromtockeyword
6496     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6497                           \gdef\thischapter{}}%
6498   \else\ifx\temptype\Yappendixkeyword
6499     \toks0={#1}%
6500     \xdef\lastchapterdefs{%
6501       \gdef\noexpand\thischaptername{\the\toks0}%
6502       \gdef\noexpand\thischapternum{\appendixletter}%
6503       % \noexpand\putwordAppendix avoids expanding indigestible
6504       % commands in some of the translations.
6505       \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
6506                                  \noexpand\thischapternum:
6507                                  \noexpand\thischaptername}%
6508     }%
6509   \else
6510     \toks0={#1}%
6511     \xdef\lastchapterdefs{%
6512       \gdef\noexpand\thischaptername{\the\toks0}%
6513       \gdef\noexpand\thischapternum{\the\chapno}%
6514       % \noexpand\putwordChapter avoids expanding indigestible
6515       % commands in some of the translations.
6516       \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
6517                                  \noexpand\thischapternum:
6518                                  \noexpand\thischaptername}%
6519     }%
6520   \fi\fi\fi
6521   %
6522   % Output the mark.  Pass it through \safewhatsit, to take care of
6523   % the preceding space.
6524   \safewhatsit\domark
6525   %
6526   % Insert the chapter heading break.
6527   \pchapsepmacro
6528   %
6529   % Now the second mark, after the heading break.  No break points
6530   % between here and the heading.
6531   \let\prevchapterdefs=\lastchapterdefs
6532   \let\prevsectiondefs=\lastsectiondefs
6533   \domark
6534   %
6535   {%
6536     \chapfonts \rm
6537     \let\footnote=\errfootnoteheading % give better error message
6538     %
6539     % Have to define \lastsection before calling \donoderef, because the
6540     % xref code eventually uses it.  On the other hand, it has to be called
6541     % after \pchapsepmacro, or the headline will change too soon.
6542     \gdef\lastsection{#1}%
6543     %
6544     % Only insert the separating space if we have a chapter/appendix
6545     % number, and don't print the unnumbered ``number''.
6546     \ifx\temptype\Ynothingkeyword
6547       \setbox0 = \hbox{}%
6548       \def\toctype{unnchap}%
6549     \else\ifx\temptype\Yomitfromtockeyword
6550       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
6551       \def\toctype{omit}%
6552     \else\ifx\temptype\Yappendixkeyword
6553       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
6554       \def\toctype{app}%
6555     \else
6556       \setbox0 = \hbox{#3\enspace}%
6557       \def\toctype{numchap}%
6558     \fi\fi\fi
6559     %
6560     % Write the toc entry for this chapter.  Must come before the
6561     % \donoderef, because we include the current node name in the toc
6562     % entry, and \donoderef resets it to empty.
6563     \writetocentry{\toctype}{#1}{#3}%
6564     %
6565     % For pdftex, we have to write out the node definition (aka, make
6566     % the pdfdest) after any page break, but before the actual text has
6567     % been typeset.  If the destination for the pdf outline is after the
6568     % text, then jumping from the outline may wind up with the text not
6569     % being visible, for instance under high magnification.
6570     \donoderef{#2}%
6571     %
6572     % Typeset the actual heading.
6573     \nobreak % Avoid page breaks at the interline glue.
6574     \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
6575           \unhbox0 #1\par}%
6576   }%
6577   \nobreak\bigskip % no page break after a chapter title
6578   \nobreak
6579 }
6580
6581 % @centerchap -- centered and unnumbered.
6582 \let\centerparametersmaybe = \relax
6583 \def\centerparameters{%
6584   \advance\rightskip by 3\rightskip
6585   \leftskip = \rightskip
6586   \parfillskip = 0pt
6587 }
6588
6589
6590 % Section titles.  These macros combine the section number parts and
6591 % call the generic \sectionheading to do the printing.
6592 %
6593 \newskip\secheadingskip
6594 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
6595
6596 % Subsection titles.
6597 \newskip\subsecheadingskip
6598 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
6599
6600 % Subsubsection titles.
6601 \def\subsubsecheadingskip{\subsecheadingskip}
6602 \def\subsubsecheadingbreak{\subsecheadingbreak}
6603
6604
6605 % Print any size, any type, section title.
6606 %
6607 % #1 is the text of the title,
6608 % #2 is the section level (sec/subsec/subsubsec),
6609 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6610 % #4 is the section number.
6611 %
6612 \def\seckeyword{sec}
6613 %
6614 \def\sectionheading#1#2#3#4{%
6615   {%
6616     \def\sectionlevel{#2}%
6617     \def\temptype{#3}%
6618     %
6619     % It is ok for the @heading series commands to appear inside an
6620     % environment (it's been historically allowed, though the logic is
6621     % dubious), but not the others.
6622     \ifx\temptype\Yomitfromtockeyword\else
6623       \checkenv{}% non-@*heading should not be in an environment.
6624     \fi
6625     \let\footnote=\errfootnoteheading
6626     %
6627     % Switch to the right set of fonts.
6628     \csname #2fonts\endcsname \rm
6629     %
6630     % Insert first mark before the heading break (see notes for \domark).
6631     \let\prevsectiondefs=\lastsectiondefs
6632     \ifx\temptype\Ynothingkeyword
6633       \ifx\sectionlevel\seckeyword
6634         \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
6635                               \gdef\thissection{\thissectionname}}%
6636       \fi
6637     \else\ifx\temptype\Yomitfromtockeyword
6638       % Don't redefine \thissection.
6639     \else\ifx\temptype\Yappendixkeyword
6640       \ifx\sectionlevel\seckeyword
6641         \toks0={#1}%
6642         \xdef\lastsectiondefs{%
6643           \gdef\noexpand\thissectionname{\the\toks0}%
6644           \gdef\noexpand\thissectionnum{#4}%
6645           % \noexpand\putwordSection avoids expanding indigestible
6646           % commands in some of the translations.
6647           \gdef\noexpand\thissection{\noexpand\putwordSection{}
6648                                      \noexpand\thissectionnum:
6649                                      \noexpand\thissectionname}%
6650         }%
6651       \fi
6652     \else
6653       \ifx\sectionlevel\seckeyword
6654         \toks0={#1}%
6655         \xdef\lastsectiondefs{%
6656           \gdef\noexpand\thissectionname{\the\toks0}%
6657           \gdef\noexpand\thissectionnum{#4}%
6658           % \noexpand\putwordSection avoids expanding indigestible
6659           % commands in some of the translations.
6660           \gdef\noexpand\thissection{\noexpand\putwordSection{}
6661                                      \noexpand\thissectionnum:
6662                                      \noexpand\thissectionname}%
6663         }%
6664       \fi
6665     \fi\fi\fi
6666     %
6667     % Go into vertical mode.  Usually we'll already be there, but we
6668     % don't want the following whatsit to end up in a preceding paragraph
6669     % if the document didn't happen to have a blank line.
6670     \par
6671     %
6672     % Output the mark.  Pass it through \safewhatsit, to take care of
6673     % the preceding space.
6674     \safewhatsit\domark
6675     %
6676     % Insert space above the heading.
6677     \csname #2headingbreak\endcsname
6678     %
6679     % Now the second mark, after the heading break.  No break points
6680     % between here and the heading.
6681     \global\let\prevsectiondefs=\lastsectiondefs
6682     \domark
6683     %
6684     % Only insert the space after the number if we have a section number.
6685     \ifx\temptype\Ynothingkeyword
6686       \setbox0 = \hbox{}%
6687       \def\toctype{unn}%
6688       \gdef\lastsection{#1}%
6689     \else\ifx\temptype\Yomitfromtockeyword
6690       % for @headings -- no section number, don't include in toc,
6691       % and don't redefine \lastsection.
6692       \setbox0 = \hbox{}%
6693       \def\toctype{omit}%
6694       \let\sectionlevel=\empty
6695     \else\ifx\temptype\Yappendixkeyword
6696       \setbox0 = \hbox{#4\enspace}%
6697       \def\toctype{app}%
6698       \gdef\lastsection{#1}%
6699     \else
6700       \setbox0 = \hbox{#4\enspace}%
6701       \def\toctype{num}%
6702       \gdef\lastsection{#1}%
6703     \fi\fi\fi
6704     %
6705     % Write the toc entry (before \donoderef).  See comments in \chapmacro.
6706     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6707     %
6708     % Write the node reference (= pdf destination for pdftex).
6709     % Again, see comments in \chapmacro.
6710     \donoderef{#3}%
6711     %
6712     % Interline glue will be inserted when the vbox is completed.
6713     % That glue will be a valid breakpoint for the page, since it'll be
6714     % preceded by a whatsit (usually from the \donoderef, or from the
6715     % \writetocentry if there was no node).  We don't want to allow that
6716     % break, since then the whatsits could end up on page n while the
6717     % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
6718     \nobreak
6719     %
6720     % Output the actual section heading.
6721     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6722           \hangindent=\wd0  % zero if no section number
6723           \unhbox0 #1}%
6724   }%
6725   % Add extra space after the heading -- half of whatever came above it.
6726   % Don't allow stretch, though.
6727   \kern .5 \csname #2headingskip\endcsname
6728   %
6729   % Do not let the kern be a potential breakpoint, as it would be if it
6730   % was followed by glue.
6731   \nobreak
6732   %
6733   % We'll almost certainly start a paragraph next, so don't let that
6734   % glue accumulate.  (Not a breakpoint because it's preceded by a
6735   % discardable item.)  However, when a paragraph is not started next
6736   % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6737   % or the negative glue will cause weirdly wrong output, typically
6738   % obscuring the section heading with something else.
6739   \vskip-\parskip
6740   %
6741   % This is so the last item on the main vertical list is a known
6742   % \penalty > 10000, so \startdefun, etc., can recognize the situation
6743   % and do the needful.
6744   \penalty 10001
6745 }
6746
6747
6748 \message{toc,}
6749 % Table of contents.
6750 \newwrite\tocfile
6751
6752 % Write an entry to the toc file, opening it if necessary.
6753 % Called from @chapter, etc.
6754 %
6755 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6756 % We append the current node name (if any) and page number as additional
6757 % arguments for the \{chap,sec,...}entry macros which will eventually
6758 % read this.  The node name is used in the pdf outlines as the
6759 % destination to jump to.
6760 %
6761 % We open the .toc file for writing here instead of at @setfilename (or
6762 % any other fixed time) so that @contents can be anywhere in the document.
6763 % But if #1 is `omit', then we don't do anything.  This is used for the
6764 % table of contents chapter openings themselves.
6765 %
6766 \newif\iftocfileopened
6767 \def\omitkeyword{omit}%
6768 %
6769 \def\writetocentry#1#2#3{%
6770   \edef\writetoctype{#1}%
6771   \ifx\writetoctype\omitkeyword \else
6772     \iftocfileopened\else
6773       \immediate\openout\tocfile = \jobname.toc
6774       \global\tocfileopenedtrue
6775     \fi
6776     %
6777     \iflinks
6778       {\atdummies
6779        \edef\temp{%
6780          \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6781        \temp
6782       }%
6783     \fi
6784   \fi
6785   %
6786   % Tell \shipout to create a pdf destination on each page, if we're
6787   % writing pdf.  These are used in the table of contents.  We can't
6788   % just write one on every page because the title pages are numbered
6789   % 1 and 2 (the page numbers aren't printed), and so are the first
6790   % two pages of the document.  Thus, we'd have two destinations named
6791   % `1', and two named `2'.
6792   \ifpdf
6793     \global\pdfmakepagedesttrue
6794   \else
6795     \ifx\XeTeXrevision\thisisundefined
6796     \else
6797       \global\pdfmakepagedesttrue
6798     \fi
6799   \fi
6800 }
6801
6802
6803 % These characters do not print properly in the Computer Modern roman
6804 % fonts, so we must take special care.  This is more or less redundant
6805 % with the Texinfo input format setup at the end of this file.
6806 %
6807 \def\activecatcodes{%
6808   \catcode`\"=\active
6809   \catcode`\$=\active
6810   \catcode`\<=\active
6811   \catcode`\>=\active
6812   \catcode`\\=\active
6813   \catcode`\^=\active
6814   \catcode`\_=\active
6815   \catcode`\|=\active
6816   \catcode`\~=\active
6817 }
6818
6819
6820 % Read the toc file, which is essentially Texinfo input.
6821 \def\readtocfile{%
6822   \setupdatafile
6823   \activecatcodes
6824   \input \tocreadfilename
6825 }
6826
6827 \newskip\contentsrightmargin \contentsrightmargin=1in
6828 \newcount\savepageno
6829 \newcount\lastnegativepageno \lastnegativepageno = -1
6830
6831 % Prepare to read what we've written to \tocfile.
6832 %
6833 \def\startcontents#1{%
6834   % If @setchapternewpage on, and @headings double, the contents should
6835   % start on an odd page, unlike chapters.  Thus, we maintain
6836   % \contentsalignmacro in parallel with \pagealignmacro.
6837   % From: Torbjorn Granlund <tege@matematik.su.se>
6838   \contentsalignmacro
6839   \immediate\closeout\tocfile
6840   %
6841   % Don't need to put `Contents' or `Short Contents' in the headline.
6842   % It is abundantly clear what they are.
6843   \chapmacro{#1}{Yomitfromtoc}{}%
6844   %
6845   \savepageno = \pageno
6846   \begingroup                  % Set up to handle contents files properly.
6847     \raggedbottom              % Worry more about breakpoints than the bottom.
6848     \entryrightmargin=\contentsrightmargin % Don't use the full line length.
6849     %
6850     % Roman numerals for page numbers.
6851     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6852 }
6853
6854 % redefined for the two-volume lispref.  We always output on
6855 % \jobname.toc even if this is redefined.
6856 %
6857 \def\tocreadfilename{\jobname.toc}
6858
6859 % Normal (long) toc.
6860 %
6861 \def\contents{%
6862   \startcontents{\putwordTOC}%
6863     \openin 1 \tocreadfilename\space
6864     \ifeof 1 \else
6865       \readtocfile
6866     \fi
6867     \vfill \eject
6868     \contentsalignmacro % in case @setchapternewpage odd is in effect
6869     \ifeof 1 \else
6870       \pdfmakeoutlines
6871     \fi
6872     \closein 1
6873   \endgroup
6874   \lastnegativepageno = \pageno
6875   \global\pageno = \savepageno
6876 }
6877
6878 % And just the chapters.
6879 \def\summarycontents{%
6880   \startcontents{\putwordShortTOC}%
6881     %
6882     \let\partentry = \shortpartentry
6883     \let\numchapentry = \shortchapentry
6884     \let\appentry = \shortchapentry
6885     \let\unnchapentry = \shortunnchapentry
6886     % We want a true roman here for the page numbers.
6887     \secfonts
6888     \let\rm=\shortcontrm \let\bf=\shortcontbf
6889     \let\sl=\shortcontsl \let\tt=\shortconttt
6890     \rm
6891     \hyphenpenalty = 10000
6892     \advance\baselineskip by 1pt % Open it up a little.
6893     \def\numsecentry##1##2##3##4{}
6894     \let\appsecentry = \numsecentry
6895     \let\unnsecentry = \numsecentry
6896     \let\numsubsecentry = \numsecentry
6897     \let\appsubsecentry = \numsecentry
6898     \let\unnsubsecentry = \numsecentry
6899     \let\numsubsubsecentry = \numsecentry
6900     \let\appsubsubsecentry = \numsecentry
6901     \let\unnsubsubsecentry = \numsecentry
6902     \openin 1 \tocreadfilename\space
6903     \ifeof 1 \else
6904       \readtocfile
6905     \fi
6906     \closein 1
6907     \vfill \eject
6908     \contentsalignmacro % in case @setchapternewpage odd is in effect
6909   \endgroup
6910   \lastnegativepageno = \pageno
6911   \global\pageno = \savepageno
6912 }
6913 \let\shortcontents = \summarycontents
6914
6915 % Typeset the label for a chapter or appendix for the short contents.
6916 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6917 %
6918 \def\shortchaplabel#1{%
6919   % This space should be enough, since a single number is .5em, and the
6920   % widest letter (M) is 1em, at least in the Computer Modern fonts.
6921   % But use \hss just in case.
6922   % (This space doesn't include the extra space that gets added after
6923   % the label; that gets put in by \shortchapentry above.)
6924   %
6925   % We'd like to right-justify chapter numbers, but that looks strange
6926   % with appendix letters.  And right-justifying numbers and
6927   % left-justifying letters looks strange when there is less than 10
6928   % chapters.  Have to read the whole toc once to know how many chapters
6929   % there are before deciding ...
6930   \hbox to 1em{#1\hss}%
6931 }
6932
6933 % These macros generate individual entries in the table of contents.
6934 % The first argument is the chapter or section name.
6935 % The last argument is the page number.
6936 % The arguments in between are the chapter number, section number, ...
6937
6938 % Parts, in the main contents.  Replace the part number, which doesn't
6939 % exist, with an empty box.  Let's hope all the numbers have the same width.
6940 % Also ignore the page number, which is conventionally not printed.
6941 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6942 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6943 %
6944 % Parts, in the short toc.
6945 \def\shortpartentry#1#2#3#4{%
6946   \penalty-300
6947   \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6948   \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6949 }
6950
6951 % Chapters, in the main contents.
6952 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6953
6954 % Chapters, in the short toc.
6955 % See comments in \dochapentry re vbox and related settings.
6956 \def\shortchapentry#1#2#3#4{%
6957   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6958 }
6959
6960 % Appendices, in the main contents.
6961 % Need the word Appendix, and a fixed-size box.
6962 %
6963 \def\appendixbox#1{%
6964   % We use M since it's probably the widest letter.
6965   \setbox0 = \hbox{\putwordAppendix{} M}%
6966   \hbox to \wd0{\putwordAppendix{} #1\hss}}
6967 %
6968 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
6969
6970 % Unnumbered chapters.
6971 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6972 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6973
6974 % Sections.
6975 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6976 \let\appsecentry=\numsecentry
6977 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6978
6979 % Subsections.
6980 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6981 \let\appsubsecentry=\numsubsecentry
6982 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6983
6984 % And subsubsections.
6985 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6986 \let\appsubsubsecentry=\numsubsubsecentry
6987 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6988
6989 % This parameter controls the indentation of the various levels.
6990 % Same as \defaultparindent.
6991 \newdimen\tocindent \tocindent = 15pt
6992
6993 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6994 % page number.
6995 %
6996 % If the toc has to be broken over pages, we want it to be at chapters
6997 % if at all possible; hence the \penalty.
6998 \def\dochapentry#1#2{%
6999    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
7000    \begingroup
7001      % Move the page numbers slightly to the right
7002      \advance\entryrightmargin by -0.05em
7003      \chapentryfonts
7004      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
7005    \endgroup
7006    \nobreak\vskip .25\baselineskip plus.1\baselineskip
7007 }
7008
7009 \def\dosecentry#1#2{\begingroup
7010   \secentryfonts \leftskip=\tocindent
7011   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
7012 \endgroup}
7013
7014 \def\dosubsecentry#1#2{\begingroup
7015   \subsecentryfonts \leftskip=2\tocindent
7016   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
7017 \endgroup}
7018
7019 \def\dosubsubsecentry#1#2{\begingroup
7020   \subsubsecentryfonts \leftskip=3\tocindent
7021   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
7022 \endgroup}
7023
7024 % We use the same \entry macro as for the index entries.
7025 \let\tocentry = \entry
7026
7027 % Space between chapter (or whatever) number and the title.
7028 \def\labelspace{\hskip1em \relax}
7029
7030 \def\dopageno#1{{\rm #1}}
7031 \def\doshortpageno#1{{\rm #1}}
7032
7033 \def\chapentryfonts{\secfonts \rm}
7034 \def\secentryfonts{\textfonts}
7035 \def\subsecentryfonts{\textfonts}
7036 \def\subsubsecentryfonts{\textfonts}
7037
7038
7039 \message{environments,}
7040 % @foo ... @end foo.
7041
7042 % @tex ... @end tex    escapes into raw TeX temporarily.
7043 % One exception: @ is still an escape character, so that @end tex works.
7044 % But \@ or @@ will get a plain @ character.
7045
7046 \envdef\tex{%
7047   \setupmarkupstyle{tex}%
7048   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
7049   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
7050   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
7051   \catcode `\%=14
7052   \catcode `\+=\other
7053   \catcode `\"=\other
7054   \catcode `\|=\other
7055   \catcode `\<=\other
7056   \catcode `\>=\other
7057   \catcode `\`=\other
7058   \catcode `\'=\other
7059   %
7060   % ' is active in math mode (mathcode"8000).  So reset it, and all our
7061   % other math active characters (just in case), to plain's definitions.
7062   \mathactive
7063   %
7064   % Inverse of the list at the beginning of the file.
7065   \let\b=\ptexb
7066   \let\bullet=\ptexbullet
7067   \let\c=\ptexc
7068   \let\,=\ptexcomma
7069   \let\.=\ptexdot
7070   \let\dots=\ptexdots
7071   \let\equiv=\ptexequiv
7072   \let\!=\ptexexclam
7073   \let\i=\ptexi
7074   \let\indent=\ptexindent
7075   \let\noindent=\ptexnoindent
7076   \let\{=\ptexlbrace
7077   \let\+=\tabalign
7078   \let\}=\ptexrbrace
7079   \let\/=\ptexslash
7080   \let\sp=\ptexsp
7081   \let\*=\ptexstar
7082   %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
7083   \let\t=\ptext
7084   \expandafter \let\csname top\endcsname=\ptextop  % we've made it outer
7085   \let\frenchspacing=\plainfrenchspacing
7086   %
7087   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
7088   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
7089   \def\@{@}%
7090 }
7091 % There is no need to define \Etex.
7092
7093 % Define @lisp ... @end lisp.
7094 % @lisp environment forms a group so it can rebind things,
7095 % including the definition of @end lisp (which normally is erroneous).
7096
7097 % Amount to narrow the margins by for @lisp.
7098 \newskip\lispnarrowing \lispnarrowing=0.4in
7099
7100 % This is the definition that ^^M gets inside @lisp, @example, and other
7101 % such environments.  \null is better than a space, since it doesn't
7102 % have any width.
7103 \def\lisppar{\null\endgraf}
7104
7105 % This space is always present above and below environments.
7106 \newskip\envskipamount \envskipamount = 0pt
7107
7108 % Make spacing and below environment symmetrical.  We use \parskip here
7109 % to help in doing that, since in @example-like environments \parskip
7110 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
7111 % start of the next paragraph will insert \parskip.
7112 %
7113 \def\aboveenvbreak{{%
7114   % =10000 instead of <10000 because of a special case in \itemzzz and
7115   % \sectionheading, q.v.
7116   \ifnum \lastpenalty=10000 \else
7117     \advance\envskipamount by \parskip
7118     \endgraf
7119     \ifdim\lastskip<\envskipamount
7120       \removelastskip
7121       \ifnum\lastpenalty<10000
7122         % Penalize breaking before the environment, because preceding text
7123         % often leads into it.
7124         \penalty100
7125       \fi
7126       \vskip\envskipamount
7127     \fi
7128   \fi
7129 }}
7130
7131 \def\afterenvbreak{{%
7132   % =10000 instead of <10000 because of a special case in \itemzzz and
7133   % \sectionheading, q.v.
7134   \ifnum \lastpenalty=10000 \else
7135     \advance\envskipamount by \parskip
7136     \endgraf
7137     \ifdim\lastskip<\envskipamount
7138       \removelastskip
7139       % it's not a good place to break if the last penalty was \nobreak
7140       % or better ...
7141       \ifnum\lastpenalty<10000 \penalty-50 \fi
7142       \vskip\envskipamount
7143     \fi
7144   \fi
7145 }}
7146
7147 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
7148 % also clear it, so that its embedded environments do the narrowing again.
7149 \let\nonarrowing=\relax
7150
7151 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
7152 % environment contents.
7153 \font\circle=lcircle10
7154 \newdimen\circthick
7155 \newdimen\cartouter\newdimen\cartinner
7156 \newskip\normbskip\newskip\normpskip\newskip\normlskip
7157 \circthick=\fontdimen8\circle
7158 %
7159 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
7160 \def\ctr{{\hskip 6pt\circle\char'010}}
7161 \def\cbl{{\circle\char'012\hskip -6pt}}
7162 \def\cbr{{\hskip 6pt\circle\char'011}}
7163 \def\carttop{\hbox to \cartouter{\hskip\lskip
7164         \ctl\leaders\hrule height\circthick\hfil\ctr
7165         \hskip\rskip}}
7166 \def\cartbot{\hbox to \cartouter{\hskip\lskip
7167         \cbl\leaders\hrule height\circthick\hfil\cbr
7168         \hskip\rskip}}
7169 %
7170 \newskip\lskip\newskip\rskip
7171
7172 \envdef\cartouche{%
7173   \ifhmode\par\fi  % can't be in the midst of a paragraph.
7174   \startsavinginserts
7175   \lskip=\leftskip \rskip=\rightskip
7176   \leftskip=0pt\rightskip=0pt % we want these *outside*.
7177   \cartinner=\hsize \advance\cartinner by-\lskip
7178   \advance\cartinner by-\rskip
7179   \cartouter=\hsize
7180   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
7181                                 % side, and for 6pt waste from
7182                                 % each corner char, and rule thickness
7183   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
7184   %
7185   % If this cartouche directly follows a sectioning command, we need the
7186   % \parskip glue (backspaced over by default) or the cartouche can
7187   % collide with the section heading.
7188   \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
7189   %
7190   \setbox\groupbox=\vbox\bgroup
7191       \baselineskip=0pt\parskip=0pt\lineskip=0pt
7192       \carttop
7193       \hbox\bgroup
7194           \hskip\lskip
7195           \vrule\kern3pt
7196           \vbox\bgroup
7197               \kern3pt
7198               \hsize=\cartinner
7199               \baselineskip=\normbskip
7200               \lineskip=\normlskip
7201               \parskip=\normpskip
7202               \vskip -\parskip
7203               \comment % For explanation, see the end of def\group.
7204 }
7205 \def\Ecartouche{%
7206               \ifhmode\par\fi
7207               \kern3pt
7208           \egroup
7209           \kern3pt\vrule
7210           \hskip\rskip
7211       \egroup
7212       \cartbot
7213   \egroup
7214   \addgroupbox
7215   \checkinserts
7216 }
7217
7218
7219 % This macro is called at the beginning of all the @example variants,
7220 % inside a group.
7221 \newdimen\nonfillparindent
7222 \def\nonfillstart{%
7223   \aboveenvbreak
7224   \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
7225   \sepspaces % Make spaces be word-separators rather than space tokens.
7226   \let\par = \lisppar % don't ignore blank lines
7227   \obeylines % each line of input is a line of output
7228   \parskip = 0pt
7229   % Turn off paragraph indentation but redefine \indent to emulate
7230   % the normal \indent.
7231   \nonfillparindent=\parindent
7232   \parindent = 0pt
7233   \let\indent\nonfillindent
7234   %
7235   \emergencystretch = 0pt % don't try to avoid overfull boxes
7236   \ifx\nonarrowing\relax
7237     \advance \leftskip by \lispnarrowing
7238     \exdentamount=\lispnarrowing
7239   \else
7240     \let\nonarrowing = \relax
7241   \fi
7242   \let\exdent=\nofillexdent
7243 }
7244
7245 \begingroup
7246 \obeyspaces
7247 % We want to swallow spaces (but not other tokens) after the fake
7248 % @indent in our nonfill-environments, where spaces are normally
7249 % active and set to @tie, resulting in them not being ignored after
7250 % @indent.
7251 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
7252 \gdef\nonfillindentcheck{%
7253 \ifx\temp %
7254 \expandafter\nonfillindentgobble%
7255 \else%
7256 \leavevmode\nonfillindentbox%
7257 \fi%
7258 }%
7259 \endgroup
7260 \def\nonfillindentgobble#1{\nonfillindent}
7261 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
7262
7263 % If you want all examples etc. small: @set dispenvsize small.
7264 % If you want even small examples the full size: @set dispenvsize nosmall.
7265 % This affects the following displayed environments:
7266 %    @example, @display, @format, @lisp
7267 %
7268 \def\smallword{small}
7269 \def\nosmallword{nosmall}
7270 \let\SETdispenvsize\relax
7271 \def\setnormaldispenv{%
7272   \ifx\SETdispenvsize\smallword
7273     % end paragraph for sake of leading, in case document has no blank
7274     % line.  This is redundant with what happens in \aboveenvbreak, but
7275     % we need to do it before changing the fonts, and it's inconvenient
7276     % to change the fonts afterward.
7277     \ifnum \lastpenalty=10000 \else \endgraf \fi
7278     \smallexamplefonts \rm
7279   \fi
7280 }
7281 \def\setsmalldispenv{%
7282   \ifx\SETdispenvsize\nosmallword
7283   \else
7284     \ifnum \lastpenalty=10000 \else \endgraf \fi
7285     \smallexamplefonts \rm
7286   \fi
7287 }
7288
7289 % We often define two environments, @foo and @smallfoo.
7290 % Let's do it in one command.  #1 is the env name, #2 the definition.
7291 \def\makedispenvdef#1#2{%
7292   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
7293   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
7294   \expandafter\let\csname E#1\endcsname \afterenvbreak
7295   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
7296 }
7297
7298 % Define two environment synonyms (#1 and #2) for an environment.
7299 \def\maketwodispenvdef#1#2#3{%
7300   \makedispenvdef{#1}{#3}%
7301   \makedispenvdef{#2}{#3}%
7302 }
7303 %
7304 % @lisp: indented, narrowed, typewriter font;
7305 % @example: same as @lisp.
7306 %
7307 % @smallexample and @smalllisp: use smaller fonts.
7308 % Originally contributed by Pavel@xerox.
7309 %
7310 \maketwodispenvdef{lisp}{example}{%
7311   \nonfillstart
7312   \tt\setupmarkupstyle{example}%
7313   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
7314   \gobble % eat return
7315 }
7316 % @display/@smalldisplay: same as @lisp except keep current font.
7317 %
7318 \makedispenvdef{display}{%
7319   \nonfillstart
7320   \gobble
7321 }
7322
7323 % @format/@smallformat: same as @display except don't narrow margins.
7324 %
7325 \makedispenvdef{format}{%
7326   \let\nonarrowing = t%
7327   \nonfillstart
7328   \gobble
7329 }
7330
7331 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
7332 \envdef\flushleft{%
7333   \let\nonarrowing = t%
7334   \nonfillstart
7335   \gobble
7336 }
7337 \let\Eflushleft = \afterenvbreak
7338
7339 % @flushright.
7340 %
7341 \envdef\flushright{%
7342   \let\nonarrowing = t%
7343   \nonfillstart
7344   \advance\leftskip by 0pt plus 1fill\relax
7345   \gobble
7346 }
7347 \let\Eflushright = \afterenvbreak
7348
7349
7350 % @raggedright does more-or-less normal line breaking but no right
7351 % justification.  From plain.tex.  Don't stretch around special
7352 % characters in urls in this environment, since the stretch at the right
7353 % should be enough.
7354 \envdef\raggedright{%
7355   \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
7356   \def\urefprestretchamount{0pt}%
7357   \def\urefpoststretchamount{0pt}%
7358 }
7359 \let\Eraggedright\par
7360
7361 \envdef\raggedleft{%
7362   \parindent=0pt \leftskip0pt plus2em
7363   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7364   \hbadness=10000 % Last line will usually be underfull, so turn off
7365                   % badness reporting.
7366 }
7367 \let\Eraggedleft\par
7368
7369 \envdef\raggedcenter{%
7370   \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
7371   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7372   \hbadness=10000 % Last line will usually be underfull, so turn off
7373                   % badness reporting.
7374 }
7375 \let\Eraggedcenter\par
7376
7377
7378 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
7379 % and narrows the margins.  We keep \parskip nonzero in general, since
7380 % we're doing normal filling.  So, when using \aboveenvbreak and
7381 % \afterenvbreak, temporarily make \parskip 0.
7382 %
7383 \makedispenvdef{quotation}{\quotationstart}
7384 %
7385 \def\quotationstart{%
7386   \indentedblockstart % same as \indentedblock, but increase right margin too.
7387   \ifx\nonarrowing\relax
7388     \advance\rightskip by \lispnarrowing
7389   \fi
7390   \parsearg\quotationlabel
7391 }
7392
7393 % We have retained a nonzero parskip for the environment, since we're
7394 % doing normal filling.
7395 %
7396 \def\Equotation{%
7397   \par
7398   \ifx\quotationauthor\thisisundefined\else
7399     % indent a bit.
7400     \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
7401   \fi
7402   {\parskip=0pt \afterenvbreak}%
7403 }
7404 \def\Esmallquotation{\Equotation}
7405
7406 % If we're given an argument, typeset it in bold with a colon after.
7407 \def\quotationlabel#1{%
7408   \def\temp{#1}%
7409   \ifx\temp\empty \else
7410     {\bf #1: }%
7411   \fi
7412 }
7413
7414 % @indentedblock is like @quotation, but indents only on the left and
7415 % has no optional argument.
7416
7417 \makedispenvdef{indentedblock}{\indentedblockstart}
7418 %
7419 \def\indentedblockstart{%
7420   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
7421   \parindent=0pt
7422   %
7423   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
7424   \ifx\nonarrowing\relax
7425     \advance\leftskip by \lispnarrowing
7426     \exdentamount = \lispnarrowing
7427   \else
7428     \let\nonarrowing = \relax
7429   \fi
7430 }
7431
7432 % Keep a nonzero parskip for the environment, since we're doing normal filling.
7433 %
7434 \def\Eindentedblock{%
7435   \par
7436   {\parskip=0pt \afterenvbreak}%
7437 }
7438 \def\Esmallindentedblock{\Eindentedblock}
7439
7440
7441 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
7442 % If we want to allow any <char> as delimiter,
7443 % we need the curly braces so that makeinfo sees the @verb command, eg:
7444 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
7445 %
7446 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
7447 %
7448 % [Knuth] p.344; only we need to do the other characters Texinfo sets
7449 % active too.  Otherwise, they get lost as the first character on a
7450 % verbatim line.
7451 \def\dospecials{%
7452   \do\ \do\\\do\{\do\}\do\$\do\&%
7453   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
7454   \do\<\do\>\do\|\do\@\do+\do\"%
7455   % Don't do the quotes -- if we do, @set txicodequoteundirected and
7456   % @set txicodequotebacktick will not have effect on @verb and
7457   % @verbatim, and ?` and !` ligatures won't get disabled.
7458   %\do\`\do\'%
7459 }
7460 %
7461 % [Knuth] p. 380
7462 \def\uncatcodespecials{%
7463   \def\do##1{\catcode`##1=\other}\dospecials}
7464 %
7465 % Setup for the @verb command.
7466 %
7467 % Eight spaces for a tab
7468 \begingroup
7469   \catcode`\^^I=\active
7470   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
7471 \endgroup
7472 %
7473 \def\setupverb{%
7474   \tt  % easiest (and conventionally used) font for verbatim
7475   \def\par{\leavevmode\endgraf}%
7476   \setupmarkupstyle{verb}%
7477   \tabeightspaces
7478   % Respect line breaks,
7479   % print special symbols as themselves, and
7480   % make each space count
7481   % must do in this order:
7482   \obeylines \uncatcodespecials \sepspaces
7483 }
7484
7485 % Setup for the @verbatim environment
7486 %
7487 % Real tab expansion.
7488 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
7489 %
7490 % We typeset each line of the verbatim in an \hbox, so we can handle
7491 % tabs.  The \global is in case the verbatim line starts with an accent,
7492 % or some other command that starts with a begin-group.  Otherwise, the
7493 % entire \verbbox would disappear at the corresponding end-group, before
7494 % it is typeset.  Meanwhile, we can't have nested verbatim commands
7495 % (can we?), so the \global won't be overwriting itself.
7496 \newbox\verbbox
7497 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
7498 %
7499 \begingroup
7500   \catcode`\^^I=\active
7501   \gdef\tabexpand{%
7502     \catcode`\^^I=\active
7503     \def^^I{\leavevmode\egroup
7504       \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
7505       \divide\dimen\verbbox by\tabw
7506       \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
7507       \advance\dimen\verbbox by\tabw  % advance to next multiple of \tabw
7508       \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
7509     }%
7510   }
7511 \endgroup
7512
7513 % start the verbatim environment.
7514 \def\setupverbatim{%
7515   \let\nonarrowing = t%
7516   \nonfillstart
7517   \tt % easiest (and conventionally used) font for verbatim
7518   % The \leavevmode here is for blank lines.  Otherwise, we would
7519   % never \starttabox and the \egroup would end verbatim mode.
7520   \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
7521   \tabexpand
7522   \setupmarkupstyle{verbatim}%
7523   % Respect line breaks,
7524   % print special symbols as themselves, and
7525   % make each space count.
7526   % Must do in this order:
7527   \obeylines \uncatcodespecials \sepspaces
7528   \everypar{\starttabbox}%
7529 }
7530
7531 % Do the @verb magic: verbatim text is quoted by unique
7532 % delimiter characters.  Before first delimiter expect a
7533 % right brace, after last delimiter expect closing brace:
7534 %
7535 %    \def\doverb'{'<char>#1<char>'}'{#1}
7536 %
7537 % [Knuth] p. 382; only eat outer {}
7538 \begingroup
7539   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
7540   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
7541 \endgroup
7542 %
7543 \def\verb{\begingroup\setupverb\doverb}
7544 %
7545 %
7546 % Do the @verbatim magic: define the macro \doverbatim so that
7547 % the (first) argument ends when '@end verbatim' is reached, ie:
7548 %
7549 %     \def\doverbatim#1@end verbatim{#1}
7550 %
7551 % For Texinfo it's a lot easier than for LaTeX,
7552 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
7553 % we need not redefine '\', '{' and '}'.
7554 %
7555 % Inspired by LaTeX's verbatim command set [latex.ltx]
7556 %
7557 \begingroup
7558   \catcode`\ =\active
7559   \obeylines %
7560   % ignore everything up to the first ^^M, that's the newline at the end
7561   % of the @verbatim input line itself.  Otherwise we get an extra blank
7562   % line in the output.
7563   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
7564   % We really want {...\end verbatim} in the body of the macro, but
7565   % without the active space; thus we have to use \xdef and \gobble.
7566 \endgroup
7567 %
7568 \envdef\verbatim{%
7569     \setupverbatim\doverbatim
7570 }
7571 \let\Everbatim = \afterenvbreak
7572
7573
7574 % @verbatiminclude FILE - insert text of file in verbatim environment.
7575 %
7576 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
7577 %
7578 \def\doverbatiminclude#1{%
7579   {%
7580     \makevalueexpandable
7581     \setupverbatim
7582     \indexnofonts       % Allow `@@' and other weird things in file names.
7583     \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
7584     \input #1
7585     \afterenvbreak
7586   }%
7587 }
7588
7589 % @copying ... @end copying.
7590 % Save the text away for @insertcopying later.
7591 %
7592 % We save the uninterpreted tokens, rather than creating a box.
7593 % Saving the text in a box would be much easier, but then all the
7594 % typesetting commands (@smallbook, font changes, etc.) have to be done
7595 % beforehand -- and a) we want @copying to be done first in the source
7596 % file; b) letting users define the frontmatter in as flexible order as
7597 % possible is desirable.
7598 %
7599 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
7600 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
7601 %
7602 \def\insertcopying{%
7603   \begingroup
7604     \parindent = 0pt  % paragraph indentation looks wrong on title page
7605     \scanexp\copyingtext
7606   \endgroup
7607 }
7608
7609
7610 \message{defuns,}
7611 % @defun etc.
7612
7613 \newskip\defbodyindent \defbodyindent=.4in
7614 \newskip\defargsindent \defargsindent=50pt
7615 \newskip\deflastargmargin \deflastargmargin=18pt
7616 \newcount\defunpenalty
7617
7618 % Start the processing of @deffn:
7619 \def\startdefun{%
7620   \ifnum\lastpenalty<10000
7621     \medbreak
7622     \defunpenalty=10003 % Will keep this @deffn together with the
7623                         % following @def command, see below.
7624   \else
7625     % If there are two @def commands in a row, we'll have a \nobreak,
7626     % which is there to keep the function description together with its
7627     % header.  But if there's nothing but headers, we need to allow a
7628     % break somewhere.  Check specifically for penalty 10002, inserted
7629     % by \printdefunline, instead of 10000, since the sectioning
7630     % commands also insert a nobreak penalty, and we don't want to allow
7631     % a break between a section heading and a defun.
7632     %
7633     % As a further refinement, we avoid "club" headers by signalling
7634     % with penalty of 10003 after the very first @deffn in the
7635     % sequence (see above), and penalty of 10002 after any following
7636     % @def command.
7637     \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
7638     %
7639     % Similarly, after a section heading, do not allow a break.
7640     % But do insert the glue.
7641     \medskip  % preceded by discardable penalty, so not a breakpoint
7642   \fi
7643   %
7644   \parindent=0in
7645   \advance\leftskip by \defbodyindent
7646   \exdentamount=\defbodyindent
7647 }
7648
7649 \def\dodefunx#1{%
7650   % First, check whether we are in the right environment:
7651   \checkenv#1%
7652   %
7653   % As above, allow line break if we have multiple x headers in a row.
7654   % It's not a great place, though.
7655   \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
7656   %
7657   % And now, it's time to reuse the body of the original defun:
7658   \expandafter\gobbledefun#1%
7659 }
7660 \def\gobbledefun#1\startdefun{}
7661
7662 % \printdefunline \deffnheader{text}
7663 %
7664 \def\printdefunline#1#2{%
7665   \begingroup
7666     % call \deffnheader:
7667     #1#2 \endheader
7668     % common ending:
7669     \interlinepenalty = 10000
7670     \advance\rightskip by 0pt plus 1fil\relax
7671     \endgraf
7672     \nobreak\vskip -\parskip
7673     \penalty\defunpenalty  % signal to \startdefun and \dodefunx
7674     % Some of the @defun-type tags do not enable magic parentheses,
7675     % rendering the following check redundant.  But we don't optimize.
7676     \checkparencounts
7677   \endgroup
7678 }
7679
7680 \def\Edefun{\endgraf\medbreak}
7681
7682 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7683 % the only thing remaining is to define \deffnheader.
7684 %
7685 \def\makedefun#1{%
7686   \expandafter\let\csname E#1\endcsname = \Edefun
7687   \edef\temp{\noexpand\domakedefun
7688     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
7689   \temp
7690 }
7691
7692 % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
7693 %
7694 % Define \deffn and \deffnx, without parameters.
7695 % \deffnheader has to be defined explicitly.
7696 %
7697 \def\domakedefun#1#2#3{%
7698   \envdef#1{%
7699     \startdefun
7700     \doingtypefnfalse    % distinguish typed functions from all else
7701     \parseargusing\activeparens{\printdefunline#3}%
7702   }%
7703   \def#2{\dodefunx#1}%
7704   \def#3%
7705 }
7706
7707 \newif\ifdoingtypefn       % doing typed function?
7708 \newif\ifrettypeownline    % typeset return type on its own line?
7709
7710 % @deftypefnnewline on|off says whether the return type of typed functions
7711 % are printed on their own line.  This affects @deftypefn, @deftypefun,
7712 % @deftypeop, and @deftypemethod.
7713
7714 \parseargdef\deftypefnnewline{%
7715   \def\temp{#1}%
7716   \ifx\temp\onword
7717     \expandafter\let\csname SETtxideftypefnnl\endcsname
7718       = \empty
7719   \else\ifx\temp\offword
7720     \expandafter\let\csname SETtxideftypefnnl\endcsname
7721       = \relax
7722   \else
7723     \errhelp = \EMsimple
7724     \errmessage{Unknown @txideftypefnnl value `\temp',
7725                 must be on|off}%
7726   \fi\fi
7727 }
7728
7729 % Untyped functions:
7730
7731 % @deffn category name args
7732 \makedefun{deffn}{\deffngeneral{}}
7733
7734 % @deffn category class name args
7735 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7736
7737 % \defopon {category on}class name args
7738 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7739
7740 % \deffngeneral {subind}category name args
7741 %
7742 \def\deffngeneral#1#2 #3 #4\endheader{%
7743   % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7744   \dosubind{fn}{\code{#3}}{#1}%
7745   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7746 }
7747
7748 % Typed functions:
7749
7750 % @deftypefn category type name args
7751 \makedefun{deftypefn}{\deftypefngeneral{}}
7752
7753 % @deftypeop category class type name args
7754 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7755
7756 % \deftypeopon {category on}class type name args
7757 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7758
7759 % \deftypefngeneral {subind}category type name args
7760 %
7761 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7762   \dosubind{fn}{\code{#4}}{#1}%
7763   \doingtypefntrue
7764   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7765 }
7766
7767 % Typed variables:
7768
7769 % @deftypevr category type var args
7770 \makedefun{deftypevr}{\deftypecvgeneral{}}
7771
7772 % @deftypecv category class type var args
7773 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7774
7775 % \deftypecvof {category of}class type var args
7776 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7777
7778 % \deftypecvgeneral {subind}category type var args
7779 %
7780 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7781   \dosubind{vr}{\code{#4}}{#1}%
7782   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7783 }
7784
7785 % Untyped variables:
7786
7787 % @defvr category var args
7788 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7789
7790 % @defcv category class var args
7791 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7792
7793 % \defcvof {category of}class var args
7794 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7795
7796 % Types:
7797
7798 % @deftp category name args
7799 \makedefun{deftp}#1 #2 #3\endheader{%
7800   \doind{tp}{\code{#2}}%
7801   \defname{#1}{}{#2}\defunargs{#3\unskip}%
7802 }
7803
7804 % Remaining @defun-like shortcuts:
7805 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7806 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7807 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7808 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7809 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7810 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7811 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7812 \makedefun{defmethod}{\defopon\putwordMethodon}
7813 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7814 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7815 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7816
7817 % \defname, which formats the name of the @def (not the args).
7818 % #1 is the category, such as "Function".
7819 % #2 is the return type, if any.
7820 % #3 is the function name.
7821 %
7822 % We are followed by (but not passed) the arguments, if any.
7823 %
7824 \def\defname#1#2#3{%
7825   \par
7826   % Get the values of \leftskip and \rightskip as they were outside the @def...
7827   \advance\leftskip by -\defbodyindent
7828   %
7829   % Determine if we are typesetting the return type of a typed function
7830   % on a line by itself.
7831   \rettypeownlinefalse
7832   \ifdoingtypefn  % doing a typed function specifically?
7833     % then check user option for putting return type on its own line:
7834     \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7835       \rettypeownlinetrue
7836     \fi
7837   \fi
7838   %
7839   % How we'll format the category name.  Putting it in brackets helps
7840   % distinguish it from the body text that may end up on the next line
7841   % just below it.
7842   \def\temp{#1}%
7843   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7844   %
7845   % Figure out line sizes for the paragraph shape.  We'll always have at
7846   % least two.
7847   \tempnum = 2
7848   %
7849   % The first line needs space for \box0; but if \rightskip is nonzero,
7850   % we need only space for the part of \box0 which exceeds it:
7851   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
7852   %
7853   % If doing a return type on its own line, we'll have another line.
7854   \ifrettypeownline
7855     \advance\tempnum by 1
7856     \def\maybeshapeline{0in \hsize}%
7857   \else
7858     \def\maybeshapeline{}%
7859   \fi
7860   %
7861   % The continuations:
7862   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
7863   %
7864   % The final paragraph shape:
7865   \parshape \tempnum  0in \dimen0  \maybeshapeline  \defargsindent \dimen2
7866   %
7867   % Put the category name at the right margin.
7868   \noindent
7869   \hbox to 0pt{%
7870     \hfil\box0 \kern-\hsize
7871     % \hsize has to be shortened this way:
7872     \kern\leftskip
7873     % Intentionally do not respect \rightskip, since we need the space.
7874   }%
7875   %
7876   % Allow all lines to be underfull without complaint:
7877   \tolerance=10000 \hbadness=10000
7878   \exdentamount=\defbodyindent
7879   {%
7880     % defun fonts. We use typewriter by default (used to be bold) because:
7881     % . we're printing identifiers, they should be in tt in principle.
7882     % . in languages with many accents, such as Czech or French, it's
7883     %   common to leave accents off identifiers.  The result looks ok in
7884     %   tt, but exceedingly strange in rm.
7885     % . we don't want -- and --- to be treated as ligatures.
7886     % . this still does not fix the ?` and !` ligatures, but so far no
7887     %   one has made identifiers using them :).
7888     \df \tt
7889     \def\temp{#2}% text of the return type
7890     \ifx\temp\empty\else
7891       \tclose{\temp}% typeset the return type
7892       \ifrettypeownline
7893         % put return type on its own line; prohibit line break following:
7894         \hfil\vadjust{\nobreak}\break  
7895       \else
7896         \space  % type on same line, so just followed by a space
7897       \fi
7898     \fi           % no return type
7899     #3% output function name
7900   }%
7901   {\rm\enskip}% hskip 0.5 em of \rmfont
7902   %
7903   \boldbrax
7904   % arguments will be output next, if any.
7905 }
7906
7907 % Print arguments in slanted roman (not ttsl), inconsistently with using
7908 % tt for the name.  This is because literal text is sometimes needed in
7909 % the argument list (groff manual), and ttsl and tt are not very
7910 % distinguishable.  Prevent hyphenation at `-' chars.
7911 %
7912 \def\defunargs#1{%
7913   % use sl by default (not ttsl),
7914   % tt for the names.
7915   \df \sl \hyphenchar\font=0
7916   %
7917   % On the other hand, if an argument has two dashes (for instance), we
7918   % want a way to get ttsl.  We used to recommend @var for that, so
7919   % leave the code in, but it's strange for @var to lead to typewriter.
7920   % Nowadays we recommend @code, since the difference between a ttsl hyphen
7921   % and a tt hyphen is pretty tiny.  @code also disables ?` !`.
7922   \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7923   #1%
7924   \sl\hyphenchar\font=45
7925 }
7926
7927 % We want ()&[] to print specially on the defun line.
7928 %
7929 \def\activeparens{%
7930   \catcode`\(=\active \catcode`\)=\active
7931   \catcode`\[=\active \catcode`\]=\active
7932   \catcode`\&=\active
7933 }
7934
7935 % Make control sequences which act like normal parenthesis chars.
7936 \let\lparen = ( \let\rparen = )
7937
7938 % Be sure that we always have a definition for `(', etc.  For example,
7939 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7940 % so TeX would otherwise complain about undefined control sequence.
7941 {
7942   \activeparens
7943   \global\let(=\lparen \global\let)=\rparen
7944   \global\let[=\lbrack \global\let]=\rbrack
7945   \global\let& = \&
7946
7947   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7948   \gdef\magicamp{\let&=\amprm}
7949 }
7950
7951 \newcount\parencount
7952
7953 % If we encounter &foo, then turn on ()-hacking afterwards
7954 \newif\ifampseen
7955 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7956
7957 \def\parenfont{%
7958   \ifampseen
7959     % At the first level, print parens in roman,
7960     % otherwise use the default font.
7961     \ifnum \parencount=1 \rm \fi
7962   \else
7963     % The \sf parens (in \boldbrax) actually are a little bolder than
7964     % the contained text.  This is especially needed for [ and ] .
7965     \sf
7966   \fi
7967 }
7968 \def\infirstlevel#1{%
7969   \ifampseen
7970     \ifnum\parencount=1
7971       #1%
7972     \fi
7973   \fi
7974 }
7975 \def\bfafterword#1 {#1 \bf}
7976
7977 \def\opnr{%
7978   \global\advance\parencount by 1
7979   {\parenfont(}%
7980   \infirstlevel \bfafterword
7981 }
7982 \def\clnr{%
7983   {\parenfont)}%
7984   \infirstlevel \sl
7985   \global\advance\parencount by -1
7986 }
7987
7988 \newcount\brackcount
7989 \def\lbrb{%
7990   \global\advance\brackcount by 1
7991   {\bf[}%
7992 }
7993 \def\rbrb{%
7994   {\bf]}%
7995   \global\advance\brackcount by -1
7996 }
7997
7998 \def\checkparencounts{%
7999   \ifnum\parencount=0 \else \badparencount \fi
8000   \ifnum\brackcount=0 \else \badbrackcount \fi
8001 }
8002 % these should not use \errmessage; the glibc manual, at least, actually
8003 % has such constructs (when documenting function pointers).
8004 \def\badparencount{%
8005   \message{Warning: unbalanced parentheses in @def...}%
8006   \global\parencount=0
8007 }
8008 \def\badbrackcount{%
8009   \message{Warning: unbalanced square brackets in @def...}%
8010   \global\brackcount=0
8011 }
8012
8013
8014 \message{macros,}
8015 % @macro.
8016
8017 % To do this right we need a feature of e-TeX, \scantokens,
8018 % which we arrange to emulate with a temporary file in ordinary TeX.
8019 \ifx\eTeXversion\thisisundefined
8020   \newwrite\macscribble
8021   \def\scantokens#1{%
8022     \toks0={#1}%
8023     \immediate\openout\macscribble=\jobname.tmp
8024     \immediate\write\macscribble{\the\toks0}%
8025     \immediate\closeout\macscribble
8026     \input \jobname.tmp
8027   }
8028 \fi
8029
8030 % alias because \c means cedilla in @tex or @math
8031 \let\texinfoc=\c
8032
8033 \newcount\savedcatcodeone
8034 \newcount\savedcatcodetwo
8035
8036 % Used at the time of macro expansion.
8037 % Argument is macro body with arguments substituted
8038 \def\scanmacro#1{%
8039   \newlinechar`\^^M
8040   \def\xeatspaces{\eatspaces}%
8041   %
8042   % Temporarily undo catcode changes of \printindex.  Set catcode of @ to
8043   % 0 so that @-commands in macro expansions aren't printed literally when 
8044   % formatting an index file, where \ is used as the escape character.
8045   \savedcatcodeone=\catcode`\@
8046   \savedcatcodetwo=\catcode`\\
8047   \catcode`\@=0
8048   \catcode`\\=\active
8049   %
8050   % Process the macro body under the current catcode regime.
8051   \scantokens{#1@texinfoc}%
8052   %
8053   \catcode`\@=\savedcatcodeone
8054   \catcode`\\=\savedcatcodetwo
8055   %
8056   % The \texinfoc is to remove the \newlinechar added by \scantokens, and
8057   % can be noticed by \parsearg.
8058   %   We avoid surrounding the call to \scantokens with \bgroup and \egroup
8059   % to allow macros to open or close groups themselves.
8060 }
8061
8062 % Used for copying and captions
8063 \def\scanexp#1{%
8064   \expandafter\scanmacro\expandafter{#1}%
8065 }
8066
8067 \newcount\paramno   % Count of parameters
8068 \newtoks\macname    % Macro name
8069 \newif\ifrecursive  % Is it recursive?
8070
8071 % List of all defined macros in the form
8072 %    \commondummyword\macro1\commondummyword\macro2...
8073 % Currently is also contains all @aliases; the list can be split
8074 % if there is a need.
8075 \def\macrolist{}
8076
8077 % Add the macro to \macrolist
8078 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
8079 \def\addtomacrolistxxx#1{%
8080      \toks0 = \expandafter{\macrolist\commondummyword#1}%
8081      \xdef\macrolist{\the\toks0}%
8082 }
8083
8084 % Utility routines.
8085 % This does \let #1 = #2, with \csnames; that is,
8086 %   \let \csname#1\endcsname = \csname#2\endcsname
8087 % (except of course we have to play expansion games).
8088 %
8089 \def\cslet#1#2{%
8090   \expandafter\let
8091   \csname#1\expandafter\endcsname
8092   \csname#2\endcsname
8093 }
8094
8095 % Trim leading and trailing spaces off a string.
8096 % Concepts from aro-bend problem 15 (see CTAN).
8097 {\catcode`\@=11
8098 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
8099 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
8100 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
8101 \def\unbrace#1{#1}
8102 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
8103 }
8104
8105 % Trim a single trailing ^^M off a string.
8106 {\catcode`\^^M=\other \catcode`\Q=3%
8107 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
8108 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
8109 \gdef\eatcrb#1Q#2Q{#1}%
8110 }
8111
8112 % Macro bodies are absorbed as an argument in a context where
8113 % all characters are catcode 10, 11 or 12, except \ which is active
8114 % (as in normal texinfo). It is necessary to change the definition of \
8115 % to recognize macro arguments; this is the job of \mbodybackslash.
8116 %
8117 % Non-ASCII encodings make 8-bit characters active, so un-activate
8118 % them to avoid their expansion.  Must do this non-globally, to
8119 % confine the change to the current group.
8120 %
8121 % It's necessary to have hard CRs when the macro is executed. This is
8122 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
8123 % body, and then making it the \newlinechar in \scanmacro.
8124 %
8125 \def\scanctxt{% used as subroutine
8126   \catcode`\"=\other
8127   \catcode`\+=\other
8128   \catcode`\<=\other
8129   \catcode`\>=\other
8130   \catcode`\^=\other
8131   \catcode`\_=\other
8132   \catcode`\|=\other
8133   \catcode`\~=\other
8134   \passthroughcharstrue
8135 }
8136
8137 \def\scanargctxt{% used for copying and captions, not macros.
8138   \scanctxt
8139   \catcode`\@=\other
8140   \catcode`\\=\other
8141   \catcode`\^^M=\other
8142 }
8143
8144 \def\macrobodyctxt{% used for @macro definitions
8145   \scanctxt
8146   \catcode`\ =\other
8147   \catcode`\@=\other
8148   \catcode`\{=\other
8149   \catcode`\}=\other
8150   \catcode`\^^M=\other
8151   \usembodybackslash
8152 }
8153
8154 % Used when scanning braced macro arguments.  Note, however, that catcode
8155 % changes here are ineffectual if the macro invocation was nested inside
8156 % an argument to another Texinfo command.
8157 \def\macroargctxt{%
8158   \scanctxt
8159   \catcode`\ =\active
8160   \catcode`\^^M=\other
8161   \catcode`\\=\active
8162 }
8163
8164 \def\macrolineargctxt{% used for whole-line arguments without braces
8165   \scanctxt
8166   \catcode`\{=\other
8167   \catcode`\}=\other
8168 }
8169
8170 % \mbodybackslash is the definition of \ in @macro bodies.
8171 % It maps \foo\ => \csname macarg.foo\endcsname => #N
8172 % where N is the macro parameter number.
8173 % We define \csname macarg.\endcsname to be \realbackslash, so
8174 % \\ in macro replacement text gets you a backslash.
8175 %
8176 {\catcode`@=0 @catcode`@\=@active
8177  @gdef@usembodybackslash{@let\=@mbodybackslash}
8178  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
8179 }
8180 \expandafter\def\csname macarg.\endcsname{\realbackslash}
8181
8182 \def\margbackslash#1{\char`\#1 }
8183
8184 \def\macro{\recursivefalse\parsearg\macroxxx}
8185 \def\rmacro{\recursivetrue\parsearg\macroxxx}
8186
8187 \def\macroxxx#1{%
8188   \getargs{#1}% now \macname is the macname and \argl the arglist
8189   \ifx\argl\empty       % no arguments
8190      \paramno=0\relax
8191   \else
8192      \expandafter\parsemargdef \argl;%
8193      \if\paramno>256\relax
8194        \ifx\eTeXversion\thisisundefined
8195          \errhelp = \EMsimple
8196          \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
8197        \fi
8198      \fi
8199   \fi
8200   \if1\csname ismacro.\the\macname\endcsname
8201      \message{Warning: redefining \the\macname}%
8202   \else
8203      \expandafter\ifx\csname \the\macname\endcsname \relax
8204      \else \errmessage{Macro name \the\macname\space already defined}\fi
8205      \global\cslet{macsave.\the\macname}{\the\macname}%
8206      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
8207      \addtomacrolist{\the\macname}%
8208   \fi
8209   \begingroup \macrobodyctxt
8210   \ifrecursive \expandafter\parsermacbody
8211   \else \expandafter\parsemacbody
8212   \fi}
8213
8214 \parseargdef\unmacro{%
8215   \if1\csname ismacro.#1\endcsname
8216     \global\cslet{#1}{macsave.#1}%
8217     \global\expandafter\let \csname ismacro.#1\endcsname=0%
8218     % Remove the macro name from \macrolist:
8219     \begingroup
8220       \expandafter\let\csname#1\endcsname \relax
8221       \let\commondummyword\unmacrodo
8222       \xdef\macrolist{\macrolist}%
8223     \endgroup
8224   \else
8225     \errmessage{Macro #1 not defined}%
8226   \fi
8227 }
8228
8229 % Called by \do from \dounmacro on each macro.  The idea is to omit any
8230 % macro definitions that have been changed to \relax.
8231 %
8232 \def\unmacrodo#1{%
8233   \ifx #1\relax
8234     % remove this
8235   \else
8236     \noexpand\commondummyword \noexpand#1%
8237   \fi
8238 }
8239
8240 % \getargs -- Parse the arguments to a @macro line.  Set \macname to
8241 % the name of the macro, and \argl to the braced argument list.
8242 \def\getargs#1{\getargsxxx#1{}}
8243 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
8244 \def\getmacname#1 #2\relax{\macname={#1}}
8245 \def\getmacargs#1{\def\argl{#1}}
8246 % This made use of the feature that if the last token of a
8247 % <parameter list> is #, then the preceding argument is delimited by
8248 % an opening brace, and that opening brace is not consumed.
8249
8250 % Parse the optional {params} list to @macro or @rmacro.
8251 % Set \paramno to the number of arguments,
8252 % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
8253 % three-param macro.)  Define \macarg.BLAH for each BLAH in the params
8254 % list to some hook where the argument is to be expanded.  If there are
8255 % less than 10 arguments that hook is to be replaced by ##N where N
8256 % is the position in that list, that is to say the macro arguments are to be
8257 % defined `a la TeX in the macro body.  
8258 %
8259 % That gets used by \mbodybackslash (above).
8260 %
8261 % If there are 10 or more arguments, a different technique is used: see
8262 % \parsemmanyargdef.
8263 %
8264 \def\parsemargdef#1;{%
8265   \paramno=0\def\paramlist{}%
8266   \let\hash\relax
8267   % \hash is redefined to `#' later to get it into definitions
8268   \let\xeatspaces\relax
8269   \parsemargdefxxx#1,;,%
8270   \ifnum\paramno<10\relax\else
8271     \paramno0\relax
8272     \parsemmanyargdef@@#1,;,% 10 or more arguments
8273   \fi
8274 }
8275 \def\parsemargdefxxx#1,{%
8276   \if#1;\let\next=\relax
8277   \else \let\next=\parsemargdefxxx
8278     \advance\paramno by 1
8279     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
8280         {\xeatspaces{\hash\the\paramno}}%
8281     \edef\paramlist{\paramlist\hash\the\paramno,}%
8282   \fi\next}
8283
8284 % \parsemacbody, \parsermacbody
8285 %
8286 % Read recursive and nonrecursive macro bodies. (They're different since
8287 % rec and nonrec macros end differently.)
8288
8289 % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro 
8290 % body to be transformed.
8291 % Set \macrobody to the body of the macro, and call \defmacro.
8292 %
8293 {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
8294 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8295 {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
8296 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8297
8298 % Make @ a letter, so that we can make private-to-Texinfo macro names.
8299 \edef\texiatcatcode{\the\catcode`\@}
8300 \catcode `@=11\relax
8301
8302 %%%%%%%%%%%%%% Code for > 10 arguments only   %%%%%%%%%%%%%%%%%%
8303
8304 % If there are 10 or more arguments, a different technique is used, where the
8305 % hook remains in the body, and when macro is to be expanded the body is
8306 % processed again to replace the arguments.
8307 %
8308 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
8309 % argument N value and then \edef the body (nothing else will expand because of
8310 % the catcode regime under which the body was input).
8311 %
8312 % If you compile with TeX (not eTeX), and you have macros with 10 or more
8313 % arguments, no macro can have more than 256 arguments (else error).
8314 %
8315 % In case that there are 10 or more arguments we parse again the arguments
8316 % list to set new definitions for the \macarg.BLAH macros corresponding to
8317 % each BLAH argument. It was anyhow needed to parse already once this list
8318 % in order to count the arguments, and as macros with at most 9 arguments
8319 % are by far more frequent than macro with 10 or more arguments, defining
8320 % twice the \macarg.BLAH macros does not cost too much processing power.
8321 \def\parsemmanyargdef@@#1,{%
8322   \if#1;\let\next=\relax
8323   \else 
8324     \let\next=\parsemmanyargdef@@
8325     \edef\tempb{\eatspaces{#1}}%
8326     \expandafter\def\expandafter\tempa
8327        \expandafter{\csname macarg.\tempb\endcsname}%
8328     % Note that we need some extra \noexpand\noexpand, this is because we
8329     % don't want \the  to be expanded in the \parsermacbody  as it uses an
8330     % \xdef .
8331     \expandafter\edef\tempa
8332       {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
8333     \advance\paramno by 1\relax
8334   \fi\next}
8335
8336
8337 \let\endargs@\relax
8338 \let\nil@\relax
8339 \def\nilm@{\nil@}%
8340 \long\def\nillm@{\nil@}%
8341
8342 % This macro is expanded during the Texinfo macro expansion, not during its
8343 % definition.  It gets all the arguments' values and assigns them to macros
8344 % macarg.ARGNAME
8345 %
8346 % #1 is the macro name
8347 % #2 is the list of argument names
8348 % #3 is the list of argument values
8349 \def\getargvals@#1#2#3{%
8350   \def\macargdeflist@{}%
8351   \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
8352   \def\paramlist{#2,\nil@}%
8353   \def\macroname{#1}%
8354   \begingroup
8355   \macroargctxt
8356   \def\argvaluelist{#3,\nil@}%
8357   \def\@tempa{#3}%
8358   \ifx\@tempa\empty
8359     \setemptyargvalues@
8360   \else
8361     \getargvals@@
8362   \fi
8363 }
8364 \def\getargvals@@{%
8365   \ifx\paramlist\nilm@
8366       % Some sanity check needed here that \argvaluelist is also empty.
8367       \ifx\argvaluelist\nillm@
8368       \else
8369         \errhelp = \EMsimple
8370         \errmessage{Too many arguments in macro `\macroname'!}%
8371       \fi
8372       \let\next\macargexpandinbody@
8373   \else
8374     \ifx\argvaluelist\nillm@
8375        % No more arguments values passed to macro.  Set remaining named-arg
8376        % macros to empty.
8377        \let\next\setemptyargvalues@
8378     \else
8379       % pop current arg name into \@tempb
8380       \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
8381       \expandafter\@tempa\expandafter{\paramlist}%
8382        % pop current argument value into \@tempc
8383       \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
8384       \expandafter\@tempa\expandafter{\argvaluelist}%
8385        % Here \@tempb is the current arg name and \@tempc is the current arg value.
8386        % First place the new argument macro definition into \@tempd
8387        \expandafter\macname\expandafter{\@tempc}%
8388        \expandafter\let\csname macarg.\@tempb\endcsname\relax
8389        \expandafter\def\expandafter\@tempe\expandafter{%
8390          \csname macarg.\@tempb\endcsname}%
8391        \edef\@tempd{\long\def\@tempe{\the\macname}}%
8392        \push@\@tempd\macargdeflist@
8393        \let\next\getargvals@@
8394     \fi
8395   \fi
8396   \next
8397 }
8398
8399 \def\push@#1#2{%
8400   \expandafter\expandafter\expandafter\def
8401   \expandafter\expandafter\expandafter#2%
8402   \expandafter\expandafter\expandafter{%
8403   \expandafter#1#2}%
8404 }
8405
8406 % Replace arguments by their values in the macro body, and place the result
8407 % in macro \@tempa.
8408
8409 \def\macvalstoargs@{%
8410   %  To do this we use the property that token registers that are \the'ed
8411   % within an \edef  expand only once. So we are going to place all argument
8412   % values into respective token registers.
8413   %
8414   % First we save the token context, and initialize argument numbering.
8415   \begingroup
8416     \paramno0\relax
8417     % Then, for each argument number #N, we place the corresponding argument
8418     % value into a new token list register \toks#N
8419     \expandafter\putargsintokens@\saveparamlist@,;,%
8420     % Then, we expand the body so that argument are replaced by their
8421     % values. The trick for values not to be expanded themselves is that they
8422     % are within tokens and that tokens expand only once in an \edef .
8423     \edef\@tempc{\csname mac.\macroname .body\endcsname}%
8424     % Now we restore the token stack pointer to free the token list registers
8425     % which we have used, but we make sure that expanded body is saved after
8426     % group.
8427     \expandafter
8428   \endgroup
8429   \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
8430   }
8431
8432 % Define the named-macro outside of this group and then close this group. 
8433
8434 \def\macargexpandinbody@{% 
8435   \expandafter
8436   \endgroup
8437   \macargdeflist@
8438   % First the replace in body the macro arguments by their values, the result
8439   % is in \@tempa .
8440   \macvalstoargs@
8441   % Then we point at the \norecurse or \gobble (for recursive) macro value
8442   % with \@tempb .
8443   \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
8444   % Depending on whether it is recursive or not, we need some tailing
8445   % \egroup .
8446   \ifx\@tempb\gobble
8447      \let\@tempc\relax
8448   \else
8449      \let\@tempc\egroup
8450   \fi
8451   % And now we do the real job:
8452   \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
8453   \@tempd
8454 }
8455
8456 \def\putargsintokens@#1,{%
8457   \if#1;\let\next\relax
8458   \else
8459     \let\next\putargsintokens@
8460     % First we allocate the new token list register, and give it a temporary
8461     % alias \@tempb .
8462     \toksdef\@tempb\the\paramno
8463     % Then we place the argument value into that token list register.
8464     \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
8465     \expandafter\@tempb\expandafter{\@tempa}%
8466     \advance\paramno by 1\relax
8467   \fi
8468   \next
8469 }
8470
8471 % Trailing missing arguments are set to empty.
8472
8473 \def\setemptyargvalues@{%
8474   \ifx\paramlist\nilm@
8475     \let\next\macargexpandinbody@
8476   \else
8477     \expandafter\setemptyargvaluesparser@\paramlist\endargs@
8478     \let\next\setemptyargvalues@
8479   \fi
8480   \next
8481 }
8482
8483 \def\setemptyargvaluesparser@#1,#2\endargs@{%
8484   \expandafter\def\expandafter\@tempa\expandafter{%
8485     \expandafter\def\csname macarg.#1\endcsname{}}%
8486   \push@\@tempa\macargdeflist@
8487   \def\paramlist{#2}%
8488 }
8489
8490 % #1 is the element target macro
8491 % #2 is the list macro
8492 % #3,#4\endargs@ is the list value
8493 \def\pop@#1#2#3,#4\endargs@{%
8494    \def#1{#3}%
8495    \def#2{#4}%
8496 }
8497 \long\def\longpop@#1#2#3,#4\endargs@{%
8498    \long\def#1{#3}%
8499    \long\def#2{#4}%
8500 }
8501
8502
8503 %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
8504
8505
8506 % This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
8507 %    \macrobody has the body of the macro in it, with placeholders for
8508 % its parameters, looking like "\xeatspaces{\hash 1}".
8509 %    \paramno is the number of parameters
8510 %    \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
8511 % There are four cases: macros of zero, one, up to nine, and many arguments.
8512 % \xdef is used so that macro definitions will survive the file
8513 % they're defined in: @include reads the file inside a group.
8514 %
8515 \def\defmacro{%
8516   \let\hash=##% convert placeholders to macro parameter chars
8517   \ifnum\paramno=1
8518     \def\xeatspaces##1{##1}%
8519     % This removes the pair of braces around the argument.  We don't
8520     % use \eatspaces, because this can cause ends of lines to be lost
8521     % when the argument to \eatspaces is read, leading to line-based
8522     % commands like "@itemize" not being read correctly.
8523   \else
8524     \let\xeatspaces\relax % suppress expansion
8525   \fi
8526   \ifcase\paramno
8527   % 0
8528     \expandafter\xdef\csname\the\macname\endcsname{%
8529       \bgroup
8530         \noexpand\spaceisspace
8531         \noexpand\endlineisspace
8532         \noexpand\expandafter % skip any whitespace after the macro name.
8533         \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8534     \expandafter\xdef\csname\the\macname @@@\endcsname{%
8535       \egroup
8536       \noexpand\scanmacro{\macrobody}}%
8537   \or % 1
8538     \expandafter\xdef\csname\the\macname\endcsname{%
8539        \bgroup
8540        \noexpand\braceorline
8541        \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8542     \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8543       \egroup
8544       \noexpand\scanmacro{\macrobody}%
8545       }%
8546   \else % at most 9
8547     \ifnum\paramno<10\relax
8548       % @MACNAME sets the context for reading the macro argument
8549       % @MACNAME@@ gets the argument, processes backslashes and appends a 
8550       % comma.
8551       % @MACNAME@@@ removes braces surrounding the argument list.
8552       % @MACNAME@@@@ scans the macro body with arguments substituted.
8553       \expandafter\xdef\csname\the\macname\endcsname{%
8554         \bgroup
8555         \noexpand\expandafter  % This \expandafter skip any spaces after the
8556         \noexpand\macroargctxt % macro before we change the catcode of space.
8557         \noexpand\expandafter
8558         \expandafter\noexpand\csname\the\macname @@\endcsname}%
8559       \expandafter\xdef\csname\the\macname @@\endcsname##1{%
8560           \noexpand\passargtomacro
8561           \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
8562       \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8563           \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
8564       \expandafter\expandafter
8565       \expandafter\xdef
8566       \expandafter\expandafter
8567         \csname\the\macname @@@@\endcsname\paramlist{%
8568           \egroup\noexpand\scanmacro{\macrobody}}%
8569     \else % 10 or more:
8570       \expandafter\xdef\csname\the\macname\endcsname{%
8571         \noexpand\getargvals@{\the\macname}{\argl}%
8572       }%
8573       \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
8574       \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
8575     \fi
8576   \fi}
8577
8578 \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
8579
8580 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
8581
8582
8583 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8584 %
8585 {\catcode`\@=0 \catcode`\\=13  % We need to manipulate \ so use @ as escape
8586 @catcode`@_=11  % private names
8587 @catcode`@!=11  % used as argument separator
8588
8589 % \passargtomacro#1#2 -
8590 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
8591 % compressed to one.
8592 %
8593 % This implementation works by expansion, and not execution (so we cannot use 
8594 % \def or similar).  This reduces the risk of this failing in contexts where 
8595 % complete expansion is done with no execution (for example, in writing out to 
8596 % an auxiliary file for an index entry).
8597
8598 % State is kept in the input stream: the argument passed to
8599 % @look_ahead, @gobble_and_check_finish and @add_segment is
8600 %
8601 % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN  (... rest of input)
8602 %
8603 % where:
8604 % THE_MACRO - name of the macro we want to call
8605 % ARG_RESULT - argument list we build to pass to that macro
8606 % PENDING_BS - either a backslash or nothing
8607 % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
8608
8609 @gdef@passargtomacro#1#2{%
8610   @add_segment #1!{}@relax#2\@_finish\%
8611 }
8612 @gdef@_finish{@_finishx} @global@let@_finishx@relax
8613
8614 % #1 - THE_MACRO ARG_RESULT
8615 % #2 - PENDING_BS
8616 % #3 - NEXT_TOKEN
8617 % #4 used to look ahead
8618 %
8619 % If the next token is not a backslash, process the rest of the argument; 
8620 % otherwise, remove the next token.
8621 @gdef@look_ahead#1!#2#3#4{%
8622   @ifx#4\%
8623    @expandafter@gobble_and_check_finish 
8624   @else
8625    @expandafter@add_segment
8626   @fi#1!{#2}#4#4%
8627 }
8628
8629 % #1 - THE_MACRO ARG_RESULT
8630 % #2 - PENDING_BS
8631 % #3 - NEXT_TOKEN
8632 % #4 should be a backslash, which is gobbled.
8633 % #5 looks ahead
8634 %
8635 % Double backslash found.  Add a single backslash, and look ahead.
8636 @gdef@gobble_and_check_finish#1!#2#3#4#5{%
8637   @add_segment#1\!{}#5#5%
8638 }
8639
8640 @gdef@is_fi{@fi}
8641
8642 % #1 - THE_MACRO ARG_RESULT
8643 % #2 - PENDING_BS
8644 % #3 - NEXT_TOKEN
8645 % #4 is input stream until next backslash
8646 %
8647 % Input stream is either at the start of the argument, or just after a 
8648 % backslash sequence, either a lone backslash, or a doubled backslash.  
8649 % NEXT_TOKEN contains the first token in the input stream: if it is \finish, 
8650 % finish; otherwise, append to ARG_RESULT the segment of the argument up until
8651 % the next backslash.  PENDING_BACKSLASH contains a backslash to represent
8652 % a backslash just before the start of the input stream that has not been
8653 % added to ARG_RESULT.
8654 @gdef@add_segment#1!#2#3#4\{%
8655 @ifx#3@_finish
8656   @call_the_macro#1!%
8657 @else
8658   % append the pending backslash to the result, followed by the next segment
8659   @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
8660   % this @fi is discarded by @look_ahead.
8661   % we can't get rid of it with \expandafter because we don't know how 
8662   % long #4 is.
8663 }
8664
8665 % #1 - THE_MACRO
8666 % #2 - ARG_RESULT
8667 % #3 discards the res of the conditional in @add_segment, and @is_fi ends the 
8668 % conditional.
8669 @gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
8670
8671 }
8672 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8673
8674 % \braceorline MAC is used for a one-argument macro MAC.  It checks
8675 % whether the next non-whitespace character is a {.  It sets the context
8676 % for reading the argument (slightly different in the two cases).  Then,
8677 % to read the argument, in the whole-line case, it then calls the regular
8678 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8679
8680 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
8681 \def\braceorlinexxx{%
8682   \ifx\nchar\bgroup
8683     \macroargctxt
8684     \expandafter\passargtomacro
8685   \else
8686     \macrolineargctxt\expandafter\parsearg
8687   \fi \macnamexxx}
8688
8689
8690 % @alias.
8691 % We need some trickery to remove the optional spaces around the equal
8692 % sign.  Make them active and then expand them all to nothing.
8693 %
8694 \def\alias{\parseargusing\obeyspaces\aliasxxx}
8695 \def\aliasxxx #1{\aliasyyy#1\relax}
8696 \def\aliasyyy #1=#2\relax{%
8697   {%
8698     \expandafter\let\obeyedspace=\empty
8699     \addtomacrolist{#1}%
8700     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
8701   }%
8702   \next
8703 }
8704
8705
8706 \message{cross references,}
8707
8708 \newwrite\auxfile
8709 \newif\ifhavexrefs    % True if xref values are known.
8710 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
8711
8712 % @inforef is relatively simple.
8713 \def\inforef #1{\inforefzzz #1,,,,**}
8714 \def\inforefzzz #1,#2,#3,#4**{%
8715   \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8716   node \samp{\ignorespaces#1{}}}
8717
8718 % @node's only job in TeX is to define \lastnode, which is used in
8719 % cross-references.  The @node line might or might not have commas, and
8720 % might or might not have spaces before the first comma, like:
8721 % @node foo , bar , ...
8722 % We don't want such trailing spaces in the node name.
8723 %
8724 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
8725 %
8726 % also remove a trailing comma, in case of something like this:
8727 % @node Help-Cross,  ,  , Cross-refs
8728 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
8729 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
8730
8731 \let\nwnode=\node
8732 \let\lastnode=\empty
8733
8734 % Write a cross-reference definition for the current node.  #1 is the
8735 % type (Ynumbered, Yappendix, Ynothing).
8736 %
8737 \def\donoderef#1{%
8738   \ifx\lastnode\empty\else
8739     \setref{\lastnode}{#1}%
8740     \global\let\lastnode=\empty
8741   \fi
8742 }
8743
8744 % @anchor{NAME} -- define xref target at arbitrary point.
8745 %
8746 \newcount\savesfregister
8747 %
8748 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
8749 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
8750 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
8751
8752 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8753 % anchor), which consists of three parts:
8754 % 1) NAME-title - the current sectioning name taken from \lastsection,
8755 %                 or the anchor name.
8756 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
8757 %                 empty for anchors.
8758 % 3) NAME-pg    - the page number.
8759 %
8760 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
8761 % floats, there is an additional part, which is not written here:
8762 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
8763 %
8764 \def\setref#1#2{%
8765   \pdfmkdest{#1}%
8766   \iflinks
8767     {%
8768       \requireauxfile
8769       \atdummies  % preserve commands, but don't expand them
8770       % match definition in \xrdef, \refx, \xrefX.
8771       \def\value##1{##1}%
8772       \edef\writexrdef##1##2{%
8773         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
8774           ##1}{##2}}% these are parameters of \writexrdef
8775       }%
8776       \toks0 = \expandafter{\lastsection}%
8777       \immediate \writexrdef{title}{\the\toks0 }%
8778       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
8779       \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
8780     }%
8781   \fi
8782 }
8783
8784 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8785 % automatically in xrefs, if the third arg is not explicitly specified.
8786 % This was provided as a "secret" @set xref-automatic-section-title
8787 % variable, now it's official.
8788
8789 \parseargdef\xrefautomaticsectiontitle{%
8790   \def\temp{#1}%
8791   \ifx\temp\onword
8792     \expandafter\let\csname SETxref-automatic-section-title\endcsname
8793       = \empty
8794   \else\ifx\temp\offword
8795     \expandafter\let\csname SETxref-automatic-section-title\endcsname
8796       = \relax
8797   \else
8798     \errhelp = \EMsimple
8799     \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
8800                 must be on|off}%
8801   \fi\fi
8802 }
8803
8804\f
8805 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
8806 % the node name, #2 the name of the Info cross-reference, #3 the printed
8807 % node name, #4 the name of the Info file, #5 the name of the printed
8808 % manual.  All but the node name can be omitted.
8809 %
8810 \def\pxref{\putwordsee{} \xrefXX}
8811 \def\xref{\putwordSee{} \xrefXX}
8812 \def\ref{\xrefXX}
8813
8814 \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
8815 \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
8816 %
8817 \newbox\toprefbox
8818 \newbox\printedrefnamebox
8819 \newbox\infofilenamebox
8820 \newbox\printedmanualbox
8821 %
8822 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8823   \unsepspaces
8824   %
8825   % Get args without leading/trailing spaces.
8826   \def\printedrefname{\ignorespaces #3}%
8827   \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8828   %
8829   \def\infofilename{\ignorespaces #4}%
8830   \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8831   %
8832   \def\printedmanual{\ignorespaces #5}%
8833   \setbox\printedmanualbox  = \hbox{\printedmanual\unskip}%
8834   %
8835   % If the printed reference name (arg #3) was not explicitly given in
8836   % the @xref, figure out what we want to use.
8837   \ifdim \wd\printedrefnamebox = 0pt
8838     % No printed node name was explicitly given.
8839     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8840       % Not auto section-title: use node name inside the square brackets.
8841       \def\printedrefname{\ignorespaces #1}%
8842     \else
8843       % Auto section-title: use chapter/section title inside
8844       % the square brackets if we have it.
8845       \ifdim \wd\printedmanualbox > 0pt
8846         % It is in another manual, so we don't have it; use node name.
8847         \def\printedrefname{\ignorespaces #1}%
8848       \else
8849         \ifhavexrefs
8850           % We (should) know the real title if we have the xref values.
8851           \def\printedrefname{\refx{#1-title}{}}%
8852         \else
8853           % Otherwise just copy the Info node name.
8854           \def\printedrefname{\ignorespaces #1}%
8855         \fi%
8856       \fi
8857     \fi
8858   \fi
8859   %
8860   % Make link in pdf output.
8861   \ifpdf
8862     % For pdfTeX and LuaTeX
8863     {\indexnofonts
8864      \makevalueexpandable
8865      \turnoffactive
8866      % This expands tokens, so do it after making catcode changes, so _
8867      % etc. don't get their TeX definitions.  This ignores all spaces in
8868      % #4, including (wrongly) those in the middle of the filename.
8869      \getfilename{#4}%
8870      %
8871      % This (wrongly) does not take account of leading or trailing
8872      % spaces in #1, which should be ignored.
8873      \setpdfdestname{#1}%
8874      %
8875      \ifx\pdfdestname\empty
8876        \def\pdfdestname{Top}% no empty targets
8877      \fi
8878      %
8879      \leavevmode
8880      \startlink attr{/Border [0 0 0]}%
8881      \ifnum\filenamelength>0
8882        goto file{\the\filename.pdf} name{\pdfdestname}%
8883      \else
8884        goto name{\pdfmkpgn{\pdfdestname}}%
8885      \fi
8886     }%
8887     \setcolor{\linkcolor}%
8888   \else
8889     \ifx\XeTeXrevision\thisisundefined
8890     \else
8891       % For XeTeX
8892       {\indexnofonts
8893        \makevalueexpandable
8894        \turnoffactive
8895        % This expands tokens, so do it after making catcode changes, so _
8896        % etc. don't get their TeX definitions.  This ignores all spaces in
8897        % #4, including (wrongly) those in the middle of the filename.
8898        \getfilename{#4}%
8899        %
8900        % This (wrongly) does not take account of leading or trailing
8901        % spaces in #1, which should be ignored.
8902        \setpdfdestname{#1}%
8903        %
8904        \ifx\pdfdestname\empty
8905          \def\pdfdestname{Top}% no empty targets
8906        \fi
8907        %
8908        \leavevmode
8909        \ifnum\filenamelength>0
8910          % With default settings,
8911          % XeTeX (xdvipdfmx) replaces link destination names with integers.
8912          % In this case, the replaced destination names of
8913          % remote PDFs are no longer known.  In order to avoid a replacement,
8914          % you can use xdvipdfmx's command line option `-C 0x0010'.
8915          % If you use XeTeX 0.99996+ (TeX Live 2016+),
8916          % this command line option is no longer necessary
8917          % because we can use the `dvipdfmx:config' special.
8918          \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8919            << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}%
8920        \else
8921          \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8922            << /S /GoTo /D (\pdfdestname) >> >>}%
8923        \fi
8924       }%
8925       \setcolor{\linkcolor}%
8926     \fi
8927   \fi
8928   {%
8929     % Have to otherify everything special to allow the \csname to
8930     % include an _ in the xref name, etc.
8931     \indexnofonts
8932     \turnoffactive
8933     \def\value##1{##1}%
8934     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8935       \csname XR#1-title\endcsname
8936   }%
8937   %
8938   % Float references are printed completely differently: "Figure 1.2"
8939   % instead of "[somenode], p.3".  \iffloat distinguishes them by
8940   % \Xthisreftitle being set to a magic string.
8941   \iffloat\Xthisreftitle
8942     % If the user specified the print name (third arg) to the ref,
8943     % print it instead of our usual "Figure 1.2".
8944     \ifdim\wd\printedrefnamebox = 0pt
8945       \refx{#1-snt}{}%
8946     \else
8947       \printedrefname
8948     \fi
8949     %
8950     % If the user also gave the printed manual name (fifth arg), append
8951     % "in MANUALNAME".
8952     \ifdim \wd\printedmanualbox > 0pt
8953       \space \putwordin{} \cite{\printedmanual}%
8954     \fi
8955   \else
8956     % node/anchor (non-float) references.
8957     % 
8958     % If we use \unhbox to print the node names, TeX does not insert
8959     % empty discretionaries after hyphens, which means that it will not
8960     % find a line break at a hyphen in a node names.  Since some manuals
8961     % are best written with fairly long node names, containing hyphens,
8962     % this is a loss.  Therefore, we give the text of the node name
8963     % again, so it is as if TeX is seeing it for the first time.
8964     % 
8965     \ifdim \wd\printedmanualbox > 0pt
8966       % Cross-manual reference with a printed manual name.
8967       % 
8968       \crossmanualxref{\cite{\printedmanual\unskip}}%
8969     %
8970     \else\ifdim \wd\infofilenamebox > 0pt
8971       % Cross-manual reference with only an info filename (arg 4), no
8972       % printed manual name (arg 5).  This is essentially the same as
8973       % the case above; we output the filename, since we have nothing else.
8974       % 
8975       \crossmanualxref{\code{\infofilename\unskip}}%
8976     %
8977     \else
8978       % Reference within this manual.
8979       %
8980       % _ (for example) has to be the character _ for the purposes of the
8981       % control sequence corresponding to the node, but it has to expand
8982       % into the usual \leavevmode...\vrule stuff for purposes of
8983       % printing. So we \turnoffactive for the \refx-snt, back on for the
8984       % printing, back off for the \refx-pg.
8985       {\turnoffactive
8986        % Only output a following space if the -snt ref is nonempty; for
8987        % @unnumbered and @anchor, it won't be.
8988        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8989        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8990       }%
8991       % output the `[mynode]' via the macro below so it can be overridden.
8992       \xrefprintnodename\printedrefname
8993       %
8994       % But we always want a comma and a space:
8995       ,\space
8996       %
8997       % output the `page 3'.
8998       \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8999       % Add a , if xref followed by a space
9000       \if\space\noexpand\tokenafterxref ,%
9001       \else\ifx\        \tokenafterxref ,% @TAB
9002       \else\ifx\*\tokenafterxref ,%   @*
9003       \else\ifx\ \tokenafterxref ,%   @SPACE
9004       \else\ifx\
9005                 \tokenafterxref ,%    @NL
9006       \else\ifx\tie\tokenafterxref ,% @tie
9007       \fi\fi\fi\fi\fi\fi
9008     \fi\fi
9009   \fi
9010   \endlink
9011 \endgroup}
9012
9013 % Output a cross-manual xref to #1.  Used just above (twice).
9014
9015 % Only include the text "Section ``foo'' in" if the foo is neither
9016 % missing or Top.  Thus, @xref{,,,foo,The Foo Manual} outputs simply
9017 % "see The Foo Manual", the idea being to refer to the whole manual.
9018
9019 % But, this being TeX, we can't easily compare our node name against the
9020 % string "Top" while ignoring the possible spaces before and after in
9021 % the input.  By adding the arbitrary 7sp below, we make it much less
9022 % likely that a real node name would have the same width as "Top" (e.g.,
9023 % in a monospaced font).  Hopefully it will never happen in practice.
9024
9025 % For the same basic reason, we retypeset the "Top" at every
9026 % reference, since the current font is indeterminate.
9027
9028 \def\crossmanualxref#1{%
9029   \setbox\toprefbox = \hbox{Top\kern7sp}%
9030   \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
9031   \ifdim \wd2 > 7sp  % nonempty?
9032     \ifdim \wd2 = \wd\toprefbox \else  % same as Top?
9033       \putwordSection{} ``\printedrefname'' \putwordin{}\space
9034     \fi
9035   \fi
9036   #1%
9037 }
9038
9039 % This macro is called from \xrefX for the `[nodename]' part of xref
9040 % output.  It's a separate macro only so it can be changed more easily,
9041 % since square brackets don't work well in some documents.  Particularly
9042 % one that Bob is working on :).
9043 %
9044 \def\xrefprintnodename#1{[#1]}
9045
9046 % Things referred to by \setref.
9047 %
9048 \def\Ynothing{}
9049 \def\Yomitfromtoc{}
9050 \def\Ynumbered{%
9051   \ifnum\secno=0
9052     \putwordChapter@tie \the\chapno
9053   \else \ifnum\subsecno=0
9054     \putwordSection@tie \the\chapno.\the\secno
9055   \else \ifnum\subsubsecno=0
9056     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
9057   \else
9058     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
9059   \fi\fi\fi
9060 }
9061 \def\Yappendix{%
9062   \ifnum\secno=0
9063      \putwordAppendix@tie @char\the\appendixno{}%
9064   \else \ifnum\subsecno=0
9065      \putwordSection@tie @char\the\appendixno.\the\secno
9066   \else \ifnum\subsubsecno=0
9067     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
9068   \else
9069     \putwordSection@tie
9070       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
9071   \fi\fi\fi
9072 }
9073
9074 % \refx{NAME}{SUFFIX} - reference a cross-reference string named NAME.  SUFFIX 
9075 % is output afterwards if non-empty.
9076 \def\refx#1#2{%
9077   \requireauxfile
9078   {%
9079     \indexnofonts
9080     \otherbackslash
9081     \def\value##1{##1}%
9082     \expandafter\global\expandafter\let\expandafter\thisrefX
9083       \csname XR#1\endcsname
9084   }%
9085   \ifx\thisrefX\relax
9086     % If not defined, say something at least.
9087     \angleleft un\-de\-fined\angleright
9088     \iflinks
9089       \ifhavexrefs
9090         {\toks0 = {#1}% avoid expansion of possibly-complex value
9091          \message{\linenumber Undefined cross reference `\the\toks0'.}}%
9092       \else
9093         \ifwarnedxrefs\else
9094           \global\warnedxrefstrue
9095           \message{Cross reference values unknown; you must run TeX again.}%
9096         \fi
9097       \fi
9098     \fi
9099   \else
9100     % It's defined, so just use it.
9101     \thisrefX
9102   \fi
9103   #2% Output the suffix in any case.
9104 }
9105
9106 % This is the macro invoked by entries in the aux file.  Define a control 
9107 % sequence for a cross-reference target (we prepend XR to the control sequence 
9108 % name to avoid collisions).  The value is the page number.  If this is a float 
9109 % type, we have more work to do.
9110 %
9111 \def\xrdef#1#2{%
9112   {% Expand the node or anchor name to remove control sequences.
9113    % \turnoffactive stops 8-bit characters being changed to commands
9114    % like @'e.  \refx does the same to retrieve the value in the definition.
9115     \indexnofonts
9116     \turnoffactive
9117     \def\value##1{##1}%
9118     \xdef\safexrefname{#1}%
9119   }%
9120   %
9121   \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
9122   %
9123   % Was that xref control sequence that we just defined for a float?
9124   \expandafter\iffloat\csname XR\safexrefname\endcsname
9125     % it was a float, and we have the (safe) float type in \iffloattype.
9126     \expandafter\let\expandafter\floatlist
9127       \csname floatlist\iffloattype\endcsname
9128     %
9129     % Is this the first time we've seen this float type?
9130     \expandafter\ifx\floatlist\relax
9131       \toks0 = {\do}% yes, so just \do
9132     \else
9133       % had it before, so preserve previous elements in list.
9134       \toks0 = \expandafter{\floatlist\do}%
9135     \fi
9136     %
9137     % Remember this xref in the control sequence \floatlistFLOATTYPE,
9138     % for later use in \listoffloats.
9139     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
9140       {\safexrefname}}%
9141   \fi
9142 }
9143
9144 % If working on a large document in chapters, it is convenient to
9145 % be able to disable indexing, cross-referencing, and contents, for test runs.
9146 % This is done with @novalidate at the beginning of the file.
9147 %
9148 \newif\iflinks \linkstrue % by default we want the aux files.
9149 \let\novalidate = \linksfalse
9150
9151 % Used when writing to the aux file, or when using data from it.
9152 \def\requireauxfile{%
9153   \iflinks
9154     \tryauxfile
9155     % Open the new aux file.  TeX will close it automatically at exit.
9156     \immediate\openout\auxfile=\jobname.aux
9157   \fi
9158   \global\let\requireauxfile=\relax   % Only do this once.
9159 }
9160
9161 % Read the last existing aux file, if any.  No error if none exists.
9162 %
9163 \def\tryauxfile{%
9164   \openin 1 \jobname.aux
9165   \ifeof 1 \else
9166     \readdatafile{aux}%
9167     \global\havexrefstrue
9168   \fi
9169   \closein 1
9170 }
9171
9172 \def\setupdatafile{%
9173   \catcode`\^^@=\other
9174   \catcode`\^^A=\other
9175   \catcode`\^^B=\other
9176   \catcode`\^^C=\other
9177   \catcode`\^^D=\other
9178   \catcode`\^^E=\other
9179   \catcode`\^^F=\other
9180   \catcode`\^^G=\other
9181   \catcode`\^^H=\other
9182   \catcode`\^^K=\other
9183   \catcode`\^^L=\other
9184   \catcode`\^^N=\other
9185   \catcode`\^^P=\other
9186   \catcode`\^^Q=\other
9187   \catcode`\^^R=\other
9188   \catcode`\^^S=\other
9189   \catcode`\^^T=\other
9190   \catcode`\^^U=\other
9191   \catcode`\^^V=\other
9192   \catcode`\^^W=\other
9193   \catcode`\^^X=\other
9194   \catcode`\^^Z=\other
9195   \catcode`\^^[=\other
9196   \catcode`\^^\=\other
9197   \catcode`\^^]=\other
9198   \catcode`\^^^=\other
9199   \catcode`\^^_=\other
9200   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
9201   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
9202   % supported in the main text, it doesn't seem desirable.  Furthermore,
9203   % that is not enough: for node names that actually contain a ^
9204   % character, we would end up writing a line like this: 'xrdef {'hat
9205   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
9206   % argument, and \hat is not an expandable control sequence.  It could
9207   % all be worked out, but why?  Either we support ^^ or we don't.
9208   %
9209   % The other change necessary for this was to define \auxhat:
9210   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
9211   % and then to call \auxhat in \setq.
9212   %
9213   \catcode`\^=\other
9214   %
9215   % Special characters.  Should be turned off anyway, but...
9216   \catcode`\~=\other
9217   \catcode`\[=\other
9218   \catcode`\]=\other
9219   \catcode`\"=\other
9220   \catcode`\_=\other
9221   \catcode`\|=\other
9222   \catcode`\<=\other
9223   \catcode`\>=\other
9224   \catcode`\$=\other
9225   \catcode`\#=\other
9226   \catcode`\&=\other
9227   \catcode`\%=\other
9228   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
9229   %
9230   % This is to support \ in node names and titles, since the \
9231   % characters end up in a \csname.  It's easier than
9232   % leaving it active and making its active definition an actual \
9233   % character.  What I don't understand is why it works in the *value*
9234   % of the xrdef.  Seems like it should be a catcode12 \, and that
9235   % should not typeset properly.  But it works, so I'm moving on for
9236   % now.  --karl, 15jan04.
9237   \catcode`\\=\other
9238   %
9239   % @ is our escape character in .aux files, and we need braces.
9240   \catcode`\{=1
9241   \catcode`\}=2
9242   \catcode`\@=0
9243 }
9244
9245 \def\readdatafile#1{%
9246 \begingroup
9247   \setupdatafile
9248   \input\jobname.#1
9249 \endgroup}
9250
9251
9252 \message{insertions,}
9253 % including footnotes.
9254
9255 \newcount \footnoteno
9256
9257 % The trailing space in the following definition for supereject is
9258 % vital for proper filling; pages come out unaligned when you do a
9259 % pagealignmacro call if that space before the closing brace is
9260 % removed. (Generally, numeric constants should always be followed by a
9261 % space to prevent strange expansion errors.)
9262 \def\supereject{\par\penalty -20000\footnoteno =0 }
9263
9264 % @footnotestyle is meaningful for Info output only.
9265 \let\footnotestyle=\comment
9266
9267 {\catcode `\@=11
9268 %
9269 % Auto-number footnotes.  Otherwise like plain.
9270 \gdef\footnote{%
9271   \global\advance\footnoteno by \@ne
9272   \edef\thisfootno{$^{\the\footnoteno}$}%
9273   %
9274   % In case the footnote comes at the end of a sentence, preserve the
9275   % extra spacing after we do the footnote number.
9276   \let\@sf\empty
9277   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
9278   %
9279   % Remove inadvertent blank space before typesetting the footnote number.
9280   \unskip
9281   \thisfootno\@sf
9282   \dofootnote
9283 }%
9284
9285 % Don't bother with the trickery in plain.tex to not require the
9286 % footnote text as a parameter.  Our footnotes don't need to be so general.
9287 %
9288 % Oh yes, they do; otherwise, @ifset (and anything else that uses
9289 % \parseargline) fails inside footnotes because the tokens are fixed when
9290 % the footnote is read.  --karl, 16nov96.
9291 %
9292 \gdef\dofootnote{%
9293   \insert\footins\bgroup
9294   %
9295   % Nested footnotes are not supported in TeX, that would take a lot
9296   % more work.  (\startsavinginserts does not suffice.)
9297   \let\footnote=\errfootnotenest
9298   %
9299   % We want to typeset this text as a normal paragraph, even if the
9300   % footnote reference occurs in (for example) a display environment.
9301   % So reset some parameters.
9302   \hsize=\txipagewidth
9303   \interlinepenalty\interfootnotelinepenalty
9304   \splittopskip\ht\strutbox % top baseline for broken footnotes
9305   \splitmaxdepth\dp\strutbox
9306   \floatingpenalty\@MM
9307   \leftskip\z@skip
9308   \rightskip\z@skip
9309   \spaceskip\z@skip
9310   \xspaceskip\z@skip
9311   \parindent\defaultparindent
9312   %
9313   \smallfonts \rm
9314   %
9315   % Because we use hanging indentation in footnotes, a @noindent appears
9316   % to exdent this text, so make it be a no-op.  makeinfo does not use
9317   % hanging indentation so @noindent can still be needed within footnote
9318   % text after an @example or the like (not that this is good style).
9319   \let\noindent = \relax
9320   %
9321   % Hang the footnote text off the number.  Use \everypar in case the
9322   % footnote extends for more than one paragraph.
9323   \everypar = {\hang}%
9324   \textindent{\thisfootno}%
9325   %
9326   % Don't crash into the line above the footnote text.  Since this
9327   % expands into a box, it must come within the paragraph, lest it
9328   % provide a place where TeX can split the footnote.
9329   \footstrut
9330   %
9331   % Invoke rest of plain TeX footnote routine.
9332   \futurelet\next\fo@t
9333 }
9334 }%end \catcode `\@=11
9335
9336 \def\errfootnotenest{%
9337   \errhelp=\EMsimple
9338   \errmessage{Nested footnotes not supported in texinfo.tex,
9339     even though they work in makeinfo; sorry}
9340 }
9341
9342 \def\errfootnoteheading{%
9343   \errhelp=\EMsimple
9344   \errmessage{Footnotes in chapters, sections, etc., are not supported}
9345 }
9346
9347 % In case a @footnote appears in a vbox, save the footnote text and create
9348 % the real \insert just after the vbox finished.  Otherwise, the insertion
9349 % would be lost.
9350 % Similarly, if a @footnote appears inside an alignment, save the footnote
9351 % text to a box and make the \insert when a row of the table is finished.
9352 % And the same can be done for other insert classes.  --kasal, 16nov03.
9353 %
9354 % Replace the \insert primitive by a cheating macro.
9355 % Deeper inside, just make sure that the saved insertions are not spilled
9356 % out prematurely.
9357 %
9358 \def\startsavinginserts{%
9359   \ifx \insert\ptexinsert
9360     \let\insert\saveinsert
9361   \else
9362     \let\checkinserts\relax
9363   \fi
9364 }
9365
9366 % This \insert replacement works for both \insert\footins{foo} and
9367 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
9368 %
9369 \def\saveinsert#1{%
9370   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
9371   \afterassignment\next
9372   % swallow the left brace
9373   \let\temp =
9374 }
9375 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
9376 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
9377
9378 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
9379
9380 \def\placesaveins#1{%
9381   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
9382     {\box#1}%
9383 }
9384
9385 % eat @SAVE -- beware, all of them have catcode \other:
9386 {
9387   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
9388   \gdef\gobblesave @SAVE{}
9389 }
9390
9391 % initialization:
9392 \def\newsaveins #1{%
9393   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
9394   \next
9395 }
9396 \def\newsaveinsX #1{%
9397   \csname newbox\endcsname #1%
9398   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
9399     \checksaveins #1}%
9400 }
9401
9402 % initialize:
9403 \let\checkinserts\empty
9404 \newsaveins\footins
9405 \newsaveins\margin
9406
9407
9408 % @image.  We use the macros from epsf.tex to support this.
9409 % If epsf.tex is not installed and @image is used, we complain.
9410 %
9411 % Check for and read epsf.tex up front.  If we read it only at @image
9412 % time, we might be inside a group, and then its definitions would get
9413 % undone and the next image would fail.
9414 \openin 1 = epsf.tex
9415 \ifeof 1 \else
9416   % Do not bother showing banner with epsf.tex v2.7k (available in
9417   % doc/epsf.tex and on ctan).
9418   \def\epsfannounce{\toks0 = }%
9419   \input epsf.tex
9420 \fi
9421 \closein 1
9422 %
9423 % We will only complain once about lack of epsf.tex.
9424 \newif\ifwarnednoepsf
9425 \newhelp\noepsfhelp{epsf.tex must be installed for images to
9426   work.  It is also included in the Texinfo distribution, or you can get
9427   it from ftp://tug.org/tex/epsf.tex.}
9428 %
9429 \def\image#1{%
9430   \ifx\epsfbox\thisisundefined
9431     \ifwarnednoepsf \else
9432       \errhelp = \noepsfhelp
9433       \errmessage{epsf.tex not found, images will be ignored}%
9434       \global\warnednoepsftrue
9435     \fi
9436   \else
9437     \imagexxx #1,,,,,\finish
9438   \fi
9439 }
9440 %
9441 % Arguments to @image:
9442 % #1 is (mandatory) image filename; we tack on .eps extension.
9443 % #2 is (optional) width, #3 is (optional) height.
9444 % #4 is (ignored optional) html alt text.
9445 % #5 is (ignored optional) extension.
9446 % #6 is just the usual extra ignored arg for parsing stuff.
9447 \newif\ifimagevmode
9448 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
9449   \catcode`\^^M = 5     % in case we're inside an example
9450   \normalturnoffactive  % allow _ et al. in names
9451   \def\xprocessmacroarg{\eatspaces}% in case we are being used via a macro
9452   % If the image is by itself, center it.
9453   \ifvmode
9454     \imagevmodetrue
9455   \else \ifx\centersub\centerV
9456     % for @center @image, we need a vbox so we can have our vertical space
9457     \imagevmodetrue
9458     \vbox\bgroup % vbox has better behavior than vtop herev
9459   \fi\fi
9460   %
9461   \ifimagevmode
9462     \nobreak\medskip
9463     % Usually we'll have text after the image which will insert
9464     % \parskip glue, so insert it here too to equalize the space
9465     % above and below.
9466     \nobreak\vskip\parskip
9467     \nobreak
9468   \fi
9469   %
9470   % Leave vertical mode so that indentation from an enclosing
9471   %  environment such as @quotation is respected.
9472   % However, if we're at the top level, we don't want the
9473   %  normal paragraph indentation.
9474   % On the other hand, if we are in the case of @center @image, we don't
9475   %  want to start a paragraph, which will create a hsize-width box and
9476   %  eradicate the centering.
9477   \ifx\centersub\centerV\else \noindent \fi
9478   %
9479   % Output the image.
9480   \ifpdf
9481     % For pdfTeX and LuaTeX <= 0.80
9482     \dopdfimage{#1}{#2}{#3}%
9483   \else
9484     \ifx\XeTeXrevision\thisisundefined
9485       % For epsf.tex
9486       % \epsfbox itself resets \epsf?size at each figure.
9487       \setbox0 = \hbox{\ignorespaces #2}%
9488         \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
9489       \setbox0 = \hbox{\ignorespaces #3}%
9490         \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
9491       \epsfbox{#1.eps}%
9492     \else
9493       % For XeTeX
9494       \doxeteximage{#1}{#2}{#3}%
9495     \fi
9496   \fi
9497   %
9498   \ifimagevmode
9499     \medskip  % space after a standalone image
9500   \fi  
9501   \ifx\centersub\centerV \egroup \fi
9502 \endgroup}
9503
9504
9505 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
9506 % etc.  We don't actually implement floating yet, we always include the
9507 % float "here".  But it seemed the best name for the future.
9508 %
9509 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
9510
9511 % There may be a space before second and/or third parameter; delete it.
9512 \def\eatcommaspace#1, {#1,}
9513
9514 % #1 is the optional FLOATTYPE, the text label for this float, typically
9515 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
9516 % this float will not be numbered and cannot be referred to.
9517 %
9518 % #2 is the optional xref label.  Also must be present for the float to
9519 % be referable.
9520 %
9521 % #3 is the optional positioning argument; for now, it is ignored.  It
9522 % will somehow specify the positions allowed to float to (here, top, bottom).
9523 %
9524 % We keep a separate counter for each FLOATTYPE, which we reset at each
9525 % chapter-level command.
9526 \let\resetallfloatnos=\empty
9527 %
9528 \def\dofloat#1,#2,#3,#4\finish{%
9529   \let\thiscaption=\empty
9530   \let\thisshortcaption=\empty
9531   %
9532   % don't lose footnotes inside @float.
9533   %
9534   % BEWARE: when the floats start float, we have to issue warning whenever an
9535   % insert appears inside a float which could possibly float. --kasal, 26may04
9536   %
9537   \startsavinginserts
9538   %
9539   % We can't be used inside a paragraph.
9540   \par
9541   %
9542   \vtop\bgroup
9543     \def\floattype{#1}%
9544     \def\floatlabel{#2}%
9545     \def\floatloc{#3}% we do nothing with this yet.
9546     %
9547     \ifx\floattype\empty
9548       \let\safefloattype=\empty
9549     \else
9550       {%
9551         % the floattype might have accents or other special characters,
9552         % but we need to use it in a control sequence name.
9553         \indexnofonts
9554         \turnoffactive
9555         \xdef\safefloattype{\floattype}%
9556       }%
9557     \fi
9558     %
9559     % If label is given but no type, we handle that as the empty type.
9560     \ifx\floatlabel\empty \else
9561       % We want each FLOATTYPE to be numbered separately (Figure 1,
9562       % Table 1, Figure 2, ...).  (And if no label, no number.)
9563       %
9564       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
9565       \global\advance\floatno by 1
9566       %
9567       {%
9568         % This magic value for \lastsection is output by \setref as the
9569         % XREFLABEL-title value.  \xrefX uses it to distinguish float
9570         % labels (which have a completely different output format) from
9571         % node and anchor labels.  And \xrdef uses it to construct the
9572         % lists of floats.
9573         %
9574         \edef\lastsection{\floatmagic=\safefloattype}%
9575         \setref{\floatlabel}{Yfloat}%
9576       }%
9577     \fi
9578     %
9579     % start with \parskip glue, I guess.
9580     \vskip\parskip
9581     %
9582     % Don't suppress indentation if a float happens to start a section.
9583     \restorefirstparagraphindent
9584 }
9585
9586 % we have these possibilities:
9587 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
9588 % @float Foo,lbl & no caption:    Foo 1.1
9589 % @float Foo & @caption{Cap}:     Foo: Cap
9590 % @float Foo & no caption:        Foo
9591 % @float ,lbl & Caption{Cap}:     1.1: Cap
9592 % @float ,lbl & no caption:       1.1
9593 % @float & @caption{Cap}:         Cap
9594 % @float & no caption:
9595 %
9596 \def\Efloat{%
9597     \let\floatident = \empty
9598     %
9599     % In all cases, if we have a float type, it comes first.
9600     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
9601     %
9602     % If we have an xref label, the number comes next.
9603     \ifx\floatlabel\empty \else
9604       \ifx\floattype\empty \else % if also had float type, need tie first.
9605         \appendtomacro\floatident{\tie}%
9606       \fi
9607       % the number.
9608       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
9609     \fi
9610     %
9611     % Start the printed caption with what we've constructed in
9612     % \floatident, but keep it separate; we need \floatident again.
9613     \let\captionline = \floatident
9614     %
9615     \ifx\thiscaption\empty \else
9616       \ifx\floatident\empty \else
9617         \appendtomacro\captionline{: }% had ident, so need a colon between
9618       \fi
9619       %
9620       % caption text.
9621       \appendtomacro\captionline{\scanexp\thiscaption}%
9622     \fi
9623     %
9624     % If we have anything to print, print it, with space before.
9625     % Eventually this needs to become an \insert.
9626     \ifx\captionline\empty \else
9627       \vskip.5\parskip
9628       \captionline
9629       %
9630       % Space below caption.
9631       \vskip\parskip
9632     \fi
9633     %
9634     % If have an xref label, write the list of floats info.  Do this
9635     % after the caption, to avoid chance of it being a breakpoint.
9636     \ifx\floatlabel\empty \else
9637       % Write the text that goes in the lof to the aux file as
9638       % \floatlabel-lof.  Besides \floatident, we include the short
9639       % caption if specified, else the full caption if specified, else nothing.
9640       {%
9641         \requireauxfile
9642         \atdummies
9643         %
9644         \ifx\thisshortcaption\empty
9645           \def\gtemp{\thiscaption}%
9646         \else
9647           \def\gtemp{\thisshortcaption}%
9648         \fi
9649         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
9650           \ifx\gtemp\empty \else : \gtemp \fi}}%
9651       }%
9652     \fi
9653   \egroup  % end of \vtop
9654   %
9655   \checkinserts
9656 }
9657
9658 % Append the tokens #2 to the definition of macro #1, not expanding either.
9659 %
9660 \def\appendtomacro#1#2{%
9661   \expandafter\def\expandafter#1\expandafter{#1#2}%
9662 }
9663
9664 % @caption, @shortcaption
9665 %
9666 \def\caption{\docaption\thiscaption}
9667 \def\shortcaption{\docaption\thisshortcaption}
9668 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
9669 \def\defcaption#1#2{\egroup \def#1{#2}}
9670
9671 % The parameter is the control sequence identifying the counter we are
9672 % going to use.  Create it if it doesn't exist and assign it to \floatno.
9673 \def\getfloatno#1{%
9674   \ifx#1\relax
9675       % Haven't seen this figure type before.
9676       \csname newcount\endcsname #1%
9677       %
9678       % Remember to reset this floatno at the next chap.
9679       \expandafter\gdef\expandafter\resetallfloatnos
9680         \expandafter{\resetallfloatnos #1=0 }%
9681   \fi
9682   \let\floatno#1%
9683 }
9684
9685 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
9686 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
9687 % first read the @float command.
9688 %
9689 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
9690
9691 % Magic string used for the XREFLABEL-title value, so \xrefX can
9692 % distinguish floats from other xref types.
9693 \def\floatmagic{!!float!!}
9694
9695 % #1 is the control sequence we are passed; we expand into a conditional
9696 % which is true if #1 represents a float ref.  That is, the magic
9697 % \lastsection value which we \setref above.
9698 %
9699 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
9700 %
9701 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
9702 % (safe) float type for this float.  We set \iffloattype to #2.
9703 %
9704 \def\doiffloat#1=#2=#3\finish{%
9705   \def\temp{#1}%
9706   \def\iffloattype{#2}%
9707   \ifx\temp\floatmagic
9708 }
9709
9710 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9711 %
9712 \parseargdef\listoffloats{%
9713   \def\floattype{#1}% floattype
9714   {%
9715     % the floattype might have accents or other special characters,
9716     % but we need to use it in a control sequence name.
9717     \indexnofonts
9718     \turnoffactive
9719     \xdef\safefloattype{\floattype}%
9720   }%
9721   %
9722   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9723   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
9724     \ifhavexrefs
9725       % if the user said @listoffloats foo but never @float foo.
9726       \message{\linenumber No `\safefloattype' floats to list.}%
9727     \fi
9728   \else
9729     \begingroup
9730       \leftskip=\tocindent  % indent these entries like a toc
9731       \let\do=\listoffloatsdo
9732       \csname floatlist\safefloattype\endcsname
9733     \endgroup
9734   \fi
9735 }
9736
9737 % This is called on each entry in a list of floats.  We're passed the
9738 % xref label, in the form LABEL-title, which is how we save it in the
9739 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
9740 % has the text we're supposed to typeset here.
9741 %
9742 % Figures without xref labels will not be included in the list (since
9743 % they won't appear in the aux file).
9744 %
9745 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
9746 \def\listoffloatsdoentry#1-title\finish{{%
9747   % Can't fully expand XR#1-lof because it can contain anything.  Just
9748   % pass the control sequence.  On the other hand, XR#1-pg is just the
9749   % page number, and we want to fully expand that so we can get a link
9750   % in pdf output.
9751   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
9752   %
9753   % use the same \entry macro we use to generate the TOC and index.
9754   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
9755   \writeentry
9756 }}
9757
9758
9759 \message{localization,}
9760
9761 % For single-language documents, @documentlanguage is usually given very
9762 % early, just after @documentencoding.  Single argument is the language
9763 % (de) or locale (de_DE) abbreviation.
9764 %
9765 {
9766   \catcode`\_ = \active
9767   \globaldefs=1
9768 \parseargdef\documentlanguage{%
9769   \tex % read txi-??.tex file in plain TeX.
9770     % Read the file by the name they passed if it exists.
9771     \let_ = \normalunderscore  % normal _ character for filename test
9772     \openin 1 txi-#1.tex
9773     \ifeof 1
9774       \documentlanguagetrywithoutunderscore #1_\finish
9775     \else
9776       \globaldefs = 1  % everything in the txi-LL files needs to persist
9777       \input txi-#1.tex
9778     \fi
9779     \closein 1
9780   \endgroup % end raw TeX
9781 }
9782 %
9783 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9784 % try txi-de.tex.
9785 %
9786 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
9787   \openin 1 txi-#1.tex
9788   \ifeof 1
9789     \errhelp = \nolanghelp
9790     \errmessage{Cannot read language file txi-#1.tex}%
9791   \else
9792     \globaldefs = 1  % everything in the txi-LL files needs to persist
9793     \input txi-#1.tex
9794   \fi
9795   \closein 1
9796 }
9797 }% end of special _ catcode
9798 %
9799 \newhelp\nolanghelp{The given language definition file cannot be found or
9800 is empty.  Maybe you need to install it?  Putting it in the current
9801 directory should work if nowhere else does.}
9802
9803 % This macro is called from txi-??.tex files; the first argument is the
9804 % \language name to set (without the "\lang@" prefix), the second and
9805 % third args are \{left,right}hyphenmin.
9806 %
9807 % The language names to pass are determined when the format is built.
9808 % See the etex.log file created at that time, e.g.,
9809 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9810 %
9811 % With TeX Live 2008, etex now includes hyphenation patterns for all
9812 % available languages.  This means we can support hyphenation in
9813 % Texinfo, at least to some extent.  (This still doesn't solve the
9814 % accented characters problem.)
9815 %
9816 \catcode`@=11
9817 \def\txisetlanguage#1#2#3{%
9818   % do not set the language if the name is undefined in the current TeX.
9819   \expandafter\ifx\csname lang@#1\endcsname \relax
9820     \message{no patterns for #1}%
9821   \else
9822     \global\language = \csname lang@#1\endcsname
9823   \fi
9824   % but there is no harm in adjusting the hyphenmin values regardless.
9825   \global\lefthyphenmin = #2\relax
9826   \global\righthyphenmin = #3\relax
9827 }
9828
9829 % XeTeX and LuaTeX can handle Unicode natively.
9830 % Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
9831 % Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
9832 %
9833 \newif\iftxinativeunicodecapable
9834 \newif\iftxiusebytewiseio
9835
9836 \ifx\XeTeXrevision\thisisundefined
9837   \ifx\luatexversion\thisisundefined
9838     \txinativeunicodecapablefalse
9839     \txiusebytewiseiotrue
9840   \else
9841     \txinativeunicodecapabletrue
9842     \txiusebytewiseiofalse
9843   \fi
9844 \else
9845   \txinativeunicodecapabletrue
9846   \txiusebytewiseiofalse
9847 \fi
9848
9849 % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
9850 % for non-UTF-8 (byte-wise) encodings.
9851 %
9852 \def\setbytewiseio{%
9853   \ifx\XeTeXrevision\thisisundefined
9854   \else
9855     \XeTeXdefaultencoding "bytes"  % For subsequent files to be read
9856     \XeTeXinputencoding "bytes"  % For document root file
9857     % Unfortunately, there seems to be no corresponding XeTeX command for
9858     % output encoding.  This is a problem for auxiliary index and TOC files.
9859     % The only solution would be perhaps to write out @U{...} sequences in
9860     % place of non-ASCII characters.
9861   \fi
9862
9863   \ifx\luatexversion\thisisundefined
9864   \else
9865     \directlua{
9866     local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
9867     local function convert_char (char)
9868       return utf8_char(byte(char))
9869     end
9870
9871     local function convert_line (line)
9872       return gsub(line, ".", convert_char)
9873     end
9874
9875     callback.register("process_input_buffer", convert_line)
9876
9877     local function convert_line_out (line)
9878       local line_out = ""
9879       for c in string.utfvalues(line) do
9880          line_out = line_out .. string.char(c)
9881       end
9882       return line_out
9883     end
9884
9885     callback.register("process_output_buffer", convert_line_out)
9886     }
9887   \fi
9888
9889   \txiusebytewiseiotrue
9890 }
9891
9892
9893 % Helpers for encodings.
9894 % Set the catcode of characters 128 through 255 to the specified number.
9895 %
9896 \def\setnonasciicharscatcode#1{%
9897    \count255=128
9898    \loop\ifnum\count255<256
9899       \global\catcode\count255=#1\relax
9900       \advance\count255 by 1
9901    \repeat
9902 }
9903
9904 \def\setnonasciicharscatcodenonglobal#1{%
9905    \count255=128
9906    \loop\ifnum\count255<256
9907       \catcode\count255=#1\relax
9908       \advance\count255 by 1
9909    \repeat
9910 }
9911
9912 % @documentencoding sets the definition of non-ASCII characters
9913 % according to the specified encoding.
9914 %
9915 \def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
9916 \def\documentencodingzzz#1{%
9917   %
9918   % Encoding being declared for the document.
9919   \def\declaredencoding{\csname #1.enc\endcsname}%
9920   %
9921   % Supported encodings: names converted to tokens in order to be able
9922   % to compare them with \ifx.
9923   \def\ascii{\csname US-ASCII.enc\endcsname}%
9924   \def\latnine{\csname ISO-8859-15.enc\endcsname}%
9925   \def\latone{\csname ISO-8859-1.enc\endcsname}%
9926   \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
9927   \def\utfeight{\csname UTF-8.enc\endcsname}%
9928   %
9929   \ifx \declaredencoding \ascii
9930      \asciichardefs
9931   %
9932   \else \ifx \declaredencoding \lattwo
9933      \iftxinativeunicodecapable
9934        \setbytewiseio
9935      \fi
9936      \setnonasciicharscatcode\active
9937      \lattwochardefs
9938   %
9939   \else \ifx \declaredencoding \latone
9940      \iftxinativeunicodecapable
9941        \setbytewiseio
9942      \fi
9943      \setnonasciicharscatcode\active
9944      \latonechardefs
9945   %
9946   \else \ifx \declaredencoding \latnine
9947      \iftxinativeunicodecapable
9948        \setbytewiseio
9949      \fi
9950      \setnonasciicharscatcode\active
9951      \latninechardefs
9952   %
9953   \else \ifx \declaredencoding \utfeight
9954      \iftxinativeunicodecapable
9955        % For native Unicode handling (XeTeX and LuaTeX)
9956        \nativeunicodechardefs
9957      \else
9958        % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX)
9959        \setnonasciicharscatcode\active
9960        % since we already invoked \utfeightchardefs at the top level
9961        % (below), do not re-invoke it, otherwise our check for duplicated
9962        % definitions gets triggered.  Making non-ascii chars active is
9963        % sufficient.
9964      \fi
9965   %
9966   \else
9967     \message{Ignoring unknown document encoding: #1.}%
9968   %
9969   \fi % utfeight
9970   \fi % latnine
9971   \fi % latone
9972   \fi % lattwo
9973   \fi % ascii
9974   %
9975   \ifx\XeTeXrevision\thisisundefined
9976   \else
9977     \ifx \declaredencoding \utfeight
9978     \else
9979       \ifx \declaredencoding \ascii
9980       \else
9981         \message{Warning: XeTeX with non-UTF-8 encodings cannot handle %
9982         non-ASCII characters in auxiliary files.}%
9983       \fi
9984     \fi
9985   \fi
9986 }
9987
9988 % emacs-page
9989 % A message to be logged when using a character that isn't available
9990 % the default font encoding (OT1).
9991 %
9992 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9993
9994 % Take account of \c (plain) vs. \, (Texinfo) difference.
9995 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9996
9997 % First, make active non-ASCII characters in order for them to be
9998 % correctly categorized when TeX reads the replacement text of
9999 % macros containing the character definitions.
10000 \setnonasciicharscatcode\active
10001 %
10002
10003 \def\gdefchar#1#2{%
10004 \gdef#1{%
10005    \ifpassthroughchars
10006      \string#1%
10007    \else
10008      #2%
10009    \fi
10010 }}
10011
10012 % Latin1 (ISO-8859-1) character definitions.
10013 \def\latonechardefs{%
10014   \gdefchar^^a0{\tie}
10015   \gdefchar^^a1{\exclamdown}
10016   \gdefchar^^a2{{\tcfont \char162}} % cent
10017   \gdefchar^^a3{\pounds{}}
10018   \gdefchar^^a4{{\tcfont \char164}} % currency
10019   \gdefchar^^a5{{\tcfont \char165}} % yen
10020   \gdefchar^^a6{{\tcfont \char166}} % broken bar
10021   \gdefchar^^a7{\S}
10022   \gdefchar^^a8{\"{}}
10023   \gdefchar^^a9{\copyright{}}
10024   \gdefchar^^aa{\ordf}
10025   \gdefchar^^ab{\guillemetleft{}}
10026   \gdefchar^^ac{\ensuremath\lnot}
10027   \gdefchar^^ad{\-}
10028   \gdefchar^^ae{\registeredsymbol{}}
10029   \gdefchar^^af{\={}}
10030   %
10031   \gdefchar^^b0{\textdegree}
10032   \gdefchar^^b1{$\pm$}
10033   \gdefchar^^b2{$^2$}
10034   \gdefchar^^b3{$^3$}
10035   \gdefchar^^b4{\'{}}
10036   \gdefchar^^b5{$\mu$}
10037   \gdefchar^^b6{\P}
10038   \gdefchar^^b7{\ensuremath\cdot}
10039   \gdefchar^^b8{\cedilla\ }
10040   \gdefchar^^b9{$^1$}
10041   \gdefchar^^ba{\ordm}
10042   \gdefchar^^bb{\guillemetright{}}
10043   \gdefchar^^bc{$1\over4$}
10044   \gdefchar^^bd{$1\over2$}
10045   \gdefchar^^be{$3\over4$}
10046   \gdefchar^^bf{\questiondown}
10047   %
10048   \gdefchar^^c0{\`A}
10049   \gdefchar^^c1{\'A}
10050   \gdefchar^^c2{\^A}
10051   \gdefchar^^c3{\~A}
10052   \gdefchar^^c4{\"A}
10053   \gdefchar^^c5{\ringaccent A}
10054   \gdefchar^^c6{\AE}
10055   \gdefchar^^c7{\cedilla C}
10056   \gdefchar^^c8{\`E}
10057   \gdefchar^^c9{\'E}
10058   \gdefchar^^ca{\^E}
10059   \gdefchar^^cb{\"E}
10060   \gdefchar^^cc{\`I}
10061   \gdefchar^^cd{\'I}
10062   \gdefchar^^ce{\^I}
10063   \gdefchar^^cf{\"I}
10064   %
10065   \gdefchar^^d0{\DH}
10066   \gdefchar^^d1{\~N}
10067   \gdefchar^^d2{\`O}
10068   \gdefchar^^d3{\'O}
10069   \gdefchar^^d4{\^O}
10070   \gdefchar^^d5{\~O}
10071   \gdefchar^^d6{\"O}
10072   \gdefchar^^d7{$\times$}
10073   \gdefchar^^d8{\O}
10074   \gdefchar^^d9{\`U}
10075   \gdefchar^^da{\'U}
10076   \gdefchar^^db{\^U}
10077   \gdefchar^^dc{\"U}
10078   \gdefchar^^dd{\'Y}
10079   \gdefchar^^de{\TH}
10080   \gdefchar^^df{\ss}
10081   %
10082   \gdefchar^^e0{\`a}
10083   \gdefchar^^e1{\'a}
10084   \gdefchar^^e2{\^a}
10085   \gdefchar^^e3{\~a}
10086   \gdefchar^^e4{\"a}
10087   \gdefchar^^e5{\ringaccent a}
10088   \gdefchar^^e6{\ae}
10089   \gdefchar^^e7{\cedilla c}
10090   \gdefchar^^e8{\`e}
10091   \gdefchar^^e9{\'e}
10092   \gdefchar^^ea{\^e}
10093   \gdefchar^^eb{\"e}
10094   \gdefchar^^ec{\`{\dotless i}}
10095   \gdefchar^^ed{\'{\dotless i}}
10096   \gdefchar^^ee{\^{\dotless i}}
10097   \gdefchar^^ef{\"{\dotless i}}
10098   %
10099   \gdefchar^^f0{\dh}
10100   \gdefchar^^f1{\~n}
10101   \gdefchar^^f2{\`o}
10102   \gdefchar^^f3{\'o}
10103   \gdefchar^^f4{\^o}
10104   \gdefchar^^f5{\~o}
10105   \gdefchar^^f6{\"o}
10106   \gdefchar^^f7{$\div$}
10107   \gdefchar^^f8{\o}
10108   \gdefchar^^f9{\`u}
10109   \gdefchar^^fa{\'u}
10110   \gdefchar^^fb{\^u}
10111   \gdefchar^^fc{\"u}
10112   \gdefchar^^fd{\'y}
10113   \gdefchar^^fe{\th}
10114   \gdefchar^^ff{\"y}
10115 }
10116
10117 % Latin9 (ISO-8859-15) encoding character definitions.
10118 \def\latninechardefs{%
10119   % Encoding is almost identical to Latin1.
10120   \latonechardefs
10121   %
10122   \gdefchar^^a4{\euro{}}
10123   \gdefchar^^a6{\v S}
10124   \gdefchar^^a8{\v s}
10125   \gdefchar^^b4{\v Z}
10126   \gdefchar^^b8{\v z}
10127   \gdefchar^^bc{\OE}
10128   \gdefchar^^bd{\oe}
10129   \gdefchar^^be{\"Y}
10130 }
10131
10132 % Latin2 (ISO-8859-2) character definitions.
10133 \def\lattwochardefs{%
10134   \gdefchar^^a0{\tie}
10135   \gdefchar^^a1{\ogonek{A}}
10136   \gdefchar^^a2{\u{}}
10137   \gdefchar^^a3{\L}
10138   \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
10139   \gdefchar^^a5{\v L}
10140   \gdefchar^^a6{\'S}
10141   \gdefchar^^a7{\S}
10142   \gdefchar^^a8{\"{}}
10143   \gdefchar^^a9{\v S}
10144   \gdefchar^^aa{\cedilla S}
10145   \gdefchar^^ab{\v T}
10146   \gdefchar^^ac{\'Z}
10147   \gdefchar^^ad{\-}
10148   \gdefchar^^ae{\v Z}
10149   \gdefchar^^af{\dotaccent Z}
10150   %
10151   \gdefchar^^b0{\textdegree{}}
10152   \gdefchar^^b1{\ogonek{a}}
10153   \gdefchar^^b2{\ogonek{ }}
10154   \gdefchar^^b3{\l}
10155   \gdefchar^^b4{\'{}}
10156   \gdefchar^^b5{\v l}
10157   \gdefchar^^b6{\'s}
10158   \gdefchar^^b7{\v{}}
10159   \gdefchar^^b8{\cedilla\ }
10160   \gdefchar^^b9{\v s}
10161   \gdefchar^^ba{\cedilla s}
10162   \gdefchar^^bb{\v t}
10163   \gdefchar^^bc{\'z}
10164   \gdefchar^^bd{\H{}}
10165   \gdefchar^^be{\v z}
10166   \gdefchar^^bf{\dotaccent z}
10167   %
10168   \gdefchar^^c0{\'R}
10169   \gdefchar^^c1{\'A}
10170   \gdefchar^^c2{\^A}
10171   \gdefchar^^c3{\u A}
10172   \gdefchar^^c4{\"A}
10173   \gdefchar^^c5{\'L}
10174   \gdefchar^^c6{\'C}
10175   \gdefchar^^c7{\cedilla C}
10176   \gdefchar^^c8{\v C}
10177   \gdefchar^^c9{\'E}
10178   \gdefchar^^ca{\ogonek{E}}
10179   \gdefchar^^cb{\"E}
10180   \gdefchar^^cc{\v E}
10181   \gdefchar^^cd{\'I}
10182   \gdefchar^^ce{\^I}
10183   \gdefchar^^cf{\v D}
10184   %
10185   \gdefchar^^d0{\DH}
10186   \gdefchar^^d1{\'N}
10187   \gdefchar^^d2{\v N}
10188   \gdefchar^^d3{\'O}
10189   \gdefchar^^d4{\^O}
10190   \gdefchar^^d5{\H O}
10191   \gdefchar^^d6{\"O}
10192   \gdefchar^^d7{$\times$}
10193   \gdefchar^^d8{\v R}
10194   \gdefchar^^d9{\ringaccent U}
10195   \gdefchar^^da{\'U}
10196   \gdefchar^^db{\H U}
10197   \gdefchar^^dc{\"U}
10198   \gdefchar^^dd{\'Y}
10199   \gdefchar^^de{\cedilla T}
10200   \gdefchar^^df{\ss}
10201   %
10202   \gdefchar^^e0{\'r}
10203   \gdefchar^^e1{\'a}
10204   \gdefchar^^e2{\^a}
10205   \gdefchar^^e3{\u a}
10206   \gdefchar^^e4{\"a}
10207   \gdefchar^^e5{\'l}
10208   \gdefchar^^e6{\'c}
10209   \gdefchar^^e7{\cedilla c}
10210   \gdefchar^^e8{\v c}
10211   \gdefchar^^e9{\'e}
10212   \gdefchar^^ea{\ogonek{e}}
10213   \gdefchar^^eb{\"e}
10214   \gdefchar^^ec{\v e}
10215   \gdefchar^^ed{\'{\dotless{i}}}
10216   \gdefchar^^ee{\^{\dotless{i}}}
10217   \gdefchar^^ef{\v d}
10218   %
10219   \gdefchar^^f0{\dh}
10220   \gdefchar^^f1{\'n}
10221   \gdefchar^^f2{\v n}
10222   \gdefchar^^f3{\'o}
10223   \gdefchar^^f4{\^o}
10224   \gdefchar^^f5{\H o}
10225   \gdefchar^^f6{\"o}
10226   \gdefchar^^f7{$\div$}
10227   \gdefchar^^f8{\v r}
10228   \gdefchar^^f9{\ringaccent u}
10229   \gdefchar^^fa{\'u}
10230   \gdefchar^^fb{\H u}
10231   \gdefchar^^fc{\"u}
10232   \gdefchar^^fd{\'y}
10233   \gdefchar^^fe{\cedilla t}
10234   \gdefchar^^ff{\dotaccent{}}
10235 }
10236
10237 % UTF-8 character definitions.
10238 %
10239 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
10240 % changes for Texinfo conventions.  It is included here under the GPL by
10241 % permission from Frank Mittelbach and the LaTeX team.
10242 %
10243 \newcount\countUTFx
10244 \newcount\countUTFy
10245 \newcount\countUTFz
10246
10247 \gdef\UTFviiiTwoOctets#1#2{\expandafter
10248    \UTFviiiDefined\csname u8:#1\string #2\endcsname}
10249 %
10250 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
10251    \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
10252 %
10253 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
10254    \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
10255
10256 \gdef\UTFviiiDefined#1{%
10257   \ifx #1\relax
10258     \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
10259   \else
10260     \expandafter #1%
10261   \fi
10262 }
10263
10264 % Give non-ASCII bytes the active definitions for processing UTF-8 sequences
10265 \begingroup
10266   \catcode`\~13
10267   \catcode`\$12
10268   \catcode`\"12
10269
10270   % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
10271   % substituting ~ and $ with a character token of that value.
10272   \def\UTFviiiLoop{%
10273     \global\catcode\countUTFx\active
10274     \uccode`\~\countUTFx
10275     \uccode`\$\countUTFx
10276     \uppercase\expandafter{\UTFviiiTmp}%
10277     \advance\countUTFx by 1
10278     \ifnum\countUTFx < \countUTFy
10279       \expandafter\UTFviiiLoop
10280     \fi}
10281
10282   % For bytes other than the first in a UTF-8 sequence.  Not expected to
10283   % be expanded except when writing to auxiliary files.
10284   \countUTFx = "80
10285   \countUTFy = "C2
10286   \def\UTFviiiTmp{%
10287     \gdef~{%
10288         \ifpassthroughchars $\fi}}%
10289   \UTFviiiLoop
10290
10291   \countUTFx = "C2
10292   \countUTFy = "E0
10293   \def\UTFviiiTmp{%
10294     \gdef~{%
10295         \ifpassthroughchars $%
10296         \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
10297   \UTFviiiLoop
10298
10299   \countUTFx = "E0
10300   \countUTFy = "F0
10301   \def\UTFviiiTmp{%
10302     \gdef~{%
10303         \ifpassthroughchars $%
10304         \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
10305   \UTFviiiLoop
10306
10307   \countUTFx = "F0
10308   \countUTFy = "F4
10309   \def\UTFviiiTmp{%
10310     \gdef~{%
10311         \ifpassthroughchars $%
10312         \else\expandafter\UTFviiiFourOctets\expandafter$\fi
10313         }}%
10314   \UTFviiiLoop
10315 \endgroup
10316
10317 \def\globallet{\global\let} % save some \expandafter's below
10318
10319 % @U{xxxx} to produce U+xxxx, if we support it.
10320 \def\U#1{%
10321   \expandafter\ifx\csname uni:#1\endcsname \relax
10322     \iftxinativeunicodecapable
10323       % All Unicode characters can be used if native Unicode handling is
10324       % active.  However, if the font does not have the glyph,
10325       % letters are missing.
10326       \begingroup
10327         \uccode`\.="#1\relax
10328         \uppercase{.}
10329       \endgroup
10330     \else
10331       \errhelp = \EMsimple      
10332       \errmessage{Unicode character U+#1 not supported, sorry}%
10333     \fi
10334   \else
10335     \csname uni:#1\endcsname
10336   \fi
10337 }
10338
10339 % These macros are used here to construct the name of a control
10340 % sequence to be defined.
10341 \def\UTFviiiTwoOctetsName#1#2{%
10342   \csname u8:#1\string #2\endcsname}%
10343 \def\UTFviiiThreeOctetsName#1#2#3{%
10344   \csname u8:#1\string #2\string #3\endcsname}%
10345 \def\UTFviiiFourOctetsName#1#2#3#4{%
10346   \csname u8:#1\string #2\string #3\string #4\endcsname}%
10347
10348 % For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
10349 % provide a definition macro to replace a Unicode character;
10350 % this gets used by the @U command
10351 %
10352 \begingroup
10353   \catcode`\"=12
10354   \catcode`\<=12
10355   \catcode`\.=12
10356   \catcode`\,=12
10357   \catcode`\;=12
10358   \catcode`\!=12
10359   \catcode`\~=13
10360   \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
10361     \countUTFz = "#1\relax
10362     \begingroup
10363       \parseXMLCharref
10364     
10365       % Give \u8:... its definition.  The sequence of seven \expandafter's
10366       % expands after the \gdef three times, e.g.
10367       %
10368       % 1.  \UTFviiTwoOctetsName B1 B2
10369       % 2.  \csname u8:B1 \string B2 \endcsname
10370       % 3.  \u8: B1 B2  (a single control sequence token)
10371       %
10372       \expandafter\expandafter
10373       \expandafter\expandafter
10374       \expandafter\expandafter
10375       \expandafter\gdef       \UTFviiiTmp{#2}%
10376       % 
10377       \expandafter\ifx\csname uni:#1\endcsname \relax \else
10378        \message{Internal error, already defined: #1}%
10379       \fi
10380       %
10381       % define an additional control sequence for this code point.
10382       \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
10383     \endgroup}
10384   %
10385   % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
10386   % to the corresponding UTF-8 sequence.
10387   \gdef\parseXMLCharref{%
10388     \ifnum\countUTFz < "A0\relax
10389       \errhelp = \EMsimple
10390       \errmessage{Cannot define Unicode char value < 00A0}%
10391     \else\ifnum\countUTFz < "800\relax
10392       \parseUTFviiiA,%
10393       \parseUTFviiiB C\UTFviiiTwoOctetsName.,%
10394     \else\ifnum\countUTFz < "10000\relax
10395       \parseUTFviiiA;%
10396       \parseUTFviiiA,%
10397       \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}%
10398     \else
10399       \parseUTFviiiA;%
10400       \parseUTFviiiA,%
10401       \parseUTFviiiA!%
10402       \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}%
10403     \fi\fi\fi
10404   }
10405
10406   % Extract a byte from the end of the UTF-8 representation of \countUTFx.
10407   % It must be a non-initial byte in the sequence.
10408   % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
10409   % of the bytes.
10410   \gdef\parseUTFviiiA#1{%
10411     \countUTFx = \countUTFz
10412     \divide\countUTFz by 64
10413     \countUTFy = \countUTFz  % Save to be the future value of \countUTFz.
10414     \multiply\countUTFz by 64
10415     
10416     % \countUTFz is now \countUTFx with the last 5 bits cleared.  Subtract
10417     % in order to get the last five bits.
10418     \advance\countUTFx by -\countUTFz
10419
10420     % Convert this to the byte in the UTF-8 sequence.
10421     \advance\countUTFx by 128
10422     \uccode `#1\countUTFx
10423     \countUTFz = \countUTFy}
10424
10425   % Used to put a UTF-8 byte sequence into \UTFviiiTmp
10426   % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
10427   %    sequence.
10428   % #2 is one of the \UTFviii*OctetsName macros.
10429   % #3 is always a full stop (.)
10430   % #4 is a template for the other bytes in the sequence.  The values for these
10431   %    bytes is substituted in here with \uppercase using the \uccode's.
10432   \gdef\parseUTFviiiB#1#2#3#4{%
10433     \advance\countUTFz by "#10\relax
10434     \uccode `#3\countUTFz
10435     \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
10436 \endgroup
10437
10438 % For native Unicode handling (XeTeX and LuaTeX),
10439 % provide a definition macro that sets a catcode to `other' non-globally
10440 %
10441 \def\DeclareUnicodeCharacterNativeOther#1#2{%
10442   \catcode"#1=\other
10443 }
10444
10445 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
10446 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
10447 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
10448 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
10449 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
10450
10451 % Many of our renditions are less than wonderful, and all the missing
10452 % characters are available somewhere.  Loading the necessary fonts
10453 % awaits user request.  We can't truly support Unicode without
10454 % reimplementing everything that's been done in LaTeX for many years,
10455 % plus probably using luatex or xetex, and who knows what else.
10456 % We won't be doing that here in this simple file.  But we can try to at
10457 % least make most of the characters not bomb out.
10458 %
10459 \def\unicodechardefs{%
10460   \DeclareUnicodeCharacter{00A0}{\tie}%
10461   \DeclareUnicodeCharacter{00A1}{\exclamdown}%
10462   \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
10463   \DeclareUnicodeCharacter{00A3}{\pounds{}}%
10464   \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
10465   \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
10466   \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
10467   \DeclareUnicodeCharacter{00A7}{\S}%
10468   \DeclareUnicodeCharacter{00A8}{\"{ }}%
10469   \DeclareUnicodeCharacter{00A9}{\copyright{}}%
10470   \DeclareUnicodeCharacter{00AA}{\ordf}%
10471   \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}%
10472   \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
10473   \DeclareUnicodeCharacter{00AD}{\-}%
10474   \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}%
10475   \DeclareUnicodeCharacter{00AF}{\={ }}%
10476   %
10477   \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}%
10478   \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
10479   \DeclareUnicodeCharacter{00B2}{$^2$}%
10480   \DeclareUnicodeCharacter{00B3}{$^3$}%
10481   \DeclareUnicodeCharacter{00B4}{\'{ }}%
10482   \DeclareUnicodeCharacter{00B5}{$\mu$}%
10483   \DeclareUnicodeCharacter{00B6}{\P}%
10484   \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
10485   \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
10486   \DeclareUnicodeCharacter{00B9}{$^1$}%
10487   \DeclareUnicodeCharacter{00BA}{\ordm}%
10488   \DeclareUnicodeCharacter{00BB}{\guillemetright{}}%
10489   \DeclareUnicodeCharacter{00BC}{$1\over4$}%
10490   \DeclareUnicodeCharacter{00BD}{$1\over2$}%
10491   \DeclareUnicodeCharacter{00BE}{$3\over4$}%
10492   \DeclareUnicodeCharacter{00BF}{\questiondown}%
10493   %
10494   \DeclareUnicodeCharacter{00C0}{\`A}%
10495   \DeclareUnicodeCharacter{00C1}{\'A}%
10496   \DeclareUnicodeCharacter{00C2}{\^A}%
10497   \DeclareUnicodeCharacter{00C3}{\~A}%
10498   \DeclareUnicodeCharacter{00C4}{\"A}%
10499   \DeclareUnicodeCharacter{00C5}{\AA}%
10500   \DeclareUnicodeCharacter{00C6}{\AE}%
10501   \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
10502   \DeclareUnicodeCharacter{00C8}{\`E}%
10503   \DeclareUnicodeCharacter{00C9}{\'E}%
10504   \DeclareUnicodeCharacter{00CA}{\^E}%
10505   \DeclareUnicodeCharacter{00CB}{\"E}%
10506   \DeclareUnicodeCharacter{00CC}{\`I}%
10507   \DeclareUnicodeCharacter{00CD}{\'I}%
10508   \DeclareUnicodeCharacter{00CE}{\^I}%
10509   \DeclareUnicodeCharacter{00CF}{\"I}%
10510   %
10511   \DeclareUnicodeCharacter{00D0}{\DH}%
10512   \DeclareUnicodeCharacter{00D1}{\~N}%
10513   \DeclareUnicodeCharacter{00D2}{\`O}%
10514   \DeclareUnicodeCharacter{00D3}{\'O}%
10515   \DeclareUnicodeCharacter{00D4}{\^O}%
10516   \DeclareUnicodeCharacter{00D5}{\~O}%
10517   \DeclareUnicodeCharacter{00D6}{\"O}%
10518   \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
10519   \DeclareUnicodeCharacter{00D8}{\O}%
10520   \DeclareUnicodeCharacter{00D9}{\`U}%
10521   \DeclareUnicodeCharacter{00DA}{\'U}%
10522   \DeclareUnicodeCharacter{00DB}{\^U}%
10523   \DeclareUnicodeCharacter{00DC}{\"U}%
10524   \DeclareUnicodeCharacter{00DD}{\'Y}%
10525   \DeclareUnicodeCharacter{00DE}{\TH}%
10526   \DeclareUnicodeCharacter{00DF}{\ss}%
10527   %
10528   \DeclareUnicodeCharacter{00E0}{\`a}%
10529   \DeclareUnicodeCharacter{00E1}{\'a}%
10530   \DeclareUnicodeCharacter{00E2}{\^a}%
10531   \DeclareUnicodeCharacter{00E3}{\~a}%
10532   \DeclareUnicodeCharacter{00E4}{\"a}%
10533   \DeclareUnicodeCharacter{00E5}{\aa}%
10534   \DeclareUnicodeCharacter{00E6}{\ae}%
10535   \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
10536   \DeclareUnicodeCharacter{00E8}{\`e}%
10537   \DeclareUnicodeCharacter{00E9}{\'e}%
10538   \DeclareUnicodeCharacter{00EA}{\^e}%
10539   \DeclareUnicodeCharacter{00EB}{\"e}%
10540   \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
10541   \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
10542   \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
10543   \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
10544   %
10545   \DeclareUnicodeCharacter{00F0}{\dh}%
10546   \DeclareUnicodeCharacter{00F1}{\~n}%
10547   \DeclareUnicodeCharacter{00F2}{\`o}%
10548   \DeclareUnicodeCharacter{00F3}{\'o}%
10549   \DeclareUnicodeCharacter{00F4}{\^o}%
10550   \DeclareUnicodeCharacter{00F5}{\~o}%
10551   \DeclareUnicodeCharacter{00F6}{\"o}%
10552   \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
10553   \DeclareUnicodeCharacter{00F8}{\o}%
10554   \DeclareUnicodeCharacter{00F9}{\`u}%
10555   \DeclareUnicodeCharacter{00FA}{\'u}%
10556   \DeclareUnicodeCharacter{00FB}{\^u}%
10557   \DeclareUnicodeCharacter{00FC}{\"u}%
10558   \DeclareUnicodeCharacter{00FD}{\'y}%
10559   \DeclareUnicodeCharacter{00FE}{\th}%
10560   \DeclareUnicodeCharacter{00FF}{\"y}%
10561   %
10562   \DeclareUnicodeCharacter{0100}{\=A}%
10563   \DeclareUnicodeCharacter{0101}{\=a}%
10564   \DeclareUnicodeCharacter{0102}{\u{A}}%
10565   \DeclareUnicodeCharacter{0103}{\u{a}}%
10566   \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
10567   \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
10568   \DeclareUnicodeCharacter{0106}{\'C}%
10569   \DeclareUnicodeCharacter{0107}{\'c}%
10570   \DeclareUnicodeCharacter{0108}{\^C}%
10571   \DeclareUnicodeCharacter{0109}{\^c}%
10572   \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
10573   \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
10574   \DeclareUnicodeCharacter{010C}{\v{C}}%
10575   \DeclareUnicodeCharacter{010D}{\v{c}}%
10576   \DeclareUnicodeCharacter{010E}{\v{D}}%
10577   \DeclareUnicodeCharacter{010F}{d'}%
10578   %
10579   \DeclareUnicodeCharacter{0110}{\DH}%
10580   \DeclareUnicodeCharacter{0111}{\dh}%
10581   \DeclareUnicodeCharacter{0112}{\=E}%
10582   \DeclareUnicodeCharacter{0113}{\=e}%
10583   \DeclareUnicodeCharacter{0114}{\u{E}}%
10584   \DeclareUnicodeCharacter{0115}{\u{e}}%
10585   \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
10586   \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
10587   \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
10588   \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
10589   \DeclareUnicodeCharacter{011A}{\v{E}}%
10590   \DeclareUnicodeCharacter{011B}{\v{e}}%
10591   \DeclareUnicodeCharacter{011C}{\^G}%
10592   \DeclareUnicodeCharacter{011D}{\^g}%
10593   \DeclareUnicodeCharacter{011E}{\u{G}}%
10594   \DeclareUnicodeCharacter{011F}{\u{g}}%
10595   %
10596   \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
10597   \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
10598   \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
10599   \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
10600   \DeclareUnicodeCharacter{0124}{\^H}%
10601   \DeclareUnicodeCharacter{0125}{\^h}%
10602   \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
10603   \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
10604   \DeclareUnicodeCharacter{0128}{\~I}%
10605   \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
10606   \DeclareUnicodeCharacter{012A}{\=I}%
10607   \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
10608   \DeclareUnicodeCharacter{012C}{\u{I}}%
10609   \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
10610   \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
10611   \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
10612   %
10613   \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
10614   \DeclareUnicodeCharacter{0131}{\dotless{i}}%
10615   \DeclareUnicodeCharacter{0132}{IJ}%
10616   \DeclareUnicodeCharacter{0133}{ij}%
10617   \DeclareUnicodeCharacter{0134}{\^J}%
10618   \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
10619   \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
10620   \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
10621   \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
10622   \DeclareUnicodeCharacter{0139}{\'L}%
10623   \DeclareUnicodeCharacter{013A}{\'l}%
10624   \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
10625   \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
10626   \DeclareUnicodeCharacter{013D}{L'}% should kern
10627   \DeclareUnicodeCharacter{013E}{l'}% should kern
10628   \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
10629   %
10630   \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
10631   \DeclareUnicodeCharacter{0141}{\L}%
10632   \DeclareUnicodeCharacter{0142}{\l}%
10633   \DeclareUnicodeCharacter{0143}{\'N}%
10634   \DeclareUnicodeCharacter{0144}{\'n}%
10635   \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
10636   \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
10637   \DeclareUnicodeCharacter{0147}{\v{N}}%
10638   \DeclareUnicodeCharacter{0148}{\v{n}}%
10639   \DeclareUnicodeCharacter{0149}{'n}%
10640   \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
10641   \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
10642   \DeclareUnicodeCharacter{014C}{\=O}%
10643   \DeclareUnicodeCharacter{014D}{\=o}%
10644   \DeclareUnicodeCharacter{014E}{\u{O}}%
10645   \DeclareUnicodeCharacter{014F}{\u{o}}%
10646   %
10647   \DeclareUnicodeCharacter{0150}{\H{O}}%
10648   \DeclareUnicodeCharacter{0151}{\H{o}}%
10649   \DeclareUnicodeCharacter{0152}{\OE}%
10650   \DeclareUnicodeCharacter{0153}{\oe}%
10651   \DeclareUnicodeCharacter{0154}{\'R}%
10652   \DeclareUnicodeCharacter{0155}{\'r}%
10653   \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
10654   \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
10655   \DeclareUnicodeCharacter{0158}{\v{R}}%
10656   \DeclareUnicodeCharacter{0159}{\v{r}}%
10657   \DeclareUnicodeCharacter{015A}{\'S}%
10658   \DeclareUnicodeCharacter{015B}{\'s}%
10659   \DeclareUnicodeCharacter{015C}{\^S}%
10660   \DeclareUnicodeCharacter{015D}{\^s}%
10661   \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
10662   \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
10663   %
10664   \DeclareUnicodeCharacter{0160}{\v{S}}%
10665   \DeclareUnicodeCharacter{0161}{\v{s}}%
10666   \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
10667   \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
10668   \DeclareUnicodeCharacter{0164}{\v{T}}%
10669   \DeclareUnicodeCharacter{0165}{\v{t}}%
10670   \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
10671   \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
10672   \DeclareUnicodeCharacter{0168}{\~U}%
10673   \DeclareUnicodeCharacter{0169}{\~u}%
10674   \DeclareUnicodeCharacter{016A}{\=U}%
10675   \DeclareUnicodeCharacter{016B}{\=u}%
10676   \DeclareUnicodeCharacter{016C}{\u{U}}%
10677   \DeclareUnicodeCharacter{016D}{\u{u}}%
10678   \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
10679   \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
10680   %
10681   \DeclareUnicodeCharacter{0170}{\H{U}}%
10682   \DeclareUnicodeCharacter{0171}{\H{u}}%
10683   \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
10684   \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
10685   \DeclareUnicodeCharacter{0174}{\^W}%
10686   \DeclareUnicodeCharacter{0175}{\^w}%
10687   \DeclareUnicodeCharacter{0176}{\^Y}%
10688   \DeclareUnicodeCharacter{0177}{\^y}%
10689   \DeclareUnicodeCharacter{0178}{\"Y}%
10690   \DeclareUnicodeCharacter{0179}{\'Z}%
10691   \DeclareUnicodeCharacter{017A}{\'z}%
10692   \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
10693   \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
10694   \DeclareUnicodeCharacter{017D}{\v{Z}}%
10695   \DeclareUnicodeCharacter{017E}{\v{z}}%
10696   \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
10697   %
10698   \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
10699   \DeclareUnicodeCharacter{01C5}{D\v{z}}%
10700   \DeclareUnicodeCharacter{01C6}{d\v{z}}%
10701   \DeclareUnicodeCharacter{01C7}{LJ}%
10702   \DeclareUnicodeCharacter{01C8}{Lj}%
10703   \DeclareUnicodeCharacter{01C9}{lj}%
10704   \DeclareUnicodeCharacter{01CA}{NJ}%
10705   \DeclareUnicodeCharacter{01CB}{Nj}%
10706   \DeclareUnicodeCharacter{01CC}{nj}%
10707   \DeclareUnicodeCharacter{01CD}{\v{A}}%
10708   \DeclareUnicodeCharacter{01CE}{\v{a}}%
10709   \DeclareUnicodeCharacter{01CF}{\v{I}}%
10710   %
10711   \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
10712   \DeclareUnicodeCharacter{01D1}{\v{O}}%
10713   \DeclareUnicodeCharacter{01D2}{\v{o}}%
10714   \DeclareUnicodeCharacter{01D3}{\v{U}}%
10715   \DeclareUnicodeCharacter{01D4}{\v{u}}%
10716   %
10717   \DeclareUnicodeCharacter{01E2}{\={\AE}}%
10718   \DeclareUnicodeCharacter{01E3}{\={\ae}}%
10719   \DeclareUnicodeCharacter{01E6}{\v{G}}%
10720   \DeclareUnicodeCharacter{01E7}{\v{g}}%
10721   \DeclareUnicodeCharacter{01E8}{\v{K}}%
10722   \DeclareUnicodeCharacter{01E9}{\v{k}}%
10723   %
10724   \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
10725   \DeclareUnicodeCharacter{01F1}{DZ}%
10726   \DeclareUnicodeCharacter{01F2}{Dz}%
10727   \DeclareUnicodeCharacter{01F3}{dz}%
10728   \DeclareUnicodeCharacter{01F4}{\'G}%
10729   \DeclareUnicodeCharacter{01F5}{\'g}%
10730   \DeclareUnicodeCharacter{01F8}{\`N}%
10731   \DeclareUnicodeCharacter{01F9}{\`n}%
10732   \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
10733   \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
10734   \DeclareUnicodeCharacter{01FE}{\'{\O}}%
10735   \DeclareUnicodeCharacter{01FF}{\'{\o}}%
10736   %
10737   \DeclareUnicodeCharacter{021E}{\v{H}}%
10738   \DeclareUnicodeCharacter{021F}{\v{h}}%
10739   %
10740   \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
10741   \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
10742   \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
10743   \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
10744   \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
10745   \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
10746   %
10747   \DeclareUnicodeCharacter{0232}{\=Y}%
10748   \DeclareUnicodeCharacter{0233}{\=y}%
10749   \DeclareUnicodeCharacter{0237}{\dotless{j}}%
10750   %
10751   \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
10752   %
10753   % Greek letters upper case
10754   \DeclareUnicodeCharacter{0391}{{\it A}}%
10755   \DeclareUnicodeCharacter{0392}{{\it B}}%
10756   \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
10757   \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
10758   \DeclareUnicodeCharacter{0395}{{\it E}}%
10759   \DeclareUnicodeCharacter{0396}{{\it Z}}%
10760   \DeclareUnicodeCharacter{0397}{{\it H}}%
10761   \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
10762   \DeclareUnicodeCharacter{0399}{{\it I}}%
10763   \DeclareUnicodeCharacter{039A}{{\it K}}%
10764   \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
10765   \DeclareUnicodeCharacter{039C}{{\it M}}%
10766   \DeclareUnicodeCharacter{039D}{{\it N}}%
10767   \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
10768   \DeclareUnicodeCharacter{039F}{{\it O}}%
10769   \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
10770   \DeclareUnicodeCharacter{03A1}{{\it P}}%
10771   %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
10772   \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
10773   \DeclareUnicodeCharacter{03A4}{{\it T}}%
10774   \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
10775   \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
10776   \DeclareUnicodeCharacter{03A7}{{\it X}}%
10777   \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
10778   \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
10779   %
10780   % Vowels with accents
10781   \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
10782   \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
10783   \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
10784   \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
10785   \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
10786   \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
10787   %
10788   % Standalone accent
10789   \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
10790   %
10791   % Greek letters lower case
10792   \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
10793   \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
10794   \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
10795   \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
10796   \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
10797   \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
10798   \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
10799   \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
10800   \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
10801   \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
10802   \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
10803   \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
10804   \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
10805   \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
10806   \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
10807   \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
10808   \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
10809   \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
10810   \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
10811   \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
10812   \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
10813   \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
10814   \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
10815   \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
10816   \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
10817   %
10818   % More Greek vowels with accents
10819   \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
10820   \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
10821   \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
10822   \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
10823   \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
10824   %
10825   % Variant Greek letters
10826   \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
10827   \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
10828   \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
10829   %
10830   \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
10831   \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
10832   \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
10833   \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
10834   \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
10835   \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
10836   \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
10837   \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
10838   \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
10839   \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
10840   \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
10841   \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
10842   %
10843   \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
10844   \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
10845   %
10846   \DeclareUnicodeCharacter{1E20}{\=G}%
10847   \DeclareUnicodeCharacter{1E21}{\=g}%
10848   \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
10849   \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
10850   \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
10851   \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
10852   \DeclareUnicodeCharacter{1E26}{\"H}%
10853   \DeclareUnicodeCharacter{1E27}{\"h}%
10854   %
10855   \DeclareUnicodeCharacter{1E30}{\'K}%
10856   \DeclareUnicodeCharacter{1E31}{\'k}%
10857   \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
10858   \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
10859   \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
10860   \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
10861   \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
10862   \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
10863   \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
10864   \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
10865   \DeclareUnicodeCharacter{1E3E}{\'M}%
10866   \DeclareUnicodeCharacter{1E3F}{\'m}%
10867   %
10868   \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
10869   \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
10870   \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
10871   \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
10872   \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
10873   \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
10874   \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
10875   \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
10876   \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
10877   \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
10878   %
10879   \DeclareUnicodeCharacter{1E54}{\'P}%
10880   \DeclareUnicodeCharacter{1E55}{\'p}%
10881   \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
10882   \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
10883   \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
10884   \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
10885   \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
10886   \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
10887   \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
10888   \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
10889   %
10890   \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
10891   \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
10892   \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
10893   \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
10894   \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
10895   \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
10896   \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
10897   \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
10898   \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
10899   \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
10900   %
10901   \DeclareUnicodeCharacter{1E7C}{\~V}%
10902   \DeclareUnicodeCharacter{1E7D}{\~v}%
10903   \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
10904   \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
10905   %
10906   \DeclareUnicodeCharacter{1E80}{\`W}%
10907   \DeclareUnicodeCharacter{1E81}{\`w}%
10908   \DeclareUnicodeCharacter{1E82}{\'W}%
10909   \DeclareUnicodeCharacter{1E83}{\'w}%
10910   \DeclareUnicodeCharacter{1E84}{\"W}%
10911   \DeclareUnicodeCharacter{1E85}{\"w}%
10912   \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
10913   \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
10914   \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
10915   \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
10916   \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
10917   \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
10918   \DeclareUnicodeCharacter{1E8C}{\"X}%
10919   \DeclareUnicodeCharacter{1E8D}{\"x}%
10920   \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
10921   \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
10922   %
10923   \DeclareUnicodeCharacter{1E90}{\^Z}%
10924   \DeclareUnicodeCharacter{1E91}{\^z}%
10925   \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
10926   \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
10927   \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
10928   \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
10929   \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
10930   \DeclareUnicodeCharacter{1E97}{\"t}%
10931   \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
10932   \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
10933   %
10934   \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
10935   \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
10936   %
10937   \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
10938   \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
10939   \DeclareUnicodeCharacter{1EBC}{\~E}%
10940   \DeclareUnicodeCharacter{1EBD}{\~e}%
10941   %
10942   \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
10943   \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
10944   \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
10945   \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
10946   %
10947   \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
10948   \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
10949   %
10950   \DeclareUnicodeCharacter{1EF2}{\`Y}%
10951   \DeclareUnicodeCharacter{1EF3}{\`y}%
10952   \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
10953   %
10954   \DeclareUnicodeCharacter{1EF8}{\~Y}%
10955   \DeclareUnicodeCharacter{1EF9}{\~y}%
10956   %
10957   % Punctuation
10958   \DeclareUnicodeCharacter{2013}{--}%
10959   \DeclareUnicodeCharacter{2014}{---}%
10960   \DeclareUnicodeCharacter{2018}{\quoteleft{}}%
10961   \DeclareUnicodeCharacter{2019}{\quoteright{}}%
10962   \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}%
10963   \DeclareUnicodeCharacter{201C}{\quotedblleft{}}%
10964   \DeclareUnicodeCharacter{201D}{\quotedblright{}}%
10965   \DeclareUnicodeCharacter{201E}{\quotedblbase{}}%
10966   \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
10967   \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
10968   \DeclareUnicodeCharacter{2022}{\bullet{}}%
10969   \DeclareUnicodeCharacter{202F}{\thinspace}%
10970   \DeclareUnicodeCharacter{2026}{\dots{}}%
10971   \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}%
10972   \DeclareUnicodeCharacter{203A}{\guilsinglright{}}%
10973   %
10974   \DeclareUnicodeCharacter{20AC}{\euro{}}%
10975   %
10976   \DeclareUnicodeCharacter{2192}{\expansion{}}%
10977   \DeclareUnicodeCharacter{21D2}{\result{}}%
10978   %
10979   % Mathematical symbols
10980   \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
10981   \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
10982   \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
10983   \DeclareUnicodeCharacter{2212}{\minus{}}%
10984   \DeclareUnicodeCharacter{2217}{\ast}%
10985   \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
10986   \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
10987   \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
10988   \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
10989   \DeclareUnicodeCharacter{2261}{\equiv{}}%
10990   \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
10991   \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
10992   \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
10993   \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
10994   %
10995   \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
10996   \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
10997   \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
10998   \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
10999   \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
11000   \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
11001   \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
11002   \DeclareUnicodeCharacter{2127}{\ensuremath\mho}%
11003   \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
11004   \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
11005   \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
11006   \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
11007   \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
11008   \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
11009   \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
11010   \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
11011   \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
11012   \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
11013   \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
11014   \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
11015   \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
11016   \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
11017   \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
11018   \DeclareUnicodeCharacter{21BE}{\ensuremath\upharpoonright}%
11019   \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
11020   \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
11021   \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
11022   \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
11023   \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
11024   \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
11025   \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
11026   \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
11027   \DeclareUnicodeCharacter{21DD}{\ensuremath\leadsto}%
11028   \DeclareUnicodeCharacter{2201}{\ensuremath\complement}%
11029   \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
11030   \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
11031   \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
11032   \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
11033   \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
11034   \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
11035   \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
11036   \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
11037   \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
11038   \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
11039   \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
11040   \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
11041   \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
11042   \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
11043   \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
11044   \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
11045   \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
11046   \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
11047   \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
11048   \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
11049   \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
11050   \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
11051   \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
11052   \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
11053   \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
11054   \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
11055   \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
11056   \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
11057   \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
11058   \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
11059   \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
11060   \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
11061   \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
11062   \DeclareUnicodeCharacter{228F}{\ensuremath\sqsubset}%
11063   \DeclareUnicodeCharacter{2290}{\ensuremath\sqsupset}%
11064   \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
11065   \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
11066   \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
11067   \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
11068   \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
11069   \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
11070   \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
11071   \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
11072   \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
11073   \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
11074   \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
11075   \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
11076   \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
11077   \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
11078   \DeclareUnicodeCharacter{22B4}{\ensuremath\unlhd}%
11079   \DeclareUnicodeCharacter{22B5}{\ensuremath\unrhd}%
11080   \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
11081   \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
11082   \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
11083   \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
11084   \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
11085   \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
11086   \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
11087   \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
11088   \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
11089   \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
11090   \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
11091   \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
11092   \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
11093   \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
11094   %
11095   \DeclareUnicodeCharacter{25A1}{\ensuremath\Box}%
11096   \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
11097   \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
11098   \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
11099   \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
11100   \DeclareUnicodeCharacter{25C7}{\ensuremath\Diamond}%
11101   \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
11102   \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
11103   \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
11104   \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
11105   \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
11106   \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
11107   \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
11108   \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
11109   \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
11110   \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
11111   \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
11112   \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
11113   \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
11114   \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
11115   \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
11116   \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
11117   \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
11118   \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
11119   \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
11120   \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
11121   \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
11122   \DeclareUnicodeCharacter{2A1D}{\ensuremath\Join}%
11123   \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
11124   \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
11125   \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
11126   %
11127   \global\mathchardef\checkmark="1370% actually the square root sign
11128   \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
11129 }% end of \unicodechardefs
11130
11131 % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
11132 % It makes the setting that replace UTF-8 byte sequence.
11133 \def\utfeightchardefs{%
11134   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
11135   \unicodechardefs
11136 }
11137
11138 % Whether the active definitions of non-ASCII characters expand to
11139 % non-active tokens with the same character code.  This is used to
11140 % write characters literally, instead of using active definitions for
11141 % printing the correct glyphs.
11142 \newif\ifpassthroughchars
11143 \passthroughcharsfalse
11144
11145 % For native Unicode handling (XeTeX and LuaTeX),
11146 % provide a definition macro to replace/pass-through a Unicode character
11147 %
11148 \def\DeclareUnicodeCharacterNative#1#2{%
11149   \catcode"#1=\active
11150   \def\dodeclareunicodecharacternative##1##2##3{%
11151     \begingroup
11152       \uccode`\~="##2\relax
11153       \uppercase{\gdef~}{%
11154         \ifpassthroughchars
11155           ##1%
11156         \else
11157           ##3%
11158         \fi
11159       }
11160     \endgroup
11161   }
11162   \begingroup
11163     \uccode`\.="#1\relax
11164     \uppercase{\def\UTFNativeTmp{.}}%
11165     \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
11166   \endgroup
11167 }
11168
11169 % Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
11170 % It activates the setting that replaces Unicode characters.
11171 \def\nativeunicodechardefs{%
11172   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
11173   \unicodechardefs
11174 }
11175
11176 % For native Unicode handling (XeTeX and LuaTeX),
11177 % make the character token expand
11178 % to the sequences given in \unicodechardefs for printing.
11179 \def\DeclareUnicodeCharacterNativeAtU#1#2{%
11180   \def\UTFAtUTmp{#2}
11181   \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
11182 }
11183
11184 % @U command definitions for native Unicode handling (XeTeX and LuaTeX).
11185 \def\nativeunicodechardefsatu{%
11186   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
11187   \unicodechardefs
11188 }
11189
11190 % US-ASCII character definitions.
11191 \def\asciichardefs{% nothing need be done
11192    \relax
11193 }
11194
11195 % define all Unicode characters we know about, for the sake of @U.
11196 \iftxinativeunicodecapable
11197   \nativeunicodechardefsatu
11198 \else
11199   \utfeightchardefs
11200 \fi
11201
11202
11203 % Make non-ASCII characters printable again for compatibility with
11204 % existing Texinfo documents that may use them, even without declaring a
11205 % document encoding.
11206 %
11207 \setnonasciicharscatcode \other
11208
11209
11210 \message{formatting,}
11211
11212 \newdimen\defaultparindent \defaultparindent = 15pt
11213
11214 \chapheadingskip = 15pt plus 4pt minus 2pt
11215 \secheadingskip = 12pt plus 3pt minus 2pt
11216 \subsecheadingskip = 9pt plus 2pt minus 2pt
11217
11218 % Prevent underfull vbox error messages.
11219 \vbadness = 10000
11220
11221 % Don't be very finicky about underfull hboxes, either.
11222 \hbadness = 6666
11223
11224 % Following George Bush, get rid of widows and orphans.
11225 \widowpenalty=10000
11226 \clubpenalty=10000
11227
11228 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
11229 % using an old version of TeX, don't do anything.  We want the amount of
11230 % stretch added to depend on the line length, hence the dependence on
11231 % \hsize.  We call this whenever the paper size is set.
11232 %
11233 \def\setemergencystretch{%
11234   \ifx\emergencystretch\thisisundefined
11235     % Allow us to assign to \emergencystretch anyway.
11236     \def\emergencystretch{\dimen0}%
11237   \else
11238     \emergencystretch = .15\hsize
11239   \fi
11240 }
11241
11242 % Parameters in order: 1) textheight; 2) textwidth;
11243 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
11244 % 7) physical page height; 8) physical page width.
11245 %
11246 % We also call \setleading{\textleading}, so the caller should define
11247 % \textleading.  The caller should also set \parskip.
11248 %
11249 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
11250   \voffset = #3\relax
11251   \topskip = #6\relax
11252   \splittopskip = \topskip
11253   %
11254   \vsize = #1\relax
11255   \advance\vsize by \topskip
11256   \outervsize = \vsize
11257   \advance\outervsize by 2\topandbottommargin
11258   \txipageheight = \vsize
11259   %
11260   \hsize = #2\relax
11261   \outerhsize = \hsize
11262   \advance\outerhsize by 0.5in
11263   \txipagewidth = \hsize
11264   %
11265   \normaloffset = #4\relax
11266   \bindingoffset = #5\relax
11267   %
11268   \ifpdf
11269     \pdfpageheight #7\relax
11270     \pdfpagewidth #8\relax
11271     % if we don't reset these, they will remain at "1 true in" of
11272     % whatever layout pdftex was dumped with.
11273     \pdfhorigin = 1 true in
11274     \pdfvorigin = 1 true in
11275   \else
11276     \ifx\XeTeXrevision\thisisundefined
11277     \else
11278       \pdfpageheight #7\relax
11279       \pdfpagewidth #8\relax
11280       % XeTeX does not have \pdfhorigin and \pdfvorigin.
11281     \fi
11282   \fi
11283   %
11284   \setleading{\textleading}
11285   %
11286   \parindent = \defaultparindent
11287   \setemergencystretch
11288 }
11289
11290 % @letterpaper (the default).
11291 \def\letterpaper{{\globaldefs = 1
11292   \parskip = 3pt plus 2pt minus 1pt
11293   \textleading = 13.2pt
11294   %
11295   % If page is nothing but text, make it come out even.
11296   \internalpagesizes{607.2pt}{6in}% that's 46 lines
11297                     {\voffset}{.25in}%
11298                     {\bindingoffset}{36pt}%
11299                     {11in}{8.5in}%
11300 }}
11301
11302 % Use @smallbook to reset parameters for 7x9.25 trim size.
11303 \def\smallbook{{\globaldefs = 1
11304   \parskip = 2pt plus 1pt
11305   \textleading = 12pt
11306   %
11307   \internalpagesizes{7.5in}{5in}%
11308                     {-.2in}{0in}%
11309                     {\bindingoffset}{16pt}%
11310                     {9.25in}{7in}%
11311   %
11312   \lispnarrowing = 0.3in
11313   \tolerance = 700
11314   \hfuzz = 1pt
11315   \contentsrightmargin = 0pt
11316   \defbodyindent = .5cm
11317 }}
11318
11319 % Use @smallerbook to reset parameters for 6x9 trim size.
11320 % (Just testing, parameters still in flux.)
11321 \def\smallerbook{{\globaldefs = 1
11322   \parskip = 1.5pt plus 1pt
11323   \textleading = 12pt
11324   %
11325   \internalpagesizes{7.4in}{4.8in}%
11326                     {-.2in}{-.4in}%
11327                     {0pt}{14pt}%
11328                     {9in}{6in}%
11329   %
11330   \lispnarrowing = 0.25in
11331   \tolerance = 700
11332   \hfuzz = 1pt
11333   \contentsrightmargin = 0pt
11334   \defbodyindent = .4cm
11335 }}
11336
11337 % Use @afourpaper to print on European A4 paper.
11338 \def\afourpaper{{\globaldefs = 1
11339   \parskip = 3pt plus 2pt minus 1pt
11340   \textleading = 13.2pt
11341   %
11342   % Double-side printing via postscript on Laserjet 4050
11343   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
11344   % To change the settings for a different printer or situation, adjust
11345   % \normaloffset until the front-side and back-side texts align.  Then
11346   % do the same for \bindingoffset.  You can set these for testing in
11347   % your texinfo source file like this:
11348   % @tex
11349   % \global\normaloffset = -6mm
11350   % \global\bindingoffset = 10mm
11351   % @end tex
11352   \internalpagesizes{673.2pt}{160mm}% that's 51 lines
11353                     {\voffset}{\hoffset}%
11354                     {\bindingoffset}{44pt}%
11355                     {297mm}{210mm}%
11356   %
11357   \tolerance = 700
11358   \hfuzz = 1pt
11359   \contentsrightmargin = 0pt
11360   \defbodyindent = 5mm
11361 }}
11362
11363 % Use @afivepaper to print on European A5 paper.
11364 % From romildo@urano.iceb.ufop.br, 2 July 2000.
11365 % He also recommends making @example and @lisp be small.
11366 \def\afivepaper{{\globaldefs = 1
11367   \parskip = 2pt plus 1pt minus 0.1pt
11368   \textleading = 12.5pt
11369   %
11370   \internalpagesizes{160mm}{120mm}%
11371                     {\voffset}{\hoffset}%
11372                     {\bindingoffset}{8pt}%
11373                     {210mm}{148mm}%
11374   %
11375   \lispnarrowing = 0.2in
11376   \tolerance = 800
11377   \hfuzz = 1.2pt
11378   \contentsrightmargin = 0pt
11379   \defbodyindent = 2mm
11380   \tableindent = 12mm
11381 }}
11382
11383 % A specific text layout, 24x15cm overall, intended for A4 paper.
11384 \def\afourlatex{{\globaldefs = 1
11385   \afourpaper
11386   \internalpagesizes{237mm}{150mm}%
11387                     {\voffset}{4.6mm}%
11388                     {\bindingoffset}{7mm}%
11389                     {297mm}{210mm}%
11390   %
11391   % Must explicitly reset to 0 because we call \afourpaper.
11392   \globaldefs = 0
11393 }}
11394
11395 % Use @afourwide to print on A4 paper in landscape format.
11396 \def\afourwide{{\globaldefs = 1
11397   \afourpaper
11398   \internalpagesizes{241mm}{165mm}%
11399                     {\voffset}{-2.95mm}%
11400                     {\bindingoffset}{7mm}%
11401                     {297mm}{210mm}%
11402   \globaldefs = 0
11403 }}
11404
11405 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
11406 % Perhaps we should allow setting the margins, \topskip, \parskip,
11407 % and/or leading, also. Or perhaps we should compute them somehow.
11408 %
11409 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
11410 \def\pagesizesyyy#1,#2,#3\finish{{%
11411   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
11412   \globaldefs = 1
11413   %
11414   \parskip = 3pt plus 2pt minus 1pt
11415   \setleading{\textleading}%
11416   %
11417   \dimen0 = #1\relax
11418   \advance\dimen0 by \voffset
11419   %
11420   \dimen2 = \hsize
11421   \advance\dimen2 by \normaloffset
11422   %
11423   \internalpagesizes{#1}{\hsize}%
11424                     {\voffset}{\normaloffset}%
11425                     {\bindingoffset}{44pt}%
11426                     {\dimen0}{\dimen2}%
11427 }}
11428
11429 % Set default to letter.
11430 %
11431 \letterpaper
11432
11433
11434 \message{and turning on texinfo input format.}
11435
11436 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
11437
11438 % DEL is a comment character, in case @c does not suffice.
11439 \catcode`\^^? = 14
11440
11441 % Define macros to output various characters with catcode for normal text.
11442 \catcode`\"=\other \def\normaldoublequote{"}
11443 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
11444 \catcode`\+=\other \def\normalplus{+}
11445 \catcode`\<=\other \def\normalless{<}
11446 \catcode`\>=\other \def\normalgreater{>}
11447 \catcode`\^=\other \def\normalcaret{^}
11448 \catcode`\_=\other \def\normalunderscore{_}
11449 \catcode`\|=\other \def\normalverticalbar{|}
11450 \catcode`\~=\other \def\normaltilde{~}
11451
11452 % This macro is used to make a character print one way in \tt
11453 % (where it can probably be output as-is), and another way in other fonts,
11454 % where something hairier probably needs to be done.
11455 %
11456 % #1 is what to print if we are indeed using \tt; #2 is what to print
11457 % otherwise.  Since all the Computer Modern typewriter fonts have zero
11458 % interword stretch (and shrink), and it is reasonable to expect all
11459 % typewriter fonts to have this, we can check that font parameter.
11460 %
11461 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
11462
11463 % Same as above, but check for italic font.  Actually this also catches
11464 % non-italic slanted fonts since it is impossible to distinguish them from
11465 % italic fonts.  But since this is only used by $ and it uses \sl anyway
11466 % this is not a problem.
11467 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
11468
11469 % Set catcodes for Texinfo file
11470
11471 % Active characters for printing the wanted glyph.
11472 % Most of these we simply print from the \tt font, but for some, we can
11473 % use math or other variants that look better in normal text.
11474 %
11475 \catcode`\"=\active
11476 \def\activedoublequote{{\tt\char34}}
11477 \let"=\activedoublequote
11478 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
11479 \chardef\hatchar=`\^
11480 \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
11481
11482 \catcode`\_=\active
11483 \def_{\ifusingtt\normalunderscore\_}
11484 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
11485 \let\realunder=_
11486
11487 \catcode`\|=\active \def|{{\tt\char124}}
11488
11489 \chardef \less=`\<
11490 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
11491 \chardef \gtr=`\>
11492 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
11493 \catcode`\+=\active \def+{{\tt \char 43}}
11494 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
11495 \catcode`\-=\active \let-=\normaldash
11496
11497
11498 % used for headline/footline in the output routine, in case the page
11499 % breaks in the middle of an @tex block.
11500 \def\texinfochars{%
11501   \let< = \activeless
11502   \let> = \activegtr
11503   \let~ = \activetilde 
11504   \let^ = \activehat
11505   \markupsetuplqdefault \markupsetuprqdefault 
11506   \let\b = \strong
11507   \let\i = \smartitalic
11508   % in principle, all other definitions in \tex have to be undone too.
11509 }
11510
11511 % Used sometimes to turn off (effectively) the active characters even after
11512 % parsing them.
11513 \def\turnoffactive{%
11514   \normalturnoffactive
11515   \otherbackslash
11516 }
11517
11518 \catcode`\@=0
11519
11520 % \backslashcurfont outputs one backslash character in current font,
11521 % as in \char`\\.
11522 \global\chardef\backslashcurfont=`\\
11523 \global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
11524
11525 % \realbackslash is an actual character `\' with catcode other, and
11526 % \doublebackslash is two of them (for the pdf outlines).
11527 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
11528
11529 % In Texinfo, backslash is an active character; it prints the backslash
11530 % in fixed width font.
11531 \catcode`\\=\active  % @ for escape char from now on.
11532
11533 % Print a typewriter backslash.  For math mode, we can't simply use
11534 % \backslashcurfont: the story here is that in math mode, the \char
11535 % of \backslashcurfont ends up printing the roman \ from the math symbol
11536 % font (because \char in math mode uses the \mathcode, and plain.tex
11537 % sets \mathcode`\\="026E).  Hence we use an explicit \mathchar,
11538 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
11539 % ignored family value; char position "5C).  We can't use " for the
11540 % usual hex value because it has already been made active.
11541
11542 @def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
11543 @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
11544
11545 % \rawbackslash defines an active \ to do \backslashcurfont.
11546 % \otherbackslash defines an active \ to be a literal `\' character with
11547 % catcode other.  We switch back and forth between these.
11548 @gdef@rawbackslash{@let\=@backslashcurfont}
11549 @gdef@otherbackslash{@let\=@realbackslash}
11550
11551 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
11552 % the literal character `\'.
11553 %
11554 {@catcode`- = @active
11555  @gdef@normalturnoffactive{%
11556    @passthroughcharstrue
11557    @let-=@normaldash
11558    @let"=@normaldoublequote
11559    @let$=@normaldollar %$ font-lock fix
11560    @let+=@normalplus
11561    @let<=@normalless
11562    @let>=@normalgreater
11563    @let^=@normalcaret
11564    @let_=@normalunderscore
11565    @let|=@normalverticalbar
11566    @let~=@normaltilde
11567    @let\=@ttbackslash
11568    @markupsetuplqdefault
11569    @markupsetuprqdefault
11570    @unsepspaces
11571  }
11572 }
11573
11574 % If a .fmt file is being used, characters that might appear in a file
11575 % name cannot be active until we have parsed the command line.
11576 % So turn them off again, and have @fixbackslash turn them back on.
11577 @catcode`+=@other @catcode`@_=@other
11578
11579 % \enablebackslashhack - allow file to begin `\input texinfo'
11580 %
11581 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
11582 % That is what \eatinput is for; after that, the `\' should revert to printing
11583 % a backslash.
11584 % If the file did not have a `\input texinfo', then it is turned off after
11585 % the first line; otherwise the first `\' in the file would cause an error.
11586 % This is used on the very last line of this file, texinfo.tex.
11587 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
11588 {
11589 @catcode`@^=7
11590 @catcode`@^^M=13@gdef@enablebackslashhack{%
11591   @global@let\ = @eatinput%
11592   @catcode`@^^M=13%
11593   @def@c{@fixbackslash@c}%
11594   % Definition for the newline at the end of this file.
11595   @def ^^M{@let^^M@secondlinenl}%
11596   % Definition for a newline in the main Texinfo file.
11597   @gdef @secondlinenl{@fixbackslash}%
11598 }}
11599
11600 {@catcode`@^=7 @catcode`@^^M=13%
11601 @gdef@eatinput input texinfo#1^^M{@fixbackslash}}
11602
11603 % Emergency active definition of newline, in case an active newline token
11604 % appears by mistake.
11605 {@catcode`@^=7 @catcode13=13%
11606 @gdef@enableemergencynewline{%
11607   @gdef^^M{%
11608     @par%
11609     %<warning: active newline>@par%
11610 }}}
11611
11612
11613 @gdef@fixbackslash{%
11614   @ifx\@eatinput @let\ = @ttbackslash @fi
11615   @catcode13=5 % regular end of line
11616   @enableemergencynewline
11617   @let@c=@texinfoc
11618   % Also turn back on active characters that might appear in the input
11619   % file name, in case not using a pre-dumped format.
11620   @catcode`+=@active
11621   @catcode`@_=@active
11622   %
11623   % If texinfo.cnf is present on the system, read it.
11624   % Useful for site-wide @afourpaper, etc.  This macro, @fixbackslash, gets
11625   % called at the beginning of every Texinfo file.  Not opening texinfo.cnf
11626   % directly in this file, texinfo.tex, makes it possible to make a format
11627   % file for Texinfo.
11628   %
11629   @openin 1 texinfo.cnf
11630   @ifeof 1 @else @input texinfo.cnf @fi
11631   @closein 1
11632 }
11633
11634
11635 % Say @foo, not \foo, in error messages.
11636 @escapechar = `@@
11637
11638 % These (along with & and #) are made active for url-breaking, so need
11639 % active definitions as the normal characters.
11640 @def@normaldot{.}
11641 @def@normalquest{?}
11642 @def@normalslash{/}
11643
11644 % These look ok in all fonts, so just make them not special.
11645 % @hashchar{} gets its own user-level command, because of #line.
11646 @catcode`@& = @other @def@normalamp{&}
11647 @catcode`@# = @other @def@normalhash{#}
11648 @catcode`@% = @other @def@normalpercent{%}
11649
11650 @let @hashchar = @normalhash
11651
11652 @c Finally, make ` and ' active, so that txicodequoteundirected and
11653 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
11654 @c don't make ` and ' active, @code will not get them as active chars.
11655 @c Do this last of all since we use ` in the previous @catcode assignments.
11656 @catcode`@'=@active
11657 @catcode`@`=@active
11658 @markupsetuplqdefault
11659 @markupsetuprqdefault
11660
11661 @c Local variables:
11662 @c eval: (add-hook 'write-file-hooks 'time-stamp)
11663 @c page-delimiter: "^\\\\message\\|emacs-page"
11664 @c time-stamp-start: "def\\\\texinfoversion{"
11665 @c time-stamp-format: "%:y-%02m-%02d.%02H"
11666 @c time-stamp-end: "}"
11667 @c End:
11668
11669 @c vim:sw=2:
11670
11671 @enablebackslashhack