]> git.donarmstrong.com Git - lilypond.git/blob - tex/texinfo.tex
d164d451b89075c9d7670202182e788aa5659f40
[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{2016-03-29.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 \chardef\other=12
71
72 % We never want plain's \outer definition of \+ in Texinfo.
73 % For @tex, we can use \tabalign.
74 \let\+ = \relax
75
76 % Save some plain tex macros whose names we will redefine.
77 \let\ptexb=\b
78 \let\ptexbullet=\bullet
79 \let\ptexc=\c
80 \let\ptexcomma=\,
81 \let\ptexdot=\.
82 \let\ptexdots=\dots
83 \let\ptexend=\end
84 \let\ptexequiv=\equiv
85 \let\ptexexclam=\!
86 \let\ptexfootnote=\footnote
87 \let\ptexgtr=>
88 \let\ptexhat=^
89 \let\ptexi=\i
90 \let\ptexindent=\indent
91 \let\ptexinsert=\insert
92 \let\ptexlbrace=\{
93 \let\ptexless=<
94 \let\ptexnewwrite\newwrite
95 \let\ptexnoindent=\noindent
96 \let\ptexplus=+
97 \let\ptexraggedright=\raggedright
98 \let\ptexrbrace=\}
99 \let\ptexslash=\/
100 \let\ptexsp=\sp
101 \let\ptexstar=\*
102 \let\ptexsup=\sup
103 \let\ptext=\t
104 \let\ptextop=\top
105 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
106
107 % If this character appears in an error message or help string, it
108 % starts a new line in the output.
109 \newlinechar = `^^J
110
111 % Use TeX 3.0's \inputlineno to get the line number, for better error
112 % messages, but if we're using an old version of TeX, don't do anything.
113 %
114 \ifx\inputlineno\thisisundefined
115   \let\linenumber = \empty % Pre-3.0.
116 \else
117   \def\linenumber{l.\the\inputlineno:\space}
118 \fi
119
120 % Set up fixed words for English if not already set.
121 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
122 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
123 \ifx\putworderror\undefined     \gdef\putworderror{error}\fi
124 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
125 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
126 \ifx\putwordIndexIsEmpty\undefined       \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
127 \ifx\putwordIndexNonexistent\undefined   \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
128 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
129 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
130 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
131 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
132 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
133 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
134 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
135 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
136 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
137 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
138 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
139 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
140 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
141 %
142 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
143 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
144 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
145 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
146 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
147 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
148 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
149 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
150 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
151 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
152 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
153 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
154 %
155 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
156 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
157 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
158 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
159 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
160
161 % Give the space character the catcode for a space.
162 \def\spaceisspace{\catcode`\ =10\relax}
163
164 \chardef\dashChar  = `\-
165 \chardef\slashChar = `\/
166 \chardef\underChar = `\_
167
168 % Ignore a token.
169 %
170 \def\gobble#1{}
171
172 % The following is used inside several \edef's.
173 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
174
175 % Hyphenation fixes.
176 \hyphenation{
177   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
178   ap-pen-dix bit-map bit-maps
179   data-base data-bases eshell fall-ing half-way long-est man-u-script
180   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
181   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
182   spell-ing spell-ings
183   stand-alone strong-est time-stamp time-stamps which-ever white-space
184   wide-spread wrap-around
185 }
186
187 % Sometimes it is convenient to have everything in the transcript file
188 % and nothing on the terminal.  We don't just call \tracingall here,
189 % since that produces some useless output on the terminal.  We also make
190 % some effort to order the tracing commands to reduce output in the log
191 % file; cf. trace.sty in LaTeX.
192 %
193 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
194 \def\loggingall{%
195   \tracingstats2
196   \tracingpages1
197   \tracinglostchars2  % 2 gives us more in etex
198   \tracingparagraphs1
199   \tracingoutput1
200   \tracingmacros2
201   \tracingrestores1
202   \showboxbreadth\maxdimen \showboxdepth\maxdimen
203   \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
204     \tracingscantokens1
205     \tracingifs1
206     \tracinggroups1
207     \tracingnesting2
208     \tracingassigns1
209   \fi
210   \tracingcommands3  % 3 gives us more in etex
211   \errorcontextlines16
212 }%
213
214 % @errormsg{MSG}.  Do the index-like expansions on MSG, but if things
215 % aren't perfect, it's not the end of the world, being an error message,
216 % after all.
217
218 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
219 \def\doerrormsg#1{\errmessage{#1}}
220
221 % add check for \lastpenalty to plain's definitions.  If the last thing
222 % we did was a \nobreak, we don't want to insert more space.
223 %
224 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
225   \removelastskip\penalty-50\smallskip\fi\fi}
226 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
227   \removelastskip\penalty-100\medskip\fi\fi}
228 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
229   \removelastskip\penalty-200\bigskip\fi\fi}
230
231 %\f Output routine
232 %
233
234 % For a final copy, take out the rectangles
235 % that mark overfull boxes (in case you have decided
236 % that the text looks ok even though it passes the margin).
237 %
238 \def\finalout{\overfullrule=0pt }
239
240 % Do @cropmarks to get crop marks.
241 %
242 \newif\ifcropmarks
243 \let\cropmarks = \cropmarkstrue
244 %
245 % Dimensions to add cropmarks at corners.
246 % Added by P. A. MacKay, 12 Nov. 1986
247 %
248 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
249 \newdimen\cornerlong  \cornerlong=1pc
250 \newdimen\cornerthick \cornerthick=.3pt
251 \newdimen\topandbottommargin \topandbottommargin=.75in
252
253 % Output a mark which sets \thischapter, \thissection and \thiscolor.
254 % We dump everything together because we only have one kind of mark.
255 % This works because we only use \botmark / \topmark, not \firstmark.
256 %
257 % A mark contains a subexpression of the \ifcase ... \fi construct.
258 % \get*marks macros below extract the needed part using \ifcase.
259 %
260 % Another complication is to let the user choose whether \thischapter
261 % (\thissection) refers to the chapter (section) in effect at the top
262 % of a page, or that at the bottom of a page.
263
264 % \domark is called twice inside \chapmacro, to add one
265 % mark before the section break, and one after.
266 %   In the second call \prevchapterdefs is the same as \lastchapterdefs,
267 % and \prevsectiondefs is the same as \lastsectiondefs.
268 %   Then if the page is not broken at the mark, some of the previous
269 % section appears on the page, and we can get the name of this section
270 % from \firstmark for @everyheadingmarks top.
271 %   @everyheadingmarks bottom uses \botmark.
272 %
273 % See page 260 of The TeXbook.
274 \def\domark{%
275   \toks0=\expandafter{\lastchapterdefs}%
276   \toks2=\expandafter{\lastsectiondefs}%
277   \toks4=\expandafter{\prevchapterdefs}%
278   \toks6=\expandafter{\prevsectiondefs}%
279   \toks8=\expandafter{\lastcolordefs}%
280   \mark{%
281                    \the\toks0 \the\toks2  % 0: marks for @everyheadingmarks top
282       \noexpand\or \the\toks4 \the\toks6  % 1: for @everyheadingmarks bottom
283     \noexpand\else \the\toks8             % 2: color marks
284   }%
285 }
286
287 % \gettopheadingmarks, \getbottomheadingmarks,
288 % \getcolormarks - extract needed part of mark.
289 %
290 % \topmark doesn't work for the very first chapter (after the title
291 % page or the contents), so we use \firstmark there -- this gets us
292 % the mark with the chapter defs, unless the user sneaks in, e.g.,
293 % @setcolor (or @url, or @link, etc.) between @contents and the very
294 % first @chapter.
295 \def\gettopheadingmarks{%
296   \ifcase0\topmark\fi
297   \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
298 }
299 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
300 \def\getcolormarks{\ifcase2\topmark\fi}
301
302 % Avoid "undefined control sequence" errors.
303 \def\lastchapterdefs{}
304 \def\lastsectiondefs{}
305 \def\lastsection{}
306 \def\prevchapterdefs{}
307 \def\prevsectiondefs{}
308 \def\lastcolordefs{}
309
310 % Margin to add to right of even pages, to left of odd pages.
311 \newdimen\bindingoffset
312 \newdimen\normaloffset
313 \newdimen\txipagewidth \newdimen\txipageheight
314
315 % Main output routine.
316 %
317 \chardef\PAGE = 255
318 \output = {\onepageout{\pagecontents\PAGE}}
319
320 \newbox\headlinebox
321 \newbox\footlinebox
322
323 % \onepageout takes a vbox as an argument.
324 % \shipout a vbox for a single page, adding an optional header, footer,
325 % cropmarks, and footnote.  This also causes index entries for this page
326 % to be written to the auxiliary files.
327 %
328 \def\onepageout#1{%
329   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
330   %
331   \ifodd\pageno  \advance\hoffset by \bindingoffset
332   \else \advance\hoffset by -\bindingoffset\fi
333   %
334   % Common context changes for both heading and footing.
335   % Do this outside of the \shipout so @code etc. will be expanded in
336   % the headline as they should be, not taken literally (outputting ''code).
337   \def\commmonheadfootline{\let\hsize=\txipagewidth \texinfochars}
338   %
339   % Retrieve the information for the headings from the marks in the page,
340   % and call Plain TeX's \makeheadline and \makefootline, which use the
341   % values in \headline and \footline.
342   %
343   % This is used to check if we are on the first page of a chapter.
344   \ifcase1\topmark\fi
345   \let\prevchaptername\thischaptername
346   \ifcase0\firstmark\fi
347   \let\curchaptername\thischaptername
348   %
349   \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
350   \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
351   %
352   \ifx\curchaptername\prevchaptername
353     \let\thischapterheading\thischapter
354   \else
355     % \thischapterheading is the same as \thischapter except it is blank
356     % for the first page of a chapter.  This is to prevent the chapter name 
357     % being shown twice.
358     \def\thischapterheading{}%
359   \fi
360   %
361   \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
362   \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
363   %
364   {%
365     % Set context for writing to auxiliary files like index files.
366     % Have to do this stuff outside the \shipout because we want it to
367     % take effect in \write's, yet the group defined by the \vbox ends
368     % before the \shipout runs.
369     %
370     \indexdummies         % don't expand commands in the output.
371     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
372                % the page break happens to be in the middle of an example.
373                % We don't want .vr (or whatever) entries like this:
374                % \entry{{\indexbackslash }acronym}{32}{\code {\acronym}}
375                % "\acronym" won't work when it's read back in;
376                % it needs to be
377                % {\code {{\backslashcurfont }acronym}
378     \shipout\vbox{%
379       % Do this early so pdf references go to the beginning of the page.
380       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
381       %
382       \ifcropmarks \vbox to \outervsize\bgroup
383         \hsize = \outerhsize
384         \vskip-\topandbottommargin
385         \vtop to0pt{%
386           \line{\ewtop\hfil\ewtop}%
387           \nointerlineskip
388           \line{%
389             \vbox{\moveleft\cornerthick\nstop}%
390             \hfill
391             \vbox{\moveright\cornerthick\nstop}%
392           }%
393           \vss}%
394         \vskip\topandbottommargin
395         \line\bgroup
396           \hfil % center the page within the outer (page) hsize.
397           \ifodd\pageno\hskip\bindingoffset\fi
398           \vbox\bgroup
399       \fi
400       %
401       \unvbox\headlinebox
402       \pagebody{#1}%
403       \ifdim\ht\footlinebox > 0pt
404         % Only leave this space if the footline is nonempty.
405         % (We lessened \vsize for it in \oddfootingyyy.)
406         % The \baselineskip=24pt in plain's \makefootline has no effect.
407         \vskip 24pt
408         \unvbox\footlinebox
409       \fi
410       %
411       \ifcropmarks
412           \egroup % end of \vbox\bgroup
413         \hfil\egroup % end of (centering) \line\bgroup
414         \vskip\topandbottommargin plus1fill minus1fill
415         \boxmaxdepth = \cornerthick
416         \vbox to0pt{\vss
417           \line{%
418             \vbox{\moveleft\cornerthick\nsbot}%
419             \hfill
420             \vbox{\moveright\cornerthick\nsbot}%
421           }%
422           \nointerlineskip
423           \line{\ewbot\hfil\ewbot}%
424         }%
425       \egroup % \vbox from first cropmarks clause
426       \fi
427     }% end of \shipout\vbox
428   }% end of group with \indexdummies
429   \advancepageno
430   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
431 }
432
433 \newinsert\margin \dimen\margin=\maxdimen
434
435 % Main part of page, including any footnotes
436 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
437 {\catcode`\@ =11
438 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
439 % marginal hacks, juha@viisa.uucp (Juha Takala)
440 \ifvoid\margin\else % marginal info is present
441   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
442 \dimen@=\dp#1\relax \unvbox#1\relax
443 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
444 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
445 }
446
447 % Here are the rules for the cropmarks.  Note that they are
448 % offset so that the space between them is truly \outerhsize or \outervsize
449 % (P. A. MacKay, 12 November, 1986)
450 %
451 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
452 \def\nstop{\vbox
453   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
454 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
455 \def\nsbot{\vbox
456   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
457
458
459 % Argument parsing
460
461 % Parse an argument, then pass it to #1.  The argument is the rest of
462 % the input line (except we remove a trailing comment).  #1 should be a
463 % macro which expects an ordinary undelimited TeX argument.
464 % For example, \def\foo{\parsearg\fooxxx}.
465 %
466 \def\parsearg{\parseargusing{}}
467 \def\parseargusing#1#2{%
468   \def\argtorun{#2}%
469   \begingroup
470     \obeylines
471     \spaceisspace
472     #1%
473     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
474 }
475
476 {\obeylines %
477   \gdef\parseargline#1^^M{%
478     \endgroup % End of the group started in \parsearg.
479     \argremovecomment #1\comment\ArgTerm%
480   }%
481 }
482
483 % First remove any @comment, then any @c comment.  Also remove a @texinfoc
484 % comment (see \scanmacro for details).  Pass the result on to \argcheckspaces.
485 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
486 \def\argremovec#1\c#2\ArgTerm{\argremovetexinfoc #1\texinfoc\ArgTerm}
487 \def\argremovetexinfoc#1\texinfoc#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
488
489 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
490 %
491 % \argremovec might leave us with trailing space, e.g.,
492 %    @end itemize  @c foo
493 % This space token undergoes the same procedure and is eventually removed
494 % by \finishparsearg.
495 %
496 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
497 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
498 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
499   \def\temp{#3}%
500   \ifx\temp\empty
501     % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
502     \let\temp\finishparsearg
503   \else
504     \let\temp\argcheckspaces
505   \fi
506   % Put the space token in:
507   \temp#1 #3\ArgTerm
508 }
509
510 % If a _delimited_ argument is enclosed in braces, they get stripped; so
511 % to get _exactly_ the rest of the line, we had to prevent such situation.
512 % We prepended an \empty token at the very beginning and we expand it now,
513 % just before passing the control to \argtorun.
514 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
515 % either the null string, or it ends with \^^M---thus there is no danger
516 % that a pair of braces would be stripped.
517 %
518 % But first, we have to remove the trailing space token.
519 %
520 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
521
522
523 % \parseargdef - define a command taking an argument on the line
524 %
525 % \parseargdef\foo{...}
526 %       is roughly equivalent to
527 % \def\foo{\parsearg\Xfoo}
528 % \def\Xfoo#1{...}
529 \def\parseargdef#1{%
530   \expandafter \doparseargdef \csname\string#1\endcsname #1%
531 }
532 \def\doparseargdef#1#2{%
533   \def#2{\parsearg#1}%
534   \def#1##1%
535 }
536
537 % Several utility definitions with active space:
538 {
539   \obeyspaces
540   \gdef\obeyedspace{ }
541
542   % Make each space character in the input produce a normal interword
543   % space in the output.  Don't allow a line break at this space, as this
544   % is used only in environments like @example, where each line of input
545   % should produce a line of output anyway.
546   %
547   \gdef\sepspaces{\obeyspaces\let =\tie}
548
549   % If an index command is used in an @example environment, any spaces
550   % therein should become regular spaces in the raw index file, not the
551   % expansion of \tie (\leavevmode \penalty \@M \ ).
552   \gdef\unsepspaces{\let =\space}
553 }
554
555
556 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
557
558 % Define the framework for environments in texinfo.tex.  It's used like this:
559 %
560 %   \envdef\foo{...}
561 %   \def\Efoo{...}
562 %
563 % It's the responsibility of \envdef to insert \begingroup before the
564 % actual body; @end closes the group after calling \Efoo.  \envdef also
565 % defines \thisenv, so the current environment is known; @end checks
566 % whether the environment name matches.  The \checkenv macro can also be
567 % used to check whether the current environment is the one expected.
568 %
569 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
570 % are not treated as environments; they don't open a group.  (The
571 % implementation of @end takes care not to call \endgroup in this
572 % special case.)
573
574
575 % At run-time, environments start with this:
576 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
577 % initialize
578 \let\thisenv\empty
579
580 % ... but they get defined via ``\envdef\foo{...}'':
581 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
582 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
583
584 % Check whether we're in the right environment:
585 \def\checkenv#1{%
586   \def\temp{#1}%
587   \ifx\thisenv\temp
588   \else
589     \badenverr
590   \fi
591 }
592
593 % Environment mismatch, #1 expected:
594 \def\badenverr{%
595   \errhelp = \EMsimple
596   \errmessage{This command can appear only \inenvironment\temp,
597     not \inenvironment\thisenv}%
598 }
599 \def\inenvironment#1{%
600   \ifx#1\empty
601     outside of any environment%
602   \else
603     in environment \expandafter\string#1%
604   \fi
605 }
606
607 % @end foo executes the definition of \Efoo.
608 % But first, it executes a specialized version of \checkenv
609 %
610 \parseargdef\end{%
611   \if 1\csname iscond.#1\endcsname
612   \else
613     % The general wording of \badenverr may not be ideal.
614     \expandafter\checkenv\csname#1\endcsname
615     \csname E#1\endcsname
616     \endgroup
617   \fi
618 }
619
620 \newhelp\EMsimple{Press RETURN to continue.}
621
622
623 % Be sure we're in horizontal mode when doing a tie, since we make space
624 % equivalent to this in @example-like environments. Otherwise, a space
625 % at the beginning of a line will start with \penalty -- and
626 % since \penalty is valid in vertical mode, we'd end up putting the
627 % penalty on the vertical list instead of in the new paragraph.
628 {\catcode`@ = 11
629  % Avoid using \@M directly, because that causes trouble
630  % if the definition is written into an index file.
631  \global\let\tiepenalty = \@M
632  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
633 }
634
635 % @: forces normal size whitespace following.
636 \def\:{\spacefactor=1000 }
637
638 % @* forces a line break.
639 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
640
641 % @/ allows a line break.
642 \let\/=\allowbreak
643
644 % @. is an end-of-sentence period.
645 \def\.{.\spacefactor=\endofsentencespacefactor\space}
646
647 % @! is an end-of-sentence bang.
648 \def\!{!\spacefactor=\endofsentencespacefactor\space}
649
650 % @? is an end-of-sentence query.
651 \def\?{?\spacefactor=\endofsentencespacefactor\space}
652
653 % @frenchspacing on|off  says whether to put extra space after punctuation.
654 %
655 \def\onword{on}
656 \def\offword{off}
657 %
658 \parseargdef\frenchspacing{%
659   \def\temp{#1}%
660   \ifx\temp\onword \plainfrenchspacing
661   \else\ifx\temp\offword \plainnonfrenchspacing
662   \else
663     \errhelp = \EMsimple
664     \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
665   \fi\fi
666 }
667
668 % @w prevents a word break.  Without the \leavevmode, @w at the
669 % beginning of a paragraph, when TeX is still in vertical mode, would
670 % produce a whole line of output instead of starting the paragraph.
671 \def\w#1{\leavevmode\hbox{#1}}
672
673 % @group ... @end group forces ... to be all on one page, by enclosing
674 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
675 % to keep its height that of a normal line.  According to the rules for
676 % \topskip (p.114 of the TeXbook), the glue inserted is
677 % max (\topskip - \ht (first item), 0).  If that height is large,
678 % therefore, no glue is inserted, and the space between the headline and
679 % the text is small, which looks bad.
680 %
681 % Another complication is that the group might be very large.  This can
682 % cause the glue on the previous page to be unduly stretched, because it
683 % does not have much material.  In this case, it's better to add an
684 % explicit \vfill so that the extra space is at the bottom.  The
685 % threshold for doing this is if the group is more than \vfilllimit
686 % percent of a page (\vfilllimit can be changed inside of @tex).
687 %
688 \newbox\groupbox
689 \def\vfilllimit{0.7}
690 %
691 \envdef\group{%
692   \ifnum\catcode`\^^M=\active \else
693     \errhelp = \groupinvalidhelp
694     \errmessage{@group invalid in context where filling is enabled}%
695   \fi
696   \startsavinginserts
697   %
698   \setbox\groupbox = \vtop\bgroup
699     % Do @comment since we are called inside an environment such as
700     % @example, where each end-of-line in the input causes an
701     % end-of-line in the output.  We don't want the end-of-line after
702     % the `@group' to put extra space in the output.  Since @group
703     % should appear on a line by itself (according to the Texinfo
704     % manual), we don't worry about eating any user text.
705     \comment
706 }
707 %
708 % The \vtop produces a box with normal height and large depth; thus, TeX puts
709 % \baselineskip glue before it, and (when the next line of text is done)
710 % \lineskip glue after it.  Thus, space below is not quite equal to space
711 % above.  But it's pretty close.
712 \def\Egroup{%
713     % To get correct interline space between the last line of the group
714     % and the first line afterwards, we have to propagate \prevdepth.
715     \endgraf % Not \par, as it may have been set to \lisppar.
716     \global\dimen1 = \prevdepth
717   \egroup           % End the \vtop.
718   \addgroupbox
719   \prevdepth = \dimen1
720   \checkinserts
721 }
722
723 \def\addgroupbox{
724   % \dimen0 is the vertical size of the group's box.
725   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
726   % \dimen2 is how much space is left on the page (more or less).
727   \dimen2 = \txipageheight   \advance\dimen2 by -\pagetotal
728   % if the group doesn't fit on the current page, and it's a big big
729   % group, force a page break.
730   \ifdim \dimen0 > \dimen2
731     \ifdim \pagetotal < \vfilllimit\txipageheight
732       \page
733     \fi
734   \fi
735   \box\groupbox
736 }
737
738 %
739 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
740 % message, so this ends up printing `@group can only ...'.
741 %
742 \newhelp\groupinvalidhelp{%
743 group can only be used in environments such as @example,^^J%
744 where each line of input produces a line of output.}
745
746 % @need space-in-mils
747 % forces a page break if there is not space-in-mils remaining.
748
749 \newdimen\mil  \mil=0.001in
750
751 \parseargdef\need{%
752   % Ensure vertical mode, so we don't make a big box in the middle of a
753   % paragraph.
754   \par
755   %
756   % If the @need value is less than one line space, it's useless.
757   \dimen0 = #1\mil
758   \dimen2 = \ht\strutbox
759   \advance\dimen2 by \dp\strutbox
760   \ifdim\dimen0 > \dimen2
761     %
762     % Do a \strut just to make the height of this box be normal, so the
763     % normal leading is inserted relative to the preceding line.
764     % And a page break here is fine.
765     \vtop to #1\mil{\strut\vfil}%
766     %
767     % TeX does not even consider page breaks if a penalty added to the
768     % main vertical list is 10000 or more.  But in order to see if the
769     % empty box we just added fits on the page, we must make it consider
770     % page breaks.  On the other hand, we don't want to actually break the
771     % page after the empty box.  So we use a penalty of 9999.
772     %
773     % There is an extremely small chance that TeX will actually break the
774     % page at this \penalty, if there are no other feasible breakpoints in
775     % sight.  (If the user is using lots of big @group commands, which
776     % almost-but-not-quite fill up a page, TeX will have a hard time doing
777     % good page breaking, for example.)  However, I could not construct an
778     % example where a page broke at this \penalty; if it happens in a real
779     % document, then we can reconsider our strategy.
780     \penalty9999
781     %
782     % Back up by the size of the box, whether we did a page break or not.
783     \kern -#1\mil
784     %
785     % Do not allow a page break right after this kern.
786     \nobreak
787   \fi
788 }
789
790 % @br   forces paragraph break (and is undocumented).
791
792 \let\br = \par
793
794 % @page forces the start of a new page.
795 %
796 \def\page{\par\vfill\supereject}
797
798 % @exdent text....
799 % outputs text on separate line in roman font, starting at standard page margin
800
801 % This records the amount of indent in the innermost environment.
802 % That's how much \exdent should take out.
803 \newskip\exdentamount
804
805 % This defn is used inside fill environments such as @defun.
806 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
807
808 % This defn is used inside nofill environments such as @example.
809 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
810   \leftline{\hskip\leftskip{\rm#1}}}}
811
812 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
813 % paragraph.  For more general purposes, use the \margin insertion
814 % class.  WHICH is `l' or `r'.  Not documented, written for gawk manual.
815 %
816 \newskip\inmarginspacing \inmarginspacing=1cm
817 \def\strutdepth{\dp\strutbox}
818 %
819 \def\doinmargin#1#2{\strut\vadjust{%
820   \nobreak
821   \kern-\strutdepth
822   \vtop to \strutdepth{%
823     \baselineskip=\strutdepth
824     \vss
825     % if you have multiple lines of stuff to put here, you'll need to
826     % make the vbox yourself of the appropriate size.
827     \ifx#1l%
828       \llap{\ignorespaces #2\hskip\inmarginspacing}%
829     \else
830       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
831     \fi
832     \null
833   }%
834 }}
835 \def\inleftmargin{\doinmargin l}
836 \def\inrightmargin{\doinmargin r}
837 %
838 % @inmargin{TEXT [, RIGHT-TEXT]}
839 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
840 % else use TEXT for both).
841 %
842 \def\inmargin#1{\parseinmargin #1,,\finish}
843 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
844   \setbox0 = \hbox{\ignorespaces #2}%
845   \ifdim\wd0 > 0pt
846     \def\lefttext{#1}%  have both texts
847     \def\righttext{#2}%
848   \else
849     \def\lefttext{#1}%  have only one text
850     \def\righttext{#1}%
851   \fi
852   %
853   \ifodd\pageno
854     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
855   \else
856     \def\temp{\inleftmargin\lefttext}%
857   \fi
858   \temp
859 }
860
861 % @| inserts a changebar to the left of the current line.  It should
862 % surround any changed text.  This approach does *not* work if the
863 % change spans more than two lines of output.  To handle that, we would
864 % have adopt a much more difficult approach (putting marks into the main
865 % vertical list for the beginning and end of each change).  This command
866 % is not documented, not supported, and doesn't work.
867 %
868 \def\|{%
869   % \vadjust can only be used in horizontal mode.
870   \leavevmode
871   %
872   % Append this vertical mode material after the current line in the output.
873   \vadjust{%
874     % We want to insert a rule with the height and depth of the current
875     % leading; that is exactly what \strutbox is supposed to record.
876     \vskip-\baselineskip
877     %
878     % \vadjust-items are inserted at the left edge of the type.  So
879     % the \llap here moves out into the left-hand margin.
880     \llap{%
881       %
882       % For a thicker or thinner bar, change the `1pt'.
883       \vrule height\baselineskip width1pt
884       %
885       % This is the space between the bar and the text.
886       \hskip 12pt
887     }%
888   }%
889 }
890
891 % @include FILE -- \input text of FILE.
892 %
893 \def\include{\parseargusing\filenamecatcodes\includezzz}
894 \def\includezzz#1{%
895   \pushthisfilestack
896   \def\thisfile{#1}%
897   {%
898     \makevalueexpandable  % we want to expand any @value in FILE.
899     \turnoffactive        % and allow special characters in the expansion
900     \indexnofonts         % Allow `@@' and other weird things in file names.
901     \wlog{texinfo.tex: doing @include of #1^^J}%
902     \edef\temp{\noexpand\input #1 }%
903     %
904     % This trickery is to read FILE outside of a group, in case it makes
905     % definitions, etc.
906     \expandafter
907   }\temp
908   \popthisfilestack
909 }
910 \def\filenamecatcodes{%
911   \catcode`\\=\other
912   \catcode`~=\other
913   \catcode`^=\other
914   \catcode`_=\other
915   \catcode`|=\other
916   \catcode`<=\other
917   \catcode`>=\other
918   \catcode`+=\other
919   \catcode`-=\other
920   \catcode`\`=\other
921   \catcode`\'=\other
922 }
923
924 \def\pushthisfilestack{%
925   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
926 }
927 \def\pushthisfilestackX{%
928   \expandafter\pushthisfilestackY\thisfile\StackTerm
929 }
930 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
931   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
932 }
933
934 \def\popthisfilestack{\errthisfilestackempty}
935 \def\errthisfilestackempty{\errmessage{Internal error:
936   the stack of filenames is empty.}}
937 %
938 \def\thisfile{}
939
940 % @center line
941 % outputs that line, centered.
942 %
943 \parseargdef\center{%
944   \ifhmode
945     \let\centersub\centerH
946   \else
947     \let\centersub\centerV
948   \fi
949   \centersub{\hfil \ignorespaces#1\unskip \hfil}%
950   \let\centersub\relax % don't let the definition persist, just in case
951 }
952 \def\centerH#1{{%
953   \hfil\break
954   \advance\hsize by -\leftskip
955   \advance\hsize by -\rightskip
956   \line{#1}%
957   \break
958 }}
959 %
960 \newcount\centerpenalty
961 \def\centerV#1{%
962   % The idea here is the same as in \startdefun, \cartouche, etc.: if
963   % @center is the first thing after a section heading, we need to wipe
964   % out the negative parskip inserted by \sectionheading, but still
965   % prevent a page break here.
966   \centerpenalty = \lastpenalty
967   \ifnum\centerpenalty>10000 \vskip\parskip \fi
968   \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
969   \line{\kern\leftskip #1\kern\rightskip}%
970 }
971
972 % @sp n   outputs n lines of vertical space
973 %
974 \parseargdef\sp{\vskip #1\baselineskip}
975
976 % @comment ...line which is ignored...
977 % @c is the same as @comment
978 % @ignore ... @end ignore  is another way to write a comment
979 %
980 \def\comment{\begingroup \catcode`\^^M=\active%
981 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other\commentxxx}%
982
983 {\catcode`\^^M=\active%
984 \gdef\commentxxx#1^^M{\endgroup%
985 \futurelet\nexttoken\commentxxxx}%
986 \gdef\commentxxxx{\ifx\nexttoken\aftermacro\expandafter\comment\fi}%
987 }
988
989 \def\c{\begingroup \catcode`\^^M=\active%
990 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
991 \cxxx}
992 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
993 % See comment in \scanmacro about why the definitions of @c and @comment differ
994
995 % @paragraphindent NCHARS
996 % We'll use ems for NCHARS, close enough.
997 % NCHARS can also be the word `asis' or `none'.
998 % We cannot feasibly implement @paragraphindent asis, though.
999 %
1000 \def\asisword{asis} % no translation, these are keywords
1001 \def\noneword{none}
1002 %
1003 \parseargdef\paragraphindent{%
1004   \def\temp{#1}%
1005   \ifx\temp\asisword
1006   \else
1007     \ifx\temp\noneword
1008       \defaultparindent = 0pt
1009     \else
1010       \defaultparindent = #1em
1011     \fi
1012   \fi
1013   \parindent = \defaultparindent
1014 }
1015
1016 % @exampleindent NCHARS
1017 % We'll use ems for NCHARS like @paragraphindent.
1018 % It seems @exampleindent asis isn't necessary, but
1019 % I preserve it to make it similar to @paragraphindent.
1020 \parseargdef\exampleindent{%
1021   \def\temp{#1}%
1022   \ifx\temp\asisword
1023   \else
1024     \ifx\temp\noneword
1025       \lispnarrowing = 0pt
1026     \else
1027       \lispnarrowing = #1em
1028     \fi
1029   \fi
1030 }
1031
1032 % @firstparagraphindent WORD
1033 % If WORD is `none', then suppress indentation of the first paragraph
1034 % after a section heading.  If WORD is `insert', then do indent at such
1035 % paragraphs.
1036 %
1037 % The paragraph indentation is suppressed or not by calling
1038 % \suppressfirstparagraphindent, which the sectioning commands do.
1039 % We switch the definition of this back and forth according to WORD.
1040 % By default, we suppress indentation.
1041 %
1042 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1043 \def\insertword{insert}
1044 %
1045 \parseargdef\firstparagraphindent{%
1046   \def\temp{#1}%
1047   \ifx\temp\noneword
1048     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1049   \else\ifx\temp\insertword
1050     \let\suppressfirstparagraphindent = \relax
1051   \else
1052     \errhelp = \EMsimple
1053     \errmessage{Unknown @firstparagraphindent option `\temp'}%
1054   \fi\fi
1055 }
1056
1057 % Here is how we actually suppress indentation.  Redefine \everypar to
1058 % \kern backwards by \parindent, and then reset itself to empty.
1059 %
1060 % We also make \indent itself not actually do anything until the next
1061 % paragraph.
1062 %
1063 \gdef\dosuppressfirstparagraphindent{%
1064   \gdef\indent  {\restorefirstparagraphindent \indent}%
1065   \gdef\noindent{\restorefirstparagraphindent \noindent}%
1066   \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
1067 }
1068 %
1069 \gdef\restorefirstparagraphindent{%
1070   \global\let\indent = \ptexindent
1071   \global\let\noindent = \ptexnoindent
1072   \global\everypar = {}%
1073 }
1074
1075
1076 % @refill is a no-op.
1077 \let\refill=\relax
1078
1079 % @setfilename INFO-FILENAME - ignored
1080 \let\setfilename=\comment
1081
1082 % @bye.
1083 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1084
1085
1086 \message{pdf,}
1087 % adobe `portable' document format
1088 \newcount\tempnum
1089 \newcount\lnkcount
1090 \newtoks\filename
1091 \newcount\filenamelength
1092 \newcount\pgn
1093 \newtoks\toksA
1094 \newtoks\toksB
1095 \newtoks\toksC
1096 \newtoks\toksD
1097 \newbox\boxA
1098 \newbox\boxB
1099 \newcount\countA
1100 \newif\ifpdf
1101 \newif\ifpdfmakepagedest
1102
1103 %
1104 % For LuaTeX
1105 %
1106
1107 \ifx\luatexversion\thisisundefined
1108 \else
1109   % Escape PDF strings UTF-8 to UTF-16
1110   \begingroup
1111     \catcode`\%=12
1112     \directlua{
1113       function UTF16oct(str)
1114         tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
1115         for c in string.utfvalues(str) do
1116           if c < 0x10000 then
1117             tex.sprint(
1118               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1119                             string.char(0x5c) .. string.char(0x25) .. '03o',
1120                             (c / 256), (c % 256)))
1121           else
1122             c = c - 0x10000
1123             local c_hi = c / 1024 + 0xd800
1124             local c_lo = c % 1024 + 0xdc00
1125             tex.sprint(
1126               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1127                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
1128                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
1129                             string.char(0x5c) .. string.char(0x25) .. '03o',
1130                             (c_hi / 256), (c_hi % 256),
1131                             (c_lo / 256), (c_lo % 256)))
1132           end
1133         end
1134       end
1135     }
1136   \endgroup
1137   \def\pdfescapestring#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
1138   \ifnum\luatexversion>84
1139     % For LuaTeX >= 0.85
1140     \def\pdfdest{\pdfextension dest}
1141     \let\pdfoutput\outputmode
1142     \def\pdfliteral{\pdfextension literal}
1143     \def\pdfcatalog{\pdfextension catalog}
1144     \def\pdftexversion{\numexpr\pdffeedback version\relax}
1145     \let\pdfximage\saveimageresource
1146     \let\pdfrefximage\useimageresource
1147     \let\pdflastximage\lastsavedimageresourceindex
1148     \def\pdfendlink{\pdfextension endlink\relax}
1149     \def\pdfoutline{\pdfextension outline}
1150     \def\pdfstartlink{\pdfextension startlink}
1151     \def\pdffontattr{\pdfextension fontattr}
1152     \def\pdfobj{\pdfextension obj}
1153     \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
1154     \let\pdfpagewidth\pagewidth
1155     \let\pdfpageheight\pageheight
1156     \edef\pdfhorigin{\pdfvariable horigin}
1157     \edef\pdfvorigin{\pdfvariable vorigin}
1158   \fi
1159 \fi
1160
1161 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1162 % can be set).  So we test for \relax and 0 as well as being undefined.
1163 \ifx\pdfoutput\thisisundefined
1164 \else
1165   \ifx\pdfoutput\relax
1166   \else
1167     \ifcase\pdfoutput
1168     \else
1169       \pdftrue
1170     \fi
1171   \fi
1172 \fi
1173
1174 % PDF uses PostScript string constants for the names of xref targets,
1175 % for display in the outlines, and in other places.  Thus, we have to
1176 % double any backslashes.  Otherwise, a name like "\node" will be
1177 % interpreted as a newline (\n), followed by o, d, e.  Not good.
1178
1179 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1180 % related messages.  The final outcome is that it is up to the TeX user
1181 % to double the backslashes and otherwise make the string valid, so
1182 % that's what we do.  pdftex 1.30.0 (ca.2005) introduced a primitive to
1183 % do this reliably, so we use it.
1184
1185 % #1 is a control sequence in which to do the replacements,
1186 % which we \xdef.
1187 \def\txiescapepdf#1{%
1188   \ifx\pdfescapestring\thisisundefined
1189     % No primitive available; should we give a warning or log?
1190     % Many times it won't matter.
1191   \else
1192     % The expandable \pdfescapestring primitive escapes parentheses,
1193     % backslashes, and other special chars.
1194     \xdef#1{\pdfescapestring{#1}}%
1195   \fi
1196 }
1197
1198 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1199 with PDF output, and none of those formats could be found.  (.eps cannot
1200 be supported due to the design of the PDF format; use regular TeX (DVI
1201 output) for that.)}
1202
1203 \ifpdf
1204   %
1205   % Color manipulation macros using ideas from pdfcolor.tex,
1206   % except using rgb instead of cmyk; the latter is said to render as a
1207   % very dark gray on-screen and a very dark halftone in print, instead
1208   % of actual black. The dark red here is dark enough to print on paper as
1209   % nearly black, but still distinguishable for online viewing.  We use
1210   % black by default, though.
1211   \def\rgbDarkRed{0.50 0.09 0.12}
1212   \def\rgbBlack{0 0 0}
1213   %
1214   % rg sets the color for filling (usual text, etc.);
1215   % RG sets the color for stroking (thin rules, e.g., normal _'s).
1216   \def\pdfsetcolor#1{\pdfliteral{#1 rg  #1 RG}}
1217   %
1218   % Set color, and create a mark which defines \thiscolor accordingly,
1219   % so that \makeheadline knows which color to restore.
1220   \def\setcolor#1{%
1221     \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1222     \domark
1223     \pdfsetcolor{#1}%
1224   }
1225   %
1226   \def\maincolor{\rgbBlack}
1227   \pdfsetcolor{\maincolor}
1228   \edef\thiscolor{\maincolor}
1229   \def\lastcolordefs{}
1230   %
1231   \def\makefootline{%
1232     \baselineskip24pt
1233     \line{\pdfsetcolor{\maincolor}\the\footline}%
1234   }
1235   %
1236   \def\makeheadline{%
1237     \vbox to 0pt{%
1238       \vskip-22.5pt
1239       \line{%
1240         \vbox to8.5pt{}%
1241         % Extract \thiscolor definition from the marks.
1242         \getcolormarks
1243         % Typeset the headline with \maincolor, then restore the color.
1244         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1245       }%
1246       \vss
1247     }%
1248     \nointerlineskip
1249   }
1250   %
1251   %
1252   \pdfcatalog{/PageMode /UseOutlines}
1253   %
1254   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1255   \def\dopdfimage#1#2#3{%
1256     \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1257     \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1258     %
1259     % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1260     % others).  Let's try in that order, PDF first since if
1261     % someone has a scalable image, presumably better to use that than a
1262     % bitmap.
1263     \let\pdfimgext=\empty
1264     \begingroup
1265       \openin 1 #1.pdf \ifeof 1
1266         \openin 1 #1.PDF \ifeof 1
1267           \openin 1 #1.png \ifeof 1
1268             \openin 1 #1.jpg \ifeof 1
1269               \openin 1 #1.jpeg \ifeof 1
1270                 \openin 1 #1.JPG \ifeof 1
1271                   \errhelp = \nopdfimagehelp
1272                   \errmessage{Could not find image file #1 for pdf}%
1273                 \else \gdef\pdfimgext{JPG}%
1274                 \fi
1275               \else \gdef\pdfimgext{jpeg}%
1276               \fi
1277             \else \gdef\pdfimgext{jpg}%
1278             \fi
1279           \else \gdef\pdfimgext{png}%
1280           \fi
1281         \else \gdef\pdfimgext{PDF}%
1282         \fi
1283       \else \gdef\pdfimgext{pdf}%
1284       \fi
1285       \closein 1
1286     \endgroup
1287     %
1288     % without \immediate, ancient pdftex seg faults when the same image is
1289     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1290     \ifnum\pdftexversion < 14
1291       \immediate\pdfimage
1292     \else
1293       \immediate\pdfximage
1294     \fi
1295       \ifdim \wd0 >0pt width \pdfimagewidth \fi
1296       \ifdim \wd2 >0pt height \pdfimageheight \fi
1297       \ifnum\pdftexversion<13
1298          #1.\pdfimgext
1299        \else
1300          {#1.\pdfimgext}%
1301        \fi
1302     \ifnum\pdftexversion < 14 \else
1303       \pdfrefximage \pdflastximage
1304     \fi}
1305   %
1306   \def\pdfmkdest#1{{%
1307     % We have to set dummies so commands such as @code, and characters
1308     % such as \, aren't expanded when present in a section title.
1309     \indexnofonts
1310     \turnoffactive
1311     \makevalueexpandable
1312     \def\pdfdestname{#1}%
1313     \txiescapepdf\pdfdestname
1314     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1315   }}
1316   %
1317   % used to mark target names; must be expandable.
1318   \def\pdfmkpgn#1{#1}
1319   %
1320   % by default, use black for everything.
1321   \def\urlcolor{\rgbBlack}
1322   \def\linkcolor{\rgbBlack}
1323   \def\endlink{\setcolor{\maincolor}\pdfendlink}
1324   %
1325   % Adding outlines to PDF; macros for calculating structure of outlines
1326   % come from Petr Olsak
1327   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1328     \else \csname#1\endcsname \fi}
1329   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1330     \advance\tempnum by 1
1331     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1332   %
1333   % #1 is the section text, which is what will be displayed in the
1334   % outline by the pdf viewer.  #2 is the pdf expression for the number
1335   % of subentries (or empty, for subsubsections).  #3 is the node text,
1336   % which might be empty if this toc entry had no corresponding node.
1337   % #4 is the page number
1338   %
1339   \def\dopdfoutline#1#2#3#4{%
1340     % Generate a link to the node text if that exists; else, use the
1341     % page number.  We could generate a destination for the section
1342     % text in the case where a section has no node, but it doesn't
1343     % seem worth the trouble, since most documents are normally structured.
1344     {
1345       \ifx\luatexversion\thisisundefined \else
1346         \turnoffactive % LuaTeX can use Unicode strings for PDF
1347       \fi
1348       \edef\pdfoutlinedest{#3}%
1349       \ifx\pdfoutlinedest\empty
1350         \def\pdfoutlinedest{#4}%
1351       \else
1352         \txiescapepdf\pdfoutlinedest
1353       \fi
1354       %
1355       % Also escape PDF chars in the display string.
1356       \edef\pdfoutlinetext{#1}%
1357       \txiescapepdf\pdfoutlinetext
1358       %
1359       \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1360     }
1361   }
1362   %
1363   \def\pdfmakeoutlines{%
1364     \begingroup
1365       % Read toc silently, to get counts of subentries for \pdfoutline.
1366       \def\partentry##1##2##3##4{}% ignore parts in the outlines
1367       \def\numchapentry##1##2##3##4{%
1368         \def\thischapnum{##2}%
1369         \def\thissecnum{0}%
1370         \def\thissubsecnum{0}%
1371       }%
1372       \def\numsecentry##1##2##3##4{%
1373         \advancenumber{chap\thischapnum}%
1374         \def\thissecnum{##2}%
1375         \def\thissubsecnum{0}%
1376       }%
1377       \def\numsubsecentry##1##2##3##4{%
1378         \advancenumber{sec\thissecnum}%
1379         \def\thissubsecnum{##2}%
1380       }%
1381       \def\numsubsubsecentry##1##2##3##4{%
1382         \advancenumber{subsec\thissubsecnum}%
1383       }%
1384       \def\thischapnum{0}%
1385       \def\thissecnum{0}%
1386       \def\thissubsecnum{0}%
1387       %
1388       % use \def rather than \let here because we redefine \chapentry et
1389       % al. a second time, below.
1390       \def\appentry{\numchapentry}%
1391       \def\appsecentry{\numsecentry}%
1392       \def\appsubsecentry{\numsubsecentry}%
1393       \def\appsubsubsecentry{\numsubsubsecentry}%
1394       \def\unnchapentry{\numchapentry}%
1395       \def\unnsecentry{\numsecentry}%
1396       \def\unnsubsecentry{\numsubsecentry}%
1397       \def\unnsubsubsecentry{\numsubsubsecentry}%
1398       \readdatafile{toc}%
1399       %
1400       % Read toc second time, this time actually producing the outlines.
1401       % The `-' means take the \expnumber as the absolute number of
1402       % subentries, which we calculated on our first read of the .toc above.
1403       %
1404       % We use the node names as the destinations.
1405       \def\numchapentry##1##2##3##4{%
1406         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1407       \def\numsecentry##1##2##3##4{%
1408         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1409       \def\numsubsecentry##1##2##3##4{%
1410         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1411       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1412         \dopdfoutline{##1}{}{##3}{##4}}%
1413       %
1414       % PDF outlines are displayed using system fonts, instead of
1415       % document fonts.  Therefore we cannot use special characters,
1416       % since the encoding is unknown.  For example, the eogonek from
1417       % Latin 2 (0xea) gets translated to a | character.  Info from
1418       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1419       %
1420       % TODO this right, we have to translate 8-bit characters to
1421       % their "best" equivalent, based on the @documentencoding.  Too
1422       % much work for too little return.  Just use the ASCII equivalents
1423       % we use for the index sort strings.
1424       % 
1425       \indexnofonts
1426       \setupdatafile
1427       % We can have normal brace characters in the PDF outlines, unlike
1428       % Texinfo index files.  So set that up.
1429       \def\{{\lbracecharliteral}%
1430       \def\}{\rbracecharliteral}%
1431       \catcode`\\=\active \otherbackslash
1432       \input \tocreadfilename
1433     \endgroup
1434   }
1435   {\catcode`[=1 \catcode`]=2
1436    \catcode`{=\other \catcode`}=\other
1437    \gdef\lbracecharliteral[{]%
1438    \gdef\rbracecharliteral[}]%
1439   ]
1440   %
1441   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1442     \ifx\PP\D\let\nextsp\relax
1443     \else\let\nextsp\skipspaces
1444       \addtokens{\filename}{\PP}%
1445       \advance\filenamelength by 1
1446     \fi
1447     \nextsp}
1448   \def\getfilename#1{%
1449     \filenamelength=0
1450     % If we don't expand the argument now, \skipspaces will get
1451     % snagged on things like "@value{foo}".
1452     \edef\temp{#1}%
1453     \expandafter\skipspaces\temp|\relax
1454   }
1455   \ifnum\pdftexversion < 14
1456     \let \startlink \pdfannotlink
1457   \else
1458     \let \startlink \pdfstartlink
1459   \fi
1460   % make a live url in pdf output.
1461   \def\pdfurl#1{%
1462     \begingroup
1463       % it seems we really need yet another set of dummies; have not
1464       % tried to figure out what each command should do in the context
1465       % of @url.  for now, just make @/ a no-op, that's the only one
1466       % people have actually reported a problem with.
1467       %
1468       \normalturnoffactive
1469       \def\@{@}%
1470       \let\/=\empty
1471       \makevalueexpandable
1472       % do we want to go so far as to use \indexnofonts instead of just
1473       % special-casing \var here?
1474       \def\var##1{##1}%
1475       %
1476       \leavevmode\setcolor{\urlcolor}%
1477       \startlink attr{/Border [0 0 0]}%
1478         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1479     \endgroup}
1480   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1481   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1482   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1483   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1484   \def\maketoks{%
1485     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1486     \ifx\first0\adn0
1487     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1488     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1489     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1490     \else
1491       \ifnum0=\countA\else\makelink\fi
1492       \ifx\first.\let\next=\done\else
1493         \let\next=\maketoks
1494         \addtokens{\toksB}{\the\toksD}
1495         \ifx\first,\addtokens{\toksB}{\space}\fi
1496       \fi
1497     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1498     \next}
1499   \def\makelink{\addtokens{\toksB}%
1500     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1501   \def\pdflink#1{%
1502     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1503     \setcolor{\linkcolor}#1\endlink}
1504   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1505 \else
1506   % non-pdf mode
1507   \let\pdfmkdest = \gobble
1508   \let\pdfurl = \gobble
1509   \let\endlink = \relax
1510   \let\setcolor = \gobble
1511   \let\pdfsetcolor = \gobble
1512   \let\pdfmakeoutlines = \relax
1513 \fi  % \ifx\pdfoutput
1514
1515 %
1516 % For XeTeX
1517 %
1518 \newif\iftxiuseunicodedestname
1519 \ifx\XeTeXrevision\thisisundefined
1520 \else
1521   %
1522   % XeTeX version check
1523   %
1524   \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99995}>-1
1525     % XeTeX 0.99995+ contains xdvipdfmx 20160307+.
1526     % It can handle Unicode destination name for PDF.
1527     \txiuseunicodedestnametrue
1528   \else
1529     % XeTeX < 0.99995 can not handle Unicode destination name for PDF
1530     % because xdvipdfmx 20150315 has UTF-16 convert issue.
1531     % It fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1532     \txiuseunicodedestnamefalse
1533   \fi
1534   %
1535   % PDF outline support
1536   %
1537   \pdfmakepagedesttrue \relax
1538   % Emulate the primitive of pdfTeX
1539   \def\pdfdest name#1 xyz{%
1540     \special{pdf:dest (name#1) [@thispage /XYZ @xpos @ypos]}%
1541   }
1542   \def\pdfmkdest#1{{%
1543     % We have to set dummies so commands such as @code, and characters
1544     % such as \, aren't expanded when present in a section title.
1545     \indexnofonts
1546     \iftxiuseunicodedestname
1547       \def\pdfdestname{#1}% Pass through Unicode characters.
1548     \else
1549       \edef\pdfdestname{#1}% Replace Unicode characters to ASCII.
1550     \fi
1551     \turnoffactive
1552     \makevalueexpandable
1553     \txiescapepdf\pdfdestname
1554     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1555   }}
1556   %
1557   \def\dopdfoutline#1#2#3#4{%
1558     \iftxiuseunicodedestname
1559       \def\pdfoutlinedest{#3}% Pass through Unicode characters.
1560     \else
1561       \edef\pdfoutlinedest{#3}% Replace Unicode characters to ASCII.
1562     \fi
1563     \ifx\pdfoutlinedest\empty
1564       \def\pdfoutlinedest{#4}%
1565     \fi
1566     {
1567       \turnoffactive
1568       \txiescapepdf\pdfoutlinedest
1569       \edef\pdfoutlinetext{#1}%
1570       \txiescapepdf\pdfoutlinetext
1571       %
1572       \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1573         << /S /GoTo /D (name\pdfoutlinedest) >> >> }%
1574     }
1575   }
1576   %
1577   \def\pdfmakeoutlines{%
1578     \begingroup
1579       %
1580       % In the case of XeTeX, counts of subentries is not necesary.
1581       % Therefore, read toc only once.
1582       %
1583       % We use the node names as the destinations.
1584       \def\partentry##1##2##3##4{}% ignore parts in the outlines
1585       \def\numchapentry##1##2##3##4{%
1586         \dopdfoutline{##1}{1}{##3}{##4}}%
1587       \def\numsecentry##1##2##3##4{%
1588         \dopdfoutline{##1}{2}{##3}{##4}}%
1589       \def\numsubsecentry##1##2##3##4{%
1590         \dopdfoutline{##1}{3}{##3}{##4}}%
1591       \def\numsubsubsecentry##1##2##3##4{%
1592         \dopdfoutline{##1}{4}{##3}{##4}}%
1593       %
1594       \let\appentry\numchapentry%
1595       \let\appsecentry\numsecentry%
1596       \let\appsubsecentry\numsubsecentry%
1597       \let\appsubsubsecentry\numsubsubsecentry%
1598       \let\unnchapentry\numchapentry%
1599       \let\unnsecentry\numsecentry%
1600       \let\unnsubsecentry\numsubsecentry%
1601       \let\unnsubsubsecentry\numsubsubsecentry%
1602       %
1603       % In the case of XeTeX, xdvipdfmx converts strings to UTF-16.
1604       % Therefore, the encoding and the language may not be considered.
1605       %
1606       \indexnofonts
1607       \setupdatafile
1608       % We can have normal brace characters in the PDF outlines, unlike
1609       % Texinfo index files.  So set that up.
1610       \def\{{\lbracecharliteral}%
1611       \def\}{\rbracecharliteral}%
1612       \catcode`\\=\active \otherbackslash
1613       \input \tocreadfilename
1614     \endgroup
1615   }
1616   {\catcode`[=1 \catcode`]=2
1617    \catcode`{=\other \catcode`}=\other
1618    \gdef\lbracecharliteral[{]%
1619    \gdef\rbracecharliteral[}]%
1620   ]
1621
1622   \special{pdf:docview << /PageMode /UseOutlines >> }
1623   % ``\special{pdf:tounicode ...}'' is not necessary
1624   % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1625   % However, due to UTF-16 convert issue of xdvipdfmx 20150315,
1626   % ``\special{pdf:dest ...}'' can not handle non-ASCII strings.
1627   % It fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1628 %
1629   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1630     \ifx\PP\D\let\nextsp\relax
1631     \else\let\nextsp\skipspaces
1632       \addtokens{\filename}{\PP}%
1633       \advance\filenamelength by 1
1634     \fi
1635     \nextsp}
1636   \def\getfilename#1{%
1637     \filenamelength=0
1638     % If we don't expand the argument now, \skipspaces will get
1639     % snagged on things like "@value{foo}".
1640     \edef\temp{#1}%
1641     \expandafter\skipspaces\temp|\relax
1642   }
1643   % make a live url in pdf output.
1644   \def\pdfurl#1{%
1645     \begingroup
1646       % it seems we really need yet another set of dummies; have not
1647       % tried to figure out what each command should do in the context
1648       % of @url.  for now, just make @/ a no-op, that's the only one
1649       % people have actually reported a problem with.
1650       %
1651       \normalturnoffactive
1652       \def\@{@}%
1653       \let\/=\empty
1654       \makevalueexpandable
1655       % do we want to go so far as to use \indexnofonts instead of just
1656       % special-casing \var here?
1657       \def\var##1{##1}%
1658       %
1659       \leavevmode\setcolor{\urlcolor}%
1660       \special{pdf:bann << /Border [0 0 0]
1661         /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
1662     \endgroup}
1663   \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
1664   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1665   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1666   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1667   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1668   \def\maketoks{%
1669     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1670     \ifx\first0\adn0
1671     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1672     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1673     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1674     \else
1675       \ifnum0=\countA\else\makelink\fi
1676       \ifx\first.\let\next=\done\else
1677         \let\next=\maketoks
1678         \addtokens{\toksB}{\the\toksD}
1679         \ifx\first,\addtokens{\toksB}{\space}\fi
1680       \fi
1681     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1682     \next}
1683   \def\makelink{\addtokens{\toksB}%
1684     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1685   \def\pdflink#1{%
1686     \special{pdf:bann << /Border [0 0 0]
1687       /Type /Annot /Subtype /Link /A << /S /GoTo /D (name#1) >> >>}%
1688     \setcolor{\linkcolor}#1\endlink}
1689   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1690 %
1691   %
1692   % @image support
1693   %
1694   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1695   \def\doxeteximage#1#2#3{%
1696     \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1697     \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1698     %
1699     % XeTeX (and the PDF format) support .pdf, .png, .jpg (among
1700     % others).  Let's try in that order, PDF first since if
1701     % someone has a scalable image, presumably better to use that than a
1702     % bitmap.
1703     \let\xeteximgext=\empty
1704     \begingroup
1705       \openin 1 #1.pdf \ifeof 1
1706         \openin 1 #1.PDF \ifeof 1
1707           \openin 1 #1.png \ifeof 1
1708             \openin 1 #1.jpg \ifeof 1
1709               \openin 1 #1.jpeg \ifeof 1
1710                 \openin 1 #1.JPG \ifeof 1
1711                   \errmessage{Could not find image file #1 for XeTeX}%
1712                 \else \gdef\xeteximgext{JPG}%
1713                 \fi
1714               \else \gdef\xeteximgext{jpeg}%
1715               \fi
1716             \else \gdef\xeteximgext{jpg}%
1717             \fi
1718           \else \gdef\xeteximgext{png}%
1719           \fi
1720         \else \gdef\xeteximgext{PDF}%
1721         \fi
1722       \else \gdef\xeteximgext{pdf}%
1723       \fi
1724       \closein 1
1725     \endgroup
1726     %
1727     \def\xetexpdfext{pdf}%
1728     \ifx\xeteximgext\xetexpdfext
1729       \XeTeXpdffile "#1".\xeteximgext ""
1730     \else
1731       \def\xetexpdfext{PDF}%
1732       \ifx\xeteximgext\xetexpdfext
1733         \XeTeXpdffile "#1".\xeteximgext ""
1734       \else
1735         \XeTeXpicfile "#1".\xeteximgext ""
1736       \fi
1737     \fi
1738     \ifdim \wd0 >0pt width \xeteximagewidth \fi
1739     \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
1740   }
1741 \fi
1742
1743 \message{fonts,}
1744
1745 % Change the current font style to #1, remembering it in \curfontstyle.
1746 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1747 % italics, not bold italics.
1748 %
1749 \def\setfontstyle#1{%
1750   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1751   \csname ten#1\endcsname  % change the current font
1752 }
1753
1754 % Select #1 fonts with the current style.
1755 %
1756 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1757
1758 \def\rm{\fam=0 \setfontstyle{rm}}
1759 \def\it{\fam=\itfam \setfontstyle{it}}
1760 \def\sl{\fam=\slfam \setfontstyle{sl}}
1761 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1762 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1763
1764 % Unfortunately, we have to override this for titles and the like, since
1765 % in those cases "rm" is bold.  Sigh.
1766 \def\rmisbold{\rm\def\curfontstyle{bf}}
1767
1768 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1769 % So we set up a \sf.
1770 \newfam\sffam
1771 \def\sf{\fam=\sffam \setfontstyle{sf}}
1772 \let\li = \sf % Sometimes we call it \li, not \sf.
1773
1774 % We don't need math for this font style.
1775 \def\ttsl{\setfontstyle{ttsl}}
1776
1777
1778 % Set the baselineskip to #1, and the lineskip and strut size
1779 % correspondingly.  There is no deep meaning behind these magic numbers
1780 % used as factors; they just match (closely enough) what Knuth defined.
1781 %
1782 \def\lineskipfactor{.08333}
1783 \def\strutheightpercent{.70833}
1784 \def\strutdepthpercent {.29167}
1785 %
1786 % can get a sort of poor man's double spacing by redefining this.
1787 \def\baselinefactor{1}
1788 %
1789 \newdimen\textleading
1790 \def\setleading#1{%
1791   \dimen0 = #1\relax
1792   \normalbaselineskip = \baselinefactor\dimen0
1793   \normallineskip = \lineskipfactor\normalbaselineskip
1794   \normalbaselines
1795   \setbox\strutbox =\hbox{%
1796     \vrule width0pt height\strutheightpercent\baselineskip
1797                     depth \strutdepthpercent \baselineskip
1798   }%
1799 }
1800
1801 % PDF CMaps.  See also LaTeX's t1.cmap.
1802 %
1803 % do nothing with this by default.
1804 \expandafter\let\csname cmapOT1\endcsname\gobble
1805 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1806 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1807
1808 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1809 % (\pdffontattr was introduced many years ago, but people still run
1810 % older pdftex's; it's easy to conditionalize, so we do.)
1811 \ifpdf \ifx\pdffontattr\thisisundefined \else
1812   \begingroup
1813     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1814     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1815 %%DocumentNeededResources: ProcSet (CIDInit)
1816 %%IncludeResource: ProcSet (CIDInit)
1817 %%BeginResource: CMap (TeX-OT1-0)
1818 %%Title: (TeX-OT1-0 TeX OT1 0)
1819 %%Version: 1.000
1820 %%EndComments
1821 /CIDInit /ProcSet findresource begin
1822 12 dict begin
1823 begincmap
1824 /CIDSystemInfo
1825 << /Registry (TeX)
1826 /Ordering (OT1)
1827 /Supplement 0
1828 >> def
1829 /CMapName /TeX-OT1-0 def
1830 /CMapType 2 def
1831 1 begincodespacerange
1832 <00> <7F>
1833 endcodespacerange
1834 8 beginbfrange
1835 <00> <01> <0393>
1836 <09> <0A> <03A8>
1837 <23> <26> <0023>
1838 <28> <3B> <0028>
1839 <3F> <5B> <003F>
1840 <5D> <5E> <005D>
1841 <61> <7A> <0061>
1842 <7B> <7C> <2013>
1843 endbfrange
1844 40 beginbfchar
1845 <02> <0398>
1846 <03> <039B>
1847 <04> <039E>
1848 <05> <03A0>
1849 <06> <03A3>
1850 <07> <03D2>
1851 <08> <03A6>
1852 <0B> <00660066>
1853 <0C> <00660069>
1854 <0D> <0066006C>
1855 <0E> <006600660069>
1856 <0F> <00660066006C>
1857 <10> <0131>
1858 <11> <0237>
1859 <12> <0060>
1860 <13> <00B4>
1861 <14> <02C7>
1862 <15> <02D8>
1863 <16> <00AF>
1864 <17> <02DA>
1865 <18> <00B8>
1866 <19> <00DF>
1867 <1A> <00E6>
1868 <1B> <0153>
1869 <1C> <00F8>
1870 <1D> <00C6>
1871 <1E> <0152>
1872 <1F> <00D8>
1873 <21> <0021>
1874 <22> <201D>
1875 <27> <2019>
1876 <3C> <00A1>
1877 <3D> <003D>
1878 <3E> <00BF>
1879 <5C> <201C>
1880 <5F> <02D9>
1881 <60> <2018>
1882 <7D> <02DD>
1883 <7E> <007E>
1884 <7F> <00A8>
1885 endbfchar
1886 endcmap
1887 CMapName currentdict /CMap defineresource pop
1888 end
1889 end
1890 %%EndResource
1891 %%EOF
1892     }\endgroup
1893   \expandafter\edef\csname cmapOT1\endcsname#1{%
1894     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1895   }%
1896 %
1897 % \cmapOT1IT
1898   \begingroup
1899     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1900     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1901 %%DocumentNeededResources: ProcSet (CIDInit)
1902 %%IncludeResource: ProcSet (CIDInit)
1903 %%BeginResource: CMap (TeX-OT1IT-0)
1904 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1905 %%Version: 1.000
1906 %%EndComments
1907 /CIDInit /ProcSet findresource begin
1908 12 dict begin
1909 begincmap
1910 /CIDSystemInfo
1911 << /Registry (TeX)
1912 /Ordering (OT1IT)
1913 /Supplement 0
1914 >> def
1915 /CMapName /TeX-OT1IT-0 def
1916 /CMapType 2 def
1917 1 begincodespacerange
1918 <00> <7F>
1919 endcodespacerange
1920 8 beginbfrange
1921 <00> <01> <0393>
1922 <09> <0A> <03A8>
1923 <25> <26> <0025>
1924 <28> <3B> <0028>
1925 <3F> <5B> <003F>
1926 <5D> <5E> <005D>
1927 <61> <7A> <0061>
1928 <7B> <7C> <2013>
1929 endbfrange
1930 42 beginbfchar
1931 <02> <0398>
1932 <03> <039B>
1933 <04> <039E>
1934 <05> <03A0>
1935 <06> <03A3>
1936 <07> <03D2>
1937 <08> <03A6>
1938 <0B> <00660066>
1939 <0C> <00660069>
1940 <0D> <0066006C>
1941 <0E> <006600660069>
1942 <0F> <00660066006C>
1943 <10> <0131>
1944 <11> <0237>
1945 <12> <0060>
1946 <13> <00B4>
1947 <14> <02C7>
1948 <15> <02D8>
1949 <16> <00AF>
1950 <17> <02DA>
1951 <18> <00B8>
1952 <19> <00DF>
1953 <1A> <00E6>
1954 <1B> <0153>
1955 <1C> <00F8>
1956 <1D> <00C6>
1957 <1E> <0152>
1958 <1F> <00D8>
1959 <21> <0021>
1960 <22> <201D>
1961 <23> <0023>
1962 <24> <00A3>
1963 <27> <2019>
1964 <3C> <00A1>
1965 <3D> <003D>
1966 <3E> <00BF>
1967 <5C> <201C>
1968 <5F> <02D9>
1969 <60> <2018>
1970 <7D> <02DD>
1971 <7E> <007E>
1972 <7F> <00A8>
1973 endbfchar
1974 endcmap
1975 CMapName currentdict /CMap defineresource pop
1976 end
1977 end
1978 %%EndResource
1979 %%EOF
1980     }\endgroup
1981   \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1982     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1983   }%
1984 %
1985 % \cmapOT1TT
1986   \begingroup
1987     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1988     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1989 %%DocumentNeededResources: ProcSet (CIDInit)
1990 %%IncludeResource: ProcSet (CIDInit)
1991 %%BeginResource: CMap (TeX-OT1TT-0)
1992 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1993 %%Version: 1.000
1994 %%EndComments
1995 /CIDInit /ProcSet findresource begin
1996 12 dict begin
1997 begincmap
1998 /CIDSystemInfo
1999 << /Registry (TeX)
2000 /Ordering (OT1TT)
2001 /Supplement 0
2002 >> def
2003 /CMapName /TeX-OT1TT-0 def
2004 /CMapType 2 def
2005 1 begincodespacerange
2006 <00> <7F>
2007 endcodespacerange
2008 5 beginbfrange
2009 <00> <01> <0393>
2010 <09> <0A> <03A8>
2011 <21> <26> <0021>
2012 <28> <5F> <0028>
2013 <61> <7E> <0061>
2014 endbfrange
2015 32 beginbfchar
2016 <02> <0398>
2017 <03> <039B>
2018 <04> <039E>
2019 <05> <03A0>
2020 <06> <03A3>
2021 <07> <03D2>
2022 <08> <03A6>
2023 <0B> <2191>
2024 <0C> <2193>
2025 <0D> <0027>
2026 <0E> <00A1>
2027 <0F> <00BF>
2028 <10> <0131>
2029 <11> <0237>
2030 <12> <0060>
2031 <13> <00B4>
2032 <14> <02C7>
2033 <15> <02D8>
2034 <16> <00AF>
2035 <17> <02DA>
2036 <18> <00B8>
2037 <19> <00DF>
2038 <1A> <00E6>
2039 <1B> <0153>
2040 <1C> <00F8>
2041 <1D> <00C6>
2042 <1E> <0152>
2043 <1F> <00D8>
2044 <20> <2423>
2045 <27> <2019>
2046 <60> <2018>
2047 <7F> <00A8>
2048 endbfchar
2049 endcmap
2050 CMapName currentdict /CMap defineresource pop
2051 end
2052 end
2053 %%EndResource
2054 %%EOF
2055     }\endgroup
2056   \expandafter\edef\csname cmapOT1TT\endcsname#1{%
2057     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2058   }%
2059 \fi\fi
2060
2061
2062 % Set the font macro #1 to the font named \fontprefix#2.
2063 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2064 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2065 % Example:
2066 % #1 = \textrm
2067 % #2 = \rmshape
2068 % #3 = 10
2069 % #4 = \mainmagstep
2070 % #5 = OT1
2071 %
2072 \def\setfont#1#2#3#4#5{%
2073   \font#1=\fontprefix#2#3 scaled #4
2074   \csname cmap#5\endcsname#1%
2075 }
2076 % This is what gets called when #5 of \setfont is empty.
2077 \let\cmap\gobble
2078 %
2079 % (end of cmaps)
2080
2081 % Use cm as the default font prefix.
2082 % To specify the font prefix, you must define \fontprefix
2083 % before you read in texinfo.tex.
2084 \ifx\fontprefix\thisisundefined
2085 \def\fontprefix{cm}
2086 \fi
2087 % Support font families that don't use the same naming scheme as CM.
2088 \def\rmshape{r}
2089 \def\rmbshape{bx}               % where the normal face is bold
2090 \def\bfshape{b}
2091 \def\bxshape{bx}
2092 \def\ttshape{tt}
2093 \def\ttbshape{tt}
2094 \def\ttslshape{sltt}
2095 \def\itshape{ti}
2096 \def\itbshape{bxti}
2097 \def\slshape{sl}
2098 \def\slbshape{bxsl}
2099 \def\sfshape{ss}
2100 \def\sfbshape{ss}
2101 \def\scshape{csc}
2102 \def\scbshape{csc}
2103
2104 % Definitions for a main text size of 11pt.  (The default in Texinfo.)
2105 %
2106 \def\definetextfontsizexi{%
2107 % Text fonts (11.2pt, magstep1).
2108 \def\textnominalsize{11pt}
2109 \edef\mainmagstep{\magstephalf}
2110 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2111 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2112 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2113 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2114 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2115 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2116 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2117 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2118 \font\texti=cmmi10 scaled \mainmagstep
2119 \font\textsy=cmsy10 scaled \mainmagstep
2120 \def\textecsize{1095}
2121
2122 % A few fonts for @defun names and args.
2123 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2124 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2125 \setfont\defsl\slshape{10}{\magstep1}{OT1TT}
2126 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2127 \def\df{\let\tentt=\deftt \let\tenbf = \defbf
2128 \let\tenttsl=\defttsl \let\tensl=\defsl \bf}
2129
2130 % Fonts for indices, footnotes, small examples (9pt).
2131 \def\smallnominalsize{9pt}
2132 \setfont\smallrm\rmshape{9}{1000}{OT1}
2133 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2134 \setfont\smallbf\bfshape{10}{900}{OT1}
2135 \setfont\smallit\itshape{9}{1000}{OT1IT}
2136 \setfont\smallsl\slshape{9}{1000}{OT1}
2137 \setfont\smallsf\sfshape{9}{1000}{OT1}
2138 \setfont\smallsc\scshape{10}{900}{OT1}
2139 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2140 \font\smalli=cmmi9
2141 \font\smallsy=cmsy9
2142 \def\smallecsize{0900}
2143
2144 % Fonts for small examples (8pt).
2145 \def\smallernominalsize{8pt}
2146 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2147 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2148 \setfont\smallerbf\bfshape{10}{800}{OT1}
2149 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2150 \setfont\smallersl\slshape{8}{1000}{OT1}
2151 \setfont\smallersf\sfshape{8}{1000}{OT1}
2152 \setfont\smallersc\scshape{10}{800}{OT1}
2153 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2154 \font\smalleri=cmmi8
2155 \font\smallersy=cmsy8
2156 \def\smallerecsize{0800}
2157
2158 % Fonts for title page (20.4pt):
2159 \def\titlenominalsize{20pt}
2160 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2161 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2162 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2163 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2164 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2165 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2166 \let\titlebf=\titlerm
2167 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2168 \font\titlei=cmmi12 scaled \magstep3
2169 \font\titlesy=cmsy10 scaled \magstep4
2170 \def\titleecsize{2074}
2171
2172 % Chapter (and unnumbered) fonts (17.28pt).
2173 \def\chapnominalsize{17pt}
2174 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2175 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2176 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2177 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2178 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2179 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2180 \let\chapbf=\chaprm
2181 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2182 \font\chapi=cmmi12 scaled \magstep2
2183 \font\chapsy=cmsy10 scaled \magstep3
2184 \def\chapecsize{1728}
2185
2186 % Section fonts (14.4pt).
2187 \def\secnominalsize{14pt}
2188 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2189 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
2190 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2191 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2192 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2193 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2194 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2195 \let\secbf\secrm
2196 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2197 \font\seci=cmmi12 scaled \magstep1
2198 \font\secsy=cmsy10 scaled \magstep2
2199 \def\sececsize{1440}
2200
2201 % Subsection fonts (13.15pt).
2202 \def\ssecnominalsize{13pt}
2203 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2204 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2205 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2206 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2207 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2208 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2209 \let\ssecbf\ssecrm
2210 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2211 \font\sseci=cmmi12 scaled \magstephalf
2212 \font\ssecsy=cmsy10 scaled 1315
2213 \def\ssececsize{1200}
2214
2215 % Reduced fonts for @acro in text (10pt).
2216 \def\reducednominalsize{10pt}
2217 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2218 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2219 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2220 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2221 \setfont\reducedsl\slshape{10}{1000}{OT1}
2222 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2223 \setfont\reducedsc\scshape{10}{1000}{OT1}
2224 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2225 \font\reducedi=cmmi10
2226 \font\reducedsy=cmsy10
2227 \def\reducedecsize{1000}
2228
2229 \textleading = 13.2pt % line spacing for 11pt CM
2230 \textfonts            % reset the current fonts
2231 \rm
2232 } % end of 11pt text font size definitions, \definetextfontsizexi
2233
2234
2235 % Definitions to make the main text be 10pt Computer Modern, with
2236 % section, chapter, etc., sizes following suit.  This is for the GNU
2237 % Press printing of the Emacs 22 manual.  Maybe other manuals in the
2238 % future.  Used with @smallbook, which sets the leading to 12pt.
2239 %
2240 \def\definetextfontsizex{%
2241 % Text fonts (10pt).
2242 \def\textnominalsize{10pt}
2243 \edef\mainmagstep{1000}
2244 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2245 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2246 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2247 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2248 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2249 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2250 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2251 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2252 \font\texti=cmmi10 scaled \mainmagstep
2253 \font\textsy=cmsy10 scaled \mainmagstep
2254 \def\textecsize{1000}
2255
2256 % A few fonts for @defun names and args.
2257 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2258 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2259 \setfont\defsl\slshape{10}{\magstephalf}{OT1TT}
2260 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2261 \def\df{\let\tentt=\deftt \let\tenbf = \defbf
2262 \let\tensl=\defsl \let\tenttsl=\defttsl \bf}
2263
2264 % Fonts for indices, footnotes, small examples (9pt).
2265 \def\smallnominalsize{9pt}
2266 \setfont\smallrm\rmshape{9}{1000}{OT1}
2267 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2268 \setfont\smallbf\bfshape{10}{900}{OT1}
2269 \setfont\smallit\itshape{9}{1000}{OT1IT}
2270 \setfont\smallsl\slshape{9}{1000}{OT1}
2271 \setfont\smallsf\sfshape{9}{1000}{OT1}
2272 \setfont\smallsc\scshape{10}{900}{OT1}
2273 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2274 \font\smalli=cmmi9
2275 \font\smallsy=cmsy9
2276 \def\smallecsize{0900}
2277
2278 % Fonts for small examples (8pt).
2279 \def\smallernominalsize{8pt}
2280 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2281 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2282 \setfont\smallerbf\bfshape{10}{800}{OT1}
2283 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2284 \setfont\smallersl\slshape{8}{1000}{OT1}
2285 \setfont\smallersf\sfshape{8}{1000}{OT1}
2286 \setfont\smallersc\scshape{10}{800}{OT1}
2287 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2288 \font\smalleri=cmmi8
2289 \font\smallersy=cmsy8
2290 \def\smallerecsize{0800}
2291
2292 % Fonts for title page (20.4pt):
2293 \def\titlenominalsize{20pt}
2294 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2295 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2296 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2297 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2298 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2299 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2300 \let\titlebf=\titlerm
2301 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2302 \font\titlei=cmmi12 scaled \magstep3
2303 \font\titlesy=cmsy10 scaled \magstep4
2304 \def\titleecsize{2074}
2305
2306 % Chapter fonts (14.4pt).
2307 \def\chapnominalsize{14pt}
2308 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2309 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2310 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2311 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2312 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2313 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2314 \let\chapbf\chaprm
2315 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2316 \font\chapi=cmmi12 scaled \magstep1
2317 \font\chapsy=cmsy10 scaled \magstep2
2318 \def\chapecsize{1440}
2319
2320 % Section fonts (12pt).
2321 \def\secnominalsize{12pt}
2322 \setfont\secrm\rmbshape{12}{1000}{OT1}
2323 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2324 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2325 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2326 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2327 \setfont\secsf\sfbshape{12}{1000}{OT1}
2328 \let\secbf\secrm
2329 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2330 \font\seci=cmmi12
2331 \font\secsy=cmsy10 scaled \magstep1
2332 \def\sececsize{1200}
2333
2334 % Subsection fonts (10pt).
2335 \def\ssecnominalsize{10pt}
2336 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2337 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2338 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2339 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2340 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2341 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2342 \let\ssecbf\ssecrm
2343 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2344 \font\sseci=cmmi10
2345 \font\ssecsy=cmsy10
2346 \def\ssececsize{1000}
2347
2348 % Reduced fonts for @acro in text (9pt).
2349 \def\reducednominalsize{9pt}
2350 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2351 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2352 \setfont\reducedbf\bfshape{10}{900}{OT1}
2353 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2354 \setfont\reducedsl\slshape{9}{1000}{OT1}
2355 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2356 \setfont\reducedsc\scshape{10}{900}{OT1}
2357 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2358 \font\reducedi=cmmi9
2359 \font\reducedsy=cmsy9
2360 \def\reducedecsize{0900}
2361
2362 \divide\parskip by 2  % reduce space between paragraphs
2363 \textleading = 12pt   % line spacing for 10pt CM
2364 \textfonts            % reset the current fonts
2365 \rm
2366 } % end of 10pt text font size definitions, \definetextfontsizex
2367
2368
2369 % We provide the user-level command
2370 %   @fonttextsize 10
2371 % (or 11) to redefine the text font size.  pt is assumed.
2372 %
2373 \def\xiword{11}
2374 \def\xword{10}
2375 \def\xwordpt{10pt}
2376 %
2377 \parseargdef\fonttextsize{%
2378   \def\textsizearg{#1}%
2379   %\wlog{doing @fonttextsize \textsizearg}%
2380   %
2381   % Set \globaldefs so that documents can use this inside @tex, since
2382   % makeinfo 4.8 does not support it, but we need it nonetheless.
2383   %
2384  \begingroup \globaldefs=1
2385   \ifx\textsizearg\xword \definetextfontsizex
2386   \else \ifx\textsizearg\xiword \definetextfontsizexi
2387   \else
2388     \errhelp=\EMsimple
2389     \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2390   \fi\fi
2391  \endgroup
2392 }
2393
2394 % In order for the font changes to affect most math symbols and letters,
2395 % we have to define the \textfont of the standard families.  We don't
2396 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2397 %
2398 \def\resetmathfonts{%
2399   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2400   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2401   \textfont\ttfam=\tentt \textfont\sffam=\tensf
2402 }
2403
2404 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2405 % of just \STYLE.  We do this because \STYLE needs to also set the
2406 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
2407 % \tenSTYLE to set the current font.
2408 %
2409 % Each font-changing command also sets the names \lsize (one size lower)
2410 % and \lllsize (three sizes lower).  These relative commands are used
2411 % in, e.g., the LaTeX logo and acronyms.
2412 %
2413 % This all needs generalizing, badly.
2414 %
2415 \def\textfonts{%
2416   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2417   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2418   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2419   \let\tenttsl=\textttsl
2420   \def\curfontsize{text}%
2421   \def\lsize{reduced}\def\lllsize{smaller}%
2422   \resetmathfonts \setleading{\textleading}}
2423 \def\titlefonts{%
2424   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2425   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2426   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2427   \let\tenttsl=\titlettsl
2428   \def\curfontsize{title}%
2429   \def\lsize{chap}\def\lllsize{subsec}%
2430   \resetmathfonts \setleading{27pt}}
2431 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2432 \def\chapfonts{%
2433   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2434   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2435   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2436   \let\tenttsl=\chapttsl
2437   \def\curfontsize{chap}%
2438   \def\lsize{sec}\def\lllsize{text}%
2439   \resetmathfonts \setleading{19pt}}
2440 \def\secfonts{%
2441   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2442   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2443   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2444   \let\tenttsl=\secttsl
2445   \def\curfontsize{sec}%
2446   \def\lsize{subsec}\def\lllsize{reduced}%
2447   \resetmathfonts \setleading{17pt}}
2448 \def\subsecfonts{%
2449   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2450   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2451   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2452   \let\tenttsl=\ssecttsl
2453   \def\curfontsize{ssec}%
2454   \def\lsize{text}\def\lllsize{small}%
2455   \resetmathfonts \setleading{15pt}}
2456 \let\subsubsecfonts = \subsecfonts
2457 \def\reducedfonts{%
2458   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2459   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2460   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2461   \let\tenttsl=\reducedttsl
2462   \def\curfontsize{reduced}%
2463   \def\lsize{small}\def\lllsize{smaller}%
2464   \resetmathfonts \setleading{10.5pt}}
2465 \def\smallfonts{%
2466   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2467   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2468   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2469   \let\tenttsl=\smallttsl
2470   \def\curfontsize{small}%
2471   \def\lsize{smaller}\def\lllsize{smaller}%
2472   \resetmathfonts \setleading{10.5pt}}
2473 \def\smallerfonts{%
2474   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2475   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2476   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2477   \let\tenttsl=\smallerttsl
2478   \def\curfontsize{smaller}%
2479   \def\lsize{smaller}\def\lllsize{smaller}%
2480   \resetmathfonts \setleading{9.5pt}}
2481
2482 % Fonts for short table of contents.
2483 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2484 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1}  % no cmb12
2485 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2486 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2487
2488 % Define these just so they can be easily changed for other fonts.
2489 \def\angleleft{$\langle$}
2490 \def\angleright{$\rangle$}
2491
2492 % Set the fonts to use with the @small... environments.
2493 \let\smallexamplefonts = \smallfonts
2494
2495 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
2496 % can fit this many characters:
2497 %   8.5x11=86   smallbook=72  a4=90  a5=69
2498 % If we use \scriptfonts (8pt), then we can fit this many characters:
2499 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
2500 % For me, subjectively, the few extra characters that fit aren't worth
2501 % the additional smallness of 8pt.  So I'm making the default 9pt.
2502 %
2503 % By the way, for comparison, here's what fits with @example (10pt):
2504 %   8.5x11=71  smallbook=60  a4=75  a5=58
2505 % --karl, 24jan03.
2506
2507 % Set up the default fonts, so we can use them for creating boxes.
2508 %
2509 \definetextfontsizexi
2510
2511
2512 \message{markup,}
2513
2514 % Check if we are currently using a typewriter font.  Since all the
2515 % Computer Modern typewriter fonts have zero interword stretch (and
2516 % shrink), and it is reasonable to expect all typewriter fonts to have
2517 % this property, we can check that font parameter.
2518 %
2519 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2520
2521 % Markup style infrastructure.  \defmarkupstylesetup\INITMACRO will
2522 % define and register \INITMACRO to be called on markup style changes.
2523 % \INITMACRO can check \currentmarkupstyle for the innermost
2524 % style and the set of \ifmarkupSTYLE switches for all styles
2525 % currently in effect.
2526 \newif\ifmarkupvar
2527 \newif\ifmarkupsamp
2528 \newif\ifmarkupkey
2529 %\newif\ifmarkupfile % @file == @samp.
2530 %\newif\ifmarkupoption % @option == @samp.
2531 \newif\ifmarkupcode
2532 \newif\ifmarkupkbd
2533 %\newif\ifmarkupenv % @env == @code.
2534 %\newif\ifmarkupcommand % @command == @code.
2535 \newif\ifmarkuptex % @tex (and part of @math, for now).
2536 \newif\ifmarkupexample
2537 \newif\ifmarkupverb
2538 \newif\ifmarkupverbatim
2539
2540 \let\currentmarkupstyle\empty
2541
2542 \def\setupmarkupstyle#1{%
2543   \csname markup#1true\endcsname
2544   \def\currentmarkupstyle{#1}%
2545   \markupstylesetup
2546 }
2547
2548 \let\markupstylesetup\empty
2549
2550 \def\defmarkupstylesetup#1{%
2551   \expandafter\def\expandafter\markupstylesetup
2552     \expandafter{\markupstylesetup #1}%
2553   \def#1%
2554 }
2555
2556 % Markup style setup for left and right quotes.
2557 \defmarkupstylesetup\markupsetuplq{%
2558   \expandafter\let\expandafter \temp
2559     \csname markupsetuplq\currentmarkupstyle\endcsname
2560   \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2561 }
2562
2563 \defmarkupstylesetup\markupsetuprq{%
2564   \expandafter\let\expandafter \temp
2565     \csname markupsetuprq\currentmarkupstyle\endcsname
2566   \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2567 }
2568
2569 {
2570 \catcode`\'=\active
2571 \catcode`\`=\active
2572
2573 \gdef\markupsetuplqdefault{\let`\lq}
2574 \gdef\markupsetuprqdefault{\let'\rq}
2575
2576 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2577 \gdef\markupsetcodequoteright{\let'\codequoteright}
2578 }
2579
2580 \let\markupsetuplqcode \markupsetcodequoteleft
2581 \let\markupsetuprqcode \markupsetcodequoteright
2582 %
2583 \let\markupsetuplqexample \markupsetcodequoteleft
2584 \let\markupsetuprqexample \markupsetcodequoteright
2585 %
2586 \let\markupsetuplqkbd     \markupsetcodequoteleft
2587 \let\markupsetuprqkbd     \markupsetcodequoteright
2588 %
2589 \let\markupsetuplqsamp \markupsetcodequoteleft
2590 \let\markupsetuprqsamp \markupsetcodequoteright
2591 %
2592 \let\markupsetuplqverb \markupsetcodequoteleft
2593 \let\markupsetuprqverb \markupsetcodequoteright
2594 %
2595 \let\markupsetuplqverbatim \markupsetcodequoteleft
2596 \let\markupsetuprqverbatim \markupsetcodequoteright
2597
2598 % Allow an option to not use regular directed right quote/apostrophe
2599 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2600 % The undirected quote is ugly, so don't make it the default, but it
2601 % works for pasting with more pdf viewers (at least evince), the
2602 % lilypond developers report.  xpdf does work with the regular 0x27.
2603 %
2604 \def\codequoteright{%
2605   \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2606     \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2607       '%
2608     \else \char'15 \fi
2609   \else \char'15 \fi
2610 }
2611 %
2612 % and a similar option for the left quote char vs. a grave accent.
2613 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2614 % the code environments to do likewise.
2615 %
2616 \def\codequoteleft{%
2617   \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2618     \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2619       % [Knuth] pp. 380,381,391
2620       % \relax disables Spanish ligatures ?` and !` of \tt font.
2621       \relax`%
2622     \else \char'22 \fi
2623   \else \char'22 \fi
2624 }
2625
2626 % Commands to set the quote options.
2627
2628 \parseargdef\codequoteundirected{%
2629   \def\temp{#1}%
2630   \ifx\temp\onword
2631     \expandafter\let\csname SETtxicodequoteundirected\endcsname
2632       = t%
2633   \else\ifx\temp\offword
2634     \expandafter\let\csname SETtxicodequoteundirected\endcsname
2635       = \relax
2636   \else
2637     \errhelp = \EMsimple
2638     \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2639   \fi\fi
2640 }
2641 %
2642 \parseargdef\codequotebacktick{%
2643   \def\temp{#1}%
2644   \ifx\temp\onword
2645     \expandafter\let\csname SETtxicodequotebacktick\endcsname
2646       = t%
2647   \else\ifx\temp\offword
2648     \expandafter\let\csname SETtxicodequotebacktick\endcsname
2649       = \relax
2650   \else
2651     \errhelp = \EMsimple
2652     \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2653   \fi\fi
2654 }
2655
2656 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2657 \def\noligaturesquoteleft{\relax\lq}
2658
2659 % Count depth in font-changes, for error checks
2660 \newcount\fontdepth \fontdepth=0
2661
2662 % Font commands.
2663
2664 % #1 is the font command (\sl or \it), #2 is the text to slant.
2665 % If we are in a monospaced environment, however, 1) always use \ttsl,
2666 % and 2) do not add an italic correction.
2667 \def\dosmartslant#1#2{%
2668   \ifusingtt 
2669     {{\ttsl #2}\let\next=\relax}%
2670     {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2671   \next
2672 }
2673 \def\smartslanted{\dosmartslant\sl}
2674 \def\smartitalic{\dosmartslant\it}
2675
2676 % Output an italic correction unless \next (presumed to be the following
2677 % character) is such as not to need one.
2678 \def\smartitaliccorrection{%
2679   \ifx\next,%
2680   \else\ifx\next-%
2681   \else\ifx\next.%
2682   \else\ifx\next\.%
2683   \else\ifx\next\comma%
2684   \else\ptexslash
2685   \fi\fi\fi\fi\fi
2686   \aftersmartic
2687 }
2688
2689 % Unconditional use \ttsl, and no ic.  @var is set to this for defuns.
2690 \def\ttslanted#1{{\ttsl #1}}
2691
2692 % @cite is like \smartslanted except unconditionally use \sl.  We never want
2693 % ttsl for book titles, do we?
2694 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2695
2696 \def\aftersmartic{}
2697 \def\var#1{%
2698   \let\saveaftersmartic = \aftersmartic
2699   \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2700   \smartslanted{#1}%
2701 }
2702
2703 \let\i=\smartitalic
2704 \let\slanted=\smartslanted
2705 \let\dfn=\smartslanted
2706 \let\emph=\smartitalic
2707
2708 % Explicit font changes: @r, @sc, undocumented @ii.
2709 \def\r#1{{\rm #1}}              % roman font
2710 \def\sc#1{{\smallcaps#1}}       % smallcaps font
2711 \def\ii#1{{\it #1}}             % italic font
2712
2713 % @b, explicit bold.  Also @strong.
2714 \def\b#1{{\bf #1}}
2715 \let\strong=\b
2716
2717 % @sansserif, explicit sans.
2718 \def\sansserif#1{{\sf #1}}
2719
2720 % We can't just use \exhyphenpenalty, because that only has effect at
2721 % the end of a paragraph.  Restore normal hyphenation at the end of the
2722 % group within which \nohyphenation is presumably called.
2723 %
2724 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
2725 \def\restorehyphenation{\hyphenchar\font = `- }
2726
2727 % Set sfcode to normal for the chars that usually have another value.
2728 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2729 % sometimes \x has an active definition that messes things up.
2730 %
2731 \catcode`@=11
2732   \def\plainfrenchspacing{%
2733     \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
2734     \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
2735     \def\endofsentencespacefactor{1000}% for @. and friends
2736   }
2737   \def\plainnonfrenchspacing{%
2738     \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2739     \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2740     \def\endofsentencespacefactor{3000}% for @. and friends
2741   }
2742 \catcode`@=\other
2743 \def\endofsentencespacefactor{3000}% default
2744
2745 % @t, explicit typewriter.
2746 \def\t#1{%
2747   {\tt \rawbackslash \plainfrenchspacing #1}%
2748   \null
2749 }
2750
2751 % @samp.
2752 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2753
2754 % @indicateurl is \samp, that is, with quotes.
2755 \let\indicateurl=\samp
2756
2757 % @code (and similar) prints in typewriter, but with spaces the same
2758 % size as normal in the surrounding text, without hyphenation, etc.
2759 % This is a subroutine for that.
2760 \def\tclose#1{%
2761   {%
2762     % Change normal interword space to be same as for the current font.
2763     \spaceskip = \fontdimen2\font
2764     %
2765     % Switch to typewriter.
2766     \tt
2767     %
2768     % But `\ ' produces the large typewriter interword space.
2769     \def\ {{\spaceskip = 0pt{} }}%
2770     %
2771     % Turn off hyphenation.
2772     \nohyphenation
2773     %
2774     \rawbackslash
2775     \plainfrenchspacing
2776     #1%
2777   }%
2778   \null % reset spacefactor to 1000
2779 }
2780
2781 % We *must* turn on hyphenation at `-' and `_' in @code.
2782 % (But see \codedashfinish below.)
2783 % Otherwise, it is too hard to avoid overfull hboxes
2784 % in the Emacs manual, the Library manual, etc.
2785 %
2786 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2787 % both hyphenation at - and hyphenation within words.
2788 % We must therefore turn them both off (\tclose does that)
2789 % and arrange explicitly to hyphenate at a dash. -- rms.
2790 {
2791   \catcode`\-=\active \catcode`\_=\active
2792   \catcode`\'=\active \catcode`\`=\active
2793   \global\let'=\rq \global\let`=\lq  % default definitions
2794   %
2795   \global\def\code{\begingroup
2796     \setupmarkupstyle{code}%
2797     % The following should really be moved into \setupmarkupstyle handlers.
2798     \catcode\dashChar=\active  \catcode\underChar=\active
2799     \ifallowcodebreaks
2800      \let-\codedash
2801      \let_\codeunder
2802     \else
2803      \let-\normaldash
2804      \let_\realunder
2805     \fi
2806     % Given -foo (with a single dash), we do not want to allow a break
2807     % after the hyphen.
2808     \global\let\codedashprev=\codedash
2809     %
2810     \codex
2811   }
2812   %
2813   \gdef\codedash{\futurelet\next\codedashfinish}
2814   \gdef\codedashfinish{%
2815     \normaldash % always output the dash character itself.
2816     % 
2817     % Now, output a discretionary to allow a line break, unless
2818     % (a) the next character is a -, or
2819     % (b) the preceding character is a -.
2820     % E.g., given --posix, we do not want to allow a break after either -.
2821     % Given --foo-bar, we do want to allow a break between the - and the b.
2822     \ifx\next\codedash \else
2823       \ifx\codedashprev\codedash 
2824       \else \discretionary{}{}{}\fi
2825     \fi
2826     % we need the space after the = for the case when \next itself is a
2827     % space token; it would get swallowed otherwise.  As in @code{- a}.
2828     \global\let\codedashprev= \next
2829   }
2830 }
2831 \def\normaldash{-}
2832 %
2833 \def\codex #1{\tclose{#1}\endgroup}
2834
2835 \def\codeunder{%
2836   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
2837   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2838   % will therefore expand the active definition of _, which is us
2839   % (inside @code that is), therefore an endless loop.
2840   \ifusingtt{\ifmmode
2841                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2842              \else\normalunderscore \fi
2843              \discretionary{}{}{}}%
2844             {\_}%
2845 }
2846
2847 % An additional complication: the above will allow breaks after, e.g.,
2848 % each of the four underscores in __typeof__.  This is bad.
2849 % @allowcodebreaks provides a document-level way to turn breaking at -
2850 % and _ on and off.
2851 %
2852 \newif\ifallowcodebreaks  \allowcodebreakstrue
2853
2854 \def\keywordtrue{true}
2855 \def\keywordfalse{false}
2856
2857 \parseargdef\allowcodebreaks{%
2858   \def\txiarg{#1}%
2859   \ifx\txiarg\keywordtrue
2860     \allowcodebreakstrue
2861   \else\ifx\txiarg\keywordfalse
2862     \allowcodebreaksfalse
2863   \else
2864     \errhelp = \EMsimple
2865     \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2866   \fi\fi
2867 }
2868
2869 % For @command, @env, @file, @option quotes seem unnecessary,
2870 % so use \code rather than \samp.
2871 \let\command=\code
2872 \let\env=\code
2873 \let\file=\code
2874 \let\option=\code
2875
2876 % @uref (abbreviation for `urlref') aka @url takes an optional
2877 % (comma-separated) second argument specifying the text to display and
2878 % an optional third arg as text to display instead of (rather than in
2879 % addition to) the url itself.  First (mandatory) arg is the url.
2880
2881 % TeX-only option to allow changing PDF output to show only the second
2882 % arg (if given), and not the url (which is then just the link target).
2883 \newif\ifurefurlonlylink
2884
2885 % The main macro is \urefbreak, which allows breaking at expected
2886 % places within the url.  (There used to be another version, which
2887 % didn't support automatic breaking.)
2888 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2889 \let\uref=\urefbreak
2890 %
2891 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2892 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2893   \unsepspaces
2894   \pdfurl{#1}%
2895   \setbox0 = \hbox{\ignorespaces #3}%
2896   \ifdim\wd0 > 0pt
2897     \unhbox0 % third arg given, show only that
2898   \else
2899     \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2900     \ifdim\wd0 > 0pt
2901       \ifpdf
2902         % For pdfTeX and LuaTeX
2903         \ifurefurlonlylink
2904           % PDF plus option to not display url, show just arg
2905           \unhbox0             
2906         \else
2907           % PDF, normally display both arg and url for consistency,
2908           % visibility, if the pdf is eventually used to print, etc.
2909           \unhbox0\ (\urefcode{#1})%
2910         \fi
2911       \else
2912         \ifx\XeTeXrevision\thisisundefined
2913           \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
2914         \else
2915           % For XeTeX
2916           \ifurefurlonlylink
2917             % PDF plus option to not display url, show just arg
2918             \unhbox0             
2919           \else
2920             % PDF, normally display both arg and url for consistency,
2921             % visibility, if the pdf is eventually used to print, etc.
2922             \unhbox0\ (\urefcode{#1})%
2923           \fi
2924         \fi
2925       \fi
2926     \else
2927       \urefcode{#1}% only url given, so show it
2928     \fi
2929   \fi
2930   \endlink
2931 \endgroup}
2932
2933 % Allow line breaks around only a few characters (only).
2934 \def\urefcatcodes{%
2935   \catcode`\&=\active \catcode`\.=\active
2936   \catcode`\#=\active \catcode`\?=\active
2937   \catcode`\/=\active
2938 }
2939 {
2940   \urefcatcodes
2941   %
2942   \global\def\urefcode{\begingroup
2943     \setupmarkupstyle{code}%
2944     \urefcatcodes
2945     \let&\urefcodeamp
2946     \let.\urefcodedot
2947     \let#\urefcodehash
2948     \let?\urefcodequest
2949     \let/\urefcodeslash
2950     \codex
2951   }
2952   %
2953   % By default, they are just regular characters.
2954   \global\def&{\normalamp}
2955   \global\def.{\normaldot}
2956   \global\def#{\normalhash}
2957   \global\def?{\normalquest}
2958   \global\def/{\normalslash}
2959 }
2960
2961 % we put a little stretch before and after the breakable chars, to help
2962 % line breaking of long url's.  The unequal skips make look better in
2963 % cmtt at least, especially for dots.
2964 \def\urefprestretchamount{.13em}
2965 \def\urefpoststretchamount{.1em}
2966 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
2967 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
2968 %
2969 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2970 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2971 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2972 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2973 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2974 {
2975   \catcode`\/=\active
2976   \global\def\urefcodeslashfinish{%
2977     \urefprestretch \slashChar
2978     % Allow line break only after the final / in a sequence of
2979     % slashes, to avoid line break between the slashes in http://.
2980     \ifx\next/\else \urefpoststretch \fi
2981   }
2982 }
2983
2984 % One more complication: by default we'll break after the special
2985 % characters, but some people like to break before the special chars, so
2986 % allow that.  Also allow no breaking at all, for manual control.
2987
2988 \parseargdef\urefbreakstyle{%
2989   \def\txiarg{#1}%
2990   \ifx\txiarg\wordnone
2991     \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2992   \else\ifx\txiarg\wordbefore
2993     \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2994   \else\ifx\txiarg\wordafter
2995     \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2996   \else
2997     \errhelp = \EMsimple
2998     \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2999   \fi\fi\fi
3000 }
3001 \def\wordafter{after}
3002 \def\wordbefore{before}
3003 \def\wordnone{none}
3004
3005 \urefbreakstyle after
3006
3007 % @url synonym for @uref, since that's how everyone uses it.
3008 %
3009 \let\url=\uref
3010
3011 % rms does not like angle brackets --karl, 17may97.
3012 % So now @email is just like @uref, unless we are pdf.
3013 %
3014 %\def\email#1{\angleleft{\tt #1}\angleright}
3015 \ifpdf
3016   \def\email#1{\doemail#1,,\finish}
3017   \def\doemail#1,#2,#3\finish{\begingroup
3018     \unsepspaces
3019     \pdfurl{mailto:#1}%
3020     \setbox0 = \hbox{\ignorespaces #2}%
3021     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3022     \endlink
3023   \endgroup}
3024 \else
3025   \ifx\XeTeXrevision\thisisundefined
3026     \let\email=\uref
3027   \else
3028     \def\email#1{\doemail#1,,\finish}
3029     \def\doemail#1,#2,#3\finish{\begingroup
3030       \unsepspaces
3031       \pdfurl{mailto:#1}%
3032       \setbox0 = \hbox{\ignorespaces #2}%
3033       \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3034       \endlink
3035     \endgroup}
3036   \fi
3037 \fi
3038
3039 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3040 %   `example' (@kbd uses ttsl only inside of @example and friends),
3041 %   or `code' (@kbd uses normal tty font always).
3042 \parseargdef\kbdinputstyle{%
3043   \def\txiarg{#1}%
3044   \ifx\txiarg\worddistinct
3045     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
3046   \else\ifx\txiarg\wordexample
3047     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
3048   \else\ifx\txiarg\wordcode
3049     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
3050   \else
3051     \errhelp = \EMsimple
3052     \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
3053   \fi\fi\fi
3054 }
3055 \def\worddistinct{distinct}
3056 \def\wordexample{example}
3057 \def\wordcode{code}
3058
3059 % Default is `distinct'.
3060 \kbdinputstyle distinct
3061
3062 % @kbd is like @code, except that if the argument is just one @key command,
3063 % then @kbd has no effect.
3064 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
3065
3066 \def\xkey{\key}
3067 \def\kbdsub#1#2#3\par{%
3068   \def\one{#1}\def\three{#3}\def\threex{??}%
3069   \ifx\one\xkey\ifx\threex\three \key{#2}%
3070   \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
3071   \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
3072 }
3073
3074 % definition of @key that produces a lozenge.  Doesn't adjust to text size.
3075 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3076 %\font\keysy=cmsy9
3077 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3078 %  \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3079 %    \vbox{\hrule\kern-0.4pt
3080 %     \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3081 %    \kern-0.4pt\hrule}%
3082 %  \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3083
3084 % definition of @key with no lozenge.  If the current font is already
3085 % monospace, don't change it; that way, we respect @kbdinputstyle.  But
3086 % if it isn't monospace, then use \tt.
3087 %
3088 \def\key#1{{\setupmarkupstyle{key}%
3089   \nohyphenation
3090   \ifmonospace\else\tt\fi
3091   #1}\null}
3092
3093 % @clicksequence{File @click{} Open ...}
3094 \def\clicksequence#1{\begingroup #1\endgroup}
3095
3096 % @clickstyle @arrow   (by default)
3097 \parseargdef\clickstyle{\def\click{#1}}
3098 \def\click{\arrow}
3099
3100 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
3101 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
3102 %
3103 \def\dmn#1{\thinspace #1}
3104
3105 % @acronym for "FBI", "NATO", and the like.
3106 % We print this one point size smaller, since it's intended for
3107 % all-uppercase.
3108 %
3109 \def\acronym#1{\doacronym #1,,\finish}
3110 \def\doacronym#1,#2,#3\finish{%
3111   {\selectfonts\lsize #1}%
3112   \def\temp{#2}%
3113   \ifx\temp\empty \else
3114     \space ({\unsepspaces \ignorespaces \temp \unskip})%
3115   \fi
3116   \null % reset \spacefactor=1000
3117 }
3118
3119 % @abbr for "Comput. J." and the like.
3120 % No font change, but don't do end-of-sentence spacing.
3121 %
3122 \def\abbr#1{\doabbr #1,,\finish}
3123 \def\doabbr#1,#2,#3\finish{%
3124   {\plainfrenchspacing #1}%
3125   \def\temp{#2}%
3126   \ifx\temp\empty \else
3127     \space ({\unsepspaces \ignorespaces \temp \unskip})%
3128   \fi
3129   \null % reset \spacefactor=1000
3130 }
3131
3132 % @asis just yields its argument.  Used with @table, for example.
3133 %
3134 \def\asis#1{#1}
3135
3136 % @math outputs its argument in math mode.
3137 %
3138 % One complication: _ usually means subscripts, but it could also mean
3139 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
3140 % _ active, and distinguish by seeing if the current family is \slfam,
3141 % which is what @var uses.
3142 {
3143   \catcode`\_ = \active
3144   \gdef\mathunderscore{%
3145     \catcode`\_=\active
3146     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
3147   }
3148 }
3149 % Another complication: we want \\ (and @\) to output a math (or tt) \.
3150 % FYI, plain.tex uses \\ as a temporary control sequence (for no
3151 % particular reason), but this is not advertised and we don't care.
3152 %
3153 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
3154 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
3155 %
3156 \def\math{%
3157   \ifmmode\else % only go into math if not in math mode already
3158     \tex
3159     \mathunderscore
3160     \let\\ = \mathbackslash
3161     \mathactive
3162     % make the texinfo accent commands work in math mode
3163     \let\"=\ddot
3164     \let\'=\acute
3165     \let\==\bar
3166     \let\^=\hat
3167     \let\`=\grave
3168     \let\u=\breve
3169     \let\v=\check
3170     \let\~=\tilde
3171     \let\dotaccent=\dot
3172     % have to provide another name for sup operator
3173     \let\mathopsup=\sup
3174   $\expandafter\finishmath\fi
3175 }
3176 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
3177
3178 % Some active characters (such as <) are spaced differently in math.
3179 % We have to reset their definitions in case the @math was an argument
3180 % to a command which sets the catcodes (such as @item or @section).
3181 %
3182 {
3183   \catcode`^ = \active
3184   \catcode`< = \active
3185   \catcode`> = \active
3186   \catcode`+ = \active
3187   \catcode`' = \active
3188   \gdef\mathactive{%
3189     \let^ = \ptexhat
3190     \let< = \ptexless
3191     \let> = \ptexgtr
3192     \let+ = \ptexplus
3193     \let' = \ptexquoteright
3194   }
3195 }
3196
3197 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
3198 % If in text, use math to place as sub/superscript, but switch
3199 % into text mode, with smaller fonts.  This is a different font than the
3200 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
3201 % fix it (significant additions to font machinery) until someone notices.
3202 %
3203 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
3204 \def\finishsub#1{$\sb{\hbox{\selectfonts\lllsize #1}}$}%
3205 %
3206 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
3207 \def\finishsup#1{$\ptexsp{\hbox{\selectfonts\lllsize #1}}$}%
3208
3209 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3210 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3211 % except specified as a normal braced arg, so no newlines to worry about.
3212
3213 \def\outfmtnametex{tex}
3214 %
3215 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
3216 \long\def\doinlinefmt#1,#2,\finish{%
3217   \def\inlinefmtname{#1}%
3218   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
3219 }
3220
3221 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3222 % FMTNAME is tex, else ELSE-TEXT.
3223 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
3224 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
3225   \def\inlinefmtname{#1}%
3226   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
3227 }
3228 %
3229 % For raw, must switch into @tex before parsing the argument, to avoid
3230 % setting catcodes prematurely.  Doing it this way means that, for
3231 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3232 % ignored.  But this isn't important because if people want a literal
3233 % *right* brace they would have to use a command anyway, so they may as
3234 % well use a command to get a left brace too.  We could re-use the
3235 % delimiter character idea from \verb, but it seems like overkill.
3236
3237 \long\def\inlineraw{\tex \doinlineraw}
3238 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
3239 \def\doinlinerawtwo#1,#2,\finish{%
3240   \def\inlinerawname{#1}%
3241   \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
3242   \endgroup % close group opened by \tex.
3243 }
3244
3245 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3246 %
3247 \long\def\inlineifset#1{\doinlineifset #1,\finish}
3248 \long\def\doinlineifset#1,#2,\finish{%
3249   \def\inlinevarname{#1}%
3250   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
3251   \else\ignorespaces#2\fi
3252 }
3253
3254 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3255 %
3256 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
3257 \long\def\doinlineifclear#1,#2,\finish{%
3258   \def\inlinevarname{#1}%
3259   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
3260 }
3261
3262
3263 \message{glyphs,}
3264 % and logos.
3265
3266 % @@ prints an @, as does @atchar{}.
3267 \def\@{\char64 }
3268 \let\atchar=\@
3269
3270 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3271 % Unless we're in typewriter, use \ecfont because the CM text fonts do
3272 % not have braces, and we don't want to switch into math.
3273 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
3274 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
3275 \let\{=\mylbrace \let\lbracechar=\{
3276 \let\}=\myrbrace \let\rbracechar=\}
3277 \begingroup
3278   % Definitions to produce \{ and \} commands for indices,
3279   % and @{ and @} for the aux/toc files.
3280   \catcode`\{ = \other \catcode`\} = \other
3281   \catcode`\[ = 1 \catcode`\] = 2
3282   \catcode`\! = 0 \catcode`\\ = \other
3283   !gdef!lbracecmd[\{]%
3284   !gdef!rbracecmd[\}]%
3285   !gdef!lbraceatcmd[@{]%
3286   !gdef!rbraceatcmd[@}]%
3287 !endgroup
3288
3289 % @comma{} to avoid , parsing problems.
3290 \let\comma = ,
3291
3292 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3293 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3294 \let\, = \ptexc
3295 \let\dotaccent = \ptexdot
3296 \def\ringaccent#1{{\accent23 #1}}
3297 \let\tieaccent = \ptext
3298 \let\ubaraccent = \ptexb
3299 \let\udotaccent = \d
3300
3301 % Other special characters: @questiondown @exclamdown @ordf @ordm
3302 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3303 \def\questiondown{?`}
3304 \def\exclamdown{!`}
3305 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
3306 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
3307
3308 % Dotless i and dotless j, used for accents.
3309 \def\imacro{i}
3310 \def\jmacro{j}
3311 \def\dotless#1{%
3312   \def\temp{#1}%
3313   \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3314   \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3315   \else \errmessage{@dotless can be used only with i or j}%
3316   \fi\fi
3317 }
3318
3319 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3320 % period following counts as ending a sentence.  (Idea found in latex.)
3321 %
3322 \edef\TeX{\TeX \spacefactor=1000 }
3323
3324 % @LaTeX{} logo.  Not quite the same results as the definition in
3325 % latex.ltx, since we use a different font for the raised A; it's most
3326 % convenient for us to use an explicitly smaller font, rather than using
3327 % the \scriptstyle font (since we don't reset \scriptstyle and
3328 % \scriptscriptstyle).
3329 %
3330 \def\LaTeX{%
3331   L\kern-.36em
3332   {\setbox0=\hbox{T}%
3333    \vbox to \ht0{\hbox{%
3334      \ifx\textnominalsize\xwordpt
3335        % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3336        % Revert to plain's \scriptsize, which is 7pt.
3337        \count255=\the\fam $\fam\count255 \scriptstyle A$%
3338      \else
3339        % For 11pt, we can use our lllsize.
3340        \selectfonts\lllsize A%
3341      \fi
3342      }%
3343      \vss
3344   }}%
3345   \kern-.15em
3346   \TeX
3347 }
3348
3349 % Some math mode symbols.  Define \ensuremath to switch into math mode
3350 % unless we are already there.  Expansion tricks may not be needed here,
3351 % but safer, and can't hurt.
3352 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3353 \def\ensuredmath#1{$\relax#1$}
3354 %
3355 \def\bullet{\ensuremath\ptexbullet}
3356 \def\geq{\ensuremath\ge}
3357 \def\leq{\ensuremath\le}
3358 \def\minus{\ensuremath-}
3359
3360 % @dots{} outputs an ellipsis using the current font.
3361 % We do .5em per period so that it has the same spacing in the cm
3362 % typewriter fonts as three actual period characters; on the other hand,
3363 % in other typewriter fonts three periods are wider than 1.5em.  So do
3364 % whichever is larger.
3365 %
3366 \def\dots{%
3367   \leavevmode
3368   \setbox0=\hbox{...}% get width of three periods
3369   \ifdim\wd0 > 1.5em
3370     \dimen0 = \wd0
3371   \else
3372     \dimen0 = 1.5em
3373   \fi
3374   \hbox to \dimen0{%
3375     \hskip 0pt plus.25fil
3376     .\hskip 0pt plus1fil
3377     .\hskip 0pt plus1fil
3378     .\hskip 0pt plus.5fil
3379   }%
3380 }
3381
3382 % @enddots{} is an end-of-sentence ellipsis.
3383 %
3384 \def\enddots{%
3385   \dots
3386   \spacefactor=\endofsentencespacefactor
3387 }
3388
3389 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3390 %
3391 % Since these characters are used in examples, they should be an even number of
3392 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3393 %
3394 \def\point{$\star$}
3395 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3396 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3397 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3398 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3399 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3400
3401 % The @error{} command.
3402 % Adapted from the TeXbook's \boxit.
3403 %
3404 \newbox\errorbox
3405 %
3406 {\tentt \global\dimen0 = 3em}% Width of the box.
3407 \dimen2 = .55pt % Thickness of rules
3408 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3409 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3410 %
3411 \setbox\errorbox=\hbox to \dimen0{\hfil
3412    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3413    \advance\hsize by -2\dimen2 % Rules.
3414    \vbox{%
3415       \hrule height\dimen2
3416       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
3417          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3418          \kern3pt\vrule width\dimen2}% Space to right.
3419       \hrule height\dimen2}
3420     \hfil}
3421 %
3422 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3423
3424 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3425 %
3426 \def\pounds{{\it\$}}
3427
3428 % @euro{} comes from a separate font, depending on the current style.
3429 % We use the free feym* fonts from the eurosym package by Henrik
3430 % Theiling, which support regular, slanted, bold and bold slanted (and
3431 % "outlined" (blackboard board, sort of) versions, which we don't need).
3432 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3433 %
3434 % Although only regular is the truly official Euro symbol, we ignore
3435 % that.  The Euro is designed to be slightly taller than the regular
3436 % font height.
3437 %
3438 % feymr - regular
3439 % feymo - slanted
3440 % feybr - bold
3441 % feybo - bold slanted
3442 %
3443 % There is no good (free) typewriter version, to my knowledge.
3444 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3445 % Hmm.
3446 %
3447 % Also doesn't work in math.  Do we need to do math with euro symbols?
3448 % Hope not.
3449 %
3450 %
3451 \def\euro{{\eurofont e}}
3452 \def\eurofont{%
3453   % We set the font at each command, rather than predefining it in
3454   % \textfonts and the other font-switching commands, so that
3455   % installations which never need the symbol don't have to have the
3456   % font installed.
3457   %
3458   % There is only one designed size (nominal 10pt), so we always scale
3459   % that to the current nominal size.
3460   %
3461   % By the way, simply using "at 1em" works for cmr10 and the like, but
3462   % does not work for cmbx10 and other extended/shrunken fonts.
3463   %
3464   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3465   %
3466   \ifx\curfontstyle\bfstylename
3467     % bold:
3468     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3469   \else
3470     % regular:
3471     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3472   \fi
3473   \thiseurofont
3474 }
3475
3476 % Glyphs from the EC fonts.  We don't use \let for the aliases, because
3477 % sometimes we redefine the original macro, and the alias should reflect
3478 % the redefinition.
3479 %
3480 % Use LaTeX names for the Icelandic letters.
3481 \def\DH{{\ecfont \char"D0}} % Eth
3482 \def\dh{{\ecfont \char"F0}} % eth
3483 \def\TH{{\ecfont \char"DE}} % Thorn
3484 \def\th{{\ecfont \char"FE}} % thorn
3485 %
3486 \def\guillemetleft{{\ecfont \char"13}}
3487 \def\guillemotleft{\guillemetleft}
3488 \def\guillemetright{{\ecfont \char"14}}
3489 \def\guillemotright{\guillemetright}
3490 \def\guilsinglleft{{\ecfont \char"0E}}
3491 \def\guilsinglright{{\ecfont \char"0F}}
3492 \def\quotedblbase{{\ecfont \char"12}}
3493 \def\quotesinglbase{{\ecfont \char"0D}}
3494 %
3495 % This positioning is not perfect (see the ogonek LaTeX package), but
3496 % we have the precomposed glyphs for the most common cases.  We put the
3497 % tests to use those glyphs in the single \ogonek macro so we have fewer
3498 % dummy definitions to worry about for index entries, etc.
3499 %
3500 % ogonek is also used with other letters in Lithuanian (IOU), but using
3501 % the precomposed glyphs for those is not so easy since they aren't in
3502 % the same EC font.
3503 \def\ogonek#1{{%
3504   \def\temp{#1}%
3505   \ifx\temp\macrocharA\Aogonek
3506   \else\ifx\temp\macrochara\aogonek
3507   \else\ifx\temp\macrocharE\Eogonek
3508   \else\ifx\temp\macrochare\eogonek
3509   \else
3510     \ecfont \setbox0=\hbox{#1}%
3511     \ifdim\ht0=1ex\accent"0C #1%
3512     \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3513     \fi
3514   \fi\fi\fi\fi
3515   }%
3516 }
3517 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3518 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3519 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3520 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3521 %
3522 % Use the European Computer Modern fonts (cm-super in outline format)
3523 % for non-CM glyphs.  That is ec* for regular text and tc* for the text
3524 % companion symbols (LaTeX TS1 encoding).  Both are part of the ec
3525 % package and follow the same conventions.
3526
3527 \def\ecfont{\etcfont{e}}
3528 \def\tcfont{\etcfont{t}}
3529 %
3530 \def\etcfont#1{%
3531   % We can't distinguish serif/sans and italic/slanted, but this
3532   % is used for crude hacks anyway (like adding French and German
3533   % quotes to documents typeset with CM, where we lose kerning), so
3534   % hopefully nobody will notice/care.
3535   \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3536   \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3537   \ifmonospace
3538     % typewriter:
3539     \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3540   \else
3541     \ifx\curfontstyle\bfstylename
3542       % bold:
3543       \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3544     \else
3545       % regular:
3546       \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3547     \fi
3548   \fi
3549   \thisecfont
3550 }
3551
3552 % @registeredsymbol - R in a circle.  The font for the R should really
3553 % be smaller yet, but lllsize is the best we can do for now.
3554 % Adapted from the plain.tex definition of \copyright.
3555 %
3556 \def\registeredsymbol{%
3557   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3558                \hfil\crcr\Orb}}%
3559     }$%
3560 }
3561
3562 % @textdegree - the normal degrees sign.
3563 %
3564 \def\textdegree{$^\circ$}
3565
3566 % Laurent Siebenmann reports \Orb undefined with:
3567 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
3568 % so we'll define it if necessary.
3569 %
3570 \ifx\Orb\thisisundefined
3571 \def\Orb{\mathhexbox20D}
3572 \fi
3573
3574 % Quotes.
3575 \chardef\quotedblleft="5C
3576 \chardef\quotedblright=`\"
3577 \chardef\quoteleft=`\`
3578 \chardef\quoteright=`\'
3579
3580
3581 \message{page headings,}
3582
3583 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3584 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3585
3586 % First the title page.  Must do @settitle before @titlepage.
3587 \newif\ifseenauthor
3588 \newif\iffinishedtitlepage
3589
3590 % @setcontentsaftertitlepage used to do an implicit @contents or
3591 % @shortcontents after @end titlepage, but it is now obsolete.
3592 \def\setcontentsaftertitlepage{%
3593   \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
3594               command; move your @contents command if you want the contents
3595               after the title page.}}%
3596 \def\setshortcontentsaftertitlepage{%
3597   \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
3598               command; move your @shortcontents and @contents commands if you 
3599               want the contents after the title page.}}%
3600
3601 \parseargdef\shorttitlepage{%
3602   \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3603   \endgroup\page\hbox{}\page}
3604
3605 \envdef\titlepage{%
3606   % Open one extra group, as we want to close it in the middle of \Etitlepage.
3607   \begingroup
3608     \parindent=0pt \textfonts
3609     % Leave some space at the very top of the page.
3610     \vglue\titlepagetopglue
3611     % No rule at page bottom unless we print one at the top with @title.
3612     \finishedtitlepagetrue
3613     %
3614     % Most title ``pages'' are actually two pages long, with space
3615     % at the top of the second.  We don't want the ragged left on the second.
3616     \let\oldpage = \page
3617     \def\page{%
3618       \iffinishedtitlepage\else
3619          \finishtitlepage
3620       \fi
3621       \let\page = \oldpage
3622       \page
3623       \null
3624     }%
3625 }
3626
3627 \def\Etitlepage{%
3628     \iffinishedtitlepage\else
3629         \finishtitlepage
3630     \fi
3631     % It is important to do the page break before ending the group,
3632     % because the headline and footline are only empty inside the group.
3633     % If we use the new definition of \page, we always get a blank page
3634     % after the title page, which we certainly don't want.
3635     \oldpage
3636   \endgroup
3637   %
3638   % Need this before the \...aftertitlepage checks so that if they are
3639   % in effect the toc pages will come out with page numbers.
3640   \HEADINGSon
3641 }
3642
3643 \def\finishtitlepage{%
3644   \vskip4pt \hrule height 2pt width \hsize
3645   \vskip\titlepagebottomglue
3646   \finishedtitlepagetrue
3647 }
3648
3649 % Settings used for typesetting titles: no hyphenation, no indentation,
3650 % don't worry much about spacing, ragged right.  This should be used
3651 % inside a \vbox, and fonts need to be set appropriately first.  Because
3652 % it is always used for titles, nothing else, we call \rmisbold.  \par
3653 % should be specified before the end of the \vbox, since a vbox is a group.
3654
3655 \def\raggedtitlesettings{%
3656   \rmisbold
3657   \hyphenpenalty=10000
3658   \parindent=0pt
3659   \tolerance=5000
3660   \ptexraggedright
3661 }
3662
3663 % Macros to be used within @titlepage:
3664
3665 \let\subtitlerm=\tenrm
3666 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3667
3668 \parseargdef\title{%
3669   \checkenv\titlepage
3670   \vbox{\titlefonts \raggedtitlesettings #1\par}%
3671   % print a rule at the page bottom also.
3672   \finishedtitlepagefalse
3673   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3674 }
3675
3676 \parseargdef\subtitle{%
3677   \checkenv\titlepage
3678   {\subtitlefont \rightline{#1}}%
3679 }
3680
3681 % @author should come last, but may come many times.
3682 % It can also be used inside @quotation.
3683 %
3684 \parseargdef\author{%
3685   \def\temp{\quotation}%
3686   \ifx\thisenv\temp
3687     \def\quotationauthor{#1}% printed in \Equotation.
3688   \else
3689     \checkenv\titlepage
3690     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3691     {\secfonts\rmisbold \leftline{#1}}%
3692   \fi
3693 }
3694
3695
3696 % Set up page headings and footings.
3697
3698 \let\thispage=\folio
3699
3700 \newtoks\evenheadline    % headline on even pages
3701 \newtoks\oddheadline     % headline on odd pages
3702 \newtoks\evenfootline    % footline on even pages
3703 \newtoks\oddfootline     % footline on odd pages
3704
3705 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3706 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3707                             \else \the\evenheadline \fi}}
3708 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3709                             \else \the\evenfootline \fi}\HEADINGShook}
3710 \let\HEADINGShook=\relax
3711
3712 % Commands to set those variables.
3713 % For example, this is what  @headings on  does
3714 % @evenheading @thistitle|@thispage|@thischapter
3715 % @oddheading @thischapter|@thispage|@thistitle
3716 % @evenfooting @thisfile||
3717 % @oddfooting ||@thisfile
3718
3719
3720 \def\evenheading{\parsearg\evenheadingxxx}
3721 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3722 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3723 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3724
3725 \def\oddheading{\parsearg\oddheadingxxx}
3726 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3727 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3728 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3729
3730 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3731
3732 \def\evenfooting{\parsearg\evenfootingxxx}
3733 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3734 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3735 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3736
3737 \def\oddfooting{\parsearg\oddfootingxxx}
3738 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3739 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3740   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3741   %
3742   % Leave some space for the footline.  Hopefully ok to assume
3743   % @evenfooting will not be used by itself.
3744   \global\advance\txipageheight by -12pt
3745   \global\advance\vsize by -12pt
3746 }
3747
3748 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3749
3750 % @evenheadingmarks top     \thischapter <- chapter at the top of a page
3751 % @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
3752 %
3753 % The same set of arguments for:
3754 %
3755 % @oddheadingmarks
3756 % @evenfootingmarks
3757 % @oddfootingmarks
3758 % @everyheadingmarks
3759 % @everyfootingmarks
3760
3761 % These define \getoddheadingmarks, \getevenheadingmarks,
3762 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3763 % \gettopheadingmarks, \getbottomheadingmarks.
3764 %
3765 \def\evenheadingmarks{\headingmarks{even}{heading}}
3766 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3767 \def\evenfootingmarks{\headingmarks{even}{footing}}
3768 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3769 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
3770                           \headingmarks{odd}{heading}{#1} }
3771 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
3772                           \headingmarks{odd}{footing}{#1} }
3773 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3774 \def\headingmarks#1#2#3 {%
3775   \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3776   \global\expandafter\let\csname get#1#2marks\endcsname \temp
3777 }
3778
3779 \everyheadingmarks bottom
3780 \everyfootingmarks bottom
3781
3782 % @headings double      turns headings on for double-sided printing.
3783 % @headings single      turns headings on for single-sided printing.
3784 % @headings off         turns them off.
3785 % @headings on          same as @headings double, retained for compatibility.
3786 % @headings after       turns on double-sided headings after this page.
3787 % @headings doubleafter turns on double-sided headings after this page.
3788 % @headings singleafter turns on single-sided headings after this page.
3789 % By default, they are off at the start of a document,
3790 % and turned `on' after @end titlepage.
3791
3792 \parseargdef\headings{\csname HEADINGS#1\endcsname}
3793
3794 \def\headingsoff{% non-global headings elimination
3795   \evenheadline={\hfil}\evenfootline={\hfil}%
3796    \oddheadline={\hfil}\oddfootline={\hfil}%
3797 }
3798
3799 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3800 \HEADINGSoff  % it's the default
3801
3802 % When we turn headings on, set the page number to 1.
3803 % For double-sided printing, put current file name in lower left corner,
3804 % chapter name on inside top of right hand pages, document
3805 % title on inside top of left hand pages, and page numbers on outside top
3806 % edge of all pages.
3807 \def\HEADINGSdouble{%
3808 \global\pageno=1
3809 \global\evenfootline={\hfil}
3810 \global\oddfootline={\hfil}
3811 \global\evenheadline={\line{\folio\hfil\thistitle}}
3812 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3813 \global\let\contentsalignmacro = \chapoddpage
3814 }
3815 \let\contentsalignmacro = \chappager
3816
3817 % For single-sided printing, chapter title goes across top left of page,
3818 % page number on top right.
3819 \def\HEADINGSsingle{%
3820 \global\pageno=1
3821 \global\evenfootline={\hfil}
3822 \global\oddfootline={\hfil}
3823 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
3824 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3825 \global\let\contentsalignmacro = \chappager
3826 }
3827 \def\HEADINGSon{\HEADINGSdouble}
3828
3829 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3830 \let\HEADINGSdoubleafter=\HEADINGSafter
3831 \def\HEADINGSdoublex{%
3832 \global\evenfootline={\hfil}
3833 \global\oddfootline={\hfil}
3834 \global\evenheadline={\line{\folio\hfil\thistitle}}
3835 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3836 \global\let\contentsalignmacro = \chapoddpage
3837 }
3838
3839 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3840 \def\HEADINGSsinglex{%
3841 \global\evenfootline={\hfil}
3842 \global\oddfootline={\hfil}
3843 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
3844 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3845 \global\let\contentsalignmacro = \chappager
3846 }
3847
3848 % Subroutines used in generating headings
3849 % This produces Day Month Year style of output.
3850 % Only define if not already defined, in case a txi-??.tex file has set
3851 % up a different format (e.g., txi-cs.tex does this).
3852 \ifx\today\thisisundefined
3853 \def\today{%
3854   \number\day\space
3855   \ifcase\month
3856   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3857   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3858   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3859   \fi
3860   \space\number\year}
3861 \fi
3862
3863 % @settitle line...  specifies the title of the document, for headings.
3864 % It generates no output of its own.
3865 \def\thistitle{\putwordNoTitle}
3866 \def\settitle{\parsearg{\gdef\thistitle}}
3867
3868
3869 \message{tables,}
3870 % Tables -- @table, @ftable, @vtable, @item(x).
3871
3872 % default indentation of table text
3873 \newdimen\tableindent \tableindent=.8in
3874 % default indentation of @itemize and @enumerate text
3875 \newdimen\itemindent  \itemindent=.3in
3876 % margin between end of table item and start of table text.
3877 \newdimen\itemmargin  \itemmargin=.1in
3878
3879 % used internally for \itemindent minus \itemmargin
3880 \newdimen\itemmax
3881
3882 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3883 % these defs.
3884 % They also define \itemindex
3885 % to index the item name in whatever manner is desired (perhaps none).
3886
3887 \newif\ifitemxneedsnegativevskip
3888
3889 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3890
3891 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3892 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3893
3894 \def\itemzzz #1{\begingroup %
3895   \advance\hsize by -\rightskip
3896   \advance\hsize by -\tableindent
3897   \setbox0=\hbox{\itemindicate{#1}}%
3898   \itemindex{#1}%
3899   \nobreak % This prevents a break before @itemx.
3900   %
3901   % If the item text does not fit in the space we have, put it on a line
3902   % by itself, and do not allow a page break either before or after that
3903   % line.  We do not start a paragraph here because then if the next
3904   % command is, e.g., @kindex, the whatsit would get put into the
3905   % horizontal list on a line by itself, resulting in extra blank space.
3906   \ifdim \wd0>\itemmax
3907     %
3908     % Make this a paragraph so we get the \parskip glue and wrapping,
3909     % but leave it ragged-right.
3910     \begingroup
3911       \advance\leftskip by-\tableindent
3912       \advance\hsize by\tableindent
3913       \advance\rightskip by0pt plus1fil\relax
3914       \leavevmode\unhbox0\par
3915     \endgroup
3916     %
3917     % We're going to be starting a paragraph, but we don't want the
3918     % \parskip glue -- logically it's part of the @item we just started.
3919     \nobreak \vskip-\parskip
3920     %
3921     % Stop a page break at the \parskip glue coming up.  However, if
3922     % what follows is an environment such as @example, there will be no
3923     % \parskip glue; then the negative vskip we just inserted would
3924     % cause the example and the item to crash together.  So we use this
3925     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3926     % \parskip glue after all.  Section titles are handled this way also.
3927     %
3928     \penalty 10001
3929     \endgroup
3930     \itemxneedsnegativevskipfalse
3931   \else
3932     % The item text fits into the space.  Start a paragraph, so that the
3933     % following text (if any) will end up on the same line.
3934     \noindent
3935     % Do this with kerns and \unhbox so that if there is a footnote in
3936     % the item text, it can migrate to the main vertical list and
3937     % eventually be printed.
3938     \nobreak\kern-\tableindent
3939     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3940     \unhbox0
3941     \nobreak\kern\dimen0
3942     \endgroup
3943     \itemxneedsnegativevskiptrue
3944   \fi
3945 }
3946
3947 \def\item{\errmessage{@item while not in a list environment}}
3948 \def\itemx{\errmessage{@itemx while not in a list environment}}
3949
3950 % @table, @ftable, @vtable.
3951 \envdef\table{%
3952   \let\itemindex\gobble
3953   \tablecheck{table}%
3954 }
3955 \envdef\ftable{%
3956   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3957   \tablecheck{ftable}%
3958 }
3959 \envdef\vtable{%
3960   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3961   \tablecheck{vtable}%
3962 }
3963 \def\tablecheck#1{%
3964   \ifnum \the\catcode`\^^M=\active
3965     \endgroup
3966     \errmessage{This command won't work in this context; perhaps the problem is
3967       that we are \inenvironment\thisenv}%
3968     \def\next{\doignore{#1}}%
3969   \else
3970     \let\next\tablex
3971   \fi
3972   \next
3973 }
3974 \def\tablex#1{%
3975   \def\itemindicate{#1}%
3976   \parsearg\tabley
3977 }
3978 \def\tabley#1{%
3979   {%
3980     \makevalueexpandable
3981     \edef\temp{\noexpand\tablez #1\space\space\space}%
3982     \expandafter
3983   }\temp \endtablez
3984 }
3985 \def\tablez #1 #2 #3 #4\endtablez{%
3986   \aboveenvbreak
3987   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3988   \ifnum 0#2>0 \tableindent=#2\mil \fi
3989   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3990   \itemmax=\tableindent
3991   \advance \itemmax by -\itemmargin
3992   \advance \leftskip by \tableindent
3993   \exdentamount=\tableindent
3994   \parindent = 0pt
3995   \parskip = \smallskipamount
3996   \ifdim \parskip=0pt \parskip=2pt \fi
3997   \let\item = \internalBitem
3998   \let\itemx = \internalBitemx
3999 }
4000 \def\Etable{\endgraf\afterenvbreak}
4001 \let\Eftable\Etable
4002 \let\Evtable\Etable
4003 \let\Eitemize\Etable
4004 \let\Eenumerate\Etable
4005
4006 % This is the counter used by @enumerate, which is really @itemize
4007
4008 \newcount \itemno
4009
4010 \envdef\itemize{\parsearg\doitemize}
4011
4012 \def\doitemize#1{%
4013   \aboveenvbreak
4014   \itemmax=\itemindent
4015   \advance\itemmax by -\itemmargin
4016   \advance\leftskip by \itemindent
4017   \exdentamount=\itemindent
4018   \parindent=0pt
4019   \parskip=\smallskipamount
4020   \ifdim\parskip=0pt \parskip=2pt \fi
4021   %
4022   % Try typesetting the item mark so that if the document erroneously says
4023   % something like @itemize @samp (intending @table), there's an error
4024   % right away at the @itemize.  It's not the best error message in the
4025   % world, but it's better than leaving it to the @item.  This means if
4026   % the user wants an empty mark, they have to say @w{} not just @w.
4027   \def\itemcontents{#1}%
4028   \setbox0 = \hbox{\itemcontents}%
4029   %
4030   % @itemize with no arg is equivalent to @itemize @bullet.
4031   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
4032   %
4033   \let\item=\itemizeitem
4034 }
4035
4036 % Definition of @item while inside @itemize and @enumerate.
4037 %
4038 \def\itemizeitem{%
4039   \advance\itemno by 1  % for enumerations
4040   {\let\par=\endgraf \smallbreak}% reasonable place to break
4041   {%
4042    % If the document has an @itemize directly after a section title, a
4043    % \nobreak will be last on the list, and \sectionheading will have
4044    % done a \vskip-\parskip.  In that case, we don't want to zero
4045    % parskip, or the item text will crash with the heading.  On the
4046    % other hand, when there is normal text preceding the item (as there
4047    % usually is), we do want to zero parskip, or there would be too much
4048    % space.  In that case, we won't have a \nobreak before.  At least
4049    % that's the theory.
4050    \ifnum\lastpenalty<10000 \parskip=0in \fi
4051    \noindent
4052    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
4053    %
4054    \ifinner\else
4055      \vadjust{\penalty 1200}% not good to break after first line of item.
4056    \fi
4057    % We can be in inner vertical mode in a footnote, although an
4058    % @itemize looks awful there.
4059   }%
4060   \flushcr
4061 }
4062
4063 % \splitoff TOKENS\endmark defines \first to be the first token in
4064 % TOKENS, and \rest to be the remainder.
4065 %
4066 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
4067
4068 % Allow an optional argument of an uppercase letter, lowercase letter,
4069 % or number, to specify the first label in the enumerated list.  No
4070 % argument is the same as `1'.
4071 %
4072 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
4073 \def\enumeratey #1 #2\endenumeratey{%
4074   % If we were given no argument, pretend we were given `1'.
4075   \def\thearg{#1}%
4076   \ifx\thearg\empty \def\thearg{1}\fi
4077   %
4078   % Detect if the argument is a single token.  If so, it might be a
4079   % letter.  Otherwise, the only valid thing it can be is a number.
4080   % (We will always have one token, because of the test we just made.
4081   % This is a good thing, since \splitoff doesn't work given nothing at
4082   % all -- the first parameter is undelimited.)
4083   \expandafter\splitoff\thearg\endmark
4084   \ifx\rest\empty
4085     % Only one token in the argument.  It could still be anything.
4086     % A ``lowercase letter'' is one whose \lccode is nonzero.
4087     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4088     %   not equal to itself.
4089     % Otherwise, we assume it's a number.
4090     %
4091     % We need the \relax at the end of the \ifnum lines to stop TeX from
4092     % continuing to look for a <number>.
4093     %
4094     \ifnum\lccode\expandafter`\thearg=0\relax
4095       \numericenumerate % a number (we hope)
4096     \else
4097       % It's a letter.
4098       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
4099         \lowercaseenumerate % lowercase letter
4100       \else
4101         \uppercaseenumerate % uppercase letter
4102       \fi
4103     \fi
4104   \else
4105     % Multiple tokens in the argument.  We hope it's a number.
4106     \numericenumerate
4107   \fi
4108 }
4109
4110 % An @enumerate whose labels are integers.  The starting integer is
4111 % given in \thearg.
4112 %
4113 \def\numericenumerate{%
4114   \itemno = \thearg
4115   \startenumeration{\the\itemno}%
4116 }
4117
4118 % The starting (lowercase) letter is in \thearg.
4119 \def\lowercaseenumerate{%
4120   \itemno = \expandafter`\thearg
4121   \startenumeration{%
4122     % Be sure we're not beyond the end of the alphabet.
4123     \ifnum\itemno=0
4124       \errmessage{No more lowercase letters in @enumerate; get a bigger
4125                   alphabet}%
4126     \fi
4127     \char\lccode\itemno
4128   }%
4129 }
4130
4131 % The starting (uppercase) letter is in \thearg.
4132 \def\uppercaseenumerate{%
4133   \itemno = \expandafter`\thearg
4134   \startenumeration{%
4135     % Be sure we're not beyond the end of the alphabet.
4136     \ifnum\itemno=0
4137       \errmessage{No more uppercase letters in @enumerate; get a bigger
4138                   alphabet}
4139     \fi
4140     \char\uccode\itemno
4141   }%
4142 }
4143
4144 % Call \doitemize, adding a period to the first argument and supplying the
4145 % common last two arguments.  Also subtract one from the initial value in
4146 % \itemno, since @item increments \itemno.
4147 %
4148 \def\startenumeration#1{%
4149   \advance\itemno by -1
4150   \doitemize{#1.}\flushcr
4151 }
4152
4153 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
4154 % to @enumerate.
4155 %
4156 \def\alphaenumerate{\enumerate{a}}
4157 \def\capsenumerate{\enumerate{A}}
4158 \def\Ealphaenumerate{\Eenumerate}
4159 \def\Ecapsenumerate{\Eenumerate}
4160
4161
4162 % @multitable macros
4163 % Amy Hendrickson, 8/18/94, 3/6/96
4164 %
4165 % @multitable ... @end multitable will make as many columns as desired.
4166 % Contents of each column will wrap at width given in preamble.  Width
4167 % can be specified either with sample text given in a template line,
4168 % or in percent of \hsize, the current width of text on page.
4169
4170 % Table can continue over pages but will only break between lines.
4171
4172 % To make preamble:
4173 %
4174 % Either define widths of columns in terms of percent of \hsize:
4175 %   @multitable @columnfractions .25 .3 .45
4176 %   @item ...
4177 %
4178 %   Numbers following @columnfractions are the percent of the total
4179 %   current hsize to be used for each column. You may use as many
4180 %   columns as desired.
4181
4182
4183 % Or use a template:
4184 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
4185 %   @item ...
4186 %   using the widest term desired in each column.
4187
4188 % Each new table line starts with @item, each subsequent new column
4189 % starts with @tab. Empty columns may be produced by supplying @tab's
4190 % with nothing between them for as many times as empty columns are needed,
4191 % ie, @tab@tab@tab will produce two empty columns.
4192
4193 % @item, @tab do not need to be on their own lines, but it will not hurt
4194 % if they are.
4195
4196 % Sample multitable:
4197
4198 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
4199 %   @item first col stuff @tab second col stuff @tab third col
4200 %   @item
4201 %   first col stuff
4202 %   @tab
4203 %   second col stuff
4204 %   @tab
4205 %   third col
4206 %   @item first col stuff @tab second col stuff
4207 %   @tab Many paragraphs of text may be used in any column.
4208 %
4209 %         They will wrap at the width determined by the template.
4210 %   @item@tab@tab This will be in third column.
4211 %   @end multitable
4212
4213 % Default dimensions may be reset by user.
4214 % @multitableparskip is vertical space between paragraphs in table.
4215 % @multitableparindent is paragraph indent in table.
4216 % @multitablecolmargin is horizontal space to be left between columns.
4217 % @multitablelinespace is space to leave between table items, baseline
4218 %                                                            to baseline.
4219 %   0pt means it depends on current normal line spacing.
4220 %
4221 \newskip\multitableparskip
4222 \newskip\multitableparindent
4223 \newdimen\multitablecolspace
4224 \newskip\multitablelinespace
4225 \multitableparskip=0pt
4226 \multitableparindent=6pt
4227 \multitablecolspace=12pt
4228 \multitablelinespace=0pt
4229
4230 % Macros used to set up halign preamble:
4231 %
4232 \let\endsetuptable\relax
4233 \def\xendsetuptable{\endsetuptable}
4234 \let\columnfractions\relax
4235 \def\xcolumnfractions{\columnfractions}
4236 \newif\ifsetpercent
4237
4238 % #1 is the @columnfraction, usually a decimal number like .5, but might
4239 % be just 1.  We just use it, whatever it is.
4240 %
4241 \def\pickupwholefraction#1 {%
4242   \global\advance\colcount by 1
4243   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
4244   \setuptable
4245 }
4246
4247 \newcount\colcount
4248 \def\setuptable#1{%
4249   \def\firstarg{#1}%
4250   \ifx\firstarg\xendsetuptable
4251     \let\go = \relax
4252   \else
4253     \ifx\firstarg\xcolumnfractions
4254       \global\setpercenttrue
4255     \else
4256       \ifsetpercent
4257          \let\go\pickupwholefraction
4258       \else
4259          \global\advance\colcount by 1
4260          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
4261                    % separator; typically that is always in the input, anyway.
4262          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
4263       \fi
4264     \fi
4265     \ifx\go\pickupwholefraction
4266       % Put the argument back for the \pickupwholefraction call, so
4267       % we'll always have a period there to be parsed.
4268       \def\go{\pickupwholefraction#1}%
4269     \else
4270       \let\go = \setuptable
4271     \fi%
4272   \fi
4273   \go
4274 }
4275
4276 % multitable-only commands.
4277
4278 % @headitem starts a heading row, which we typeset in bold.  Assignments
4279 % have to be global since we are inside the implicit group of an
4280 % alignment entry.  \everycr below resets \everytab so we don't have to
4281 % undo it ourselves.
4282 \def\headitemfont{\b}% for people to use in the template row; not changeable
4283 \def\headitem{%
4284   \checkenv\multitable
4285   \crcr
4286   \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
4287   \global\everytab={\bf}% can't use \headitemfont since the parsing differs
4288   \the\everytab % for the first item
4289 }%
4290 %
4291 % default for tables with no headings.
4292 \let\headitemcrhook=\relax
4293 %
4294 % A \tab used to include \hskip1sp.  But then the space in a template
4295 % line is not enough.  That is bad.  So let's go back to just `&' until
4296 % we again encounter the problem the 1sp was intended to solve.
4297 %                                       --karl, nathan@acm.org, 20apr99.
4298 \def\tab{\checkenv\multitable &\the\everytab}%
4299
4300 % @multitable ... @end multitable definitions:
4301 %
4302 \newtoks\everytab  % insert after every tab.
4303 %
4304 \envdef\multitable{%
4305   \vskip\parskip
4306   \startsavinginserts
4307   %
4308   % @item within a multitable starts a normal row.
4309   % We use \def instead of \let so that if one of the multitable entries
4310   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4311   % \endtemplate) expanding \doitemize.
4312   \def\item{\crcr}%
4313   %
4314   \tolerance=9500
4315   \hbadness=9500
4316   \setmultitablespacing
4317   \parskip=\multitableparskip
4318   \parindent=\multitableparindent
4319   \overfullrule=0pt
4320   \global\colcount=0
4321   %
4322   \everycr = {%
4323     \noalign{%
4324       \global\everytab={}% Reset from possible headitem.
4325       \global\colcount=0 % Reset the column counter.
4326       %
4327       % Check for saved footnotes, etc.:
4328       \checkinserts
4329       %
4330       % Perhaps a \nobreak, then reset:
4331       \headitemcrhook
4332       \global\let\headitemcrhook=\relax
4333     }%
4334   }%
4335   %
4336   \parsearg\domultitable
4337 }
4338 \def\domultitable#1{%
4339   % To parse everything between @multitable and @item:
4340   \setuptable#1 \endsetuptable
4341   %
4342   % This preamble sets up a generic column definition, which will
4343   % be used as many times as user calls for columns.
4344   % \vtop will set a single line and will also let text wrap and
4345   % continue for many paragraphs if desired.
4346   \halign\bgroup &%
4347     \global\advance\colcount by 1
4348     \multistrut
4349     \vtop{%
4350       % Use the current \colcount to find the correct column width:
4351       \hsize=\expandafter\csname col\the\colcount\endcsname
4352       %
4353       % In order to keep entries from bumping into each other
4354       % we will add a \leftskip of \multitablecolspace to all columns after
4355       % the first one.
4356       %
4357       % If a template has been used, we will add \multitablecolspace
4358       % to the width of each template entry.
4359       %
4360       % If the user has set preamble in terms of percent of \hsize we will
4361       % use that dimension as the width of the column, and the \leftskip
4362       % will keep entries from bumping into each other.  Table will start at
4363       % left margin and final column will justify at right margin.
4364       %
4365       % Make sure we don't inherit \rightskip from the outer environment.
4366       \rightskip=0pt
4367       \ifnum\colcount=1
4368         % The first column will be indented with the surrounding text.
4369         \advance\hsize by\leftskip
4370       \else
4371         \ifsetpercent \else
4372           % If user has not set preamble in terms of percent of \hsize
4373           % we will advance \hsize by \multitablecolspace.
4374           \advance\hsize by \multitablecolspace
4375         \fi
4376        % In either case we will make \leftskip=\multitablecolspace:
4377       \leftskip=\multitablecolspace
4378       \fi
4379       % Ignoring space at the beginning and end avoids an occasional spurious
4380       % blank line, when TeX decides to break the line at the space before the
4381       % box from the multistrut, so the strut ends up on a line by itself.
4382       % For example:
4383       % @multitable @columnfractions .11 .89
4384       % @item @code{#}
4385       % @tab Legal holiday which is valid in major parts of the whole country.
4386       % Is automatically provided with highlighting sequences respectively
4387       % marking characters.
4388       \noindent\ignorespaces##\unskip\multistrut
4389     }\cr
4390 }
4391 \def\Emultitable{%
4392   \crcr
4393   \egroup % end the \halign
4394   \global\setpercentfalse
4395 }
4396
4397 \def\setmultitablespacing{%
4398   \def\multistrut{\strut}% just use the standard line spacing
4399   %
4400   % Compute \multitablelinespace (if not defined by user) for use in
4401   % \multitableparskip calculation.  We used define \multistrut based on
4402   % this, but (ironically) that caused the spacing to be off.
4403   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4404 \ifdim\multitablelinespace=0pt
4405 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4406 \global\advance\multitablelinespace by-\ht0
4407 \fi
4408 % Test to see if parskip is larger than space between lines of
4409 % table. If not, do nothing.
4410 %        If so, set to same dimension as multitablelinespace.
4411 \ifdim\multitableparskip>\multitablelinespace
4412 \global\multitableparskip=\multitablelinespace
4413 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4414                                       % than skip between lines in the table.
4415 \fi%
4416 \ifdim\multitableparskip=0pt
4417 \global\multitableparskip=\multitablelinespace
4418 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4419                                       % than skip between lines in the table.
4420 \fi}
4421
4422
4423 \message{conditionals,}
4424
4425 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4426 % @ifnotxml always succeed.  They currently do nothing; we don't
4427 % attempt to check whether the conditionals are properly nested.  But we
4428 % have to remember that they are conditionals, so that @end doesn't
4429 % attempt to close an environment group.
4430 %
4431 \def\makecond#1{%
4432   \expandafter\let\csname #1\endcsname = \relax
4433   \expandafter\let\csname iscond.#1\endcsname = 1
4434 }
4435 \makecond{iftex}
4436 \makecond{ifnotdocbook}
4437 \makecond{ifnothtml}
4438 \makecond{ifnotinfo}
4439 \makecond{ifnotplaintext}
4440 \makecond{ifnotxml}
4441
4442 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4443 %
4444 \def\direntry{\doignore{direntry}}
4445 \def\documentdescription{\doignore{documentdescription}}
4446 \def\docbook{\doignore{docbook}}
4447 \def\html{\doignore{html}}
4448 \def\ifdocbook{\doignore{ifdocbook}}
4449 \def\ifhtml{\doignore{ifhtml}}
4450 \def\ifinfo{\doignore{ifinfo}}
4451 \def\ifnottex{\doignore{ifnottex}}
4452 \def\ifplaintext{\doignore{ifplaintext}}
4453 \def\ifxml{\doignore{ifxml}}
4454 \def\ignore{\doignore{ignore}}
4455 \def\menu{\doignore{menu}}
4456 \def\xml{\doignore{xml}}
4457
4458 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4459 %
4460 % A count to remember the depth of nesting.
4461 \newcount\doignorecount
4462
4463 \def\doignore#1{\begingroup
4464   % Scan in ``verbatim'' mode:
4465   \obeylines
4466   \catcode`\@ = \other
4467   \catcode`\{ = \other
4468   \catcode`\} = \other
4469   %
4470   % Make sure that spaces turn into tokens that match what \doignoretext wants.
4471   \spaceisspace
4472   %
4473   % Count number of #1's that we've seen.
4474   \doignorecount = 0
4475   %
4476   % Swallow text until we reach the matching `@end #1'.
4477   \dodoignore{#1}%
4478 }
4479
4480 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4481   \obeylines %
4482   %
4483   \gdef\dodoignore#1{%
4484     % #1 contains the command name as a string, e.g., `ifinfo'.
4485     %
4486     % Define a command to find the next `@end #1'.
4487     \long\def\doignoretext##1^^M@end #1{%
4488       \doignoretextyyy##1^^M@#1\_STOP_}%
4489     %
4490     % And this command to find another #1 command, at the beginning of a
4491     % line.  (Otherwise, we would consider a line `@c @ifset', for
4492     % example, to count as an @ifset for nesting.)
4493     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4494     %
4495     % And now expand that command.
4496     \doignoretext ^^M%
4497   }%
4498 }
4499
4500 \def\doignoreyyy#1{%
4501   \def\temp{#1}%
4502   \ifx\temp\empty                       % Nothing found.
4503     \let\next\doignoretextzzz
4504   \else                                 % Found a nested condition, ...
4505     \advance\doignorecount by 1
4506     \let\next\doignoretextyyy           % ..., look for another.
4507     % If we're here, #1 ends with ^^M\ifinfo (for example).
4508   \fi
4509   \next #1% the token \_STOP_ is present just after this macro.
4510 }
4511
4512 % We have to swallow the remaining "\_STOP_".
4513 %
4514 \def\doignoretextzzz#1{%
4515   \ifnum\doignorecount = 0      % We have just found the outermost @end.
4516     \let\next\enddoignore
4517   \else                         % Still inside a nested condition.
4518     \advance\doignorecount by -1
4519     \let\next\doignoretext      % Look for the next @end.
4520   \fi
4521   \next
4522 }
4523
4524 % Finish off ignored text.
4525 { \obeylines%
4526   % Ignore anything after the last `@end #1'; this matters in verbatim
4527   % environments, where otherwise the newline after an ignored conditional
4528   % would result in a blank line in the output.
4529   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4530 }
4531
4532
4533 % @set VAR sets the variable VAR to an empty value.
4534 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4535 %
4536 % Since we want to separate VAR from REST-OF-LINE (which might be
4537 % empty), we can't just use \parsearg; we have to insert a space of our
4538 % own to delimit the rest of the line, and then take it out again if we
4539 % didn't need it.
4540 % We rely on the fact that \parsearg sets \catcode`\ =10.
4541 %
4542 \parseargdef\set{\setyyy#1 \endsetyyy}
4543 \def\setyyy#1 #2\endsetyyy{%
4544   {%
4545     \makevalueexpandable
4546     \def\temp{#2}%
4547     \edef\next{\gdef\makecsname{SET#1}}%
4548     \ifx\temp\empty
4549       \next{}%
4550     \else
4551       \setzzz#2\endsetzzz
4552     \fi
4553   }%
4554 }
4555 % Remove the trailing space \setxxx inserted.
4556 \def\setzzz#1 \endsetzzz{\next{#1}}
4557
4558 % @clear VAR clears (i.e., unsets) the variable VAR.
4559 %
4560 \parseargdef\clear{%
4561   {%
4562     \makevalueexpandable
4563     \global\expandafter\let\csname SET#1\endcsname=\relax
4564   }%
4565 }
4566
4567 % @value{foo} gets the text saved in variable foo.
4568 \def\value{\begingroup\makevalueexpandable\valuexxx}
4569 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4570 {
4571   \catcode`\-=\active \catcode`\_=\active
4572   %
4573   \gdef\makevalueexpandable{%
4574     \let\value = \expandablevalue
4575     % We don't want these characters active, ...
4576     \catcode`\-=\other \catcode`\_=\other
4577     % ..., but we might end up with active ones in the argument if
4578     % we're called from @code, as @code{@value{foo-bar_}}, though.
4579     % So \let them to their normal equivalents.
4580     \let-\normaldash \let_\normalunderscore
4581   }
4582 }
4583
4584 % We have this subroutine so that we can handle at least some @value's
4585 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4586 % The command has to be fully expandable (if the variable is set), since
4587 % the result winds up in the index file.  This means that if the
4588 % variable's value contains other Texinfo commands, it's almost certain
4589 % it will fail (although perhaps we could fix that with sufficient work
4590 % to do a one-level expansion on the result, instead of complete).
4591
4592 % Unfortunately, this has the consequence that when _ is in the *value*
4593 % of an @set, it does not print properly in the roman fonts (get the cmr
4594 % dot accent at position 126 instead).  No fix comes to mind, and it's
4595 % been this way since 2003 or earlier, so just ignore it.
4596
4597 \def\expandablevalue#1{%
4598   \expandafter\ifx\csname SET#1\endcsname\relax
4599     {[No value for ``#1'']}%
4600     \message{Variable `#1', used in @value, is not set.}%
4601   \else
4602     \csname SET#1\endcsname
4603   \fi
4604 }
4605
4606 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4607 % with @set.
4608
4609 % To get the special treatment we need for `@end ifset,' we call
4610 % \makecond and then redefine.
4611 %
4612 \makecond{ifset}
4613 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4614 \def\doifset#1#2{%
4615   {%
4616     \makevalueexpandable
4617     \let\next=\empty
4618     \expandafter\ifx\csname SET#2\endcsname\relax
4619       #1% If not set, redefine \next.
4620     \fi
4621     \expandafter
4622   }\next
4623 }
4624 \def\ifsetfail{\doignore{ifset}}
4625
4626 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4627 % defined with @set, or has been undefined with @clear.
4628 %
4629 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4630 % above code: if the variable is not set, do nothing, if it is set,
4631 % then redefine \next to \ifclearfail.
4632 %
4633 \makecond{ifclear}
4634 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4635 \def\ifclearfail{\doignore{ifclear}}
4636
4637 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4638 % without the @) is in fact defined.  We can only feasibly check at the
4639 % TeX level, so something like `mathcode' is going to considered
4640 % defined even though it is not a Texinfo command.
4641
4642 \makecond{ifcommanddefined}
4643 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4644 %
4645 \def\doifcmddefined#1#2{{%
4646     \makevalueexpandable
4647     \let\next=\empty
4648     \expandafter\ifx\csname #2\endcsname\relax
4649       #1% If not defined, \let\next as above.
4650     \fi
4651     \expandafter
4652   }\next
4653 }
4654 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4655
4656 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4657 \makecond{ifcommandnotdefined}
4658 \def\ifcommandnotdefined{%
4659   \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4660 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4661
4662 % Set the `txicommandconditionals' variable, so documents have a way to
4663 % test if the @ifcommand...defined conditionals are available.
4664 \set txicommandconditionals
4665
4666 % @dircategory CATEGORY  -- specify a category of the dir file
4667 % which this file should belong to.  Ignore this in TeX.
4668 \let\dircategory=\comment
4669
4670 % @defininfoenclose.
4671 \let\definfoenclose=\comment
4672
4673
4674 \message{indexing,}
4675 % Index generation facilities
4676
4677 % Define \newwrite to be identical to plain tex's \newwrite
4678 % except not \outer, so it can be used within macros and \if's.
4679 \edef\newwrite{\makecsname{ptexnewwrite}}
4680
4681 % \newindex {foo} defines an index named IX.
4682 % It automatically defines \IXindex such that
4683 % \IXindex ...rest of line... puts an entry in the index IX.
4684 % It also defines \IXindfile to be the number of the output channel for
4685 % the file that accumulates this index.  The file's extension is IX.
4686 % The name of an index should be no more than 2 characters long
4687 % for the sake of vms.
4688 %
4689 \def\newindex#1{%
4690   \expandafter\chardef\csname#1indfile\endcsname=0
4691   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
4692     \noexpand\doindex{#1}}
4693 }
4694
4695 % @defindex foo  ==  \newindex{foo}
4696 %
4697 \def\defindex{\parsearg\newindex}
4698
4699 % Define @defcodeindex, like @defindex except put all entries in @code.
4700 %
4701 \def\defcodeindex{\parsearg\newcodeindex}
4702 %
4703 \def\newcodeindex#1{%
4704   \expandafter\chardef\csname#1indfile\endcsname=0
4705   \expandafter\xdef\csname#1index\endcsname{%
4706     \noexpand\docodeindex{#1}}%
4707 }
4708
4709 % The default indices:
4710 \newindex{cp}%      concepts,
4711 \newcodeindex{fn}%  functions,
4712 \newcodeindex{vr}%  variables,
4713 \newcodeindex{tp}%  types,
4714 \newcodeindex{ky}%  keys
4715 \newcodeindex{pg}%  and programs.
4716
4717
4718 % @synindex foo bar    makes index foo feed into index bar.
4719 % Do this instead of @defindex foo if you don't want it as a separate index.
4720 %
4721 % @syncodeindex foo bar   similar, but put all entries made for index foo
4722 % inside @code.
4723 %
4724 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4725 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4726
4727 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4728 % #3 the target index (bar).
4729 \def\dosynindex#1#2#3{%
4730   % Only do \closeout if we haven't already done it, else we'll end up
4731   % closing the target index.
4732   \expandafter \ifx\csname donesynindex#2\endcsname \relax
4733     % The \closeout helps reduce unnecessary open files; the limit on the
4734     % Acorn RISC OS is a mere 16 files.
4735     \expandafter\closeout\csname#2indfile\endcsname
4736     \expandafter\let\csname donesynindex#2\endcsname = 1
4737   \fi
4738   % redefine \fooindfile:
4739   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4740   \expandafter\let\csname#2indfile\endcsname=\temp
4741   % redefine \fooindex:
4742   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4743 }
4744
4745 % Define \doindex, the driver for all index macros.
4746 % Argument #1 is generated by the calling \fooindex macro,
4747 % and it the two-letter name of the index.
4748
4749 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4750 \def\doindexxxx #1{\doind{\indexname}{#1}}
4751
4752 % like the previous two, but they put @code around the argument.
4753 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4754 \def\docodeindexxxx #1{\doind{\indexname}{\code{#1}}}
4755
4756 % Used when writing an index entry out to an index file, to prevent
4757 % expansion of Texinfo commands that can appear in an index entry.
4758 %
4759 \def\indexdummies{%
4760   \escapechar = `\\     % use backslash in output files.
4761   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4762   \def\ {\realbackslash\space }%
4763   %
4764   % Need these unexpandable (because we define \tt as a dummy)
4765   % definitions when @{ or @} appear in index entry text.  Also, more
4766   % complicated, when \tex is in effect and \{ is a \delimiter again.
4767   % We can't use \lbracecmd and \rbracecmd because texindex assumes
4768   % braces and backslashes are used only as delimiters.  Perhaps we
4769   % should use @lbracechar and @rbracechar?
4770   \def\{{{\tt\char123}}%
4771   \def\}{{\tt\char125}}%
4772   %
4773   % Do the redefinitions.
4774   \commondummies
4775 }
4776
4777 % For the aux and toc files, @ is the escape character.  So we want to
4778 % redefine everything using @ as the escape character (instead of
4779 % \realbackslash, still used for index files).  When everything uses @,
4780 % this will be simpler.
4781 %
4782 \def\atdummies{%
4783   \def\@{@@}%
4784   \def\ {@ }%
4785   \let\{ = \lbraceatcmd
4786   \let\} = \rbraceatcmd
4787   %
4788   % Do the redefinitions.
4789   \commondummies
4790   \otherbackslash
4791 }
4792
4793 % Called from \indexdummies and \atdummies.
4794 %
4795 \def\commondummies{%
4796   % \definedummyword defines \#1 as \string\#1\space, thus effectively
4797   % preventing its expansion.  This is used only for control words,
4798   % not control letters, because the \space would be incorrect for
4799   % control characters, but is needed to separate the control word
4800   % from whatever follows.
4801   %
4802   % For control letters, we have \definedummyletter, which omits the
4803   % space.
4804   %
4805   % These can be used both for control words that take an argument and
4806   % those that do not.  If it is followed by {arg} in the input, then
4807   % that will dutifully get written to the index (or wherever).
4808   %
4809   \def\definedummyword  ##1{\def##1{\string##1\space}}%
4810   \def\definedummyletter##1{\def##1{\string##1}}%
4811   \let\definedummyaccent\definedummyletter
4812   %
4813   \commondummiesnofonts
4814   %
4815   \definedummyletter\_%
4816   \definedummyletter\-%
4817   %
4818   % Non-English letters.
4819   \definedummyword\AA
4820   \definedummyword\AE
4821   \definedummyword\DH
4822   \definedummyword\L
4823   \definedummyword\O
4824   \definedummyword\OE
4825   \definedummyword\TH
4826   \definedummyword\aa
4827   \definedummyword\ae
4828   \definedummyword\dh
4829   \definedummyword\exclamdown
4830   \definedummyword\l
4831   \definedummyword\o
4832   \definedummyword\oe
4833   \definedummyword\ordf
4834   \definedummyword\ordm
4835   \definedummyword\questiondown
4836   \definedummyword\ss
4837   \definedummyword\th
4838   %
4839   % Although these internal commands shouldn't show up, sometimes they do.
4840   \definedummyword\bf
4841   \definedummyword\gtr
4842   \definedummyword\hat
4843   \definedummyword\less
4844   \definedummyword\sf
4845   \definedummyword\sl
4846   \definedummyword\tclose
4847   \definedummyword\tt
4848   %
4849   \definedummyword\LaTeX
4850   \definedummyword\TeX
4851   %
4852   % Assorted special characters.
4853   \definedummyword\arrow
4854   \definedummyword\bullet
4855   \definedummyword\comma
4856   \definedummyword\copyright
4857   \definedummyword\registeredsymbol
4858   \definedummyword\dots
4859   \definedummyword\enddots
4860   \definedummyword\entrybreak
4861   \definedummyword\equiv
4862   \definedummyword\error
4863   \definedummyword\euro
4864   \definedummyword\expansion
4865   \definedummyword\geq
4866   \definedummyword\guillemetleft
4867   \definedummyword\guillemetright
4868   \definedummyword\guilsinglleft
4869   \definedummyword\guilsinglright
4870   \definedummyword\lbracechar
4871   \definedummyword\leq
4872   \definedummyword\mathopsup
4873   \definedummyword\minus
4874   \definedummyword\ogonek
4875   \definedummyword\pounds
4876   \definedummyword\point
4877   \definedummyword\print
4878   \definedummyword\quotedblbase
4879   \definedummyword\quotedblleft
4880   \definedummyword\quotedblright
4881   \definedummyword\quoteleft
4882   \definedummyword\quoteright
4883   \definedummyword\quotesinglbase
4884   \definedummyword\rbracechar
4885   \definedummyword\result
4886   \definedummyword\sub
4887   \definedummyword\sup
4888   \definedummyword\textdegree
4889   %
4890   % We want to disable all macros so that they are not expanded by \write.
4891   \macrolist
4892   %
4893   \normalturnoffactive
4894   %
4895   % Handle some cases of @value -- where it does not contain any
4896   % (non-fully-expandable) commands.
4897   \makevalueexpandable
4898 }
4899
4900 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4901 % Define \definedumyletter, \definedummyaccent and \definedummyword before
4902 % using.
4903 %
4904 \def\commondummiesnofonts{%
4905   % Control letters and accents.
4906   \definedummyletter\!%
4907   \definedummyaccent\"%
4908   \definedummyaccent\'%
4909   \definedummyletter\*%
4910   \definedummyaccent\,%
4911   \definedummyletter\.%
4912   \definedummyletter\/%
4913   \definedummyletter\:%
4914   \definedummyaccent\=%
4915   \definedummyletter\?%
4916   \definedummyaccent\^%
4917   \definedummyaccent\`%
4918   \definedummyaccent\~%
4919   \definedummyword\u
4920   \definedummyword\v
4921   \definedummyword\H
4922   \definedummyword\dotaccent
4923   \definedummyword\ogonek
4924   \definedummyword\ringaccent
4925   \definedummyword\tieaccent
4926   \definedummyword\ubaraccent
4927   \definedummyword\udotaccent
4928   \definedummyword\dotless
4929   %
4930   % Texinfo font commands.
4931   \definedummyword\b
4932   \definedummyword\i
4933   \definedummyword\r
4934   \definedummyword\sansserif
4935   \definedummyword\sc
4936   \definedummyword\slanted
4937   \definedummyword\t
4938   %
4939   % Commands that take arguments.
4940   \definedummyword\abbr
4941   \definedummyword\acronym
4942   \definedummyword\anchor
4943   \definedummyword\cite
4944   \definedummyword\code
4945   \definedummyword\command
4946   \definedummyword\dfn
4947   \definedummyword\dmn
4948   \definedummyword\email
4949   \definedummyword\emph
4950   \definedummyword\env
4951   \definedummyword\file
4952   \definedummyword\image
4953   \definedummyword\indicateurl
4954   \definedummyword\inforef
4955   \definedummyword\kbd
4956   \definedummyword\key
4957   \definedummyword\math
4958   \definedummyword\option
4959   \definedummyword\pxref
4960   \definedummyword\ref
4961   \definedummyword\samp
4962   \definedummyword\strong
4963   \definedummyword\tie
4964   \definedummyword\U
4965   \definedummyword\uref
4966   \definedummyword\url
4967   \definedummyword\var
4968   \definedummyword\verb
4969   \definedummyword\w
4970   \definedummyword\xref
4971 }
4972
4973 % For testing: output @{ and @} in index sort strings as \{ and \}.
4974 \newif\ifusebracesinindexes
4975
4976 \let\indexlbrace\relax
4977 \let\indexrbrace\relax
4978
4979 {\catcode`\@=0
4980 \catcode`\\=13
4981   @gdef@backslashdisappear{@def\{}}
4982 }
4983
4984 {
4985 \catcode`\<=13
4986 \catcode`\-=13
4987 \catcode`\`=13
4988   \gdef\indexnonalnumdisappear{%
4989     \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
4990       % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
4991       % (Introduced for FSFS 2nd ed.)
4992       \let`=\empty
4993     \fi
4994     %
4995     \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
4996       \backslashdisappear
4997     \fi
4998     %
4999     \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
5000       \def-{}%
5001     \fi
5002     \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
5003       \def<{}%
5004     \fi
5005     \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
5006       \def\@{}%
5007     \fi
5008   }
5009
5010   \gdef\indexnonalnumreappear{%
5011     \useindexbackslash
5012     \let-\normaldash
5013     \let<\normalless
5014     \def\@{@}%
5015   }
5016 }
5017
5018
5019 % \indexnofonts is used when outputting the strings to sort the index
5020 % by, and when constructing control sequence names.  It eliminates all
5021 % control sequences and just writes whatever the best ASCII sort string
5022 % would be for a given command (usually its argument).
5023 %
5024 \def\indexnofonts{%
5025   % Accent commands should become @asis.
5026   \def\definedummyaccent##1{\let##1\asis}%
5027   % We can just ignore other control letters.
5028   \def\definedummyletter##1{\let##1\empty}%
5029   % All control words become @asis by default; overrides below.
5030   \let\definedummyword\definedummyaccent
5031   \commondummiesnofonts
5032   %
5033   % Don't no-op \tt, since it isn't a user-level command
5034   % and is used in the definitions of the active chars like <, >, |, etc.
5035   % Likewise with the other plain tex font commands.
5036   %\let\tt=\asis
5037   %
5038   \def\ { }%
5039   \def\@{@}%
5040   \def\_{\normalunderscore}%
5041   \def\-{}% @- shouldn't affect sorting
5042   %
5043   \uccode`\1=`\{ \uppercase{\def\{{1}}%
5044   \uccode`\1=`\} \uppercase{\def\}{1}}%
5045   \let\lbracechar\{%
5046   \let\rbracechar\}%
5047   %
5048   % Non-English letters.
5049   \def\AA{AA}%
5050   \def\AE{AE}%
5051   \def\DH{DZZ}%
5052   \def\L{L}%
5053   \def\OE{OE}%
5054   \def\O{O}%
5055   \def\TH{TH}%
5056   \def\aa{aa}%
5057   \def\ae{ae}%
5058   \def\dh{dzz}%
5059   \def\exclamdown{!}%
5060   \def\l{l}%
5061   \def\oe{oe}%
5062   \def\ordf{a}%
5063   \def\ordm{o}%
5064   \def\o{o}%
5065   \def\questiondown{?}%
5066   \def\ss{ss}%
5067   \def\th{th}%
5068   %
5069   \def\LaTeX{LaTeX}%
5070   \def\TeX{TeX}%
5071   %
5072   % Assorted special characters.
5073   % (The following {} will end up in the sort string, but that's ok.)
5074   \def\arrow{->}%
5075   \def\bullet{bullet}%
5076   \def\comma{,}%
5077   \def\copyright{copyright}%
5078   \def\dots{...}%
5079   \def\enddots{...}%
5080   \def\equiv{==}%
5081   \def\error{error}%
5082   \def\euro{euro}%
5083   \def\expansion{==>}%
5084   \def\geq{>=}%
5085   \def\guillemetleft{<<}%
5086   \def\guillemetright{>>}%
5087   \def\guilsinglleft{<}%
5088   \def\guilsinglright{>}%
5089   \def\leq{<=}%
5090   \def\minus{-}%
5091   \def\point{.}%
5092   \def\pounds{pounds}%
5093   \def\print{-|}%
5094   \def\quotedblbase{"}%
5095   \def\quotedblleft{"}%
5096   \def\quotedblright{"}%
5097   \def\quoteleft{`}%
5098   \def\quoteright{'}%
5099   \def\quotesinglbase{,}%
5100   \def\registeredsymbol{R}%
5101   \def\result{=>}%
5102   \def\textdegree{o}%
5103   %
5104   % We need to get rid of all macros, leaving only the arguments (if present).
5105   % Of course this is not nearly correct, but it is the best we can do for now.
5106   % makeinfo does not expand macros in the argument to @deffn, which ends up
5107   % writing an index entry, and texindex isn't prepared for an index sort entry
5108   % that starts with \.
5109   %
5110   % Since macro invocations are followed by braces, we can just redefine them
5111   % to take a single TeX argument.  The case of a macro invocation that
5112   % goes to end-of-line is not handled.
5113   %
5114   \macrolist
5115 }
5116
5117
5118 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
5119
5120 % Most index entries go through here, but \dosubind is the general case.
5121 % #1 is the index name, #2 is the entry text.
5122 \def\doind#1#2{\dosubind{#1}{#2}{}}
5123
5124 % There is also \dosubind {index}{topic}{subtopic}
5125 % which makes an entry in a two-level index such as the operation index.
5126 % TODO: Two-level index?  Operation index?
5127
5128 % Workhorse for all indexes.
5129 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
5130 % empty if called from \doind, as we usually are (the main exception
5131 % is with most defuns, which call us directly).
5132 %
5133 \def\dosubind#1#2#3{%
5134   \iflinks
5135   {%
5136     \requireopenindexfile{#1}%
5137     % Store the main index entry text (including the third arg).
5138     \toks0 = {#2}%
5139     % If third arg is present, precede it with a space.
5140     \def\thirdarg{#3}%
5141     \ifx\thirdarg\empty \else
5142       \toks0 = \expandafter{\the\toks0 \space #3}%
5143     \fi
5144     %
5145     \edef\writeto{\csname#1indfile\endcsname}%
5146     %
5147     \safewhatsit\dosubindwrite
5148   }%
5149   \fi
5150 }
5151
5152 % Check if an index file has been opened, and if not, open it.
5153 \def\requireopenindexfile#1{%
5154 \ifnum\csname #1indfile\endcsname=0
5155   \expandafter\newwrite \csname#1indfile\endcsname
5156   \edef\suffix{#1}%
5157   % A .fls suffix would conflict with the file extension for the output
5158   % of -recorder, so use .f1s instead.
5159   \ifx\suffix\indexisfl\def\suffix{f1}\fi
5160   % Open the file
5161   \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
5162   % Using \immediate here prevents an object entering into the current box,
5163   % which could confound checks such as those in \safewhatsit for preceding
5164   % skips.
5165 \fi}
5166 \def\indexisfl{fl}
5167
5168 % Output \ as {\indexbackslash}, because \ is an escape character in
5169 % the index files.
5170 \let\indexbackslash=\relax
5171 {\catcode`\@=0 \catcode`\\=\active
5172   @gdef@useindexbackslash{@def\{{@indexbackslash}}}
5173 }
5174
5175 % Definition for writing index entry text.
5176 \def\sortas#1{\ignorespaces}%
5177
5178 % Definition for writing index entry sort key.  Should occur at the at
5179 % the beginning of the index entry, like
5180 %     @cindex @sortas{september} \september
5181 % The \ignorespaces takes care of following space, but there's no way
5182 % to remove space before it.
5183 {
5184 \catcode`\-=13
5185 \gdef\indexwritesortas{%
5186   \begingroup
5187   \indexnonalnumreappear
5188   \indexwritesortasxxx}
5189 \gdef\indexwritesortasxxx#1{%
5190   \xdef\indexsortkey{#1}\endgroup}
5191 }
5192
5193
5194 % Write the entry in \toks0 to the index file.
5195 %
5196 \def\dosubindwrite{%
5197   % Put the index entry in the margin if desired.
5198   \ifx\SETmarginindex\relax\else
5199     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
5200   \fi
5201   %
5202   % Remember, we are within a group.
5203   \indexdummies % Must do this here, since \bf, etc expand at this stage
5204   \useindexbackslash % \indexbackslash isn't defined now so it will be output 
5205                      % as is; and it will print as backslash.
5206   % The braces around \indexbrace are recognized by texindex.
5207   %
5208   % Get the string to sort by, by processing the index entry with all
5209   % font commands turned off.
5210   {\indexnofonts
5211    \def\lbracechar{{\indexlbrace}}%
5212    \def\rbracechar{{\indexrbrace}}%
5213    \let\{=\lbracechar
5214    \let\}=\rbracechar
5215    \indexnonalnumdisappear
5216    \xdef\indexsortkey{}%
5217    \let\sortas=\indexwritesortas
5218    \edef\temp{\the\toks0}%
5219    \setbox\dummybox = \hbox{\temp}% Make sure to execute any \sortas
5220    \ifx\indexsortkey\empty
5221      \xdef\indexsortkey{\temp}%
5222      \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
5223    \fi
5224   }%
5225   %
5226   % Set up the complete index entry, with both the sort key and
5227   % the original text, including any font commands.  We write
5228   % three arguments to \entry to the .?? file (four in the
5229   % subentry case), texindex reduces to two when writing the .??s
5230   % sorted result.
5231   \edef\temp{%
5232     \write\writeto{%
5233       \string\entry{\indexsortkey}{\noexpand\folio}{\the\toks0}}%
5234   }%
5235   \temp
5236 }
5237 \newbox\dummybox % used above
5238
5239 % Take care of unwanted page breaks/skips around a whatsit:
5240 %
5241 % If a skip is the last thing on the list now, preserve it
5242 % by backing up by \lastskip, doing the \write, then inserting
5243 % the skip again.  Otherwise, the whatsit generated by the
5244 % \write or \pdfdest will make \lastskip zero.  The result is that
5245 % sequences like this:
5246 % @end defun
5247 % @tindex whatever
5248 % @defun ...
5249 % will have extra space inserted, because the \medbreak in the
5250 % start of the @defun won't see the skip inserted by the @end of
5251 % the previous defun.
5252 %
5253 % But don't do any of this if we're not in vertical mode.  We
5254 % don't want to do a \vskip and prematurely end a paragraph.
5255 %
5256 % Avoid page breaks due to these extra skips, too.
5257 %
5258 % But wait, there is a catch there:
5259 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
5260 % sufficient for this purpose, as it ignores stretch and shrink parts
5261 % of the skip.  The only way seems to be to check the textual
5262 % representation of the skip.
5263 %
5264 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5265 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5266 %
5267 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
5268 %
5269 \newskip\whatsitskip
5270 \newcount\whatsitpenalty
5271 %
5272 % ..., ready, GO:
5273 %
5274 \def\safewhatsit#1{\ifhmode
5275   #1%
5276  \else
5277   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5278   \whatsitskip = \lastskip
5279   \edef\lastskipmacro{\the\lastskip}%
5280   \whatsitpenalty = \lastpenalty
5281   %
5282   % If \lastskip is nonzero, that means the last item was a
5283   % skip.  And since a skip is discardable, that means this
5284   % -\whatsitskip glue we're inserting is preceded by a
5285   % non-discardable item, therefore it is not a potential
5286   % breakpoint, therefore no \nobreak needed.
5287   \ifx\lastskipmacro\zeroskipmacro
5288   \else
5289     \vskip-\whatsitskip
5290   \fi
5291   %
5292   #1%
5293   %
5294   \ifx\lastskipmacro\zeroskipmacro
5295     % If \lastskip was zero, perhaps the last item was a penalty, and
5296     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
5297     % to re-insert the same penalty (values >10000 are used for various
5298     % signals); since we just inserted a non-discardable item, any
5299     % following glue (such as a \parskip) would be a breakpoint.  For example:
5300     %   @deffn deffn-whatever
5301     %   @vindex index-whatever
5302     %   Description.
5303     % would allow a break between the index-whatever whatsit
5304     % and the "Description." paragraph.
5305     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
5306   \else
5307     % On the other hand, if we had a nonzero \lastskip,
5308     % this make-up glue would be preceded by a non-discardable item
5309     % (the whatsit from the \write), so we must insert a \nobreak.
5310     \nobreak\vskip\whatsitskip
5311   \fi
5312 \fi}
5313
5314 % The index entry written in the file actually looks like
5315 %  \entry {sortstring}{page}{topic}
5316 % or
5317 %  \entry {sortstring}{page}{topic}{subtopic}
5318 % The texindex program reads in these files and writes files
5319 % containing these kinds of lines:
5320 %  \initial {c}
5321 %     before the first topic whose initial is c
5322 %  \entry {topic}{pagelist}
5323 %     for a topic that is used without subtopics
5324 %  \primary {topic}
5325 %     for the beginning of a topic that is used with subtopics
5326 %  \secondary {subtopic}{pagelist}
5327 %     for each subtopic.
5328
5329 % Define the user-accessible indexing commands
5330 % @findex, @vindex, @kindex, @cindex.
5331
5332 \def\findex {\fnindex}
5333 \def\kindex {\kyindex}
5334 \def\cindex {\cpindex}
5335 \def\vindex {\vrindex}
5336 \def\tindex {\tpindex}
5337 \def\pindex {\pgindex}
5338
5339 \def\cindexsub {\begingroup\obeylines\cindexsub}
5340 {\obeylines %
5341 \gdef\cindexsub "#1" #2^^M{\endgroup %
5342 \dosubind{cp}{#2}{#1}}}
5343
5344 % Define the macros used in formatting output of the sorted index material.
5345
5346 % @printindex causes a particular index (the ??s file) to get printed.
5347 % It does not print any chapter heading (usually an @unnumbered).
5348 %
5349 \parseargdef\printindex{\begingroup
5350   \dobreak \chapheadingskip{10000}%
5351   %
5352   \smallfonts \rm
5353   \tolerance = 9500
5354   \plainfrenchspacing
5355   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
5356   %
5357   % See if the index file exists and is nonempty.
5358   % Change catcode of @ here so that if the index file contains
5359   % \initial {@}
5360   % as its first line, TeX doesn't complain about mismatched braces
5361   % (because it thinks @} is a control sequence).
5362   \catcode`\@ = 11
5363   % See comment in \requireopenindexfile.
5364   \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
5365   \openin 1 \jobname.\indexname s
5366   \ifeof 1
5367     % \enddoublecolumns gets confused if there is no text in the index,
5368     % and it loses the chapter title and the aux file entries for the
5369     % index.  The easiest way to prevent this problem is to make sure
5370     % there is some text.
5371     \putwordIndexNonexistent
5372   \else
5373     \catcode`\\ = 0
5374     \escapechar = `\\
5375     %
5376     % If the index file exists but is empty, then \openin leaves \ifeof
5377     % false.  We have to make TeX try to read something from the file, so
5378     % it can discover if there is anything in it.
5379     \read 1 to \thisline
5380     \ifeof 1
5381       \putwordIndexIsEmpty
5382     \else
5383       % Index files are almost Texinfo source, but we use \ as the escape
5384       % character.  It would be better to use @, but that's too big a change
5385       % to make right now.
5386       \def\indexbackslash{\ttbackslash}%
5387       \let\indexlbrace\{   % Likewise, set these sequences for braces
5388       \let\indexrbrace\}   % used in the sort key.
5389       \begindoublecolumns
5390       \let\entryorphanpenalty=\indexorphanpenalty
5391       %
5392       % Read input from the index file line by line.
5393       \loopdo
5394         \ifeof1
5395           \let\firsttoken\relax
5396         \else
5397           \read 1 to \nextline
5398           \edef\act{\gdef\noexpand\firsttoken{\getfirsttoken\nextline}}%
5399           \act
5400         \fi
5401         \thisline
5402         %
5403         \ifeof1\else
5404         \let\thisline\nextline
5405       \repeat
5406       %%
5407       \enddoublecolumns
5408     \fi
5409   \fi
5410   \closein 1
5411 \endgroup}
5412
5413 \def\getfirsttoken#1{\expandafter\getfirsttokenx#1\endfirsttoken}
5414 \long\def\getfirsttokenx#1#2\endfirsttoken{\noexpand#1}
5415
5416 \def\loopdo#1\repeat{\def\body{#1}\loopdoxxx}
5417 \def\loopdoxxx{\let\next=\relax\body\let\next=\loopdoxxx\fi\next}
5418
5419 % These macros are used by the sorted index file itself.
5420 % Change them to control the appearance of the index.
5421
5422 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5423 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5424 \catcode`\$=3
5425 \gdef\initialglyphs{%
5426   % Some changes for non-alphabetic characters.  Using the glyphs from the
5427   % math fonts looks more consistent than the typewriter font used elsewhere
5428   % for these characters.
5429   \def\indexbackslash{\math{\backslash}}%
5430   \let\\=\indexbackslash
5431   %
5432   % Can't get bold backslash so don't use bold forward slash
5433   \catcode`\/=13
5434   \def/{{\secrmnotbold \normalslash}}%
5435   \def-{{\normaldash\normaldash}}% en dash `--'
5436   \def^{{\chapbf \normalcaret}}%
5437   \def~{{\chapbf \normaltilde}}%
5438   \def\_{%
5439      \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
5440   \def|{$\vert$}%
5441   \def<{$\less$}%
5442   \def>{$\gtr$}%
5443   \def+{$\normalplus$}%
5444 }}
5445
5446 \def\initial{%
5447   \bgroup
5448   \initialglyphs
5449   \initialx
5450 }
5451
5452 \def\initialx#1{%
5453   % Remove any glue we may have, we'll be inserting our own.
5454   \removelastskip
5455   %
5456   % We like breaks before the index initials, so insert a bonus.
5457   % The glue before the bonus allows a little bit of space at the
5458   % bottom of a column to reduce an increase in inter-line spacing.
5459   \nobreak
5460   \vskip 0pt plus 5\baselineskip
5461   \penalty -300 
5462   \vskip 0pt plus -5\baselineskip
5463   %
5464   % Typeset the initial.  Making this add up to a whole number of
5465   % baselineskips increases the chance of the dots lining up from column
5466   % to column.  It still won't often be perfect, because of the stretch
5467   % we need before each entry, but it's better.
5468   %
5469   % No shrink because it confuses \balancecolumns.
5470   \vskip 1.67\baselineskip plus 1\baselineskip
5471   \leftline{\secfonts \kern-0.05em \secbf #1}%
5472   % \secfonts is inside the argument of \leftline so that the change of
5473   % \baselineskip will not affect any glue inserted before the vbox that
5474   % \leftline creates.
5475   % Do our best not to break after the initial.
5476   \nobreak
5477   \vskip .33\baselineskip plus .1\baselineskip
5478   \egroup % \initialglyphs
5479 }
5480
5481 \newdimen\entryrightmargin
5482 \entryrightmargin=0pt
5483
5484 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5485 % then page number (#2) flushed to the right margin.  It is used for index
5486 % and table of contents entries.  The paragraph is indented by \leftskip.
5487 %
5488 \def\entry{%
5489   \begingroup
5490     %
5491     % Start a new paragraph if necessary, so our assignments below can't
5492     % affect previous text.
5493     \par
5494     %
5495     % No extra space above this paragraph.
5496     \parskip = 0in
5497     %
5498     % When reading the text of entry, convert explicit line breaks
5499     % from @* into spaces.  The user might give these in long section
5500     % titles, for instance.
5501     \def\*{\unskip\space\ignorespaces}%
5502     \def\entrybreak{\hfil\break}% An undocumented command
5503     %
5504     % A bit of stretch before each entry for the benefit of balancing
5505     % columns.
5506     \vskip 0pt plus0.5pt
5507     %
5508     % Swallow the left brace of the text (first parameter):
5509     \afterassignment\doentry
5510     \let\temp =
5511 }
5512 \def\entrybreak{\unskip\space\ignorespaces}%
5513 \def\doentry{%
5514     % Save the text of the entry
5515     \global\setbox\boxA=\hbox\bgroup
5516     \bgroup % Instead of the swallowed brace.
5517       \noindent
5518       \aftergroup\finishentry
5519       % And now comes the text of the entry.
5520       % Not absorbing as a macro argument reduces the chance of problems
5521       % with catcodes occurring.
5522 }
5523 {\catcode`\@=11
5524 \gdef\finishentry#1{%
5525     \egroup % end box A
5526     \dimen@ = \wd\boxA % Length of text of entry
5527     \global\setbox\boxA=\hbox\bgroup\unhbox\boxA
5528     % #1 is the page number.
5529     %
5530     % Get the width of the page numbers, and only use
5531     % leaders if they are present.
5532     \global\setbox\boxB = \hbox{#1}%
5533     \ifdim\wd\boxB = 0pt
5534       \null\nobreak\hfill\ %
5535     \else
5536       %
5537       \null\nobreak\indexdotfill % Have leaders before the page number.
5538       %
5539       \ifpdf
5540         \pdfgettoks#1.%
5541         \bgroup\let\domark\relax
5542           \hskip\skip\thinshrinkable\the\toksA
5543         \egroup
5544         % The redefinion of \domark stops marks being added in \pdflink to 
5545         % preserve coloured links across page boundaries.  Otherwise the marks
5546         % would get in the way of \lastbox in \insertindexentrybox.
5547       \else
5548         \ifx\XeTeXrevision\thisisundefined
5549           \hskip\skip\thinshrinkable #1%
5550         \else
5551           \pdfgettoks#1.%
5552           \bgroup\let\domark\relax
5553             \hskip\skip\thinshrinkable\the\toksA
5554           \egroup
5555         \fi
5556       \fi
5557     \fi
5558     \egroup % end \boxA
5559     \ifdim\wd\boxB = 0pt
5560       \global\setbox\entryindexbox=\vbox{\unhbox\boxA}%
5561     \else
5562     \global\setbox\entryindexbox=\vbox\bgroup
5563       \prevdepth=\entrylinedepth
5564       \noindent
5565       % We want the text of the entries to be aligned to the left, and the
5566       % page numbers to be aligned to the right.
5567       %
5568       \advance\leftskip by 0pt plus 1fil
5569       \advance\leftskip by 0pt plus -1fill
5570       \rightskip = 0pt plus -1fil
5571       \advance\rightskip by 0pt plus 1fill
5572       % Cause last line, which could consist of page numbers on their own
5573       % if the list of page numbers is long, to be aligned to the right.
5574       \parfillskip=0pt plus -1fill
5575       %
5576       \hangindent=1em
5577       %
5578       \advance\rightskip by \entryrightmargin
5579       % Determine how far we can stretch into the margin.
5580       % This allows, e.g., "Appendix H  GNU Free Documentation License" to
5581       % fit on one line in @letterpaper format.
5582       \ifdim\entryrightmargin>2.1em
5583         \dimen@i=2.1em
5584       \else
5585         \dimen@i=0em
5586       \fi
5587       \advance \parfillskip by 0pt minus 1\dimen@i
5588       %
5589       \dimen@ii = \hsize
5590       \advance\dimen@ii by -1\leftskip
5591       \advance\dimen@ii by -1\entryrightmargin
5592       \advance\dimen@ii by 1\dimen@i
5593       \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
5594       \ifdim\dimen@ > 0.8\dimen@ii   % due to long index text
5595         \dimen@ = 0.7\dimen@ % Try to split the text roughly evenly
5596         \dimen@ii = \hsize
5597         \advance \dimen@ii by -1em
5598         \ifnum\dimen@>\dimen@ii
5599           % If the entry is too long, use the whole line
5600           \dimen@ = \dimen@ii
5601         \fi
5602         \advance\leftskip by 0pt plus 1fill % ragged right
5603         \advance \dimen@ by 1\rightskip
5604         \parshape = 2 0pt \dimen@ 1em \dimen@ii
5605         % Ideally we'd add a finite glue at the end of the first line only, but
5606         % TeX doesn't seem to provide a way to do such a thing.
5607       \fi\fi
5608       \unhbox\boxA
5609       %
5610       % Do not prefer a separate line ending with a hyphen to fewer lines.
5611       \finalhyphendemerits = 0
5612       %
5613       % Word spacing - no stretch
5614       \spaceskip=\fontdimen2\font minus \fontdimen4\font
5615       %
5616       \linepenalty=1000  % Discourage line breaks.
5617       \hyphenpenalty=5000  % Discourage hyphenation.
5618       %
5619       \par % format the paragraph
5620     \egroup % The \vbox
5621     \fi
5622   \endgroup
5623   % delay text of entry until after penalty
5624   \bgroup\aftergroup\insertindexentrybox
5625   \entryorphanpenalty
5626 }}
5627
5628 \newskip\thinshrinkable
5629 \skip\thinshrinkable=.15em minus .15em
5630
5631 \newbox\entryindexbox
5632 \def\insertindexentrybox{%
5633   \copy\entryindexbox
5634   % The following gets the depth of the last box.  This is for even
5635   % line spacing when entries span several lines.
5636   \setbox\dummybox\vbox{%
5637     \unvbox\entryindexbox
5638     \nointerlineskip
5639     \lastbox
5640     \global\entrylinedepth=\prevdepth
5641   }%
5642   % Note that we couldn't simply \unvbox\entryindexbox followed by 
5643   % \nointerlineskip\lastbox to remove the last box and then reinstate it, 
5644   % because this resets how far the box has been \moveleft'ed to 0.  \unvbox
5645   % doesn't affect \prevdepth either.
5646 }
5647 \newdimen\entrylinedepth
5648
5649 % Default is no penalty
5650 \let\entryorphanpenalty\egroup
5651
5652 % Used from \printindex.  \firsttoken should be the first token
5653 % after the \entry.  If it's not another \entry, we are at the last
5654 % line of a group of index entries, so insert a penalty to discourage
5655 % orphaned index entries.
5656 \long\def\indexorphanpenalty{%
5657   \def\isentry{\entry}%
5658   \ifx\firsttoken\isentry
5659   \else
5660     \unskip\penalty 9000
5661     % The \unskip here stops breaking before the glue.  It relies on the
5662     % \vskip above being there, otherwise there is an error
5663     % "You can't use `\unskip' in vertical mode".  There has to be glue
5664     % in the current vertical list that hasn't been added to the
5665     % "current page".  See Chapter 24 of the TeXbook.  This contradicts
5666     % Section 8.3.7 in "TeX by Topic," though.
5667   \fi
5668   \egroup % now comes the box added with \aftergroup
5669 }
5670
5671 % Like plain.tex's \dotfill, except uses up at least 1 em.
5672 % The filll stretch here overpowers both the fil and fill stretch to push
5673 % the page number to the right.
5674 \def\indexdotfill{\cleaders
5675   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
5676
5677
5678 \def\primary #1{\line{#1\hfil}}
5679
5680 \newskip\secondaryindent \secondaryindent=0.5cm
5681 \def\secondary#1#2{{%
5682   \parfillskip=0in
5683   \parskip=0in
5684   \hangindent=1in
5685   \hangafter=1
5686   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5687   \ifpdf
5688     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5689   \else
5690     \ifx\XeTeXrevision\thisisundefined
5691       #2
5692     \else
5693       \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5694     \fi
5695   \fi
5696   \par
5697 }}
5698
5699 % Define two-column mode, which we use to typeset indexes.
5700 % Adapted from the TeXbook, page 416, which is to say,
5701 % the manmac.tex format used to print the TeXbook itself.
5702 \catcode`\@=11  % private names
5703
5704 \newbox\partialpage
5705 \newdimen\doublecolumnhsize
5706 \newdimen\doublecolumntopgap
5707 \doublecolumntopgap = 0pt
5708
5709 % Use inside an output routine to save \topmark and \firstmark
5710 \def\savemarks{%
5711   \global\savedtopmark=\expandafter{\topmark }%
5712   \global\savedfirstmark=\expandafter{\firstmark }%
5713 }
5714 \newtoks\savedtopmark
5715 \newtoks\savedfirstmark
5716
5717 % Set \topmark and \firstmark for next time \output runs.
5718 % Can't be run from withinside \output (because any material
5719 % added while an output routine is active, including 
5720 % penalties, is saved for after it finishes).  The page so far
5721 % should be empty, otherwise what's on it will be thrown away.
5722 \def\restoremarks{%
5723   \mark{\the\savedtopmark}%
5724   \bgroup\output = {%
5725     \setbox\dummybox=\box\PAGE
5726   }abc\eject\egroup
5727   % "abc" because output routine doesn't fire for a completely empty page.
5728   \mark{\the\savedfirstmark}%
5729 }
5730
5731 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5732   % If not much space left on page, start a new page.
5733   \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
5734   %
5735   % Grab any single-column material above us.
5736   \output = {%
5737     %
5738     % Here is a possibility not foreseen in manmac: if we accumulate a
5739     % whole lot of material, we might end up calling this \output
5740     % routine twice in a row (see the doublecol-lose test, which is
5741     % essentially a couple of indexes with @setchapternewpage off).  In
5742     % that case we just ship out what is in \partialpage with the normal
5743     % output routine.  Generally, \partialpage will be empty when this
5744     % runs and this will be a no-op.  See the indexspread.tex test case.
5745     \ifvoid\partialpage \else
5746       \onepageout{\pagecontents\partialpage}%
5747     \fi
5748     %
5749     \global\setbox\partialpage = \vbox{%
5750       % Unvbox the main output page.
5751       \unvbox\PAGE
5752       \kern-\topskip \kern\baselineskip
5753     }%
5754     \savemarks
5755   }%
5756   \eject % run that output routine to set \partialpage
5757   \restoremarks
5758   %
5759   % We recover the two marks that the last output routine saved in order
5760   % to propagate the information in marks added around a chapter heading,
5761   % which could be otherwise be lost by the time the final page is output.
5762   %
5763   %
5764   % Use the double-column output routine for subsequent pages.
5765   \output = {\doublecolumnout}%
5766   %
5767   % Change the page size parameters.  We could do this once outside this
5768   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5769   % format, but then we repeat the same computation.  Repeating a couple
5770   % of assignments once per index is clearly meaningless for the
5771   % execution time, so we may as well do it in one place.
5772   %
5773   % First we halve the line length, less a little for the gutter between
5774   % the columns.  We compute the gutter based on the line length, so it
5775   % changes automatically with the paper format.  The magic constant
5776   % below is chosen so that the gutter has the same value (well, +-<1pt)
5777   % as it did when we hard-coded it.
5778   %
5779   % We put the result in a separate register, \doublecolumhsize, so we
5780   % can restore it in \pagesofar, after \hsize itself has (potentially)
5781   % been clobbered.
5782   %
5783   \doublecolumnhsize = \hsize
5784     \advance\doublecolumnhsize by -.04154\hsize
5785     \divide\doublecolumnhsize by 2
5786   \hsize = \doublecolumnhsize
5787   %
5788   % Double the \vsize as well.  (We don't need a separate register here,
5789   % since nobody clobbers \vsize.)
5790   \global\doublecolumntopgap = \topskip
5791   \global\advance\doublecolumntopgap by -1\baselineskip
5792   \advance\vsize by -1\doublecolumntopgap
5793   \vsize = 2\vsize
5794   \topskip=0pt
5795   \global\entrylinedepth=0pt\relax
5796 }
5797
5798 % The double-column output routine for all double-column pages except
5799 % the last, which is done by \balancecolumns.
5800 %
5801 \def\doublecolumnout{%
5802   %
5803   \splittopskip=\topskip \splitmaxdepth=\maxdepth
5804   % Get the available space for the double columns -- the normal
5805   % (undoubled) page height minus any material left over from the
5806   % previous page.
5807   \dimen@ = \vsize
5808   \divide\dimen@ by 2
5809   \advance\dimen@ by -\ht\partialpage
5810   %
5811   % box0 will be the left-hand column, box2 the right.
5812   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5813   \onepageout\pagesofar
5814   \unvbox255
5815   \penalty\outputpenalty
5816 }
5817 %
5818 % Re-output the contents of the output page -- any previous material,
5819 % followed by the two boxes we just split, in box0 and box2.
5820 \def\pagesofar{%
5821   \unvbox\partialpage
5822   %
5823   \hsize = \doublecolumnhsize
5824   \wd0=\hsize \wd2=\hsize
5825   \vbox{%
5826     \vskip\doublecolumntopgap
5827     \hbox to\txipagewidth{\box0\hfil\box2}}%
5828 }
5829
5830
5831 % Finished with with double columns.
5832 \def\enddoublecolumns{%
5833   % The following penalty ensures that the page builder is exercised
5834   % _before_ we change the output routine.  This is necessary in the
5835   % following situation:
5836   %
5837   % The last section of the index consists only of a single entry.
5838   % Before this section, \pagetotal is less than \pagegoal, so no
5839   % break occurs before the last section starts.  However, the last
5840   % section, consisting of \initial and the single \entry, does not
5841   % fit on the page and has to be broken off.  Without the following
5842   % penalty the page builder will not be exercised until \eject
5843   % below, and by that time we'll already have changed the output
5844   % routine to the \balancecolumns version, so the next-to-last
5845   % double-column page will be processed with \balancecolumns, which
5846   % is wrong:  The two columns will go to the main vertical list, with
5847   % the broken-off section in the recent contributions.  As soon as
5848   % the output routine finishes, TeX starts reconsidering the page
5849   % break.  The two columns and the broken-off section both fit on the
5850   % page, because the two columns now take up only half of the page
5851   % goal.  When TeX sees \eject from below which follows the final
5852   % section, it invokes the new output routine that we've set after
5853   % \balancecolumns below; \onepageout will try to fit the two columns
5854   % and the final section into the vbox of \txipageheight (see
5855   % \pagebody), causing an overfull box.
5856   %
5857   % Note that glue won't work here, because glue does not exercise the
5858   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5859   \penalty0
5860   %
5861   \output = {%
5862     % Split the last of the double-column material.
5863     \savemarks
5864     \balancecolumns
5865     %
5866     % Having called \balancecolumns once, we do not
5867     % want to call it again.  Therefore, reset \output to its normal
5868     % definition right away.
5869     \global\output = {\onepageout{\pagecontents\PAGE}}%
5870   }%
5871   \eject
5872   \endgroup % started in \begindoublecolumns
5873   \restoremarks
5874   % Leave the double-column material on the current page, no automatic
5875   % page break.
5876   \box\balancedcolumns
5877   %
5878   % \pagegoal was set to the doubled \vsize above, since we restarted
5879   % the current page.  We're now back to normal single-column
5880   % typesetting, so reset \pagegoal to the normal \vsize (after the
5881   % \endgroup where \vsize got restored).
5882   \pagegoal = \vsize
5883 }
5884 \newbox\balancedcolumns
5885 \setbox\balancedcolumns=\vbox{shouldnt see this}%
5886 %
5887 % Only called for the last of the double column material.  \doublecolumnout 
5888 % does the others.
5889 \def\balancecolumns{%
5890   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5891   \dimen@ = \ht0
5892   \advance\dimen@ by \topskip
5893   \advance\dimen@ by-\baselineskip
5894   \ifdim\dimen@<14\baselineskip
5895     % Don't split a short final column in two.
5896     \setbox2=\vbox{}%
5897   \else
5898     \divide\dimen@ by 2 % target to split to
5899     \dimen@ii = \dimen@
5900     \splittopskip = \topskip
5901     % Loop until the second column is no higher than the first
5902     {%
5903       \vbadness = 10000
5904       \loop
5905         \global\setbox3 = \copy0
5906         \global\setbox1 = \vsplit3 to \dimen@
5907         % Remove glue from bottom of first column to
5908         % make sure it is higher than the second.
5909         \global\setbox1 = \vbox{\unvbox1\unpenalty\unskip}%
5910       \ifdim\ht3>\ht1
5911         \global\advance\dimen@ by 1pt
5912       \repeat
5913     }%
5914     \multiply\dimen@ii by 4
5915     \divide\dimen@ii by 5
5916     \ifdim\ht3<\dimen@ii
5917       % Column heights are too different, so don't make their bottoms
5918       % flush with each other.  The glue at the end of the second column
5919       % allows a second column to stretch, reducing the difference in
5920       % height between the two.
5921       \setbox0=\vbox to\dimen@{\unvbox1\vfill}%
5922       \setbox2=\vbox to\dimen@{\unvbox3\vskip 0pt plus 0.3\ht0}%
5923     \else
5924       \setbox0=\vbox to\dimen@{\unvbox1}%
5925       \setbox2=\vbox to\dimen@{\unvbox3}%
5926     \fi
5927   \fi
5928   %
5929   \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5930 }
5931 \catcode`\@ = \other
5932
5933
5934 \message{sectioning,}
5935 % Chapters, sections, etc.
5936
5937 % Let's start with @part.
5938 \outer\parseargdef\part{\partzzz{#1}}
5939 \def\partzzz#1{%
5940   \chapoddpage
5941   \null
5942   \vskip.3\vsize  % move it down on the page a bit
5943   \begingroup
5944     \noindent \titlefonts\rmisbold #1\par % the text
5945     \let\lastnode=\empty      % no node to associate with
5946     \writetocentry{part}{#1}{}% but put it in the toc
5947     \headingsoff              % no headline or footline on the part page
5948     % This outputs a mark at the end of the page that clears \thischapter
5949     % and \thissection, as is done in \startcontents.
5950     \let\pchapsepmacro\relax
5951     \chapmacro{}{Yomitfromtoc}{}%
5952     \chapoddpage
5953   \endgroup
5954 }
5955
5956 % \unnumberedno is an oxymoron.  But we count the unnumbered
5957 % sections so that we can refer to them unambiguously in the pdf
5958 % outlines by their "section number".  We avoid collisions with chapter
5959 % numbers by starting them at 10000.  (If a document ever has 10000
5960 % chapters, we're in trouble anyway, I'm sure.)
5961 \newcount\unnumberedno \unnumberedno = 10000
5962 \newcount\chapno
5963 \newcount\secno        \secno=0
5964 \newcount\subsecno     \subsecno=0
5965 \newcount\subsubsecno  \subsubsecno=0
5966
5967 % This counter is funny since it counts through charcodes of letters A, B, ...
5968 \newcount\appendixno  \appendixno = `\@
5969 %
5970 % \def\appendixletter{\char\the\appendixno}
5971 % We do the following ugly conditional instead of the above simple
5972 % construct for the sake of pdftex, which needs the actual
5973 % letter in the expansion, not just typeset.
5974 %
5975 \def\appendixletter{%
5976   \ifnum\appendixno=`A A%
5977   \else\ifnum\appendixno=`B B%
5978   \else\ifnum\appendixno=`C C%
5979   \else\ifnum\appendixno=`D D%
5980   \else\ifnum\appendixno=`E E%
5981   \else\ifnum\appendixno=`F F%
5982   \else\ifnum\appendixno=`G G%
5983   \else\ifnum\appendixno=`H H%
5984   \else\ifnum\appendixno=`I I%
5985   \else\ifnum\appendixno=`J J%
5986   \else\ifnum\appendixno=`K K%
5987   \else\ifnum\appendixno=`L L%
5988   \else\ifnum\appendixno=`M M%
5989   \else\ifnum\appendixno=`N N%
5990   \else\ifnum\appendixno=`O O%
5991   \else\ifnum\appendixno=`P P%
5992   \else\ifnum\appendixno=`Q Q%
5993   \else\ifnum\appendixno=`R R%
5994   \else\ifnum\appendixno=`S S%
5995   \else\ifnum\appendixno=`T T%
5996   \else\ifnum\appendixno=`U U%
5997   \else\ifnum\appendixno=`V V%
5998   \else\ifnum\appendixno=`W W%
5999   \else\ifnum\appendixno=`X X%
6000   \else\ifnum\appendixno=`Y Y%
6001   \else\ifnum\appendixno=`Z Z%
6002   % The \the is necessary, despite appearances, because \appendixletter is
6003   % expanded while writing the .toc file.  \char\appendixno is not
6004   % expandable, thus it is written literally, thus all appendixes come out
6005   % with the same letter (or @) in the toc without it.
6006   \else\char\the\appendixno
6007   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6008   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
6009
6010 % Each @chapter defines these (using marks) as the number+name, number
6011 % and name of the chapter.  Page headings and footings can use
6012 % these.  @section does likewise.
6013 \def\thischapter{}
6014 \def\thischapternum{}
6015 \def\thischaptername{}
6016 \def\thissection{}
6017 \def\thissectionnum{}
6018 \def\thissectionname{}
6019
6020 \newcount\absseclevel % used to calculate proper heading level
6021 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
6022
6023 % @raisesections: treat @section as chapter, @subsection as section, etc.
6024 \def\raisesections{\global\advance\secbase by -1}
6025 \let\up=\raisesections % original BFox name
6026
6027 % @lowersections: treat @chapter as section, @section as subsection, etc.
6028 \def\lowersections{\global\advance\secbase by 1}
6029 \let\down=\lowersections % original BFox name
6030
6031 % we only have subsub.
6032 \chardef\maxseclevel = 3
6033 %
6034 % A numbered section within an unnumbered changes to unnumbered too.
6035 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6036 \chardef\unnlevel = \maxseclevel
6037 %
6038 % Trace whether the current chapter is an appendix or not:
6039 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6040 \def\chapheadtype{N}
6041
6042 % Choose a heading macro
6043 % #1 is heading type
6044 % #2 is heading level
6045 % #3 is text for heading
6046 \def\genhead#1#2#3{%
6047   % Compute the abs. sec. level:
6048   \absseclevel=#2
6049   \advance\absseclevel by \secbase
6050   % Make sure \absseclevel doesn't fall outside the range:
6051   \ifnum \absseclevel < 0
6052     \absseclevel = 0
6053   \else
6054     \ifnum \absseclevel > 3
6055       \absseclevel = 3
6056     \fi
6057   \fi
6058   % The heading type:
6059   \def\headtype{#1}%
6060   \if \headtype U%
6061     \ifnum \absseclevel < \unnlevel
6062       \chardef\unnlevel = \absseclevel
6063     \fi
6064   \else
6065     % Check for appendix sections:
6066     \ifnum \absseclevel = 0
6067       \edef\chapheadtype{\headtype}%
6068     \else
6069       \if \headtype A\if \chapheadtype N%
6070         \errmessage{@appendix... within a non-appendix chapter}%
6071       \fi\fi
6072     \fi
6073     % Check for numbered within unnumbered:
6074     \ifnum \absseclevel > \unnlevel
6075       \def\headtype{U}%
6076     \else
6077       \chardef\unnlevel = 3
6078     \fi
6079   \fi
6080   % Now print the heading:
6081   \if \headtype U%
6082     \ifcase\absseclevel
6083         \unnumberedzzz{#3}%
6084     \or \unnumberedseczzz{#3}%
6085     \or \unnumberedsubseczzz{#3}%
6086     \or \unnumberedsubsubseczzz{#3}%
6087     \fi
6088   \else
6089     \if \headtype A%
6090       \ifcase\absseclevel
6091           \appendixzzz{#3}%
6092       \or \appendixsectionzzz{#3}%
6093       \or \appendixsubseczzz{#3}%
6094       \or \appendixsubsubseczzz{#3}%
6095       \fi
6096     \else
6097       \ifcase\absseclevel
6098           \chapterzzz{#3}%
6099       \or \seczzz{#3}%
6100       \or \numberedsubseczzz{#3}%
6101       \or \numberedsubsubseczzz{#3}%
6102       \fi
6103     \fi
6104   \fi
6105   \suppressfirstparagraphindent
6106 }
6107
6108 % an interface:
6109 \def\numhead{\genhead N}
6110 \def\apphead{\genhead A}
6111 \def\unnmhead{\genhead U}
6112
6113 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
6114 % all lower-level sectioning counters to zero.
6115 %
6116 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6117 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
6118 \let\chaplevelprefix = \empty
6119 %
6120 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
6121 \def\chapterzzz#1{%
6122   % section resetting is \global in case the chapter is in a group, such
6123   % as an @include file.
6124   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6125     \global\advance\chapno by 1
6126   %
6127   % Used for \float.
6128   \gdef\chaplevelprefix{\the\chapno.}%
6129   \resetallfloatnos
6130   %
6131   % \putwordChapter can contain complex things in translations.
6132   \toks0=\expandafter{\putwordChapter}%
6133   \message{\the\toks0 \space \the\chapno}%
6134   %
6135   % Write the actual heading.
6136   \chapmacro{#1}{Ynumbered}{\the\chapno}%
6137   %
6138   % So @section and the like are numbered underneath this chapter.
6139   \global\let\section = \numberedsec
6140   \global\let\subsection = \numberedsubsec
6141   \global\let\subsubsection = \numberedsubsubsec
6142 }
6143
6144 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
6145 %
6146 \def\appendixzzz#1{%
6147   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6148     \global\advance\appendixno by 1
6149   \gdef\chaplevelprefix{\appendixletter.}%
6150   \resetallfloatnos
6151   %
6152   % \putwordAppendix can contain complex things in translations.
6153   \toks0=\expandafter{\putwordAppendix}%
6154   \message{\the\toks0 \space \appendixletter}%
6155   %
6156   \chapmacro{#1}{Yappendix}{\appendixletter}%
6157   %
6158   \global\let\section = \appendixsec
6159   \global\let\subsection = \appendixsubsec
6160   \global\let\subsubsection = \appendixsubsubsec
6161 }
6162
6163 % normally unnmhead0 calls unnumberedzzz:
6164 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
6165 \def\unnumberedzzz#1{%
6166   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6167     \global\advance\unnumberedno by 1
6168   %
6169   % Since an unnumbered has no number, no prefix for figures.
6170   \global\let\chaplevelprefix = \empty
6171   \resetallfloatnos
6172   %
6173   % This used to be simply \message{#1}, but TeX fully expands the
6174   % argument to \message.  Therefore, if #1 contained @-commands, TeX
6175   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
6176   % expanded @cite (which turns out to cause errors because \cite is meant
6177   % to be executed, not expanded).
6178   %
6179   % Anyway, we don't want the fully-expanded definition of @cite to appear
6180   % as a result of the \message, we just want `@cite' itself.  We use
6181   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6182   % simply yielding the contents of <toks register>.  (We also do this for
6183   % the toc entries.)
6184   \toks0 = {#1}%
6185   \message{(\the\toks0)}%
6186   %
6187   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
6188   %
6189   \global\let\section = \unnumberedsec
6190   \global\let\subsection = \unnumberedsubsec
6191   \global\let\subsubsection = \unnumberedsubsubsec
6192 }
6193
6194 % @centerchap is like @unnumbered, but the heading is centered.
6195 \outer\parseargdef\centerchap{%
6196   \let\centerparametersmaybe = \centerparameters
6197   \unnmhead0{#1}%
6198   \let\centerparametersmaybe = \relax
6199 }
6200
6201 % @top is like @unnumbered.
6202 \let\top\unnumbered
6203
6204 % Sections.
6205
6206 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
6207 \def\seczzz#1{%
6208   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6209   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
6210 }
6211
6212 % normally calls appendixsectionzzz:
6213 \outer\parseargdef\appendixsection{\apphead1{#1}}
6214 \def\appendixsectionzzz#1{%
6215   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6216   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
6217 }
6218 \let\appendixsec\appendixsection
6219
6220 % normally calls unnumberedseczzz:
6221 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
6222 \def\unnumberedseczzz#1{%
6223   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6224   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
6225 }
6226
6227 % Subsections.
6228
6229 % normally calls numberedsubseczzz:
6230 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
6231 \def\numberedsubseczzz#1{%
6232   \global\subsubsecno=0  \global\advance\subsecno by 1
6233   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
6234 }
6235
6236 % normally calls appendixsubseczzz:
6237 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
6238 \def\appendixsubseczzz#1{%
6239   \global\subsubsecno=0  \global\advance\subsecno by 1
6240   \sectionheading{#1}{subsec}{Yappendix}%
6241                  {\appendixletter.\the\secno.\the\subsecno}%
6242 }
6243
6244 % normally calls unnumberedsubseczzz:
6245 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
6246 \def\unnumberedsubseczzz#1{%
6247   \global\subsubsecno=0  \global\advance\subsecno by 1
6248   \sectionheading{#1}{subsec}{Ynothing}%
6249                  {\the\unnumberedno.\the\secno.\the\subsecno}%
6250 }
6251
6252 % Subsubsections.
6253
6254 % normally numberedsubsubseczzz:
6255 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
6256 \def\numberedsubsubseczzz#1{%
6257   \global\advance\subsubsecno by 1
6258   \sectionheading{#1}{subsubsec}{Ynumbered}%
6259                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
6260 }
6261
6262 % normally appendixsubsubseczzz:
6263 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
6264 \def\appendixsubsubseczzz#1{%
6265   \global\advance\subsubsecno by 1
6266   \sectionheading{#1}{subsubsec}{Yappendix}%
6267                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
6268 }
6269
6270 % normally unnumberedsubsubseczzz:
6271 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
6272 \def\unnumberedsubsubseczzz#1{%
6273   \global\advance\subsubsecno by 1
6274   \sectionheading{#1}{subsubsec}{Ynothing}%
6275                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
6276 }
6277
6278 % These macros control what the section commands do, according
6279 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
6280 % Define them by default for a numbered chapter.
6281 \let\section = \numberedsec
6282 \let\subsection = \numberedsubsec
6283 \let\subsubsection = \numberedsubsubsec
6284
6285 % Define @majorheading, @heading and @subheading
6286
6287 \def\majorheading{%
6288   {\advance\chapheadingskip by 10pt \chapbreak }%
6289   \parsearg\chapheadingzzz
6290 }
6291
6292 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
6293 \def\chapheadingzzz#1{%
6294   \vbox{\chapfonts \raggedtitlesettings #1\par}%
6295   \nobreak\bigskip \nobreak
6296   \suppressfirstparagraphindent
6297 }
6298
6299 % @heading, @subheading, @subsubheading.
6300 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
6301   \suppressfirstparagraphindent}
6302 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
6303   \suppressfirstparagraphindent}
6304 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
6305   \suppressfirstparagraphindent}
6306
6307 % These macros generate a chapter, section, etc. heading only
6308 % (including whitespace, linebreaking, etc. around it),
6309 % given all the information in convenient, parsed form.
6310
6311 % Args are the skip and penalty (usually negative)
6312 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
6313
6314 % Parameter controlling skip before chapter headings (if needed)
6315 \newskip\chapheadingskip
6316
6317 % Define plain chapter starts, and page on/off switching for it.
6318 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
6319
6320 % Start a new page
6321 \def\chappager{\par\vfill\supereject}
6322
6323 % \chapoddpage - start on an odd page for a new chapter
6324 % Because \domark is called before \chapoddpage, the filler page will
6325 % get the headings for the next chapter, which is wrong.  But we don't
6326 % care -- we just disable all headings on the filler page.
6327 \def\chapoddpage{%
6328   \chappager
6329   \ifodd\pageno \else
6330     \begingroup
6331       \headingsoff
6332       \null
6333       \chappager
6334     \endgroup
6335   \fi
6336 }
6337
6338 \parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname}
6339
6340 \def\CHAPPAGoff{%
6341 \global\let\contentsalignmacro = \chappager
6342 \global\let\pchapsepmacro=\chapbreak
6343 \global\let\pagealignmacro=\chappager}
6344
6345 \def\CHAPPAGon{%
6346 \global\let\contentsalignmacro = \chappager
6347 \global\let\pchapsepmacro=\chappager
6348 \global\let\pagealignmacro=\chappager
6349 \global\def\HEADINGSon{\HEADINGSsingle}}
6350
6351 \def\CHAPPAGodd{%
6352 \global\let\contentsalignmacro = \chapoddpage
6353 \global\let\pchapsepmacro=\chapoddpage
6354 \global\let\pagealignmacro=\chapoddpage
6355 \global\def\HEADINGSon{\HEADINGSdouble}}
6356
6357 \CHAPPAGon
6358
6359 % \chapmacro - Chapter opening.
6360 %
6361 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
6362 % Yappendix, Yomitfromtoc), #3 the chapter number.
6363 % Not used for @heading series.
6364 %
6365 % To test against our argument.
6366 \def\Ynothingkeyword{Ynothing}
6367 \def\Yappendixkeyword{Yappendix}
6368 \def\Yomitfromtockeyword{Yomitfromtoc}
6369 %
6370 \def\chapmacro#1#2#3{%
6371   \expandafter\ifx\thisenv\titlepage\else
6372     \checkenv{}% chapters, etc., should not start inside an environment.
6373   \fi
6374   % FIXME: \chapmacro is currently called from inside \titlepage when
6375   % \setcontentsaftertitlepage to print the "Table of Contents" heading, but
6376   % this should probably be done by \sectionheading with an option to print
6377   % in chapter size.
6378   %
6379   % Insert the first mark before the heading break (see notes for \domark).
6380   \let\prevchapterdefs=\lastchapterdefs
6381   \let\prevsectiondefs=\lastsectiondefs
6382   \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
6383                         \gdef\thissection{}}%
6384   %
6385   \def\temptype{#2}%
6386   \ifx\temptype\Ynothingkeyword
6387     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6388                           \gdef\thischapter{\thischaptername}}%
6389   \else\ifx\temptype\Yomitfromtockeyword
6390     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6391                           \gdef\thischapter{}}%
6392   \else\ifx\temptype\Yappendixkeyword
6393     \toks0={#1}%
6394     \xdef\lastchapterdefs{%
6395       \gdef\noexpand\thischaptername{\the\toks0}%
6396       \gdef\noexpand\thischapternum{\appendixletter}%
6397       % \noexpand\putwordAppendix avoids expanding indigestible
6398       % commands in some of the translations.
6399       \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
6400                                  \noexpand\thischapternum:
6401                                  \noexpand\thischaptername}%
6402     }%
6403   \else
6404     \toks0={#1}%
6405     \xdef\lastchapterdefs{%
6406       \gdef\noexpand\thischaptername{\the\toks0}%
6407       \gdef\noexpand\thischapternum{\the\chapno}%
6408       % \noexpand\putwordChapter avoids expanding indigestible
6409       % commands in some of the translations.
6410       \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
6411                                  \noexpand\thischapternum:
6412                                  \noexpand\thischaptername}%
6413     }%
6414   \fi\fi\fi
6415   %
6416   % Output the mark.  Pass it through \safewhatsit, to take care of
6417   % the preceding space.
6418   \safewhatsit\domark
6419   %
6420   % Insert the chapter heading break.
6421   \pchapsepmacro
6422   %
6423   % Now the second mark, after the heading break.  No break points
6424   % between here and the heading.
6425   \let\prevchapterdefs=\lastchapterdefs
6426   \let\prevsectiondefs=\lastsectiondefs
6427   \domark
6428   %
6429   {%
6430     \chapfonts \rmisbold
6431     \let\footnote=\errfootnoteheading % give better error message
6432     %
6433     % Have to define \lastsection before calling \donoderef, because the
6434     % xref code eventually uses it.  On the other hand, it has to be called
6435     % after \pchapsepmacro, or the headline will change too soon.
6436     \gdef\lastsection{#1}%
6437     %
6438     % Only insert the separating space if we have a chapter/appendix
6439     % number, and don't print the unnumbered ``number''.
6440     \ifx\temptype\Ynothingkeyword
6441       \setbox0 = \hbox{}%
6442       \def\toctype{unnchap}%
6443     \else\ifx\temptype\Yomitfromtockeyword
6444       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
6445       \def\toctype{omit}%
6446     \else\ifx\temptype\Yappendixkeyword
6447       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
6448       \def\toctype{app}%
6449     \else
6450       \setbox0 = \hbox{#3\enspace}%
6451       \def\toctype{numchap}%
6452     \fi\fi\fi
6453     %
6454     % Write the toc entry for this chapter.  Must come before the
6455     % \donoderef, because we include the current node name in the toc
6456     % entry, and \donoderef resets it to empty.
6457     \writetocentry{\toctype}{#1}{#3}%
6458     %
6459     % For pdftex, we have to write out the node definition (aka, make
6460     % the pdfdest) after any page break, but before the actual text has
6461     % been typeset.  If the destination for the pdf outline is after the
6462     % text, then jumping from the outline may wind up with the text not
6463     % being visible, for instance under high magnification.
6464     \donoderef{#2}%
6465     %
6466     % Typeset the actual heading.
6467     \nobreak % Avoid page breaks at the interline glue.
6468     \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
6469           \unhbox0 #1\par}%
6470   }%
6471   \nobreak\bigskip % no page break after a chapter title
6472   \nobreak
6473 }
6474
6475 % @centerchap -- centered and unnumbered.
6476 \let\centerparametersmaybe = \relax
6477 \def\centerparameters{%
6478   \advance\rightskip by 3\rightskip
6479   \leftskip = \rightskip
6480   \parfillskip = 0pt
6481 }
6482
6483
6484 % Section titles.  These macros combine the section number parts and
6485 % call the generic \sectionheading to do the printing.
6486 %
6487 \newskip\secheadingskip
6488 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
6489
6490 % Subsection titles.
6491 \newskip\subsecheadingskip
6492 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
6493
6494 % Subsubsection titles.
6495 \def\subsubsecheadingskip{\subsecheadingskip}
6496 \def\subsubsecheadingbreak{\subsecheadingbreak}
6497
6498
6499 % Print any size, any type, section title.
6500 %
6501 % #1 is the text of the title,
6502 % #2 is the section level (sec/subsec/subsubsec),
6503 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6504 % #4 is the section number.
6505 %
6506 \def\seckeyword{sec}
6507 %
6508 \def\sectionheading#1#2#3#4{%
6509   {%
6510     \def\sectionlevel{#2}%
6511     \def\temptype{#3}%
6512     %
6513     % It is ok for the @heading series commands to appear inside an
6514     % environment (it's been historically allowed, though the logic is
6515     % dubious), but not the others.
6516     \ifx\temptype\Yomitfromtockeyword\else
6517       \checkenv{}% non-@*heading should not be in an environment.
6518     \fi
6519     \let\footnote=\errfootnoteheading
6520     %
6521     % Switch to the right set of fonts.
6522     \csname #2fonts\endcsname \rmisbold
6523     %
6524     % Insert first mark before the heading break (see notes for \domark).
6525     \let\prevsectiondefs=\lastsectiondefs
6526     \ifx\temptype\Ynothingkeyword
6527       \ifx\sectionlevel\seckeyword
6528         \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
6529                               \gdef\thissection{\thissectionname}}%
6530       \fi
6531     \else\ifx\temptype\Yomitfromtockeyword
6532       % Don't redefine \thissection.
6533     \else\ifx\temptype\Yappendixkeyword
6534       \ifx\sectionlevel\seckeyword
6535         \toks0={#1}%
6536         \xdef\lastsectiondefs{%
6537           \gdef\noexpand\thissectionname{\the\toks0}%
6538           \gdef\noexpand\thissectionnum{#4}%
6539           % \noexpand\putwordSection avoids expanding indigestible
6540           % commands in some of the translations.
6541           \gdef\noexpand\thissection{\noexpand\putwordSection{}
6542                                      \noexpand\thissectionnum:
6543                                      \noexpand\thissectionname}%
6544         }%
6545       \fi
6546     \else
6547       \ifx\sectionlevel\seckeyword
6548         \toks0={#1}%
6549         \xdef\lastsectiondefs{%
6550           \gdef\noexpand\thissectionname{\the\toks0}%
6551           \gdef\noexpand\thissectionnum{#4}%
6552           % \noexpand\putwordSection avoids expanding indigestible
6553           % commands in some of the translations.
6554           \gdef\noexpand\thissection{\noexpand\putwordSection{}
6555                                      \noexpand\thissectionnum:
6556                                      \noexpand\thissectionname}%
6557         }%
6558       \fi
6559     \fi\fi\fi
6560     %
6561     % Go into vertical mode.  Usually we'll already be there, but we
6562     % don't want the following whatsit to end up in a preceding paragraph
6563     % if the document didn't happen to have a blank line.
6564     \par
6565     %
6566     % Output the mark.  Pass it through \safewhatsit, to take care of
6567     % the preceding space.
6568     \safewhatsit\domark
6569     %
6570     % Insert space above the heading.
6571     \csname #2headingbreak\endcsname
6572     %
6573     % Now the second mark, after the heading break.  No break points
6574     % between here and the heading.
6575     \global\let\prevsectiondefs=\lastsectiondefs
6576     \domark
6577     %
6578     % Only insert the space after the number if we have a section number.
6579     \ifx\temptype\Ynothingkeyword
6580       \setbox0 = \hbox{}%
6581       \def\toctype{unn}%
6582       \gdef\lastsection{#1}%
6583     \else\ifx\temptype\Yomitfromtockeyword
6584       % for @headings -- no section number, don't include in toc,
6585       % and don't redefine \lastsection.
6586       \setbox0 = \hbox{}%
6587       \def\toctype{omit}%
6588       \let\sectionlevel=\empty
6589     \else\ifx\temptype\Yappendixkeyword
6590       \setbox0 = \hbox{#4\enspace}%
6591       \def\toctype{app}%
6592       \gdef\lastsection{#1}%
6593     \else
6594       \setbox0 = \hbox{#4\enspace}%
6595       \def\toctype{num}%
6596       \gdef\lastsection{#1}%
6597     \fi\fi\fi
6598     %
6599     % Write the toc entry (before \donoderef).  See comments in \chapmacro.
6600     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6601     %
6602     % Write the node reference (= pdf destination for pdftex).
6603     % Again, see comments in \chapmacro.
6604     \donoderef{#3}%
6605     %
6606     % Interline glue will be inserted when the vbox is completed.
6607     % That glue will be a valid breakpoint for the page, since it'll be
6608     % preceded by a whatsit (usually from the \donoderef, or from the
6609     % \writetocentry if there was no node).  We don't want to allow that
6610     % break, since then the whatsits could end up on page n while the
6611     % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
6612     \nobreak
6613     %
6614     % Output the actual section heading.
6615     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6616           \hangindent=\wd0  % zero if no section number
6617           \unhbox0 #1}%
6618   }%
6619   % Add extra space after the heading -- half of whatever came above it.
6620   % Don't allow stretch, though.
6621   \kern .5 \csname #2headingskip\endcsname
6622   %
6623   % Do not let the kern be a potential breakpoint, as it would be if it
6624   % was followed by glue.
6625   \nobreak
6626   %
6627   % We'll almost certainly start a paragraph next, so don't let that
6628   % glue accumulate.  (Not a breakpoint because it's preceded by a
6629   % discardable item.)  However, when a paragraph is not started next
6630   % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6631   % or the negative glue will cause weirdly wrong output, typically
6632   % obscuring the section heading with something else.
6633   \vskip-\parskip
6634   %
6635   % This is so the last item on the main vertical list is a known
6636   % \penalty > 10000, so \startdefun, etc., can recognize the situation
6637   % and do the needful.
6638   \penalty 10001
6639 }
6640
6641
6642 \message{toc,}
6643 % Table of contents.
6644 \newwrite\tocfile
6645
6646 % Write an entry to the toc file, opening it if necessary.
6647 % Called from @chapter, etc.
6648 %
6649 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6650 % We append the current node name (if any) and page number as additional
6651 % arguments for the \{chap,sec,...}entry macros which will eventually
6652 % read this.  The node name is used in the pdf outlines as the
6653 % destination to jump to.
6654 %
6655 % We open the .toc file for writing here instead of at @setfilename (or
6656 % any other fixed time) so that @contents can be anywhere in the document.
6657 % But if #1 is `omit', then we don't do anything.  This is used for the
6658 % table of contents chapter openings themselves.
6659 %
6660 \newif\iftocfileopened
6661 \def\omitkeyword{omit}%
6662 %
6663 \def\writetocentry#1#2#3{%
6664   \edef\writetoctype{#1}%
6665   \ifx\writetoctype\omitkeyword \else
6666     \iftocfileopened\else
6667       \immediate\openout\tocfile = \jobname.toc
6668       \global\tocfileopenedtrue
6669     \fi
6670     %
6671     \iflinks
6672       {\atdummies
6673        \edef\temp{%
6674          \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6675        \temp
6676       }%
6677     \fi
6678   \fi
6679   %
6680   % Tell \shipout to create a pdf destination on each page, if we're
6681   % writing pdf.  These are used in the table of contents.  We can't
6682   % just write one on every page because the title pages are numbered
6683   % 1 and 2 (the page numbers aren't printed), and so are the first
6684   % two pages of the document.  Thus, we'd have two destinations named
6685   % `1', and two named `2'.
6686   \ifpdf \global\pdfmakepagedesttrue \fi
6687 }
6688
6689
6690 % These characters do not print properly in the Computer Modern roman
6691 % fonts, so we must take special care.  This is more or less redundant
6692 % with the Texinfo input format setup at the end of this file.
6693 %
6694 \def\activecatcodes{%
6695   \catcode`\"=\active
6696   \catcode`\$=\active
6697   \catcode`\<=\active
6698   \catcode`\>=\active
6699   \catcode`\\=\active
6700   \catcode`\^=\active
6701   \catcode`\_=\active
6702   \catcode`\|=\active
6703   \catcode`\~=\active
6704 }
6705
6706
6707 % Read the toc file, which is essentially Texinfo input.
6708 \def\readtocfile{%
6709   \setupdatafile
6710   \activecatcodes
6711   \input \tocreadfilename
6712 }
6713
6714 \newskip\contentsrightmargin \contentsrightmargin=1in
6715 \newcount\savepageno
6716 \newcount\lastnegativepageno \lastnegativepageno = -1
6717
6718 % Prepare to read what we've written to \tocfile.
6719 %
6720 \def\startcontents#1{%
6721   % If @setchapternewpage on, and @headings double, the contents should
6722   % start on an odd page, unlike chapters.  Thus, we maintain
6723   % \contentsalignmacro in parallel with \pagealignmacro.
6724   % From: Torbjorn Granlund <tege@matematik.su.se>
6725   \contentsalignmacro
6726   \immediate\closeout\tocfile
6727   %
6728   % Don't need to put `Contents' or `Short Contents' in the headline.
6729   % It is abundantly clear what they are.
6730   \chapmacro{#1}{Yomitfromtoc}{}%
6731   %
6732   \savepageno = \pageno
6733   \begingroup                  % Set up to handle contents files properly.
6734     \raggedbottom              % Worry more about breakpoints than the bottom.
6735     \entryrightmargin=\contentsrightmargin % Don't use the full line length.
6736     %
6737     % Roman numerals for page numbers.
6738     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6739 }
6740
6741 % redefined for the two-volume lispref.  We always output on
6742 % \jobname.toc even if this is redefined.
6743 %
6744 \def\tocreadfilename{\jobname.toc}
6745
6746 % Normal (long) toc.
6747 %
6748 \def\contents{%
6749   \startcontents{\putwordTOC}%
6750     \openin 1 \tocreadfilename\space
6751     \ifeof 1 \else
6752       \readtocfile
6753     \fi
6754     \vfill \eject
6755     \contentsalignmacro % in case @setchapternewpage odd is in effect
6756     \ifeof 1 \else
6757       \pdfmakeoutlines
6758     \fi
6759     \closein 1
6760   \endgroup
6761   \lastnegativepageno = \pageno
6762   \global\pageno = \savepageno
6763 }
6764
6765 % And just the chapters.
6766 \def\summarycontents{%
6767   \startcontents{\putwordShortTOC}%
6768     %
6769     \let\partentry = \shortpartentry
6770     \let\numchapentry = \shortchapentry
6771     \let\appentry = \shortchapentry
6772     \let\unnchapentry = \shortunnchapentry
6773     % We want a true roman here for the page numbers.
6774     \secfonts
6775     \let\rm=\shortcontrm \let\bf=\shortcontbf
6776     \let\sl=\shortcontsl \let\tt=\shortconttt
6777     \rm
6778     \hyphenpenalty = 10000
6779     \advance\baselineskip by 1pt % Open it up a little.
6780     \def\numsecentry##1##2##3##4{}
6781     \let\appsecentry = \numsecentry
6782     \let\unnsecentry = \numsecentry
6783     \let\numsubsecentry = \numsecentry
6784     \let\appsubsecentry = \numsecentry
6785     \let\unnsubsecentry = \numsecentry
6786     \let\numsubsubsecentry = \numsecentry
6787     \let\appsubsubsecentry = \numsecentry
6788     \let\unnsubsubsecentry = \numsecentry
6789     \openin 1 \tocreadfilename\space
6790     \ifeof 1 \else
6791       \readtocfile
6792     \fi
6793     \closein 1
6794     \vfill \eject
6795     \contentsalignmacro % in case @setchapternewpage odd is in effect
6796   \endgroup
6797   \lastnegativepageno = \pageno
6798   \global\pageno = \savepageno
6799 }
6800 \let\shortcontents = \summarycontents
6801
6802 % Typeset the label for a chapter or appendix for the short contents.
6803 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6804 %
6805 \def\shortchaplabel#1{%
6806   % This space should be enough, since a single number is .5em, and the
6807   % widest letter (M) is 1em, at least in the Computer Modern fonts.
6808   % But use \hss just in case.
6809   % (This space doesn't include the extra space that gets added after
6810   % the label; that gets put in by \shortchapentry above.)
6811   %
6812   % We'd like to right-justify chapter numbers, but that looks strange
6813   % with appendix letters.  And right-justifying numbers and
6814   % left-justifying letters looks strange when there is less than 10
6815   % chapters.  Have to read the whole toc once to know how many chapters
6816   % there are before deciding ...
6817   \hbox to 1em{#1\hss}%
6818 }
6819
6820 % These macros generate individual entries in the table of contents.
6821 % The first argument is the chapter or section name.
6822 % The last argument is the page number.
6823 % The arguments in between are the chapter number, section number, ...
6824
6825 % Parts, in the main contents.  Replace the part number, which doesn't
6826 % exist, with an empty box.  Let's hope all the numbers have the same width.
6827 % Also ignore the page number, which is conventionally not printed.
6828 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6829 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6830 %
6831 % Parts, in the short toc.
6832 \def\shortpartentry#1#2#3#4{%
6833   \penalty-300
6834   \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6835   \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6836 }
6837
6838 % Chapters, in the main contents.
6839 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6840
6841 % Chapters, in the short toc.
6842 % See comments in \dochapentry re vbox and related settings.
6843 \def\shortchapentry#1#2#3#4{%
6844   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6845 }
6846
6847 % Appendices, in the main contents.
6848 % Need the word Appendix, and a fixed-size box.
6849 %
6850 \def\appendixbox#1{%
6851   % We use M since it's probably the widest letter.
6852   \setbox0 = \hbox{\putwordAppendix{} M}%
6853   \hbox to \wd0{\putwordAppendix{} #1\hss}}
6854 %
6855 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
6856
6857 % Unnumbered chapters.
6858 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6859 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6860
6861 % Sections.
6862 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6863 \let\appsecentry=\numsecentry
6864 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6865
6866 % Subsections.
6867 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6868 \let\appsubsecentry=\numsubsecentry
6869 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6870
6871 % And subsubsections.
6872 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6873 \let\appsubsubsecentry=\numsubsubsecentry
6874 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6875
6876 % This parameter controls the indentation of the various levels.
6877 % Same as \defaultparindent.
6878 \newdimen\tocindent \tocindent = 15pt
6879
6880 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6881 % page number.
6882 %
6883 % If the toc has to be broken over pages, we want it to be at chapters
6884 % if at all possible; hence the \penalty.
6885 \def\dochapentry#1#2{%
6886    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6887    \begingroup
6888      % Move the page numbers slightly to the right
6889      \advance\entryrightmargin by -0.05em
6890      \chapentryfonts
6891      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6892    \endgroup
6893    \nobreak\vskip .25\baselineskip plus.1\baselineskip
6894 }
6895
6896 \def\dosecentry#1#2{\begingroup
6897   \secentryfonts \leftskip=\tocindent
6898   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6899 \endgroup}
6900
6901 \def\dosubsecentry#1#2{\begingroup
6902   \subsecentryfonts \leftskip=2\tocindent
6903   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6904 \endgroup}
6905
6906 \def\dosubsubsecentry#1#2{\begingroup
6907   \subsubsecentryfonts \leftskip=3\tocindent
6908   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6909 \endgroup}
6910
6911 % We use the same \entry macro as for the index entries.
6912 \let\tocentry = \entry
6913
6914 % Space between chapter (or whatever) number and the title.
6915 \def\labelspace{\hskip1em \relax}
6916
6917 \def\dopageno#1{{\rm #1}}
6918 \def\doshortpageno#1{{\rm #1}}
6919
6920 \def\chapentryfonts{\secfonts \rm}
6921 \def\secentryfonts{\textfonts}
6922 \def\subsecentryfonts{\textfonts}
6923 \def\subsubsecentryfonts{\textfonts}
6924
6925
6926 \message{environments,}
6927 % @foo ... @end foo.
6928
6929 % @tex ... @end tex    escapes into raw TeX temporarily.
6930 % One exception: @ is still an escape character, so that @end tex works.
6931 % But \@ or @@ will get a plain @ character.
6932
6933 \envdef\tex{%
6934   \setupmarkupstyle{tex}%
6935   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6936   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6937   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6938   \catcode `\%=14
6939   \catcode `\+=\other
6940   \catcode `\"=\other
6941   \catcode `\|=\other
6942   \catcode `\<=\other
6943   \catcode `\>=\other
6944   \catcode `\`=\other
6945   \catcode `\'=\other
6946   \escapechar=`\\
6947   %
6948   % ' is active in math mode (mathcode"8000).  So reset it, and all our
6949   % other math active characters (just in case), to plain's definitions.
6950   \mathactive
6951   %
6952   % Inverse of the list at the beginning of the file.
6953   \let\b=\ptexb
6954   \let\bullet=\ptexbullet
6955   \let\c=\ptexc
6956   \let\,=\ptexcomma
6957   \let\.=\ptexdot
6958   \let\dots=\ptexdots
6959   \let\equiv=\ptexequiv
6960   \let\!=\ptexexclam
6961   \let\i=\ptexi
6962   \let\indent=\ptexindent
6963   \let\noindent=\ptexnoindent
6964   \let\{=\ptexlbrace
6965   \let\+=\tabalign
6966   \let\}=\ptexrbrace
6967   \let\/=\ptexslash
6968   \let\sp=\ptexsp
6969   \let\*=\ptexstar
6970   %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6971   \let\t=\ptext
6972   \expandafter \let\csname top\endcsname=\ptextop  % we've made it outer
6973   \let\frenchspacing=\plainfrenchspacing
6974   %
6975   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6976   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6977   \def\@{@}%
6978 }
6979 % There is no need to define \Etex.
6980
6981 % Define @lisp ... @end lisp.
6982 % @lisp environment forms a group so it can rebind things,
6983 % including the definition of @end lisp (which normally is erroneous).
6984
6985 % Amount to narrow the margins by for @lisp.
6986 \newskip\lispnarrowing \lispnarrowing=0.4in
6987
6988 % This is the definition that ^^M gets inside @lisp, @example, and other
6989 % such environments.  \null is better than a space, since it doesn't
6990 % have any width.
6991 \def\lisppar{\null\endgraf}
6992
6993 % This space is always present above and below environments.
6994 \newskip\envskipamount \envskipamount = 0pt
6995
6996 % Make spacing and below environment symmetrical.  We use \parskip here
6997 % to help in doing that, since in @example-like environments \parskip
6998 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6999 % start of the next paragraph will insert \parskip.
7000 %
7001 \def\aboveenvbreak{{%
7002   % =10000 instead of <10000 because of a special case in \itemzzz and
7003   % \sectionheading, q.v.
7004   \ifnum \lastpenalty=10000 \else
7005     \advance\envskipamount by \parskip
7006     \endgraf
7007     \ifdim\lastskip<\envskipamount
7008       \removelastskip
7009       \ifnum\lastpenalty<10000
7010         % Penalize breaking before the environment, because preceding text
7011         % often leads into it.
7012         \penalty100
7013       \fi
7014       \vskip\envskipamount
7015     \fi
7016   \fi
7017 }}
7018
7019 \def\afterenvbreak{{%
7020   % =10000 instead of <10000 because of a special case in \itemzzz and
7021   % \sectionheading, q.v.
7022   \ifnum \lastpenalty=10000 \else
7023     \advance\envskipamount by \parskip
7024     \endgraf
7025     \ifdim\lastskip<\envskipamount
7026       \removelastskip
7027       % it's not a good place to break if the last penalty was \nobreak
7028       % or better ...
7029       \ifnum\lastpenalty<10000 \penalty-50 \fi
7030       \vskip\envskipamount
7031     \fi
7032   \fi
7033 }}
7034
7035 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
7036 % also clear it, so that its embedded environments do the narrowing again.
7037 \let\nonarrowing=\relax
7038
7039 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
7040 % environment contents.
7041 \font\circle=lcircle10
7042 \newdimen\circthick
7043 \newdimen\cartouter\newdimen\cartinner
7044 \newskip\normbskip\newskip\normpskip\newskip\normlskip
7045 \circthick=\fontdimen8\circle
7046 %
7047 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
7048 \def\ctr{{\hskip 6pt\circle\char'010}}
7049 \def\cbl{{\circle\char'012\hskip -6pt}}
7050 \def\cbr{{\hskip 6pt\circle\char'011}}
7051 \def\carttop{\hbox to \cartouter{\hskip\lskip
7052         \ctl\leaders\hrule height\circthick\hfil\ctr
7053         \hskip\rskip}}
7054 \def\cartbot{\hbox to \cartouter{\hskip\lskip
7055         \cbl\leaders\hrule height\circthick\hfil\cbr
7056         \hskip\rskip}}
7057 %
7058 \newskip\lskip\newskip\rskip
7059
7060 \envdef\cartouche{%
7061   \ifhmode\par\fi  % can't be in the midst of a paragraph.
7062   \startsavinginserts
7063   \lskip=\leftskip \rskip=\rightskip
7064   \leftskip=0pt\rightskip=0pt % we want these *outside*.
7065   \cartinner=\hsize \advance\cartinner by-\lskip
7066   \advance\cartinner by-\rskip
7067   \cartouter=\hsize
7068   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
7069                                 % side, and for 6pt waste from
7070                                 % each corner char, and rule thickness
7071   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
7072   %
7073   % If this cartouche directly follows a sectioning command, we need the
7074   % \parskip glue (backspaced over by default) or the cartouche can
7075   % collide with the section heading.
7076   \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
7077   %
7078   \setbox\groupbox=\vbox\bgroup
7079       \baselineskip=0pt\parskip=0pt\lineskip=0pt
7080       \carttop
7081       \hbox\bgroup
7082           \hskip\lskip
7083           \vrule\kern3pt
7084           \vbox\bgroup
7085               \kern3pt
7086               \hsize=\cartinner
7087               \baselineskip=\normbskip
7088               \lineskip=\normlskip
7089               \parskip=\normpskip
7090               \vskip -\parskip
7091               \comment % For explanation, see the end of def\group.
7092 }
7093 \def\Ecartouche{%
7094               \ifhmode\par\fi
7095               \kern3pt
7096           \egroup
7097           \kern3pt\vrule
7098           \hskip\rskip
7099       \egroup
7100       \cartbot
7101   \egroup
7102   \addgroupbox
7103   \checkinserts
7104 }
7105
7106
7107 % This macro is called at the beginning of all the @example variants,
7108 % inside a group.
7109 \newdimen\nonfillparindent
7110 \def\nonfillstart{%
7111   \aboveenvbreak
7112   \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
7113   \sepspaces % Make spaces be word-separators rather than space tokens.
7114   \let\par = \lisppar % don't ignore blank lines
7115   \obeylines % each line of input is a line of output
7116   \parskip = 0pt
7117   % Turn off paragraph indentation but redefine \indent to emulate
7118   % the normal \indent.
7119   \nonfillparindent=\parindent
7120   \parindent = 0pt
7121   \let\indent\nonfillindent
7122   %
7123   \emergencystretch = 0pt % don't try to avoid overfull boxes
7124   \ifx\nonarrowing\relax
7125     \advance \leftskip by \lispnarrowing
7126     \exdentamount=\lispnarrowing
7127   \else
7128     \let\nonarrowing = \relax
7129   \fi
7130   \let\exdent=\nofillexdent
7131 }
7132
7133 \begingroup
7134 \obeyspaces
7135 % We want to swallow spaces (but not other tokens) after the fake
7136 % @indent in our nonfill-environments, where spaces are normally
7137 % active and set to @tie, resulting in them not being ignored after
7138 % @indent.
7139 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
7140 \gdef\nonfillindentcheck{%
7141 \ifx\temp %
7142 \expandafter\nonfillindentgobble%
7143 \else%
7144 \leavevmode\nonfillindentbox%
7145 \fi%
7146 }%
7147 \endgroup
7148 \def\nonfillindentgobble#1{\nonfillindent}
7149 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
7150
7151 % If you want all examples etc. small: @set dispenvsize small.
7152 % If you want even small examples the full size: @set dispenvsize nosmall.
7153 % This affects the following displayed environments:
7154 %    @example, @display, @format, @lisp
7155 %
7156 \def\smallword{small}
7157 \def\nosmallword{nosmall}
7158 \let\SETdispenvsize\relax
7159 \def\setnormaldispenv{%
7160   \ifx\SETdispenvsize\smallword
7161     % end paragraph for sake of leading, in case document has no blank
7162     % line.  This is redundant with what happens in \aboveenvbreak, but
7163     % we need to do it before changing the fonts, and it's inconvenient
7164     % to change the fonts afterward.
7165     \ifnum \lastpenalty=10000 \else \endgraf \fi
7166     \smallexamplefonts \rm
7167   \fi
7168 }
7169 \def\setsmalldispenv{%
7170   \ifx\SETdispenvsize\nosmallword
7171   \else
7172     \ifnum \lastpenalty=10000 \else \endgraf \fi
7173     \smallexamplefonts \rm
7174   \fi
7175 }
7176
7177 % We often define two environments, @foo and @smallfoo.
7178 % Let's do it in one command.  #1 is the env name, #2 the definition.
7179 \def\makedispenvdef#1#2{%
7180   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
7181   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
7182   \expandafter\let\csname E#1\endcsname \afterenvbreak
7183   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
7184 }
7185
7186 % Define two environment synonyms (#1 and #2) for an environment.
7187 \def\maketwodispenvdef#1#2#3{%
7188   \makedispenvdef{#1}{#3}%
7189   \makedispenvdef{#2}{#3}%
7190 }
7191 %
7192 % @lisp: indented, narrowed, typewriter font;
7193 % @example: same as @lisp.
7194 %
7195 % @smallexample and @smalllisp: use smaller fonts.
7196 % Originally contributed by Pavel@xerox.
7197 %
7198 \maketwodispenvdef{lisp}{example}{%
7199   \nonfillstart
7200   \tt\setupmarkupstyle{example}%
7201   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
7202   \gobble % eat return
7203 }
7204 % @display/@smalldisplay: same as @lisp except keep current font.
7205 %
7206 \makedispenvdef{display}{%
7207   \nonfillstart
7208   \gobble
7209 }
7210
7211 % @format/@smallformat: same as @display except don't narrow margins.
7212 %
7213 \makedispenvdef{format}{%
7214   \let\nonarrowing = t%
7215   \nonfillstart
7216   \gobble
7217 }
7218
7219 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
7220 \envdef\flushleft{%
7221   \let\nonarrowing = t%
7222   \nonfillstart
7223   \gobble
7224 }
7225 \let\Eflushleft = \afterenvbreak
7226
7227 % @flushright.
7228 %
7229 \envdef\flushright{%
7230   \let\nonarrowing = t%
7231   \nonfillstart
7232   \advance\leftskip by 0pt plus 1fill\relax
7233   \gobble
7234 }
7235 \let\Eflushright = \afterenvbreak
7236
7237
7238 % @raggedright does more-or-less normal line breaking but no right
7239 % justification.  From plain.tex.  Don't stretch around special
7240 % characters in urls in this environment, since the stretch at the right
7241 % should be enough.
7242 \envdef\raggedright{%
7243   \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
7244   \def\urefprestretchamount{0pt}%
7245   \def\urefpoststretchamount{0pt}%
7246 }
7247 \let\Eraggedright\par
7248
7249 \envdef\raggedleft{%
7250   \parindent=0pt \leftskip0pt plus2em
7251   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7252   \hbadness=10000 % Last line will usually be underfull, so turn off
7253                   % badness reporting.
7254 }
7255 \let\Eraggedleft\par
7256
7257 \envdef\raggedcenter{%
7258   \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
7259   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7260   \hbadness=10000 % Last line will usually be underfull, so turn off
7261                   % badness reporting.
7262 }
7263 \let\Eraggedcenter\par
7264
7265
7266 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
7267 % and narrows the margins.  We keep \parskip nonzero in general, since
7268 % we're doing normal filling.  So, when using \aboveenvbreak and
7269 % \afterenvbreak, temporarily make \parskip 0.
7270 %
7271 \makedispenvdef{quotation}{\quotationstart}
7272 %
7273 \def\quotationstart{%
7274   \indentedblockstart % same as \indentedblock, but increase right margin too.
7275   \ifx\nonarrowing\relax
7276     \advance\rightskip by \lispnarrowing
7277   \fi
7278   \parsearg\quotationlabel
7279 }
7280
7281 % We have retained a nonzero parskip for the environment, since we're
7282 % doing normal filling.
7283 %
7284 \def\Equotation{%
7285   \par
7286   \ifx\quotationauthor\thisisundefined\else
7287     % indent a bit.
7288     \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
7289   \fi
7290   {\parskip=0pt \afterenvbreak}%
7291 }
7292 \def\Esmallquotation{\Equotation}
7293
7294 % If we're given an argument, typeset it in bold with a colon after.
7295 \def\quotationlabel#1{%
7296   \def\temp{#1}%
7297   \ifx\temp\empty \else
7298     {\bf #1: }%
7299   \fi
7300 }
7301
7302 % @indentedblock is like @quotation, but indents only on the left and
7303 % has no optional argument.
7304
7305 \makedispenvdef{indentedblock}{\indentedblockstart}
7306 %
7307 \def\indentedblockstart{%
7308   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
7309   \parindent=0pt
7310   %
7311   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
7312   \ifx\nonarrowing\relax
7313     \advance\leftskip by \lispnarrowing
7314     \exdentamount = \lispnarrowing
7315   \else
7316     \let\nonarrowing = \relax
7317   \fi
7318 }
7319
7320 % Keep a nonzero parskip for the environment, since we're doing normal filling.
7321 %
7322 \def\Eindentedblock{%
7323   \par
7324   {\parskip=0pt \afterenvbreak}%
7325 }
7326 \def\Esmallindentedblock{\Eindentedblock}
7327
7328
7329 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
7330 % If we want to allow any <char> as delimiter,
7331 % we need the curly braces so that makeinfo sees the @verb command, eg:
7332 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
7333 %
7334 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
7335 %
7336 % [Knuth] p.344; only we need to do the other characters Texinfo sets
7337 % active too.  Otherwise, they get lost as the first character on a
7338 % verbatim line.
7339 \def\dospecials{%
7340   \do\ \do\\\do\{\do\}\do\$\do\&%
7341   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
7342   \do\<\do\>\do\|\do\@\do+\do\"%
7343   % Don't do the quotes -- if we do, @set txicodequoteundirected and
7344   % @set txicodequotebacktick will not have effect on @verb and
7345   % @verbatim, and ?` and !` ligatures won't get disabled.
7346   %\do\`\do\'%
7347 }
7348 %
7349 % [Knuth] p. 380
7350 \def\uncatcodespecials{%
7351   \def\do##1{\catcode`##1=\other}\dospecials}
7352 %
7353 % Setup for the @verb command.
7354 %
7355 % Eight spaces for a tab
7356 \begingroup
7357   \catcode`\^^I=\active
7358   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
7359 \endgroup
7360 %
7361 \def\setupverb{%
7362   \tt  % easiest (and conventionally used) font for verbatim
7363   \def\par{\leavevmode\endgraf}%
7364   \setupmarkupstyle{verb}%
7365   \tabeightspaces
7366   % Respect line breaks,
7367   % print special symbols as themselves, and
7368   % make each space count
7369   % must do in this order:
7370   \obeylines \uncatcodespecials \sepspaces
7371 }
7372
7373 % Setup for the @verbatim environment
7374 %
7375 % Real tab expansion.
7376 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
7377 %
7378 % We typeset each line of the verbatim in an \hbox, so we can handle
7379 % tabs.  The \global is in case the verbatim line starts with an accent,
7380 % or some other command that starts with a begin-group.  Otherwise, the
7381 % entire \verbbox would disappear at the corresponding end-group, before
7382 % it is typeset.  Meanwhile, we can't have nested verbatim commands
7383 % (can we?), so the \global won't be overwriting itself.
7384 \newbox\verbbox
7385 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
7386 %
7387 \begingroup
7388   \catcode`\^^I=\active
7389   \gdef\tabexpand{%
7390     \catcode`\^^I=\active
7391     \def^^I{\leavevmode\egroup
7392       \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
7393       \divide\dimen\verbbox by\tabw
7394       \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
7395       \advance\dimen\verbbox by\tabw  % advance to next multiple of \tabw
7396       \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
7397     }%
7398   }
7399 \endgroup
7400
7401 % start the verbatim environment.
7402 \def\setupverbatim{%
7403   \let\nonarrowing = t%
7404   \nonfillstart
7405   \tt % easiest (and conventionally used) font for verbatim
7406   % The \leavevmode here is for blank lines.  Otherwise, we would
7407   % never \starttabox and the \egroup would end verbatim mode.
7408   \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
7409   \tabexpand
7410   \setupmarkupstyle{verbatim}%
7411   % Respect line breaks,
7412   % print special symbols as themselves, and
7413   % make each space count.
7414   % Must do in this order:
7415   \obeylines \uncatcodespecials \sepspaces
7416   \everypar{\starttabbox}%
7417 }
7418
7419 % Do the @verb magic: verbatim text is quoted by unique
7420 % delimiter characters.  Before first delimiter expect a
7421 % right brace, after last delimiter expect closing brace:
7422 %
7423 %    \def\doverb'{'<char>#1<char>'}'{#1}
7424 %
7425 % [Knuth] p. 382; only eat outer {}
7426 \begingroup
7427   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
7428   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
7429 \endgroup
7430 %
7431 \def\verb{\begingroup\setupverb\doverb}
7432 %
7433 %
7434 % Do the @verbatim magic: define the macro \doverbatim so that
7435 % the (first) argument ends when '@end verbatim' is reached, ie:
7436 %
7437 %     \def\doverbatim#1@end verbatim{#1}
7438 %
7439 % For Texinfo it's a lot easier than for LaTeX,
7440 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
7441 % we need not redefine '\', '{' and '}'.
7442 %
7443 % Inspired by LaTeX's verbatim command set [latex.ltx]
7444 %
7445 \begingroup
7446   \catcode`\ =\active
7447   \obeylines %
7448   % ignore everything up to the first ^^M, that's the newline at the end
7449   % of the @verbatim input line itself.  Otherwise we get an extra blank
7450   % line in the output.
7451   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
7452   % We really want {...\end verbatim} in the body of the macro, but
7453   % without the active space; thus we have to use \xdef and \gobble.
7454 \endgroup
7455 %
7456 \envdef\verbatim{%
7457     \setupverbatim\doverbatim
7458 }
7459 \let\Everbatim = \afterenvbreak
7460
7461
7462 % @verbatiminclude FILE - insert text of file in verbatim environment.
7463 %
7464 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
7465 %
7466 \def\doverbatiminclude#1{%
7467   {%
7468     \makevalueexpandable
7469     \setupverbatim
7470     \indexnofonts       % Allow `@@' and other weird things in file names.
7471     \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
7472     \input #1
7473     \afterenvbreak
7474   }%
7475 }
7476
7477 % @copying ... @end copying.
7478 % Save the text away for @insertcopying later.
7479 %
7480 % We save the uninterpreted tokens, rather than creating a box.
7481 % Saving the text in a box would be much easier, but then all the
7482 % typesetting commands (@smallbook, font changes, etc.) have to be done
7483 % beforehand -- and a) we want @copying to be done first in the source
7484 % file; b) letting users define the frontmatter in as flexible order as
7485 % possible is desirable.
7486 %
7487 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
7488 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
7489 %
7490 \def\insertcopying{%
7491   \begingroup
7492     \parindent = 0pt  % paragraph indentation looks wrong on title page
7493     \scanexp\copyingtext
7494   \endgroup
7495 }
7496
7497
7498 \message{defuns,}
7499 % @defun etc.
7500
7501 \newskip\defbodyindent \defbodyindent=.4in
7502 \newskip\defargsindent \defargsindent=50pt
7503 \newskip\deflastargmargin \deflastargmargin=18pt
7504 \newcount\defunpenalty
7505
7506 % Start the processing of @deffn:
7507 \def\startdefun{%
7508   \ifnum\lastpenalty<10000
7509     \medbreak
7510     \defunpenalty=10003 % Will keep this @deffn together with the
7511                         % following @def command, see below.
7512   \else
7513     % If there are two @def commands in a row, we'll have a \nobreak,
7514     % which is there to keep the function description together with its
7515     % header.  But if there's nothing but headers, we need to allow a
7516     % break somewhere.  Check specifically for penalty 10002, inserted
7517     % by \printdefunline, instead of 10000, since the sectioning
7518     % commands also insert a nobreak penalty, and we don't want to allow
7519     % a break between a section heading and a defun.
7520     %
7521     % As a further refinement, we avoid "club" headers by signalling
7522     % with penalty of 10003 after the very first @deffn in the
7523     % sequence (see above), and penalty of 10002 after any following
7524     % @def command.
7525     \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
7526     %
7527     % Similarly, after a section heading, do not allow a break.
7528     % But do insert the glue.
7529     \medskip  % preceded by discardable penalty, so not a breakpoint
7530   \fi
7531   %
7532   \parindent=0in
7533   \advance\leftskip by \defbodyindent
7534   \exdentamount=\defbodyindent
7535 }
7536
7537 \def\dodefunx#1{%
7538   % First, check whether we are in the right environment:
7539   \checkenv#1%
7540   %
7541   % As above, allow line break if we have multiple x headers in a row.
7542   % It's not a great place, though.
7543   \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
7544   %
7545   % And now, it's time to reuse the body of the original defun:
7546   \expandafter\gobbledefun#1%
7547 }
7548 \def\gobbledefun#1\startdefun{}
7549
7550 % \printdefunline \deffnheader{text}
7551 %
7552 \def\printdefunline#1#2{%
7553   \begingroup
7554     % call \deffnheader:
7555     #1#2 \endheader
7556     % common ending:
7557     \interlinepenalty = 10000
7558     \advance\rightskip by 0pt plus 1fil\relax
7559     \endgraf
7560     \nobreak\vskip -\parskip
7561     \penalty\defunpenalty  % signal to \startdefun and \dodefunx
7562     % Some of the @defun-type tags do not enable magic parentheses,
7563     % rendering the following check redundant.  But we don't optimize.
7564     \checkparencounts
7565   \endgroup
7566 }
7567
7568 \def\Edefun{\endgraf\medbreak}
7569
7570 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7571 % the only thing remaining is to define \deffnheader.
7572 %
7573 \def\makedefun#1{%
7574   \expandafter\let\csname E#1\endcsname = \Edefun
7575   \edef\temp{\noexpand\domakedefun
7576     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
7577   \temp
7578 }
7579
7580 % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
7581 %
7582 % Define \deffn and \deffnx, without parameters.
7583 % \deffnheader has to be defined explicitly.
7584 %
7585 \def\domakedefun#1#2#3{%
7586   \envdef#1{%
7587     \startdefun
7588     \doingtypefnfalse    % distinguish typed functions from all else
7589     \parseargusing\activeparens{\printdefunline#3}%
7590   }%
7591   \def#2{\dodefunx#1}%
7592   \def#3%
7593 }
7594
7595 \newif\ifdoingtypefn       % doing typed function?
7596 \newif\ifrettypeownline    % typeset return type on its own line?
7597
7598 % @deftypefnnewline on|off says whether the return type of typed functions
7599 % are printed on their own line.  This affects @deftypefn, @deftypefun,
7600 % @deftypeop, and @deftypemethod.
7601
7602 \parseargdef\deftypefnnewline{%
7603   \def\temp{#1}%
7604   \ifx\temp\onword
7605     \expandafter\let\csname SETtxideftypefnnl\endcsname
7606       = \empty
7607   \else\ifx\temp\offword
7608     \expandafter\let\csname SETtxideftypefnnl\endcsname
7609       = \relax
7610   \else
7611     \errhelp = \EMsimple
7612     \errmessage{Unknown @txideftypefnnl value `\temp',
7613                 must be on|off}%
7614   \fi\fi
7615 }
7616
7617 % Untyped functions:
7618
7619 % @deffn category name args
7620 \makedefun{deffn}{\deffngeneral{}}
7621
7622 % @deffn category class name args
7623 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7624
7625 % \defopon {category on}class name args
7626 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7627
7628 % \deffngeneral {subind}category name args
7629 %
7630 \def\deffngeneral#1#2 #3 #4\endheader{%
7631   % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7632   \dosubind{fn}{\code{#3}}{#1}%
7633   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7634 }
7635
7636 % Typed functions:
7637
7638 % @deftypefn category type name args
7639 \makedefun{deftypefn}{\deftypefngeneral{}}
7640
7641 % @deftypeop category class type name args
7642 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7643
7644 % \deftypeopon {category on}class type name args
7645 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7646
7647 % \deftypefngeneral {subind}category type name args
7648 %
7649 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7650   \dosubind{fn}{\code{#4}}{#1}%
7651   \doingtypefntrue
7652   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7653 }
7654
7655 % Typed variables:
7656
7657 % @deftypevr category type var args
7658 \makedefun{deftypevr}{\deftypecvgeneral{}}
7659
7660 % @deftypecv category class type var args
7661 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7662
7663 % \deftypecvof {category of}class type var args
7664 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7665
7666 % \deftypecvgeneral {subind}category type var args
7667 %
7668 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7669   \dosubind{vr}{\code{#4}}{#1}%
7670   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7671 }
7672
7673 % Untyped variables:
7674
7675 % @defvr category var args
7676 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7677
7678 % @defcv category class var args
7679 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7680
7681 % \defcvof {category of}class var args
7682 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7683
7684 % Types:
7685
7686 % @deftp category name args
7687 \makedefun{deftp}#1 #2 #3\endheader{%
7688   \doind{tp}{\code{#2}}%
7689   \defname{#1}{}{#2}\defunargs{#3\unskip}%
7690 }
7691
7692 % Remaining @defun-like shortcuts:
7693 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7694 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7695 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7696 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7697 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7698 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7699 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7700 \makedefun{defmethod}{\defopon\putwordMethodon}
7701 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7702 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7703 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7704
7705 % \defname, which formats the name of the @def (not the args).
7706 % #1 is the category, such as "Function".
7707 % #2 is the return type, if any.
7708 % #3 is the function name.
7709 %
7710 % We are followed by (but not passed) the arguments, if any.
7711 %
7712 \def\defname#1#2#3{%
7713   \par
7714   % Get the values of \leftskip and \rightskip as they were outside the @def...
7715   \advance\leftskip by -\defbodyindent
7716   %
7717   % Determine if we are typesetting the return type of a typed function
7718   % on a line by itself.
7719   \rettypeownlinefalse
7720   \ifdoingtypefn  % doing a typed function specifically?
7721     % then check user option for putting return type on its own line:
7722     \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7723       \rettypeownlinetrue
7724     \fi
7725   \fi
7726   %
7727   % How we'll format the category name.  Putting it in brackets helps
7728   % distinguish it from the body text that may end up on the next line
7729   % just below it.
7730   \def\temp{#1}%
7731   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7732   %
7733   % Figure out line sizes for the paragraph shape.  We'll always have at
7734   % least two.
7735   \tempnum = 2
7736   %
7737   % The first line needs space for \box0; but if \rightskip is nonzero,
7738   % we need only space for the part of \box0 which exceeds it:
7739   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
7740   %
7741   % If doing a return type on its own line, we'll have another line.
7742   \ifrettypeownline
7743     \advance\tempnum by 1
7744     \def\maybeshapeline{0in \hsize}%
7745   \else
7746     \def\maybeshapeline{}%
7747   \fi
7748   %
7749   % The continuations:
7750   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
7751   %
7752   % The final paragraph shape:
7753   \parshape \tempnum  0in \dimen0  \maybeshapeline  \defargsindent \dimen2
7754   %
7755   % Put the category name at the right margin.
7756   \noindent
7757   \hbox to 0pt{%
7758     \hfil\box0 \kern-\hsize
7759     % \hsize has to be shortened this way:
7760     \kern\leftskip
7761     % Intentionally do not respect \rightskip, since we need the space.
7762   }%
7763   %
7764   % Allow all lines to be underfull without complaint:
7765   \tolerance=10000 \hbadness=10000
7766   \exdentamount=\defbodyindent
7767   {%
7768     % defun fonts. We use typewriter by default (used to be bold) because:
7769     % . we're printing identifiers, they should be in tt in principle.
7770     % . in languages with many accents, such as Czech or French, it's
7771     %   common to leave accents off identifiers.  The result looks ok in
7772     %   tt, but exceedingly strange in rm.
7773     % . we don't want -- and --- to be treated as ligatures.
7774     % . this still does not fix the ?` and !` ligatures, but so far no
7775     %   one has made identifiers using them :).
7776     \df \tt
7777     \def\temp{#2}% text of the return type
7778     \ifx\temp\empty\else
7779       \tclose{\temp}% typeset the return type
7780       \ifrettypeownline
7781         % put return type on its own line; prohibit line break following:
7782         \hfil\vadjust{\nobreak}\break  
7783       \else
7784         \space  % type on same line, so just followed by a space
7785       \fi
7786     \fi           % no return type
7787     #3% output function name
7788   }%
7789   {\rm\enskip}% hskip 0.5 em of \tenrm
7790   %
7791   \boldbrax
7792   % arguments will be output next, if any.
7793 }
7794
7795 % Print arguments in slanted roman (not ttsl), inconsistently with using
7796 % tt for the name.  This is because literal text is sometimes needed in
7797 % the argument list (groff manual), and ttsl and tt are not very
7798 % distinguishable.  Prevent hyphenation at `-' chars.
7799 %
7800 \def\defunargs#1{%
7801   % use sl by default (not ttsl),
7802   % tt for the names.
7803   \df \sl \hyphenchar\font=0
7804   %
7805   % On the other hand, if an argument has two dashes (for instance), we
7806   % want a way to get ttsl.  We used to recommend @var for that, so
7807   % leave the code in, but it's strange for @var to lead to typewriter.
7808   % Nowadays we recommend @code, since the difference between a ttsl hyphen
7809   % and a tt hyphen is pretty tiny.  @code also disables ?` !`.
7810   \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7811   #1%
7812   \sl\hyphenchar\font=45
7813 }
7814
7815 % We want ()&[] to print specially on the defun line.
7816 %
7817 \def\activeparens{%
7818   \catcode`\(=\active \catcode`\)=\active
7819   \catcode`\[=\active \catcode`\]=\active
7820   \catcode`\&=\active
7821 }
7822
7823 % Make control sequences which act like normal parenthesis chars.
7824 \let\lparen = ( \let\rparen = )
7825
7826 % Be sure that we always have a definition for `(', etc.  For example,
7827 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7828 % so TeX would otherwise complain about undefined control sequence.
7829 {
7830   \activeparens
7831   \global\let(=\lparen \global\let)=\rparen
7832   \global\let[=\lbrack \global\let]=\rbrack
7833   \global\let& = \&
7834
7835   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7836   \gdef\magicamp{\let&=\amprm}
7837 }
7838
7839 \newcount\parencount
7840
7841 % If we encounter &foo, then turn on ()-hacking afterwards
7842 \newif\ifampseen
7843 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7844
7845 \def\parenfont{%
7846   \ifampseen
7847     % At the first level, print parens in roman,
7848     % otherwise use the default font.
7849     \ifnum \parencount=1 \rm \fi
7850   \else
7851     % The \sf parens (in \boldbrax) actually are a little bolder than
7852     % the contained text.  This is especially needed for [ and ] .
7853     \sf
7854   \fi
7855 }
7856 \def\infirstlevel#1{%
7857   \ifampseen
7858     \ifnum\parencount=1
7859       #1%
7860     \fi
7861   \fi
7862 }
7863 \def\bfafterword#1 {#1 \bf}
7864
7865 \def\opnr{%
7866   \global\advance\parencount by 1
7867   {\parenfont(}%
7868   \infirstlevel \bfafterword
7869 }
7870 \def\clnr{%
7871   {\parenfont)}%
7872   \infirstlevel \sl
7873   \global\advance\parencount by -1
7874 }
7875
7876 \newcount\brackcount
7877 \def\lbrb{%
7878   \global\advance\brackcount by 1
7879   {\bf[}%
7880 }
7881 \def\rbrb{%
7882   {\bf]}%
7883   \global\advance\brackcount by -1
7884 }
7885
7886 \def\checkparencounts{%
7887   \ifnum\parencount=0 \else \badparencount \fi
7888   \ifnum\brackcount=0 \else \badbrackcount \fi
7889 }
7890 % these should not use \errmessage; the glibc manual, at least, actually
7891 % has such constructs (when documenting function pointers).
7892 \def\badparencount{%
7893   \message{Warning: unbalanced parentheses in @def...}%
7894   \global\parencount=0
7895 }
7896 \def\badbrackcount{%
7897   \message{Warning: unbalanced square brackets in @def...}%
7898   \global\brackcount=0
7899 }
7900
7901
7902 \message{macros,}
7903 % @macro.
7904
7905 % To do this right we need a feature of e-TeX, \scantokens,
7906 % which we arrange to emulate with a temporary file in ordinary TeX.
7907 \ifx\eTeXversion\thisisundefined
7908   \newwrite\macscribble
7909   \def\scantokens#1{%
7910     \toks0={#1}%
7911     \immediate\openout\macscribble=\jobname.tmp
7912     \immediate\write\macscribble{\the\toks0}%
7913     \immediate\closeout\macscribble
7914     \input \jobname.tmp
7915   }
7916 \fi
7917
7918 \let\aftermacroxxx\relax
7919 \def\aftermacro{\aftermacroxxx}
7920
7921 % alias because \c means cedilla in @tex or @math
7922 \let\texinfoc=\c
7923
7924 % Used at the time of macro expansion.
7925 % Argument is macro body with arguments substituted
7926 \def\scanmacro#1{%
7927   \newlinechar`\^^M
7928   \def\xeatspaces{\eatspaces}%
7929   %
7930   % Process the macro body under the current catcode regime.
7931   \scantokens{#1\texinfoc}\aftermacro%
7932   %
7933   % The \texinfoc is to remove the \newlinechar added by \scantokens, and
7934   % can be noticed by \parsearg.
7935   %   The \aftermacro allows a \comment at the end of the macro definition
7936   % to duplicate itself past the final \newlinechar added by \scantokens:
7937   % this is used in the definition of \group to comment out a newline.  We
7938   % don't do the same for \c to support Texinfo files with macros that ended
7939   % with a @c, which should no longer be necessary.
7940   %   We avoid surrounding the call to \scantokens with \bgroup and \egroup
7941   % to allow macros to open or close groups themselves.
7942 }
7943
7944 % Used for copying and captions
7945 \def\scanexp#1{%
7946   \expandafter\scanmacro\expandafter{#1}%
7947 }
7948
7949 \newcount\paramno   % Count of parameters
7950 \newtoks\macname    % Macro name
7951 \newif\ifrecursive  % Is it recursive?
7952
7953 % List of all defined macros in the form
7954 %    \definedummyword\macro1\definedummyword\macro2...
7955 % Currently is also contains all @aliases; the list can be split
7956 % if there is a need.
7957 \def\macrolist{}
7958
7959 % Add the macro to \macrolist
7960 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7961 \def\addtomacrolistxxx#1{%
7962      \toks0 = \expandafter{\macrolist\definedummyword#1}%
7963      \xdef\macrolist{\the\toks0}%
7964 }
7965
7966 % Utility routines.
7967 % This does \let #1 = #2, with \csnames; that is,
7968 %   \let \csname#1\endcsname = \csname#2\endcsname
7969 % (except of course we have to play expansion games).
7970 %
7971 \def\cslet#1#2{%
7972   \expandafter\let
7973   \csname#1\expandafter\endcsname
7974   \csname#2\endcsname
7975 }
7976
7977 % Trim leading and trailing spaces off a string.
7978 % Concepts from aro-bend problem 15 (see CTAN).
7979 {\catcode`\@=11
7980 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7981 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7982 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7983 \def\unbrace#1{#1}
7984 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7985 }
7986
7987 % Trim a single trailing ^^M off a string.
7988 {\catcode`\^^M=\other \catcode`\Q=3%
7989 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7990 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7991 \gdef\eatcrb#1Q#2Q{#1}%
7992 }
7993
7994 % Macro bodies are absorbed as an argument in a context where
7995 % all characters are catcode 10, 11 or 12, except \ which is active
7996 % (as in normal texinfo). It is necessary to change the definition of \
7997 % to recognize macro arguments; this is the job of \mbodybackslash.
7998 %
7999 % Non-ASCII encodings make 8-bit characters active, so un-activate
8000 % them to avoid their expansion.  Must do this non-globally, to
8001 % confine the change to the current group.
8002 %
8003 % It's necessary to have hard CRs when the macro is executed. This is
8004 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
8005 % body, and then making it the \newlinechar in \scanmacro.
8006 %
8007 \def\scanctxt{% used as subroutine
8008   \catcode`\"=\other
8009   \catcode`\+=\other
8010   \catcode`\<=\other
8011   \catcode`\>=\other
8012   \catcode`\^=\other
8013   \catcode`\_=\other
8014   \catcode`\|=\other
8015   \catcode`\~=\other
8016   \passthroughcharstrue
8017 }
8018
8019 \def\scanargctxt{% used for copying and captions, not macros.
8020   \scanctxt
8021   \catcode`\@=\other
8022   \catcode`\\=\other
8023   \catcode`\^^M=\other
8024 }
8025
8026 \def\macrobodyctxt{% used for @macro definitions
8027   \scanctxt
8028   \catcode`\ =\other
8029   \catcode`\@=\other
8030   \catcode`\{=\other
8031   \catcode`\}=\other
8032   \catcode`\^^M=\other
8033   \usembodybackslash
8034 }
8035
8036 % Used when scanning braced macro arguments.  Note, however, that catcode
8037 % changes here are ineffectual if the macro invocation was nested inside
8038 % an argument to another Texinfo command.
8039 \def\macroargctxt{%
8040   \scanctxt
8041   \catcode`\ =\active
8042   \catcode`\^^M=\other
8043   \catcode`\\=\active
8044 }
8045
8046 \def\macrolineargctxt{% used for whole-line arguments without braces
8047   \scanctxt
8048   \catcode`\{=\other
8049   \catcode`\}=\other
8050 }
8051
8052 % \mbodybackslash is the definition of \ in @macro bodies.
8053 % It maps \foo\ => \csname macarg.foo\endcsname => #N
8054 % where N is the macro parameter number.
8055 % We define \csname macarg.\endcsname to be \realbackslash, so
8056 % \\ in macro replacement text gets you a backslash.
8057 %
8058 {\catcode`@=0 @catcode`@\=@active
8059  @gdef@usembodybackslash{@let\=@mbodybackslash}
8060  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
8061 }
8062 \expandafter\def\csname macarg.\endcsname{\realbackslash}
8063
8064 \def\margbackslash#1{\char`\#1 }
8065
8066 \def\macro{\recursivefalse\parsearg\macroxxx}
8067 \def\rmacro{\recursivetrue\parsearg\macroxxx}
8068
8069 \def\macroxxx#1{%
8070   \getargs{#1}% now \macname is the macname and \argl the arglist
8071   \ifx\argl\empty       % no arguments
8072      \paramno=0\relax
8073   \else
8074      \expandafter\parsemargdef \argl;%
8075      \if\paramno>256\relax
8076        \ifx\eTeXversion\thisisundefined
8077          \errhelp = \EMsimple
8078          \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
8079        \fi
8080      \fi
8081   \fi
8082   \if1\csname ismacro.\the\macname\endcsname
8083      \message{Warning: redefining \the\macname}%
8084   \else
8085      \expandafter\ifx\csname \the\macname\endcsname \relax
8086      \else \errmessage{Macro name \the\macname\space already defined}\fi
8087      \global\cslet{macsave.\the\macname}{\the\macname}%
8088      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
8089      \addtomacrolist{\the\macname}%
8090   \fi
8091   \begingroup \macrobodyctxt
8092   \ifrecursive \expandafter\parsermacbody
8093   \else \expandafter\parsemacbody
8094   \fi}
8095
8096 \parseargdef\unmacro{%
8097   \if1\csname ismacro.#1\endcsname
8098     \global\cslet{#1}{macsave.#1}%
8099     \global\expandafter\let \csname ismacro.#1\endcsname=0%
8100     % Remove the macro name from \macrolist:
8101     \begingroup
8102       \expandafter\let\csname#1\endcsname \relax
8103       \let\definedummyword\unmacrodo
8104       \xdef\macrolist{\macrolist}%
8105     \endgroup
8106   \else
8107     \errmessage{Macro #1 not defined}%
8108   \fi
8109 }
8110
8111 % Called by \do from \dounmacro on each macro.  The idea is to omit any
8112 % macro definitions that have been changed to \relax.
8113 %
8114 \def\unmacrodo#1{%
8115   \ifx #1\relax
8116     % remove this
8117   \else
8118     \noexpand\definedummyword \noexpand#1%
8119   \fi
8120 }
8121
8122 % \getargs -- Parse the arguments to a @macro line.  Set \macname to
8123 % the name of the macro, and \argl to the braced argument list.
8124 \def\getargs#1{\getargsxxx#1{}}
8125 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
8126 \def\getmacname#1 #2\relax{\macname={#1}}
8127 \def\getmacargs#1{\def\argl{#1}}
8128 % This made use of the feature that if the last token of a
8129 % <parameter list> is #, then the preceding argument is delimited by
8130 % an opening brace, and that opening brace is not consumed.
8131
8132 % Parse the optional {params} list to @macro or @rmacro.
8133 % Set \paramno to the number of arguments,
8134 % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
8135 % three-param macro.)  Define \macarg.BLAH for each BLAH in the params
8136 % list to some hook where the argument is to be expanded.  If there are
8137 % less than 10 arguments that hook is to be replaced by ##N where N
8138 % is the position in that list, that is to say the macro arguments are to be
8139 % defined `a la TeX in the macro body.  
8140 %
8141 % That gets used by \mbodybackslash (above).
8142 %
8143 % If there are 10 or more arguments, a different technique is used: see
8144 % \parsemmanyargdef.
8145 %
8146 \def\parsemargdef#1;{%
8147   \paramno=0\def\paramlist{}%
8148   \let\hash\relax
8149   % \hash is redefined to `#' later to get it into definitions
8150   \let\xeatspaces\relax
8151   \parsemargdefxxx#1,;,%
8152   \ifnum\paramno<10\relax\else
8153     \paramno0\relax
8154     \parsemmanyargdef@@#1,;,% 10 or more arguments
8155   \fi
8156 }
8157 \def\parsemargdefxxx#1,{%
8158   \if#1;\let\next=\relax
8159   \else \let\next=\parsemargdefxxx
8160     \advance\paramno by 1
8161     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
8162         {\xeatspaces{\hash\the\paramno}}%
8163     \edef\paramlist{\paramlist\hash\the\paramno,}%
8164   \fi\next}
8165
8166 % \parsemacbody, \parsermacbody
8167 %
8168 % Read recursive and nonrecursive macro bodies. (They're different since
8169 % rec and nonrec macros end differently.)
8170
8171 % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro 
8172 % body to be transformed.
8173 % Set \macrobody to the body of the macro, and call \defmacro.
8174 %
8175 {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
8176 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8177 {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
8178 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8179
8180 % Make @ a letter, so that we can make private-to-Texinfo macro names.
8181 \edef\texiatcatcode{\the\catcode`\@}
8182 \catcode `@=11\relax
8183
8184 %%%%%%%%%%%%%% Code for > 10 arguments only   %%%%%%%%%%%%%%%%%%
8185
8186 % If there are 10 or more arguments, a different technique is used, where the
8187 % hook remains in the body, and when macro is to be expanded the body is
8188 % processed again to replace the arguments.
8189 %
8190 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
8191 % argument N value and then \edef the body (nothing else will expand because of
8192 % the catcode regime under which the body was input).
8193 %
8194 % If you compile with TeX (not eTeX), and you have macros with 10 or more
8195 % arguments, no macro can have more than 256 arguments (else error).
8196 %
8197 % In case that there are 10 or more arguments we parse again the arguments
8198 % list to set new definitions for the \macarg.BLAH macros corresponding to
8199 % each BLAH argument. It was anyhow needed to parse already once this list
8200 % in order to count the arguments, and as macros with at most 9 arguments
8201 % are by far more frequent than macro with 10 or more arguments, defining
8202 % twice the \macarg.BLAH macros does not cost too much processing power.
8203 \def\parsemmanyargdef@@#1,{%
8204   \if#1;\let\next=\relax
8205   \else 
8206     \let\next=\parsemmanyargdef@@
8207     \edef\tempb{\eatspaces{#1}}%
8208     \expandafter\def\expandafter\tempa
8209        \expandafter{\csname macarg.\tempb\endcsname}%
8210     % Note that we need some extra \noexpand\noexpand, this is because we
8211     % don't want \the  to be expanded in the \parsermacbody  as it uses an
8212     % \xdef .
8213     \expandafter\edef\tempa
8214       {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
8215     \advance\paramno by 1\relax
8216   \fi\next}
8217
8218
8219 \let\endargs@\relax
8220 \let\nil@\relax
8221 \def\nilm@{\nil@}%
8222 \long\def\nillm@{\nil@}%
8223
8224 % This macro is expanded during the Texinfo macro expansion, not during its
8225 % definition.  It gets all the arguments' values and assigns them to macros
8226 % macarg.ARGNAME
8227 %
8228 % #1 is the macro name
8229 % #2 is the list of argument names
8230 % #3 is the list of argument values
8231 \def\getargvals@#1#2#3{%
8232   \def\macargdeflist@{}%
8233   \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
8234   \def\paramlist{#2,\nil@}%
8235   \def\macroname{#1}%
8236   \begingroup
8237   \macroargctxt
8238   \def\argvaluelist{#3,\nil@}%
8239   \def\@tempa{#3}%
8240   \ifx\@tempa\empty
8241     \setemptyargvalues@
8242   \else
8243     \getargvals@@
8244   \fi
8245 }
8246 \def\getargvals@@{%
8247   \ifx\paramlist\nilm@
8248       % Some sanity check needed here that \argvaluelist is also empty.
8249       \ifx\argvaluelist\nillm@
8250       \else
8251         \errhelp = \EMsimple
8252         \errmessage{Too many arguments in macro `\macroname'!}%
8253       \fi
8254       \let\next\macargexpandinbody@
8255   \else
8256     \ifx\argvaluelist\nillm@
8257        % No more arguments values passed to macro.  Set remaining named-arg
8258        % macros to empty.
8259        \let\next\setemptyargvalues@
8260     \else
8261       % pop current arg name into \@tempb
8262       \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
8263       \expandafter\@tempa\expandafter{\paramlist}%
8264        % pop current argument value into \@tempc
8265       \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
8266       \expandafter\@tempa\expandafter{\argvaluelist}%
8267        % Here \@tempb is the current arg name and \@tempc is the current arg value.
8268        % First place the new argument macro definition into \@tempd
8269        \expandafter\macname\expandafter{\@tempc}%
8270        \expandafter\let\csname macarg.\@tempb\endcsname\relax
8271        \expandafter\def\expandafter\@tempe\expandafter{%
8272          \csname macarg.\@tempb\endcsname}%
8273        \edef\@tempd{\long\def\@tempe{\the\macname}}%
8274        \push@\@tempd\macargdeflist@
8275        \let\next\getargvals@@
8276     \fi
8277   \fi
8278   \next
8279 }
8280
8281 \def\push@#1#2{%
8282   \expandafter\expandafter\expandafter\def
8283   \expandafter\expandafter\expandafter#2%
8284   \expandafter\expandafter\expandafter{%
8285   \expandafter#1#2}%
8286 }
8287
8288 % Replace arguments by their values in the macro body, and place the result
8289 % in macro \@tempa.
8290
8291 \def\macvalstoargs@{%
8292   %  To do this we use the property that token registers that are \the'ed
8293   % within an \edef  expand only once. So we are going to place all argument
8294   % values into respective token registers.
8295   %
8296   % First we save the token context, and initialize argument numbering.
8297   \begingroup
8298     \paramno0\relax
8299     % Then, for each argument number #N, we place the corresponding argument
8300     % value into a new token list register \toks#N
8301     \expandafter\putargsintokens@\saveparamlist@,;,%
8302     % Then, we expand the body so that argument are replaced by their
8303     % values. The trick for values not to be expanded themselves is that they
8304     % are within tokens and that tokens expand only once in an \edef .
8305     \edef\@tempc{\csname mac.\macroname .body\endcsname}%
8306     % Now we restore the token stack pointer to free the token list registers
8307     % which we have used, but we make sure that expanded body is saved after
8308     % group.
8309     \expandafter
8310   \endgroup
8311   \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
8312   }
8313
8314 % Define the named-macro outside of this group and then close this group. 
8315
8316 \def\macargexpandinbody@{% 
8317   \expandafter
8318   \endgroup
8319   \macargdeflist@
8320   % First the replace in body the macro arguments by their values, the result
8321   % is in \@tempa .
8322   \macvalstoargs@
8323   % Then we point at the \norecurse or \gobble (for recursive) macro value
8324   % with \@tempb .
8325   \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
8326   % Depending on whether it is recursive or not, we need some tailing
8327   % \egroup .
8328   \ifx\@tempb\gobble
8329      \let\@tempc\relax
8330   \else
8331      \let\@tempc\egroup
8332   \fi
8333   % And now we do the real job:
8334   \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
8335   \@tempd
8336 }
8337
8338 \def\putargsintokens@#1,{%
8339   \if#1;\let\next\relax
8340   \else
8341     \let\next\putargsintokens@
8342     % First we allocate the new token list register, and give it a temporary
8343     % alias \@tempb .
8344     \toksdef\@tempb\the\paramno
8345     % Then we place the argument value into that token list register.
8346     \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
8347     \expandafter\@tempb\expandafter{\@tempa}%
8348     \advance\paramno by 1\relax
8349   \fi
8350   \next
8351 }
8352
8353 % Trailing missing arguments are set to empty.
8354
8355 \def\setemptyargvalues@{%
8356   \ifx\paramlist\nilm@
8357     \let\next\macargexpandinbody@
8358   \else
8359     \expandafter\setemptyargvaluesparser@\paramlist\endargs@
8360     \let\next\setemptyargvalues@
8361   \fi
8362   \next
8363 }
8364
8365 \def\setemptyargvaluesparser@#1,#2\endargs@{%
8366   \expandafter\def\expandafter\@tempa\expandafter{%
8367     \expandafter\def\csname macarg.#1\endcsname{}}%
8368   \push@\@tempa\macargdeflist@
8369   \def\paramlist{#2}%
8370 }
8371
8372 % #1 is the element target macro
8373 % #2 is the list macro
8374 % #3,#4\endargs@ is the list value
8375 \def\pop@#1#2#3,#4\endargs@{%
8376    \def#1{#3}%
8377    \def#2{#4}%
8378 }
8379 \long\def\longpop@#1#2#3,#4\endargs@{%
8380    \long\def#1{#3}%
8381    \long\def#2{#4}%
8382 }
8383
8384
8385 %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
8386
8387
8388 % This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
8389 %    \macrobody has the body of the macro in it, with placeholders for
8390 % its parameters, looking like "\xeatspaces{\hash 1}".
8391 %    \paramno is the number of parameters
8392 %    \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
8393 % There are eight cases: recursive and nonrecursive macros of zero, one,
8394 % up to nine, and many arguments.
8395 % \xdef is used so that macro definitions will survive the file
8396 % they're defined in: @include reads the file inside a group.
8397 %
8398 \def\defmacro{%
8399   \let\hash=##% convert placeholders to macro parameter chars
8400   \ifnum\paramno=1
8401     \def\xeatspaces##1{##1}%
8402     % This removes the pair of braces around the argument.  We don't
8403     % use \eatspaces, because this can cause ends of lines to be lost
8404     % when the argument to \eatspaces is read, leading to line-based
8405     % commands like "@itemize" not being read correctly.
8406   \else
8407     \let\xeatspaces\relax % suppress expansion
8408   \fi
8409   \ifrecursive   %%%%%%%%%%%%%% Recursive %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8410     \ifcase\paramno
8411     % 0
8412       \expandafter\xdef\csname\the\macname\endcsname{%
8413         \noexpand\scanmacro{\macrobody}}%
8414     \or % 1
8415       \expandafter\xdef\csname\the\macname\endcsname{%
8416          \bgroup
8417          \noexpand\braceorline
8418          \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8419       \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8420         \egroup
8421         \noexpand\scanmacro{\macrobody}%
8422         }%
8423     \else
8424       \ifnum\paramno<10\relax % at most 9
8425         % See non-recursive section below for comments
8426         \expandafter\xdef\csname\the\macname\endcsname{%
8427           \bgroup
8428           \noexpand\expandafter
8429           \noexpand\macroargctxt
8430           \noexpand\expandafter
8431           \expandafter\noexpand\csname\the\macname @@\endcsname}%
8432         \expandafter\xdef\csname\the\macname @@\endcsname##1{%
8433             \noexpand\passargtomacro
8434             \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
8435         \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8436             \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
8437         \expandafter\expandafter
8438         \expandafter\xdef
8439         \expandafter\expandafter
8440           \csname\the\macname @@@@\endcsname\paramlist{%
8441             \egroup\noexpand\scanmacro{\macrobody}}%
8442       \else % 10 or more
8443         \expandafter\xdef\csname\the\macname\endcsname{%
8444           \noexpand\getargvals@{\the\macname}{\argl}%
8445         }%    
8446         \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
8447         \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
8448       \fi
8449     \fi
8450   \else  %%%%%%%%%%%%%%%%%%%%%% Non-recursive %%%%%%%%%%%%%%%%%%%%%%%%%%
8451     \ifcase\paramno
8452     % 0
8453       \expandafter\xdef\csname\the\macname\endcsname{%
8454         \noexpand\scanmacro{\macrobody}}%
8455     \or % 1
8456       \expandafter\xdef\csname\the\macname\endcsname{%
8457          \bgroup
8458          \noexpand\braceorline
8459          \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8460       \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8461         \egroup
8462         \noexpand\scanmacro{\macrobody}%
8463         }%
8464     \else % at most 9
8465       \ifnum\paramno<10\relax
8466         % @MACNAME sets the context for reading the macro argument
8467         % @MACNAME@@ gets the argument, processes backslashes and appends a 
8468         % comma.
8469         % @MACNAME@@@ removes braces surrounding the argument list.
8470         % @MACNAME@@@@ scans the macro body with arguments substituted.
8471         \expandafter\xdef\csname\the\macname\endcsname{%
8472           \bgroup
8473           \noexpand\expandafter  % This \expandafter skip any spaces after the
8474           \noexpand\macroargctxt % macro before we change the catcode of space.
8475           \noexpand\expandafter
8476           \expandafter\noexpand\csname\the\macname @@\endcsname}%
8477         \expandafter\xdef\csname\the\macname @@\endcsname##1{%
8478             \noexpand\passargtomacro
8479             \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
8480         \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8481             \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
8482         \expandafter\expandafter
8483         \expandafter\xdef
8484         \expandafter\expandafter
8485           \csname\the\macname @@@@\endcsname\paramlist{%
8486             \egroup\noexpand\scanmacro{\macrobody}}%
8487       \else % 10 or more:
8488         \expandafter\xdef\csname\the\macname\endcsname{%
8489           \noexpand\getargvals@{\the\macname}{\argl}%
8490         }%
8491         \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
8492         \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
8493       \fi
8494     \fi
8495   \fi}
8496
8497 \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
8498
8499 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
8500
8501
8502 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8503 %
8504 {\catcode`\@=0 \catcode`\\=13  % We need to manipulate \ so use @ as escape
8505 @catcode`@_=11  % private names
8506 @catcode`@!=11  % used as argument separator
8507
8508 % \passargtomacro#1#2 -
8509 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
8510 % compressed to one.
8511 %
8512 % This implementation works by expansion, and not execution (so we cannot use 
8513 % \def or similar).  This reduces the risk of this failing in contexts where 
8514 % complete expansion is done with no execution (for example, in writing out to 
8515 % an auxiliary file for an index entry).
8516
8517 % State is kept in the input stream: the argument passed to
8518 % @look_ahead, @gobble_and_check_finish and @add_segment is
8519 %
8520 % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN  (... rest of input)
8521 %
8522 % where:
8523 % THE_MACRO - name of the macro we want to call
8524 % ARG_RESULT - argument list we build to pass to that macro
8525 % PENDING_BS - either a backslash or nothing
8526 % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
8527
8528 @gdef@passargtomacro#1#2{%
8529   @add_segment #1!{}@relax#2\@_finish\%
8530 }
8531 @gdef@_finish{@_finishx} @global@let@_finishx@relax
8532
8533 % #1 - THE_MACRO ARG_RESULT
8534 % #2 - PENDING_BS
8535 % #3 - NEXT_TOKEN
8536 % #4 used to look ahead
8537 %
8538 % If the next token is not a backslash, process the rest of the argument; 
8539 % otherwise, remove the next token.
8540 @gdef@look_ahead#1!#2#3#4{%
8541   @ifx#4\%
8542    @expandafter@gobble_and_check_finish 
8543   @else
8544    @expandafter@add_segment
8545   @fi#1!{#2}#4#4%
8546 }
8547
8548 % #1 - THE_MACRO ARG_RESULT
8549 % #2 - PENDING_BS
8550 % #3 - NEXT_TOKEN
8551 % #4 should be a backslash, which is gobbled.
8552 % #5 looks ahead
8553 %
8554 % Double backslash found.  Add a single backslash, and look ahead.
8555 @gdef@gobble_and_check_finish#1!#2#3#4#5{%
8556   @add_segment#1\!{}#5#5%
8557 }
8558
8559 @gdef@is_fi{@fi}
8560
8561 % #1 - THE_MACRO ARG_RESULT
8562 % #2 - PENDING_BS
8563 % #3 - NEXT_TOKEN
8564 % #4 is input stream until next backslash
8565 %
8566 % Input stream is either at the start of the argument, or just after a 
8567 % backslash sequence, either a lone backslash, or a doubled backslash.  
8568 % NEXT_TOKEN contains the first token in the input stream: if it is \finish, 
8569 % finish; otherwise, append to ARG_RESULT the segment of the argument up until
8570 % the next backslash.  PENDING_BACKSLASH contains a backslash to represent
8571 % a backslash just before the start of the input stream that has not been
8572 % added to ARG_RESULT.
8573 @gdef@add_segment#1!#2#3#4\{%
8574 @ifx#3@_finish
8575   @call_the_macro#1!%
8576 @else
8577   % append the pending backslash to the result, followed by the next segment
8578   @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
8579   % this @fi is discarded by @look_ahead.
8580   % we can't get rid of it with \expandafter because we don't know how 
8581   % long #4 is.
8582 }
8583
8584 % #1 - THE_MACRO
8585 % #2 - ARG_RESULT
8586 % #3 discards the res of the conditional in @add_segment, and @is_fi ends the 
8587 % conditional.
8588 @gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
8589
8590 }
8591 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8592
8593 % \braceorline MAC is used for a one-argument macro MAC.  It checks
8594 % whether the next non-whitespace character is a {.  It sets the context
8595 % for reading the argument (slightly different in the two cases).  Then,
8596 % to read the argument, in the whole-line case, it then calls the regular
8597 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8598
8599 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
8600 \def\braceorlinexxx{%
8601   \ifx\nchar\bgroup
8602     \macroargctxt
8603     \expandafter\passargtomacro
8604   \else
8605     \macrolineargctxt\expandafter\parsearg
8606   \fi \macnamexxx}
8607
8608
8609 % @alias.
8610 % We need some trickery to remove the optional spaces around the equal
8611 % sign.  Make them active and then expand them all to nothing.
8612 %
8613 \def\alias{\parseargusing\obeyspaces\aliasxxx}
8614 \def\aliasxxx #1{\aliasyyy#1\relax}
8615 \def\aliasyyy #1=#2\relax{%
8616   {%
8617     \expandafter\let\obeyedspace=\empty
8618     \addtomacrolist{#1}%
8619     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
8620   }%
8621   \next
8622 }
8623
8624
8625 \message{cross references,}
8626
8627 \newwrite\auxfile
8628 \newif\ifhavexrefs    % True if xref values are known.
8629 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
8630
8631 % @inforef is relatively simple.
8632 \def\inforef #1{\inforefzzz #1,,,,**}
8633 \def\inforefzzz #1,#2,#3,#4**{%
8634   \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8635   node \samp{\ignorespaces#1{}}}
8636
8637 % @node's only job in TeX is to define \lastnode, which is used in
8638 % cross-references.  The @node line might or might not have commas, and
8639 % might or might not have spaces before the first comma, like:
8640 % @node foo , bar , ...
8641 % We don't want such trailing spaces in the node name.
8642 %
8643 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
8644 %
8645 % also remove a trailing comma, in case of something like this:
8646 % @node Help-Cross,  ,  , Cross-refs
8647 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
8648 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
8649
8650 \let\nwnode=\node
8651 \let\lastnode=\empty
8652
8653 % Write a cross-reference definition for the current node.  #1 is the
8654 % type (Ynumbered, Yappendix, Ynothing).
8655 %
8656 \def\donoderef#1{%
8657   \ifx\lastnode\empty\else
8658     \setref{\lastnode}{#1}%
8659     \global\let\lastnode=\empty
8660   \fi
8661 }
8662
8663 % @anchor{NAME} -- define xref target at arbitrary point.
8664 %
8665 \newcount\savesfregister
8666 %
8667 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
8668 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
8669 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
8670
8671 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8672 % anchor), which consists of three parts:
8673 % 1) NAME-title - the current sectioning name taken from \lastsection,
8674 %                 or the anchor name.
8675 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
8676 %                 empty for anchors.
8677 % 3) NAME-pg    - the page number.
8678 %
8679 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
8680 % floats, there is an additional part, which is not written here:
8681 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
8682 %
8683 \def\setref#1#2{%
8684   \pdfmkdest{#1}%
8685   \iflinks
8686     {%
8687       \requireauxfile
8688       \atdummies  % preserve commands, but don't expand them
8689       \edef\writexrdef##1##2{%
8690         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
8691           ##1}{##2}}% these are parameters of \writexrdef
8692       }%
8693       \toks0 = \expandafter{\lastsection}%
8694       \immediate \writexrdef{title}{\the\toks0 }%
8695       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
8696       \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
8697     }%
8698   \fi
8699 }
8700
8701 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8702 % automatically in xrefs, if the third arg is not explicitly specified.
8703 % This was provided as a "secret" @set xref-automatic-section-title
8704 % variable, now it's official.
8705
8706 \parseargdef\xrefautomaticsectiontitle{%
8707   \def\temp{#1}%
8708   \ifx\temp\onword
8709     \expandafter\let\csname SETxref-automatic-section-title\endcsname
8710       = \empty
8711   \else\ifx\temp\offword
8712     \expandafter\let\csname SETxref-automatic-section-title\endcsname
8713       = \relax
8714   \else
8715     \errhelp = \EMsimple
8716     \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
8717                 must be on|off}%
8718   \fi\fi
8719 }
8720
8721\f
8722 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
8723 % the node name, #2 the name of the Info cross-reference, #3 the printed
8724 % node name, #4 the name of the Info file, #5 the name of the printed
8725 % manual.  All but the node name can be omitted.
8726 %
8727 \def\pxref{\putwordsee{} \xrefXX}
8728 \def\xref{\putwordSee{} \xrefXX}
8729 \def\ref{\xrefXX}
8730
8731 \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
8732 \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
8733 %
8734 \newbox\toprefbox
8735 \newbox\printedrefnamebox
8736 \newbox\infofilenamebox
8737 \newbox\printedmanualbox
8738 %
8739 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8740   \unsepspaces
8741   %
8742   % Get args without leading/trailing spaces.
8743   \def\printedrefname{\ignorespaces #3}%
8744   \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8745   %
8746   \def\infofilename{\ignorespaces #4}%
8747   \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8748   %
8749   \def\printedmanual{\ignorespaces #5}%
8750   \setbox\printedmanualbox  = \hbox{\printedmanual\unskip}%
8751   %
8752   % If the printed reference name (arg #3) was not explicitly given in
8753   % the @xref, figure out what we want to use.
8754   \ifdim \wd\printedrefnamebox = 0pt
8755     % No printed node name was explicitly given.
8756     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8757       % Not auto section-title: use node name inside the square brackets.
8758       \def\printedrefname{\ignorespaces #1}%
8759     \else
8760       % Auto section-title: use chapter/section title inside
8761       % the square brackets if we have it.
8762       \ifdim \wd\printedmanualbox > 0pt
8763         % It is in another manual, so we don't have it; use node name.
8764         \def\printedrefname{\ignorespaces #1}%
8765       \else
8766         \ifhavexrefs
8767           % We (should) know the real title if we have the xref values.
8768           \def\printedrefname{\refx{#1-title}{}}%
8769         \else
8770           % Otherwise just copy the Info node name.
8771           \def\printedrefname{\ignorespaces #1}%
8772         \fi%
8773       \fi
8774     \fi
8775   \fi
8776   %
8777   % Make link in pdf output.
8778   \ifpdf
8779     % For pdfTeX and LuaTeX
8780     {\indexnofonts
8781      \turnoffactive
8782      \makevalueexpandable
8783      % This expands tokens, so do it after making catcode changes, so _
8784      % etc. don't get their TeX definitions.  This ignores all spaces in
8785      % #4, including (wrongly) those in the middle of the filename.
8786      \getfilename{#4}%
8787      %
8788      % This (wrongly) does not take account of leading or trailing
8789      % spaces in #1, which should be ignored.
8790      \edef\pdfxrefdest{#1}%
8791      \ifx\pdfxrefdest\empty
8792        \def\pdfxrefdest{Top}% no empty targets
8793      \else
8794        \txiescapepdf\pdfxrefdest  % escape PDF special chars
8795      \fi
8796      %
8797      \leavevmode
8798      \startlink attr{/Border [0 0 0]}%
8799      \ifnum\filenamelength>0
8800        goto file{\the\filename.pdf} name{\pdfxrefdest}%
8801      \else
8802        goto name{\pdfmkpgn{\pdfxrefdest}}%
8803      \fi
8804     }%
8805     \setcolor{\linkcolor}%
8806   \else
8807     \ifx\XeTeXrevision\thisisundefined
8808     \else
8809       % For XeTeX
8810       {\indexnofonts
8811        \turnoffactive
8812        \makevalueexpandable
8813        % This expands tokens, so do it after making catcode changes, so _
8814        % etc. don't get their TeX definitions.  This ignores all spaces in
8815        % #4, including (wrongly) those in the middle of the filename.
8816        \getfilename{#4}%
8817        %
8818        % This (wrongly) does not take account of leading or trailing
8819        % spaces in #1, which should be ignored.
8820        \iftxiuseunicodedestname
8821          \def\pdfxrefdest{#1}% Pass through Unicode characters.
8822        \else
8823          \edef\pdfxrefdest{#1}% Replace Unicode characters to ASCII.
8824        \fi
8825        \ifx\pdfxrefdest\empty
8826          \def\pdfxrefdest{Top}% no empty targets
8827        \else
8828          \txiescapepdf\pdfxrefdest  % escape PDF special chars
8829        \fi
8830        %
8831        \leavevmode
8832        \ifnum\filenamelength>0
8833          % By the default settings,
8834          % XeTeX (xdvipdfmx) replaces link destination names with integers.
8835          % In this case, the replaced destination names of
8836          % remote PDF cannot be known. In order to avoid replacement,
8837          % you can use commandline option `-C 0x0010' for xdvipdfmx.
8838          \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8839            << /S /GoToR /F (\the\filename.pdf) /D (name\pdfxrefdest) >> >>}%
8840        \else
8841          \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8842            << /S /GoTo /D (name\pdfxrefdest) >> >>}%
8843        \fi
8844       }%
8845       \setcolor{\linkcolor}%
8846     \fi
8847   \fi
8848   {%
8849     % Have to otherify everything special to allow the \csname to
8850     % include an _ in the xref name, etc.
8851     \indexnofonts
8852     \turnoffactive
8853     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8854       \csname XR#1-title\endcsname
8855   }%
8856   %
8857   % Float references are printed completely differently: "Figure 1.2"
8858   % instead of "[somenode], p.3".  \iffloat distinguishes them by
8859   % \Xthisreftitle being set to a magic string.
8860   \iffloat\Xthisreftitle
8861     % If the user specified the print name (third arg) to the ref,
8862     % print it instead of our usual "Figure 1.2".
8863     \ifdim\wd\printedrefnamebox = 0pt
8864       \refx{#1-snt}{}%
8865     \else
8866       \printedrefname
8867     \fi
8868     %
8869     % If the user also gave the printed manual name (fifth arg), append
8870     % "in MANUALNAME".
8871     \ifdim \wd\printedmanualbox > 0pt
8872       \space \putwordin{} \cite{\printedmanual}%
8873     \fi
8874   \else
8875     % node/anchor (non-float) references.
8876     % 
8877     % If we use \unhbox to print the node names, TeX does not insert
8878     % empty discretionaries after hyphens, which means that it will not
8879     % find a line break at a hyphen in a node names.  Since some manuals
8880     % are best written with fairly long node names, containing hyphens,
8881     % this is a loss.  Therefore, we give the text of the node name
8882     % again, so it is as if TeX is seeing it for the first time.
8883     % 
8884     \ifdim \wd\printedmanualbox > 0pt
8885       % Cross-manual reference with a printed manual name.
8886       % 
8887       \crossmanualxref{\cite{\printedmanual\unskip}}%
8888     %
8889     \else\ifdim \wd\infofilenamebox > 0pt
8890       % Cross-manual reference with only an info filename (arg 4), no
8891       % printed manual name (arg 5).  This is essentially the same as
8892       % the case above; we output the filename, since we have nothing else.
8893       % 
8894       \crossmanualxref{\code{\infofilename\unskip}}%
8895     %
8896     \else
8897       % Reference within this manual.
8898       %
8899       % _ (for example) has to be the character _ for the purposes of the
8900       % control sequence corresponding to the node, but it has to expand
8901       % into the usual \leavevmode...\vrule stuff for purposes of
8902       % printing. So we \turnoffactive for the \refx-snt, back on for the
8903       % printing, back off for the \refx-pg.
8904       {\turnoffactive
8905        % Only output a following space if the -snt ref is nonempty; for
8906        % @unnumbered and @anchor, it won't be.
8907        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8908        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8909       }%
8910       % output the `[mynode]' via the macro below so it can be overridden.
8911       \xrefprintnodename\printedrefname
8912       %
8913       % But we always want a comma and a space:
8914       ,\space
8915       %
8916       % output the `page 3'.
8917       \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8918       % Add a , if xref followed by a space
8919       \if\space\noexpand\tokenafterxref ,%
8920       \else\ifx\        \tokenafterxref ,% @TAB
8921       \else\ifx\*\tokenafterxref ,%   @*
8922       \else\ifx\ \tokenafterxref ,%   @SPACE
8923       \else\ifx\
8924                 \tokenafterxref ,%    @NL
8925       \else\ifx\tie\tokenafterxref ,% @tie
8926       \fi\fi\fi\fi\fi\fi
8927     \fi\fi
8928   \fi
8929   \endlink
8930 \endgroup}
8931
8932 % Output a cross-manual xref to #1.  Used just above (twice).
8933
8934 % Only include the text "Section ``foo'' in" if the foo is neither
8935 % missing or Top.  Thus, @xref{,,,foo,The Foo Manual} outputs simply
8936 % "see The Foo Manual", the idea being to refer to the whole manual.
8937
8938 % But, this being TeX, we can't easily compare our node name against the
8939 % string "Top" while ignoring the possible spaces before and after in
8940 % the input.  By adding the arbitrary 7sp below, we make it much less
8941 % likely that a real node name would have the same width as "Top" (e.g.,
8942 % in a monospaced font).  Hopefully it will never happen in practice.
8943
8944 % For the same basic reason, we retypeset the "Top" at every
8945 % reference, since the current font is indeterminate.
8946
8947 \def\crossmanualxref#1{%
8948   \setbox\toprefbox = \hbox{Top\kern7sp}%
8949   \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8950   \ifdim \wd2 > 7sp  % nonempty?
8951     \ifdim \wd2 = \wd\toprefbox \else  % same as Top?
8952       \putwordSection{} ``\printedrefname'' \putwordin{}\space
8953     \fi
8954   \fi
8955   #1%
8956 }
8957
8958 % This macro is called from \xrefX for the `[nodename]' part of xref
8959 % output.  It's a separate macro only so it can be changed more easily,
8960 % since square brackets don't work well in some documents.  Particularly
8961 % one that Bob is working on :).
8962 %
8963 \def\xrefprintnodename#1{[#1]}
8964
8965 % Things referred to by \setref.
8966 %
8967 \def\Ynothing{}
8968 \def\Yomitfromtoc{}
8969 \def\Ynumbered{%
8970   \ifnum\secno=0
8971     \putwordChapter@tie \the\chapno
8972   \else \ifnum\subsecno=0
8973     \putwordSection@tie \the\chapno.\the\secno
8974   \else \ifnum\subsubsecno=0
8975     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8976   \else
8977     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8978   \fi\fi\fi
8979 }
8980 \def\Yappendix{%
8981   \ifnum\secno=0
8982      \putwordAppendix@tie @char\the\appendixno{}%
8983   \else \ifnum\subsecno=0
8984      \putwordSection@tie @char\the\appendixno.\the\secno
8985   \else \ifnum\subsubsecno=0
8986     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8987   \else
8988     \putwordSection@tie
8989       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8990   \fi\fi\fi
8991 }
8992
8993 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8994 % If its value is nonempty, SUFFIX is output afterward.
8995 %
8996 \def\refx#1#2{%
8997   \requireauxfile
8998   {%
8999     \indexnofonts
9000     \otherbackslash
9001     \expandafter\global\expandafter\let\expandafter\thisrefX
9002       \csname XR#1\endcsname
9003   }%
9004   \ifx\thisrefX\relax
9005     % If not defined, say something at least.
9006     \angleleft un\-de\-fined\angleright
9007     \iflinks
9008       \ifhavexrefs
9009         {\toks0 = {#1}% avoid expansion of possibly-complex value
9010          \message{\linenumber Undefined cross reference `\the\toks0'.}}%
9011       \else
9012         \ifwarnedxrefs\else
9013           \global\warnedxrefstrue
9014           \message{Cross reference values unknown; you must run TeX again.}%
9015         \fi
9016       \fi
9017     \fi
9018   \else
9019     % It's defined, so just use it.
9020     \thisrefX
9021   \fi
9022   #2% Output the suffix in any case.
9023 }
9024
9025 % This is the macro invoked by entries in the aux file.  Usually it's
9026 % just a \def (we prepend XR to the control sequence name to avoid
9027 % collisions).  But if this is a float type, we have more work to do.
9028 %
9029 \def\xrdef#1#2{%
9030   {% The node name might contain 8-bit characters, which in our current
9031    % implementation are changed to commands like @'e.  Don't let these
9032    % mess up the control sequence name.
9033     \indexnofonts
9034     \turnoffactive
9035     \xdef\safexrefname{#1}%
9036   }%
9037   %
9038   \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
9039   %
9040   % Was that xref control sequence that we just defined for a float?
9041   \expandafter\iffloat\csname XR\safexrefname\endcsname
9042     % it was a float, and we have the (safe) float type in \iffloattype.
9043     \expandafter\let\expandafter\floatlist
9044       \csname floatlist\iffloattype\endcsname
9045     %
9046     % Is this the first time we've seen this float type?
9047     \expandafter\ifx\floatlist\relax
9048       \toks0 = {\do}% yes, so just \do
9049     \else
9050       % had it before, so preserve previous elements in list.
9051       \toks0 = \expandafter{\floatlist\do}%
9052     \fi
9053     %
9054     % Remember this xref in the control sequence \floatlistFLOATTYPE,
9055     % for later use in \listoffloats.
9056     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
9057       {\safexrefname}}%
9058   \fi
9059 }
9060
9061 % If working on a large document in chapters, it is convenient to
9062 % be able to disable indexing, cross-referencing, and contents, for test runs.
9063 % This is done with @novalidate at the beginning of the file.
9064 %
9065 \newif\iflinks \linkstrue % by default we want the aux files.
9066 \let\novalidate = \linksfalse
9067
9068 % Used when writing to the aux file, or when using data from it.
9069 \def\requireauxfile{%
9070   \iflinks
9071     \tryauxfile
9072     % Open the new aux file.  TeX will close it automatically at exit.
9073     \immediate\openout\auxfile=\jobname.aux
9074   \fi
9075   \global\let\requireauxfile=\relax   % Only do this once.
9076 }
9077
9078 % Read the last existing aux file, if any.  No error if none exists.
9079 %
9080 \def\tryauxfile{%
9081   \openin 1 \jobname.aux
9082   \ifeof 1 \else
9083     \readdatafile{aux}%
9084     \global\havexrefstrue
9085   \fi
9086   \closein 1
9087 }
9088
9089 \def\setupdatafile{%
9090   \catcode`\^^@=\other
9091   \catcode`\^^A=\other
9092   \catcode`\^^B=\other
9093   \catcode`\^^C=\other
9094   \catcode`\^^D=\other
9095   \catcode`\^^E=\other
9096   \catcode`\^^F=\other
9097   \catcode`\^^G=\other
9098   \catcode`\^^H=\other
9099   \catcode`\^^K=\other
9100   \catcode`\^^L=\other
9101   \catcode`\^^N=\other
9102   \catcode`\^^P=\other
9103   \catcode`\^^Q=\other
9104   \catcode`\^^R=\other
9105   \catcode`\^^S=\other
9106   \catcode`\^^T=\other
9107   \catcode`\^^U=\other
9108   \catcode`\^^V=\other
9109   \catcode`\^^W=\other
9110   \catcode`\^^X=\other
9111   \catcode`\^^Z=\other
9112   \catcode`\^^[=\other
9113   \catcode`\^^\=\other
9114   \catcode`\^^]=\other
9115   \catcode`\^^^=\other
9116   \catcode`\^^_=\other
9117   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
9118   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
9119   % supported in the main text, it doesn't seem desirable.  Furthermore,
9120   % that is not enough: for node names that actually contain a ^
9121   % character, we would end up writing a line like this: 'xrdef {'hat
9122   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
9123   % argument, and \hat is not an expandable control sequence.  It could
9124   % all be worked out, but why?  Either we support ^^ or we don't.
9125   %
9126   % The other change necessary for this was to define \auxhat:
9127   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
9128   % and then to call \auxhat in \setq.
9129   %
9130   \catcode`\^=\other
9131   %
9132   % Special characters.  Should be turned off anyway, but...
9133   \catcode`\~=\other
9134   \catcode`\[=\other
9135   \catcode`\]=\other
9136   \catcode`\"=\other
9137   \catcode`\_=\other
9138   \catcode`\|=\other
9139   \catcode`\<=\other
9140   \catcode`\>=\other
9141   \catcode`\$=\other
9142   \catcode`\#=\other
9143   \catcode`\&=\other
9144   \catcode`\%=\other
9145   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
9146   %
9147   % This is to support \ in node names and titles, since the \
9148   % characters end up in a \csname.  It's easier than
9149   % leaving it active and making its active definition an actual \
9150   % character.  What I don't understand is why it works in the *value*
9151   % of the xrdef.  Seems like it should be a catcode12 \, and that
9152   % should not typeset properly.  But it works, so I'm moving on for
9153   % now.  --karl, 15jan04.
9154   \catcode`\\=\other
9155   %
9156   % @ is our escape character in .aux files, and we need braces.
9157   \catcode`\{=1
9158   \catcode`\}=2
9159   \catcode`\@=0
9160 }
9161
9162 \def\readdatafile#1{%
9163 \begingroup
9164   \setupdatafile
9165   \input\jobname.#1
9166 \endgroup}
9167
9168
9169 \message{insertions,}
9170 % including footnotes.
9171
9172 \newcount \footnoteno
9173
9174 % The trailing space in the following definition for supereject is
9175 % vital for proper filling; pages come out unaligned when you do a
9176 % pagealignmacro call if that space before the closing brace is
9177 % removed. (Generally, numeric constants should always be followed by a
9178 % space to prevent strange expansion errors.)
9179 \def\supereject{\par\penalty -20000\footnoteno =0 }
9180
9181 % @footnotestyle is meaningful for Info output only.
9182 \let\footnotestyle=\comment
9183
9184 {\catcode `\@=11
9185 %
9186 % Auto-number footnotes.  Otherwise like plain.
9187 \gdef\footnote{%
9188   \global\advance\footnoteno by \@ne
9189   \edef\thisfootno{$^{\the\footnoteno}$}%
9190   %
9191   % In case the footnote comes at the end of a sentence, preserve the
9192   % extra spacing after we do the footnote number.
9193   \let\@sf\empty
9194   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
9195   %
9196   % Remove inadvertent blank space before typesetting the footnote number.
9197   \unskip
9198   \thisfootno\@sf
9199   \dofootnote
9200 }%
9201
9202 % Don't bother with the trickery in plain.tex to not require the
9203 % footnote text as a parameter.  Our footnotes don't need to be so general.
9204 %
9205 % Oh yes, they do; otherwise, @ifset (and anything else that uses
9206 % \parseargline) fails inside footnotes because the tokens are fixed when
9207 % the footnote is read.  --karl, 16nov96.
9208 %
9209 \gdef\dofootnote{%
9210   \insert\footins\bgroup
9211   %
9212   % Nested footnotes are not supported in TeX, that would take a lot
9213   % more work.  (\startsavinginserts does not suffice.)
9214   \let\footnote=\errfootnotenest
9215   %
9216   % We want to typeset this text as a normal paragraph, even if the
9217   % footnote reference occurs in (for example) a display environment.
9218   % So reset some parameters.
9219   \hsize=\txipagewidth
9220   \interlinepenalty\interfootnotelinepenalty
9221   \splittopskip\ht\strutbox % top baseline for broken footnotes
9222   \splitmaxdepth\dp\strutbox
9223   \floatingpenalty\@MM
9224   \leftskip\z@skip
9225   \rightskip\z@skip
9226   \spaceskip\z@skip
9227   \xspaceskip\z@skip
9228   \parindent\defaultparindent
9229   %
9230   \smallfonts \rm
9231   %
9232   % Because we use hanging indentation in footnotes, a @noindent appears
9233   % to exdent this text, so make it be a no-op.  makeinfo does not use
9234   % hanging indentation so @noindent can still be needed within footnote
9235   % text after an @example or the like (not that this is good style).
9236   \let\noindent = \relax
9237   %
9238   % Hang the footnote text off the number.  Use \everypar in case the
9239   % footnote extends for more than one paragraph.
9240   \everypar = {\hang}%
9241   \textindent{\thisfootno}%
9242   %
9243   % Don't crash into the line above the footnote text.  Since this
9244   % expands into a box, it must come within the paragraph, lest it
9245   % provide a place where TeX can split the footnote.
9246   \footstrut
9247   %
9248   % Invoke rest of plain TeX footnote routine.
9249   \futurelet\next\fo@t
9250 }
9251 }%end \catcode `\@=11
9252
9253 \def\errfootnotenest{%
9254   \errhelp=\EMsimple
9255   \errmessage{Nested footnotes not supported in texinfo.tex,
9256     even though they work in makeinfo; sorry}
9257 }
9258
9259 \def\errfootnoteheading{%
9260   \errhelp=\EMsimple
9261   \errmessage{Footnotes in chapters, sections, etc., are not supported}
9262 }
9263
9264 % In case a @footnote appears in a vbox, save the footnote text and create
9265 % the real \insert just after the vbox finished.  Otherwise, the insertion
9266 % would be lost.
9267 % Similarly, if a @footnote appears inside an alignment, save the footnote
9268 % text to a box and make the \insert when a row of the table is finished.
9269 % And the same can be done for other insert classes.  --kasal, 16nov03.
9270 %
9271 % Replace the \insert primitive by a cheating macro.
9272 % Deeper inside, just make sure that the saved insertions are not spilled
9273 % out prematurely.
9274 %
9275 \def\startsavinginserts{%
9276   \ifx \insert\ptexinsert
9277     \let\insert\saveinsert
9278   \else
9279     \let\checkinserts\relax
9280   \fi
9281 }
9282
9283 % This \insert replacement works for both \insert\footins{foo} and
9284 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
9285 %
9286 \def\saveinsert#1{%
9287   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
9288   \afterassignment\next
9289   % swallow the left brace
9290   \let\temp =
9291 }
9292 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
9293 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
9294
9295 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
9296
9297 \def\placesaveins#1{%
9298   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
9299     {\box#1}%
9300 }
9301
9302 % eat @SAVE -- beware, all of them have catcode \other:
9303 {
9304   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
9305   \gdef\gobblesave @SAVE{}
9306 }
9307
9308 % initialization:
9309 \def\newsaveins #1{%
9310   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
9311   \next
9312 }
9313 \def\newsaveinsX #1{%
9314   \csname newbox\endcsname #1%
9315   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
9316     \checksaveins #1}%
9317 }
9318
9319 % initialize:
9320 \let\checkinserts\empty
9321 \newsaveins\footins
9322 \newsaveins\margin
9323
9324
9325 % @image.  We use the macros from epsf.tex to support this.
9326 % If epsf.tex is not installed and @image is used, we complain.
9327 %
9328 % Check for and read epsf.tex up front.  If we read it only at @image
9329 % time, we might be inside a group, and then its definitions would get
9330 % undone and the next image would fail.
9331 \openin 1 = epsf.tex
9332 \ifeof 1 \else
9333   % Do not bother showing banner with epsf.tex v2.7k (available in
9334   % doc/epsf.tex and on ctan).
9335   \def\epsfannounce{\toks0 = }%
9336   \input epsf.tex
9337 \fi
9338 \closein 1
9339 %
9340 % We will only complain once about lack of epsf.tex.
9341 \newif\ifwarnednoepsf
9342 \newhelp\noepsfhelp{epsf.tex must be installed for images to
9343   work.  It is also included in the Texinfo distribution, or you can get
9344   it from ftp://tug.org/tex/epsf.tex.}
9345 %
9346 \def\image#1{%
9347   \ifx\epsfbox\thisisundefined
9348     \ifwarnednoepsf \else
9349       \errhelp = \noepsfhelp
9350       \errmessage{epsf.tex not found, images will be ignored}%
9351       \global\warnednoepsftrue
9352     \fi
9353   \else
9354     \imagexxx #1,,,,,\finish
9355   \fi
9356 }
9357 %
9358 % Arguments to @image:
9359 % #1 is (mandatory) image filename; we tack on .eps extension.
9360 % #2 is (optional) width, #3 is (optional) height.
9361 % #4 is (ignored optional) html alt text.
9362 % #5 is (ignored optional) extension.
9363 % #6 is just the usual extra ignored arg for parsing stuff.
9364 \newif\ifimagevmode
9365 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
9366   \catcode`\^^M = 5     % in case we're inside an example
9367   \normalturnoffactive  % allow _ et al. in names
9368   \def\xprocessmacroarg{\eatspaces}% in case we are being used via a macro
9369   % If the image is by itself, center it.
9370   \ifvmode
9371     \imagevmodetrue
9372   \else \ifx\centersub\centerV
9373     % for @center @image, we need a vbox so we can have our vertical space
9374     \imagevmodetrue
9375     \vbox\bgroup % vbox has better behavior than vtop herev
9376   \fi\fi
9377   %
9378   \ifimagevmode
9379     \nobreak\medskip
9380     % Usually we'll have text after the image which will insert
9381     % \parskip glue, so insert it here too to equalize the space
9382     % above and below.
9383     \nobreak\vskip\parskip
9384     \nobreak
9385   \fi
9386   %
9387   % Leave vertical mode so that indentation from an enclosing
9388   %  environment such as @quotation is respected.
9389   % However, if we're at the top level, we don't want the
9390   %  normal paragraph indentation.
9391   % On the other hand, if we are in the case of @center @image, we don't
9392   %  want to start a paragraph, which will create a hsize-width box and
9393   %  eradicate the centering.
9394   \ifx\centersub\centerV\else \noindent \fi
9395   %
9396   % Output the image.
9397   \ifpdf
9398     % For pdfTeX and LuaTeX <= 0.80
9399     \dopdfimage{#1}{#2}{#3}%
9400   \else
9401     \ifx\XeTeXrevision\thisisundefined
9402       % For epsf.tex
9403       % \epsfbox itself resets \epsf?size at each figure.
9404       \setbox0 = \hbox{\ignorespaces #2}%
9405         \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
9406       \setbox0 = \hbox{\ignorespaces #3}%
9407         \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
9408       \epsfbox{#1.eps}%
9409     \else
9410       % For XeTeX
9411       \doxeteximage{#1}{#2}{#3}%
9412     \fi
9413   \fi
9414   %
9415   \ifimagevmode
9416     \medskip  % space after a standalone image
9417   \fi  
9418   \ifx\centersub\centerV \egroup \fi
9419 \endgroup}
9420
9421
9422 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
9423 % etc.  We don't actually implement floating yet, we always include the
9424 % float "here".  But it seemed the best name for the future.
9425 %
9426 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
9427
9428 % There may be a space before second and/or third parameter; delete it.
9429 \def\eatcommaspace#1, {#1,}
9430
9431 % #1 is the optional FLOATTYPE, the text label for this float, typically
9432 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
9433 % this float will not be numbered and cannot be referred to.
9434 %
9435 % #2 is the optional xref label.  Also must be present for the float to
9436 % be referable.
9437 %
9438 % #3 is the optional positioning argument; for now, it is ignored.  It
9439 % will somehow specify the positions allowed to float to (here, top, bottom).
9440 %
9441 % We keep a separate counter for each FLOATTYPE, which we reset at each
9442 % chapter-level command.
9443 \let\resetallfloatnos=\empty
9444 %
9445 \def\dofloat#1,#2,#3,#4\finish{%
9446   \let\thiscaption=\empty
9447   \let\thisshortcaption=\empty
9448   %
9449   % don't lose footnotes inside @float.
9450   %
9451   % BEWARE: when the floats start float, we have to issue warning whenever an
9452   % insert appears inside a float which could possibly float. --kasal, 26may04
9453   %
9454   \startsavinginserts
9455   %
9456   % We can't be used inside a paragraph.
9457   \par
9458   %
9459   \vtop\bgroup
9460     \def\floattype{#1}%
9461     \def\floatlabel{#2}%
9462     \def\floatloc{#3}% we do nothing with this yet.
9463     %
9464     \ifx\floattype\empty
9465       \let\safefloattype=\empty
9466     \else
9467       {%
9468         % the floattype might have accents or other special characters,
9469         % but we need to use it in a control sequence name.
9470         \indexnofonts
9471         \turnoffactive
9472         \xdef\safefloattype{\floattype}%
9473       }%
9474     \fi
9475     %
9476     % If label is given but no type, we handle that as the empty type.
9477     \ifx\floatlabel\empty \else
9478       % We want each FLOATTYPE to be numbered separately (Figure 1,
9479       % Table 1, Figure 2, ...).  (And if no label, no number.)
9480       %
9481       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
9482       \global\advance\floatno by 1
9483       %
9484       {%
9485         % This magic value for \lastsection is output by \setref as the
9486         % XREFLABEL-title value.  \xrefX uses it to distinguish float
9487         % labels (which have a completely different output format) from
9488         % node and anchor labels.  And \xrdef uses it to construct the
9489         % lists of floats.
9490         %
9491         \edef\lastsection{\floatmagic=\safefloattype}%
9492         \setref{\floatlabel}{Yfloat}%
9493       }%
9494     \fi
9495     %
9496     % start with \parskip glue, I guess.
9497     \vskip\parskip
9498     %
9499     % Don't suppress indentation if a float happens to start a section.
9500     \restorefirstparagraphindent
9501 }
9502
9503 % we have these possibilities:
9504 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
9505 % @float Foo,lbl & no caption:    Foo 1.1
9506 % @float Foo & @caption{Cap}:     Foo: Cap
9507 % @float Foo & no caption:        Foo
9508 % @float ,lbl & Caption{Cap}:     1.1: Cap
9509 % @float ,lbl & no caption:       1.1
9510 % @float & @caption{Cap}:         Cap
9511 % @float & no caption:
9512 %
9513 \def\Efloat{%
9514     \let\floatident = \empty
9515     %
9516     % In all cases, if we have a float type, it comes first.
9517     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
9518     %
9519     % If we have an xref label, the number comes next.
9520     \ifx\floatlabel\empty \else
9521       \ifx\floattype\empty \else % if also had float type, need tie first.
9522         \appendtomacro\floatident{\tie}%
9523       \fi
9524       % the number.
9525       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
9526     \fi
9527     %
9528     % Start the printed caption with what we've constructed in
9529     % \floatident, but keep it separate; we need \floatident again.
9530     \let\captionline = \floatident
9531     %
9532     \ifx\thiscaption\empty \else
9533       \ifx\floatident\empty \else
9534         \appendtomacro\captionline{: }% had ident, so need a colon between
9535       \fi
9536       %
9537       % caption text.
9538       \appendtomacro\captionline{\scanexp\thiscaption}%
9539     \fi
9540     %
9541     % If we have anything to print, print it, with space before.
9542     % Eventually this needs to become an \insert.
9543     \ifx\captionline\empty \else
9544       \vskip.5\parskip
9545       \captionline
9546       %
9547       % Space below caption.
9548       \vskip\parskip
9549     \fi
9550     %
9551     % If have an xref label, write the list of floats info.  Do this
9552     % after the caption, to avoid chance of it being a breakpoint.
9553     \ifx\floatlabel\empty \else
9554       % Write the text that goes in the lof to the aux file as
9555       % \floatlabel-lof.  Besides \floatident, we include the short
9556       % caption if specified, else the full caption if specified, else nothing.
9557       {%
9558         \requireauxfile
9559         \atdummies
9560         %
9561         \ifx\thisshortcaption\empty
9562           \def\gtemp{\thiscaption}%
9563         \else
9564           \def\gtemp{\thisshortcaption}%
9565         \fi
9566         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
9567           \ifx\gtemp\empty \else : \gtemp \fi}}%
9568       }%
9569     \fi
9570   \egroup  % end of \vtop
9571   %
9572   \checkinserts
9573 }
9574
9575 % Append the tokens #2 to the definition of macro #1, not expanding either.
9576 %
9577 \def\appendtomacro#1#2{%
9578   \expandafter\def\expandafter#1\expandafter{#1#2}%
9579 }
9580
9581 % @caption, @shortcaption
9582 %
9583 \def\caption{\docaption\thiscaption}
9584 \def\shortcaption{\docaption\thisshortcaption}
9585 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
9586 \def\defcaption#1#2{\egroup \def#1{#2}}
9587
9588 % The parameter is the control sequence identifying the counter we are
9589 % going to use.  Create it if it doesn't exist and assign it to \floatno.
9590 \def\getfloatno#1{%
9591   \ifx#1\relax
9592       % Haven't seen this figure type before.
9593       \csname newcount\endcsname #1%
9594       %
9595       % Remember to reset this floatno at the next chap.
9596       \expandafter\gdef\expandafter\resetallfloatnos
9597         \expandafter{\resetallfloatnos #1=0 }%
9598   \fi
9599   \let\floatno#1%
9600 }
9601
9602 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
9603 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
9604 % first read the @float command.
9605 %
9606 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
9607
9608 % Magic string used for the XREFLABEL-title value, so \xrefX can
9609 % distinguish floats from other xref types.
9610 \def\floatmagic{!!float!!}
9611
9612 % #1 is the control sequence we are passed; we expand into a conditional
9613 % which is true if #1 represents a float ref.  That is, the magic
9614 % \lastsection value which we \setref above.
9615 %
9616 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
9617 %
9618 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
9619 % (safe) float type for this float.  We set \iffloattype to #2.
9620 %
9621 \def\doiffloat#1=#2=#3\finish{%
9622   \def\temp{#1}%
9623   \def\iffloattype{#2}%
9624   \ifx\temp\floatmagic
9625 }
9626
9627 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9628 %
9629 \parseargdef\listoffloats{%
9630   \def\floattype{#1}% floattype
9631   {%
9632     % the floattype might have accents or other special characters,
9633     % but we need to use it in a control sequence name.
9634     \indexnofonts
9635     \turnoffactive
9636     \xdef\safefloattype{\floattype}%
9637   }%
9638   %
9639   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9640   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
9641     \ifhavexrefs
9642       % if the user said @listoffloats foo but never @float foo.
9643       \message{\linenumber No `\safefloattype' floats to list.}%
9644     \fi
9645   \else
9646     \begingroup
9647       \leftskip=\tocindent  % indent these entries like a toc
9648       \let\do=\listoffloatsdo
9649       \csname floatlist\safefloattype\endcsname
9650     \endgroup
9651   \fi
9652 }
9653
9654 % This is called on each entry in a list of floats.  We're passed the
9655 % xref label, in the form LABEL-title, which is how we save it in the
9656 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
9657 % has the text we're supposed to typeset here.
9658 %
9659 % Figures without xref labels will not be included in the list (since
9660 % they won't appear in the aux file).
9661 %
9662 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
9663 \def\listoffloatsdoentry#1-title\finish{{%
9664   % Can't fully expand XR#1-lof because it can contain anything.  Just
9665   % pass the control sequence.  On the other hand, XR#1-pg is just the
9666   % page number, and we want to fully expand that so we can get a link
9667   % in pdf output.
9668   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
9669   %
9670   % use the same \entry macro we use to generate the TOC and index.
9671   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
9672   \writeentry
9673 }}
9674
9675
9676 \message{localization,}
9677
9678 % For single-language documents, @documentlanguage is usually given very
9679 % early, just after @documentencoding.  Single argument is the language
9680 % (de) or locale (de_DE) abbreviation.
9681 %
9682 {
9683   \catcode`\_ = \active
9684   \globaldefs=1
9685 \parseargdef\documentlanguage{%
9686   \tex % read txi-??.tex file in plain TeX.
9687     % Read the file by the name they passed if it exists.
9688     \let_ = \normalunderscore  % normal _ character for filename test
9689     \openin 1 txi-#1.tex
9690     \ifeof 1
9691       \documentlanguagetrywithoutunderscore #1_\finish
9692     \else
9693       \globaldefs = 1  % everything in the txi-LL files needs to persist
9694       \input txi-#1.tex
9695     \fi
9696     \closein 1
9697   \endgroup % end raw TeX
9698 }
9699 %
9700 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9701 % try txi-de.tex.
9702 %
9703 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
9704   \openin 1 txi-#1.tex
9705   \ifeof 1
9706     \errhelp = \nolanghelp
9707     \errmessage{Cannot read language file txi-#1.tex}%
9708   \else
9709     \globaldefs = 1  % everything in the txi-LL files needs to persist
9710     \input txi-#1.tex
9711   \fi
9712   \closein 1
9713 }
9714 }% end of special _ catcode
9715 %
9716 \newhelp\nolanghelp{The given language definition file cannot be found or
9717 is empty.  Maybe you need to install it?  Putting it in the current
9718 directory should work if nowhere else does.}
9719
9720 % This macro is called from txi-??.tex files; the first argument is the
9721 % \language name to set (without the "\lang@" prefix), the second and
9722 % third args are \{left,right}hyphenmin.
9723 %
9724 % The language names to pass are determined when the format is built.
9725 % See the etex.log file created at that time, e.g.,
9726 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9727 %
9728 % With TeX Live 2008, etex now includes hyphenation patterns for all
9729 % available languages.  This means we can support hyphenation in
9730 % Texinfo, at least to some extent.  (This still doesn't solve the
9731 % accented characters problem.)
9732 %
9733 \catcode`@=11
9734 \def\txisetlanguage#1#2#3{%
9735   % do not set the language if the name is undefined in the current TeX.
9736   \expandafter\ifx\csname lang@#1\endcsname \relax
9737     \message{no patterns for #1}%
9738   \else
9739     \global\language = \csname lang@#1\endcsname
9740   \fi
9741   % but there is no harm in adjusting the hyphenmin values regardless.
9742   \global\lefthyphenmin = #2\relax
9743   \global\righthyphenmin = #3\relax
9744 }
9745
9746 % XeTeX and LuaTeX can handle native Unicode.
9747 % Their default I/O is UTF-8 sequence instead of byte-wise.
9748 % Other TeX engine (pdfTeX etc.) I/O is byte-wise.
9749 %
9750 \newif\iftxinativeunicodecapable
9751 \newif\iftxiusebytewiseio
9752
9753 \ifx\XeTeXrevision\thisisundefined
9754   \ifx\luatexversion\thisisundefined
9755     \txinativeunicodecapablefalse
9756     \txiusebytewiseiotrue
9757   \else
9758     \txinativeunicodecapabletrue
9759     \txiusebytewiseiofalse
9760   \fi
9761 \else
9762   \txinativeunicodecapabletrue
9763   \txiusebytewiseiofalse
9764 \fi
9765
9766 % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
9767 % for non-UTF-8 (byte-wise) encodings.
9768 %
9769 \def\setbytewiseio{%
9770   \ifx\XeTeXrevision\thisisundefined
9771   \else
9772     \XeTeXdefaultencoding "bytes"  % For subsequent files to be read
9773     \XeTeXinputencoding "bytes"  % For document root file
9774     % Unfortunately, there seems to be no corresponding XeTeX command for
9775     % output encoding.  This is a problem for auxiliary index and TOC files.
9776     % The only solution would be perhaps to write out @U{...} sequences in
9777     % place of non-ASCII characters.
9778   \fi
9779
9780   \ifx\luatexversion\thisisundefined
9781   \else
9782     \directlua{
9783     local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
9784     local function convert_char (char)
9785       return utf8_char(byte(char))
9786     end
9787
9788     local function convert_line (line)
9789       return gsub(line, ".", convert_char)
9790     end
9791
9792     callback.register("process_input_buffer", convert_line)
9793
9794     local function convert_line_out (line)
9795       local line_out = ""
9796       for c in string.utfvalues(line) do
9797          line_out = line_out .. string.char(c)
9798       end
9799       return line_out
9800     end
9801
9802     callback.register("process_output_buffer", convert_line_out)
9803     }
9804   \fi
9805
9806   \txiusebytewiseiotrue
9807 }
9808
9809
9810 % Helpers for encodings.
9811 % Set the catcode of characters 128 through 255 to the specified number.
9812 %
9813 \def\setnonasciicharscatcode#1{%
9814    \count255=128
9815    \loop\ifnum\count255<256
9816       \global\catcode\count255=#1\relax
9817       \advance\count255 by 1
9818    \repeat
9819 }
9820
9821 \def\setnonasciicharscatcodenonglobal#1{%
9822    \count255=128
9823    \loop\ifnum\count255<256
9824       \catcode\count255=#1\relax
9825       \advance\count255 by 1
9826    \repeat
9827 }
9828
9829 % @documentencoding sets the definition of non-ASCII characters
9830 % according to the specified encoding.
9831 %
9832 \def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
9833 \def\documentencodingzzz#1{%
9834   %
9835   % Encoding being declared for the document.
9836   \def\declaredencoding{\csname #1.enc\endcsname}%
9837   %
9838   % Supported encodings: names converted to tokens in order to be able
9839   % to compare them with \ifx.
9840   \def\ascii{\csname US-ASCII.enc\endcsname}%
9841   \def\latnine{\csname ISO-8859-15.enc\endcsname}%
9842   \def\latone{\csname ISO-8859-1.enc\endcsname}%
9843   \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
9844   \def\utfeight{\csname UTF-8.enc\endcsname}%
9845   %
9846   \ifx \declaredencoding \ascii
9847      \asciichardefs
9848   %
9849   \else \ifx \declaredencoding \lattwo
9850      \iftxinativeunicodecapable
9851        \setbytewiseio
9852      \fi
9853      \setnonasciicharscatcode\active
9854      \lattwochardefs
9855   %
9856   \else \ifx \declaredencoding \latone
9857      \iftxinativeunicodecapable
9858        \setbytewiseio
9859      \fi
9860      \setnonasciicharscatcode\active
9861      \latonechardefs
9862   %
9863   \else \ifx \declaredencoding \latnine
9864      \iftxinativeunicodecapable
9865        \setbytewiseio
9866      \fi
9867      \setnonasciicharscatcode\active
9868      \latninechardefs
9869   %
9870   \else \ifx \declaredencoding \utfeight
9871      \iftxinativeunicodecapable
9872        % For native Unicode (XeTeX and LuaTeX)
9873        \nativeunicodechardefs
9874      \else
9875        % For UTF-8 byte sequence (TeX, eTeX and pdfTeX)
9876        \setnonasciicharscatcode\active
9877        % since we already invoked \utfeightchardefs at the top level
9878        % (below), do not re-invoke it, then our check for duplicated
9879        % definitions triggers.  Making non-ascii chars active is enough.
9880      \fi
9881   %
9882   \else
9883     \message{Ignoring unknown document encoding: #1.}%
9884   %
9885   \fi % utfeight
9886   \fi % latnine
9887   \fi % latone
9888   \fi % lattwo
9889   \fi % ascii
9890 }
9891
9892 % emacs-page
9893 % A message to be logged when using a character that isn't available
9894 % the default font encoding (OT1).
9895 %
9896 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9897
9898 % Take account of \c (plain) vs. \, (Texinfo) difference.
9899 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9900
9901 % First, make active non-ASCII characters in order for them to be
9902 % correctly categorized when TeX reads the replacement text of
9903 % macros containing the character definitions.
9904 \setnonasciicharscatcode\active
9905 %
9906
9907 \def\gdefchar#1#2{%
9908 \gdef#1{%
9909    \ifpassthroughchars
9910      \string#1%
9911    \else
9912      #2%
9913    \fi
9914 }}
9915
9916 % Latin1 (ISO-8859-1) character definitions.
9917 \def\latonechardefs{%
9918   \gdefchar^^a0{\tie}
9919   \gdefchar^^a1{\exclamdown}
9920   \gdefchar^^a2{{\tcfont \char162}} % cent
9921   \gdefchar^^a3{\pounds}
9922   \gdefchar^^a4{{\tcfont \char164}} % currency
9923   \gdefchar^^a5{{\tcfont \char165}} % yen
9924   \gdefchar^^a6{{\tcfont \char166}} % broken bar
9925   \gdefchar^^a7{\S}
9926   \gdefchar^^a8{\"{}}
9927   \gdefchar^^a9{\copyright}
9928   \gdefchar^^aa{\ordf}
9929   \gdefchar^^ab{\guillemetleft}
9930   \gdefchar^^ac{\ensuremath\lnot}
9931   \gdefchar^^ad{\-}
9932   \gdefchar^^ae{\registeredsymbol}
9933   \gdefchar^^af{\={}}
9934   %
9935   \gdefchar^^b0{\textdegree}
9936   \gdefchar^^b1{$\pm$}
9937   \gdefchar^^b2{$^2$}
9938   \gdefchar^^b3{$^3$}
9939   \gdefchar^^b4{\'{}}
9940   \gdefchar^^b5{$\mu$}
9941   \gdefchar^^b6{\P}
9942   \gdefchar^^b7{\ensuremath\cdot}
9943   \gdefchar^^b8{\cedilla\ }
9944   \gdefchar^^b9{$^1$}
9945   \gdefchar^^ba{\ordm}
9946   \gdefchar^^bb{\guillemetright}
9947   \gdefchar^^bc{$1\over4$}
9948   \gdefchar^^bd{$1\over2$}
9949   \gdefchar^^be{$3\over4$}
9950   \gdefchar^^bf{\questiondown}
9951   %
9952   \gdefchar^^c0{\`A}
9953   \gdefchar^^c1{\'A}
9954   \gdefchar^^c2{\^A}
9955   \gdefchar^^c3{\~A}
9956   \gdefchar^^c4{\"A}
9957   \gdefchar^^c5{\ringaccent A}
9958   \gdefchar^^c6{\AE}
9959   \gdefchar^^c7{\cedilla C}
9960   \gdefchar^^c8{\`E}
9961   \gdefchar^^c9{\'E}
9962   \gdefchar^^ca{\^E}
9963   \gdefchar^^cb{\"E}
9964   \gdefchar^^cc{\`I}
9965   \gdefchar^^cd{\'I}
9966   \gdefchar^^ce{\^I}
9967   \gdefchar^^cf{\"I}
9968   %
9969   \gdefchar^^d0{\DH}
9970   \gdefchar^^d1{\~N}
9971   \gdefchar^^d2{\`O}
9972   \gdefchar^^d3{\'O}
9973   \gdefchar^^d4{\^O}
9974   \gdefchar^^d5{\~O}
9975   \gdefchar^^d6{\"O}
9976   \gdefchar^^d7{$\times$}
9977   \gdefchar^^d8{\O}
9978   \gdefchar^^d9{\`U}
9979   \gdefchar^^da{\'U}
9980   \gdefchar^^db{\^U}
9981   \gdefchar^^dc{\"U}
9982   \gdefchar^^dd{\'Y}
9983   \gdefchar^^de{\TH}
9984   \gdefchar^^df{\ss}
9985   %
9986   \gdefchar^^e0{\`a}
9987   \gdefchar^^e1{\'a}
9988   \gdefchar^^e2{\^a}
9989   \gdefchar^^e3{\~a}
9990   \gdefchar^^e4{\"a}
9991   \gdefchar^^e5{\ringaccent a}
9992   \gdefchar^^e6{\ae}
9993   \gdefchar^^e7{\cedilla c}
9994   \gdefchar^^e8{\`e}
9995   \gdefchar^^e9{\'e}
9996   \gdefchar^^ea{\^e}
9997   \gdefchar^^eb{\"e}
9998   \gdefchar^^ec{\`{\dotless i}}
9999   \gdefchar^^ed{\'{\dotless i}}
10000   \gdefchar^^ee{\^{\dotless i}}
10001   \gdefchar^^ef{\"{\dotless i}}
10002   %
10003   \gdefchar^^f0{\dh}
10004   \gdefchar^^f1{\~n}
10005   \gdefchar^^f2{\`o}
10006   \gdefchar^^f3{\'o}
10007   \gdefchar^^f4{\^o}
10008   \gdefchar^^f5{\~o}
10009   \gdefchar^^f6{\"o}
10010   \gdefchar^^f7{$\div$}
10011   \gdefchar^^f8{\o}
10012   \gdefchar^^f9{\`u}
10013   \gdefchar^^fa{\'u}
10014   \gdefchar^^fb{\^u}
10015   \gdefchar^^fc{\"u}
10016   \gdefchar^^fd{\'y}
10017   \gdefchar^^fe{\th}
10018   \gdefchar^^ff{\"y}
10019 }
10020
10021 % Latin9 (ISO-8859-15) encoding character definitions.
10022 \def\latninechardefs{%
10023   % Encoding is almost identical to Latin1.
10024   \latonechardefs
10025   %
10026   \gdefchar^^a4{\euro}
10027   \gdefchar^^a6{\v S}
10028   \gdefchar^^a8{\v s}
10029   \gdefchar^^b4{\v Z}
10030   \gdefchar^^b8{\v z}
10031   \gdefchar^^bc{\OE}
10032   \gdefchar^^bd{\oe}
10033   \gdefchar^^be{\"Y}
10034 }
10035
10036 % Latin2 (ISO-8859-2) character definitions.
10037 \def\lattwochardefs{%
10038   \gdefchar^^a0{\tie}
10039   \gdefchar^^a1{\ogonek{A}}
10040   \gdefchar^^a2{\u{}}
10041   \gdefchar^^a3{\L}
10042   \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
10043   \gdefchar^^a5{\v L}
10044   \gdefchar^^a6{\'S}
10045   \gdefchar^^a7{\S}
10046   \gdefchar^^a8{\"{}}
10047   \gdefchar^^a9{\v S}
10048   \gdefchar^^aa{\cedilla S}
10049   \gdefchar^^ab{\v T}
10050   \gdefchar^^ac{\'Z}
10051   \gdefchar^^ad{\-}
10052   \gdefchar^^ae{\v Z}
10053   \gdefchar^^af{\dotaccent Z}
10054   %
10055   \gdefchar^^b0{\textdegree}
10056   \gdefchar^^b1{\ogonek{a}}
10057   \gdefchar^^b2{\ogonek{ }}
10058   \gdefchar^^b3{\l}
10059   \gdefchar^^b4{\'{}}
10060   \gdefchar^^b5{\v l}
10061   \gdefchar^^b6{\'s}
10062   \gdefchar^^b7{\v{}}
10063   \gdefchar^^b8{\cedilla\ }
10064   \gdefchar^^b9{\v s}
10065   \gdefchar^^ba{\cedilla s}
10066   \gdefchar^^bb{\v t}
10067   \gdefchar^^bc{\'z}
10068   \gdefchar^^bd{\H{}}
10069   \gdefchar^^be{\v z}
10070   \gdefchar^^bf{\dotaccent z}
10071   %
10072   \gdefchar^^c0{\'R}
10073   \gdefchar^^c1{\'A}
10074   \gdefchar^^c2{\^A}
10075   \gdefchar^^c3{\u A}
10076   \gdefchar^^c4{\"A}
10077   \gdefchar^^c5{\'L}
10078   \gdefchar^^c6{\'C}
10079   \gdefchar^^c7{\cedilla C}
10080   \gdefchar^^c8{\v C}
10081   \gdefchar^^c9{\'E}
10082   \gdefchar^^ca{\ogonek{E}}
10083   \gdefchar^^cb{\"E}
10084   \gdefchar^^cc{\v E}
10085   \gdefchar^^cd{\'I}
10086   \gdefchar^^ce{\^I}
10087   \gdefchar^^cf{\v D}
10088   %
10089   \gdefchar^^d0{\DH}
10090   \gdefchar^^d1{\'N}
10091   \gdefchar^^d2{\v N}
10092   \gdefchar^^d3{\'O}
10093   \gdefchar^^d4{\^O}
10094   \gdefchar^^d5{\H O}
10095   \gdefchar^^d6{\"O}
10096   \gdefchar^^d7{$\times$}
10097   \gdefchar^^d8{\v R}
10098   \gdefchar^^d9{\ringaccent U}
10099   \gdefchar^^da{\'U}
10100   \gdefchar^^db{\H U}
10101   \gdefchar^^dc{\"U}
10102   \gdefchar^^dd{\'Y}
10103   \gdefchar^^de{\cedilla T}
10104   \gdefchar^^df{\ss}
10105   %
10106   \gdefchar^^e0{\'r}
10107   \gdefchar^^e1{\'a}
10108   \gdefchar^^e2{\^a}
10109   \gdefchar^^e3{\u a}
10110   \gdefchar^^e4{\"a}
10111   \gdefchar^^e5{\'l}
10112   \gdefchar^^e6{\'c}
10113   \gdefchar^^e7{\cedilla c}
10114   \gdefchar^^e8{\v c}
10115   \gdefchar^^e9{\'e}
10116   \gdefchar^^ea{\ogonek{e}}
10117   \gdefchar^^eb{\"e}
10118   \gdefchar^^ec{\v e}
10119   \gdefchar^^ed{\'{\dotless{i}}}
10120   \gdefchar^^ee{\^{\dotless{i}}}
10121   \gdefchar^^ef{\v d}
10122   %
10123   \gdefchar^^f0{\dh}
10124   \gdefchar^^f1{\'n}
10125   \gdefchar^^f2{\v n}
10126   \gdefchar^^f3{\'o}
10127   \gdefchar^^f4{\^o}
10128   \gdefchar^^f5{\H o}
10129   \gdefchar^^f6{\"o}
10130   \gdefchar^^f7{$\div$}
10131   \gdefchar^^f8{\v r}
10132   \gdefchar^^f9{\ringaccent u}
10133   \gdefchar^^fa{\'u}
10134   \gdefchar^^fb{\H u}
10135   \gdefchar^^fc{\"u}
10136   \gdefchar^^fd{\'y}
10137   \gdefchar^^fe{\cedilla t}
10138   \gdefchar^^ff{\dotaccent{}}
10139 }
10140
10141 % UTF-8 character definitions.
10142 %
10143 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
10144 % changes for Texinfo conventions.  It is included here under the GPL by
10145 % permission from Frank Mittelbach and the LaTeX team.
10146 %
10147 \newcount\countUTFx
10148 \newcount\countUTFy
10149 \newcount\countUTFz
10150
10151 \gdef\UTFviiiTwoOctets#1#2{\expandafter
10152    \UTFviiiDefined\csname u8:#1\string #2\endcsname}
10153 %
10154 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
10155    \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
10156 %
10157 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
10158    \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
10159
10160 \gdef\UTFviiiDefined#1{%
10161   \ifx #1\relax
10162     \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
10163   \else
10164     \expandafter #1%
10165   \fi
10166 }
10167
10168 % Give non-ASCII bytes the active definitions for processing UTF-8 sequences
10169 \begingroup
10170   \catcode`\~13
10171   \catcode`\$12
10172   \catcode`\"12
10173
10174   % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
10175   % substituting ~ and $ with a character token of that value.
10176   \def\UTFviiiLoop{%
10177     \global\catcode\countUTFx\active
10178     \uccode`\~\countUTFx
10179     \uccode`\$\countUTFx
10180     \uppercase\expandafter{\UTFviiiTmp}%
10181     \advance\countUTFx by 1
10182     \ifnum\countUTFx < \countUTFy
10183       \expandafter\UTFviiiLoop
10184     \fi}
10185
10186   % For bytes other than the first in a UTF-8 sequence.  Not expected to
10187   % be expanded except when writing to auxiliary files.
10188   \countUTFx = "80
10189   \countUTFy = "C2
10190   \def\UTFviiiTmp{%
10191     \gdef~{
10192         \ifpassthroughchars $\fi}}%
10193   \UTFviiiLoop
10194
10195   \countUTFx = "C2
10196   \countUTFy = "E0
10197   \def\UTFviiiTmp{%
10198     \gdef~{%
10199         \ifpassthroughchars $%
10200         \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
10201   \UTFviiiLoop
10202
10203   \countUTFx = "E0
10204   \countUTFy = "F0
10205   \def\UTFviiiTmp{%
10206     \gdef~{%
10207         \ifpassthroughchars $%
10208         \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
10209   \UTFviiiLoop
10210
10211   \countUTFx = "F0
10212   \countUTFy = "F4
10213   \def\UTFviiiTmp{%
10214     \gdef~{%
10215         \ifpassthroughchars $%
10216         \else\expandafter\UTFviiiFourOctets\expandafter$\fi
10217         }}%
10218   \UTFviiiLoop
10219 \endgroup
10220
10221 \def\globallet{\global\let} % save some \expandafter's below
10222
10223 % @U{xxxx} to produce U+xxxx, if we support it.
10224 \def\U#1{%
10225   \expandafter\ifx\csname uni:#1\endcsname \relax
10226     \iftxinativeunicodecapable
10227       % Any Unicode characters can be used by native Unicode.
10228       % However, if the font does not have the glyph, the letter will miss.
10229       \begingroup
10230         \uccode`\.="#1\relax
10231         \uppercase{.}
10232       \endgroup
10233     \else
10234       \errhelp = \EMsimple      
10235       \errmessage{Unicode character U+#1 not supported, sorry}%
10236     \fi
10237   \else
10238     \csname uni:#1\endcsname
10239   \fi
10240 }
10241
10242 % For UTF-8 byte sequence (TeX, e-TeX and pdfTeX)
10243 % Definition macro to replace the Unicode character
10244 % Definition macro that is used by @U command
10245 %
10246 \begingroup
10247   \catcode`\"=12
10248   \catcode`\<=12
10249   \catcode`\.=12
10250   \catcode`\,=12
10251   \catcode`\;=12
10252   \catcode`\!=12
10253   \catcode`\~=13
10254   \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
10255     \countUTFz = "#1\relax
10256     \begingroup
10257       \parseXMLCharref
10258       %
10259       % Access definitions of characters given UTF-8 sequences
10260       \def\UTFviiiTwoOctets##1##2{%
10261         \csname u8:##1\string ##2\endcsname}%
10262       \def\UTFviiiThreeOctets##1##2##3{%
10263         \csname u8:##1\string ##2\string ##3\endcsname}%
10264       \def\UTFviiiFourOctets##1##2##3##4{%
10265         \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
10266       \expandafter\expandafter\expandafter\expandafter
10267        \expandafter\expandafter\expandafter
10268        \gdef\UTFviiiTmp{#2}%
10269       % 
10270       \expandafter\ifx\csname uni:#1\endcsname \relax \else
10271        \message{Internal error, already defined: #1}%
10272       \fi
10273       %
10274       % define an additional control sequence for this code point.
10275       \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
10276     \endgroup}
10277   %
10278   % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp.
10279   \gdef\parseXMLCharref{%
10280     \ifnum\countUTFz < "A0\relax
10281       \errhelp = \EMsimple
10282       \errmessage{Cannot define Unicode char value < 00A0}%
10283     \else\ifnum\countUTFz < "800\relax
10284       \parseUTFviiiA,%
10285       \parseUTFviiiB C\UTFviiiTwoOctets.,%
10286     \else\ifnum\countUTFz < "10000\relax
10287       \parseUTFviiiA;%
10288       \parseUTFviiiA,%
10289       \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
10290     \else
10291       \parseUTFviiiA;%
10292       \parseUTFviiiA,%
10293       \parseUTFviiiA!%
10294       \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
10295     \fi\fi\fi
10296   }
10297
10298   \gdef\parseUTFviiiA#1{%
10299     \countUTFx = \countUTFz
10300     \divide\countUTFz by 64
10301     \countUTFy = \countUTFz
10302     \multiply\countUTFz by 64
10303     \advance\countUTFx by -\countUTFz
10304     \advance\countUTFx by 128
10305     \uccode `#1\countUTFx
10306     \countUTFz = \countUTFy}
10307
10308   % Used to set \UTFviiiTmp to a UTF-8 byte sequence
10309   \gdef\parseUTFviiiB#1#2#3#4{%
10310     \advance\countUTFz by "#10\relax
10311     \uccode `#3\countUTFz
10312     \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
10313 \endgroup
10314
10315 % For native Unicode (XeTeX and LuaTeX)
10316 % Definition macro that is set catcode other non global
10317 %
10318 \def\DeclareUnicodeCharacterNativeOther#1#2{%
10319   \catcode"#1=\other
10320 }
10321
10322 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
10323 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
10324 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
10325 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
10326 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
10327
10328 % Many of our renditions are less than wonderful, and all the missing
10329 % characters are available somewhere.  Loading the necessary fonts
10330 % awaits user request.  We can't truly support Unicode without
10331 % reimplementing everything that's been done in LaTeX for many years,
10332 % plus probably using luatex or xetex, and who knows what else.
10333 % We won't be doing that here in this simple file.  But we can try to at
10334 % least make most of the characters not bomb out.
10335 %
10336 \def\unicodechardefs{%
10337   \DeclareUnicodeCharacter{00A0}{\tie}%
10338   \DeclareUnicodeCharacter{00A1}{\exclamdown}%
10339   \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
10340   \DeclareUnicodeCharacter{00A3}{\pounds}%
10341   \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
10342   \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
10343   \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
10344   \DeclareUnicodeCharacter{00A7}{\S}%
10345   \DeclareUnicodeCharacter{00A8}{\"{ }}%
10346   \DeclareUnicodeCharacter{00A9}{\copyright}%
10347   \DeclareUnicodeCharacter{00AA}{\ordf}%
10348   \DeclareUnicodeCharacter{00AB}{\guillemetleft}%
10349   \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
10350   \DeclareUnicodeCharacter{00AD}{\-}%
10351   \DeclareUnicodeCharacter{00AE}{\registeredsymbol}%
10352   \DeclareUnicodeCharacter{00AF}{\={ }}%
10353   %
10354   \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}%
10355   \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
10356   \DeclareUnicodeCharacter{00B2}{$^2$}%
10357   \DeclareUnicodeCharacter{00B3}{$^3$}%
10358   \DeclareUnicodeCharacter{00B4}{\'{ }}%
10359   \DeclareUnicodeCharacter{00B5}{$\mu$}%
10360   \DeclareUnicodeCharacter{00B6}{\P}%
10361   \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
10362   \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
10363   \DeclareUnicodeCharacter{00B9}{$^1$}%
10364   \DeclareUnicodeCharacter{00BA}{\ordm}%
10365   \DeclareUnicodeCharacter{00BB}{\guillemetright}%
10366   \DeclareUnicodeCharacter{00BC}{$1\over4$}%
10367   \DeclareUnicodeCharacter{00BD}{$1\over2$}%
10368   \DeclareUnicodeCharacter{00BE}{$3\over4$}%
10369   \DeclareUnicodeCharacter{00BF}{\questiondown}%
10370   %
10371   \DeclareUnicodeCharacter{00C0}{\`A}%
10372   \DeclareUnicodeCharacter{00C1}{\'A}%
10373   \DeclareUnicodeCharacter{00C2}{\^A}%
10374   \DeclareUnicodeCharacter{00C3}{\~A}%
10375   \DeclareUnicodeCharacter{00C4}{\"A}%
10376   \DeclareUnicodeCharacter{00C5}{\AA}%
10377   \DeclareUnicodeCharacter{00C6}{\AE}%
10378   \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
10379   \DeclareUnicodeCharacter{00C8}{\`E}%
10380   \DeclareUnicodeCharacter{00C9}{\'E}%
10381   \DeclareUnicodeCharacter{00CA}{\^E}%
10382   \DeclareUnicodeCharacter{00CB}{\"E}%
10383   \DeclareUnicodeCharacter{00CC}{\`I}%
10384   \DeclareUnicodeCharacter{00CD}{\'I}%
10385   \DeclareUnicodeCharacter{00CE}{\^I}%
10386   \DeclareUnicodeCharacter{00CF}{\"I}%
10387   %
10388   \DeclareUnicodeCharacter{00D0}{\DH}%
10389   \DeclareUnicodeCharacter{00D1}{\~N}%
10390   \DeclareUnicodeCharacter{00D2}{\`O}%
10391   \DeclareUnicodeCharacter{00D3}{\'O}%
10392   \DeclareUnicodeCharacter{00D4}{\^O}%
10393   \DeclareUnicodeCharacter{00D5}{\~O}%
10394   \DeclareUnicodeCharacter{00D6}{\"O}%
10395   \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
10396   \DeclareUnicodeCharacter{00D8}{\O}%
10397   \DeclareUnicodeCharacter{00D9}{\`U}%
10398   \DeclareUnicodeCharacter{00DA}{\'U}%
10399   \DeclareUnicodeCharacter{00DB}{\^U}%
10400   \DeclareUnicodeCharacter{00DC}{\"U}%
10401   \DeclareUnicodeCharacter{00DD}{\'Y}%
10402   \DeclareUnicodeCharacter{00DE}{\TH}%
10403   \DeclareUnicodeCharacter{00DF}{\ss}%
10404   %
10405   \DeclareUnicodeCharacter{00E0}{\`a}%
10406   \DeclareUnicodeCharacter{00E1}{\'a}%
10407   \DeclareUnicodeCharacter{00E2}{\^a}%
10408   \DeclareUnicodeCharacter{00E3}{\~a}%
10409   \DeclareUnicodeCharacter{00E4}{\"a}%
10410   \DeclareUnicodeCharacter{00E5}{\aa}%
10411   \DeclareUnicodeCharacter{00E6}{\ae}%
10412   \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
10413   \DeclareUnicodeCharacter{00E8}{\`e}%
10414   \DeclareUnicodeCharacter{00E9}{\'e}%
10415   \DeclareUnicodeCharacter{00EA}{\^e}%
10416   \DeclareUnicodeCharacter{00EB}{\"e}%
10417   \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
10418   \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
10419   \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
10420   \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
10421   %
10422   \DeclareUnicodeCharacter{00F0}{\dh}%
10423   \DeclareUnicodeCharacter{00F1}{\~n}%
10424   \DeclareUnicodeCharacter{00F2}{\`o}%
10425   \DeclareUnicodeCharacter{00F3}{\'o}%
10426   \DeclareUnicodeCharacter{00F4}{\^o}%
10427   \DeclareUnicodeCharacter{00F5}{\~o}%
10428   \DeclareUnicodeCharacter{00F6}{\"o}%
10429   \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
10430   \DeclareUnicodeCharacter{00F8}{\o}%
10431   \DeclareUnicodeCharacter{00F9}{\`u}%
10432   \DeclareUnicodeCharacter{00FA}{\'u}%
10433   \DeclareUnicodeCharacter{00FB}{\^u}%
10434   \DeclareUnicodeCharacter{00FC}{\"u}%
10435   \DeclareUnicodeCharacter{00FD}{\'y}%
10436   \DeclareUnicodeCharacter{00FE}{\th}%
10437   \DeclareUnicodeCharacter{00FF}{\"y}%
10438   %
10439   \DeclareUnicodeCharacter{0100}{\=A}%
10440   \DeclareUnicodeCharacter{0101}{\=a}%
10441   \DeclareUnicodeCharacter{0102}{\u{A}}%
10442   \DeclareUnicodeCharacter{0103}{\u{a}}%
10443   \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
10444   \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
10445   \DeclareUnicodeCharacter{0106}{\'C}%
10446   \DeclareUnicodeCharacter{0107}{\'c}%
10447   \DeclareUnicodeCharacter{0108}{\^C}%
10448   \DeclareUnicodeCharacter{0109}{\^c}%
10449   \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
10450   \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
10451   \DeclareUnicodeCharacter{010C}{\v{C}}%
10452   \DeclareUnicodeCharacter{010D}{\v{c}}%
10453   \DeclareUnicodeCharacter{010E}{\v{D}}%
10454   \DeclareUnicodeCharacter{010F}{d'}%
10455   %
10456   \DeclareUnicodeCharacter{0110}{\DH}%
10457   \DeclareUnicodeCharacter{0111}{\dh}%
10458   \DeclareUnicodeCharacter{0112}{\=E}%
10459   \DeclareUnicodeCharacter{0113}{\=e}%
10460   \DeclareUnicodeCharacter{0114}{\u{E}}%
10461   \DeclareUnicodeCharacter{0115}{\u{e}}%
10462   \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
10463   \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
10464   \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
10465   \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
10466   \DeclareUnicodeCharacter{011A}{\v{E}}%
10467   \DeclareUnicodeCharacter{011B}{\v{e}}%
10468   \DeclareUnicodeCharacter{011C}{\^G}%
10469   \DeclareUnicodeCharacter{011D}{\^g}%
10470   \DeclareUnicodeCharacter{011E}{\u{G}}%
10471   \DeclareUnicodeCharacter{011F}{\u{g}}%
10472   %
10473   \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
10474   \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
10475   \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
10476   \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
10477   \DeclareUnicodeCharacter{0124}{\^H}%
10478   \DeclareUnicodeCharacter{0125}{\^h}%
10479   \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
10480   \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
10481   \DeclareUnicodeCharacter{0128}{\~I}%
10482   \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
10483   \DeclareUnicodeCharacter{012A}{\=I}%
10484   \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
10485   \DeclareUnicodeCharacter{012C}{\u{I}}%
10486   \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
10487   \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
10488   \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
10489   %
10490   \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
10491   \DeclareUnicodeCharacter{0131}{\dotless{i}}%
10492   \DeclareUnicodeCharacter{0132}{IJ}%
10493   \DeclareUnicodeCharacter{0133}{ij}%
10494   \DeclareUnicodeCharacter{0134}{\^J}%
10495   \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
10496   \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
10497   \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
10498   \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
10499   \DeclareUnicodeCharacter{0139}{\'L}%
10500   \DeclareUnicodeCharacter{013A}{\'l}%
10501   \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
10502   \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
10503   \DeclareUnicodeCharacter{013D}{L'}% should kern
10504   \DeclareUnicodeCharacter{013E}{l'}% should kern
10505   \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
10506   %
10507   \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
10508   \DeclareUnicodeCharacter{0141}{\L}%
10509   \DeclareUnicodeCharacter{0142}{\l}%
10510   \DeclareUnicodeCharacter{0143}{\'N}%
10511   \DeclareUnicodeCharacter{0144}{\'n}%
10512   \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
10513   \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
10514   \DeclareUnicodeCharacter{0147}{\v{N}}%
10515   \DeclareUnicodeCharacter{0148}{\v{n}}%
10516   \DeclareUnicodeCharacter{0149}{'n}%
10517   \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
10518   \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
10519   \DeclareUnicodeCharacter{014C}{\=O}%
10520   \DeclareUnicodeCharacter{014D}{\=o}%
10521   \DeclareUnicodeCharacter{014E}{\u{O}}%
10522   \DeclareUnicodeCharacter{014F}{\u{o}}%
10523   %
10524   \DeclareUnicodeCharacter{0150}{\H{O}}%
10525   \DeclareUnicodeCharacter{0151}{\H{o}}%
10526   \DeclareUnicodeCharacter{0152}{\OE}%
10527   \DeclareUnicodeCharacter{0153}{\oe}%
10528   \DeclareUnicodeCharacter{0154}{\'R}%
10529   \DeclareUnicodeCharacter{0155}{\'r}%
10530   \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
10531   \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
10532   \DeclareUnicodeCharacter{0158}{\v{R}}%
10533   \DeclareUnicodeCharacter{0159}{\v{r}}%
10534   \DeclareUnicodeCharacter{015A}{\'S}%
10535   \DeclareUnicodeCharacter{015B}{\'s}%
10536   \DeclareUnicodeCharacter{015C}{\^S}%
10537   \DeclareUnicodeCharacter{015D}{\^s}%
10538   \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
10539   \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
10540   %
10541   \DeclareUnicodeCharacter{0160}{\v{S}}%
10542   \DeclareUnicodeCharacter{0161}{\v{s}}%
10543   \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
10544   \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
10545   \DeclareUnicodeCharacter{0164}{\v{T}}%
10546   \DeclareUnicodeCharacter{0165}{\v{t}}%
10547   \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
10548   \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
10549   \DeclareUnicodeCharacter{0168}{\~U}%
10550   \DeclareUnicodeCharacter{0169}{\~u}%
10551   \DeclareUnicodeCharacter{016A}{\=U}%
10552   \DeclareUnicodeCharacter{016B}{\=u}%
10553   \DeclareUnicodeCharacter{016C}{\u{U}}%
10554   \DeclareUnicodeCharacter{016D}{\u{u}}%
10555   \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
10556   \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
10557   %
10558   \DeclareUnicodeCharacter{0170}{\H{U}}%
10559   \DeclareUnicodeCharacter{0171}{\H{u}}%
10560   \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
10561   \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
10562   \DeclareUnicodeCharacter{0174}{\^W}%
10563   \DeclareUnicodeCharacter{0175}{\^w}%
10564   \DeclareUnicodeCharacter{0176}{\^Y}%
10565   \DeclareUnicodeCharacter{0177}{\^y}%
10566   \DeclareUnicodeCharacter{0178}{\"Y}%
10567   \DeclareUnicodeCharacter{0179}{\'Z}%
10568   \DeclareUnicodeCharacter{017A}{\'z}%
10569   \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
10570   \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
10571   \DeclareUnicodeCharacter{017D}{\v{Z}}%
10572   \DeclareUnicodeCharacter{017E}{\v{z}}%
10573   \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
10574   %
10575   \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
10576   \DeclareUnicodeCharacter{01C5}{D\v{z}}%
10577   \DeclareUnicodeCharacter{01C6}{d\v{z}}%
10578   \DeclareUnicodeCharacter{01C7}{LJ}%
10579   \DeclareUnicodeCharacter{01C8}{Lj}%
10580   \DeclareUnicodeCharacter{01C9}{lj}%
10581   \DeclareUnicodeCharacter{01CA}{NJ}%
10582   \DeclareUnicodeCharacter{01CB}{Nj}%
10583   \DeclareUnicodeCharacter{01CC}{nj}%
10584   \DeclareUnicodeCharacter{01CD}{\v{A}}%
10585   \DeclareUnicodeCharacter{01CE}{\v{a}}%
10586   \DeclareUnicodeCharacter{01CF}{\v{I}}%
10587   %
10588   \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
10589   \DeclareUnicodeCharacter{01D1}{\v{O}}%
10590   \DeclareUnicodeCharacter{01D2}{\v{o}}%
10591   \DeclareUnicodeCharacter{01D3}{\v{U}}%
10592   \DeclareUnicodeCharacter{01D4}{\v{u}}%
10593   %
10594   \DeclareUnicodeCharacter{01E2}{\={\AE}}%
10595   \DeclareUnicodeCharacter{01E3}{\={\ae}}%
10596   \DeclareUnicodeCharacter{01E6}{\v{G}}%
10597   \DeclareUnicodeCharacter{01E7}{\v{g}}%
10598   \DeclareUnicodeCharacter{01E8}{\v{K}}%
10599   \DeclareUnicodeCharacter{01E9}{\v{k}}%
10600   %
10601   \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
10602   \DeclareUnicodeCharacter{01F1}{DZ}%
10603   \DeclareUnicodeCharacter{01F2}{Dz}%
10604   \DeclareUnicodeCharacter{01F3}{dz}%
10605   \DeclareUnicodeCharacter{01F4}{\'G}%
10606   \DeclareUnicodeCharacter{01F5}{\'g}%
10607   \DeclareUnicodeCharacter{01F8}{\`N}%
10608   \DeclareUnicodeCharacter{01F9}{\`n}%
10609   \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
10610   \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
10611   \DeclareUnicodeCharacter{01FE}{\'{\O}}%
10612   \DeclareUnicodeCharacter{01FF}{\'{\o}}%
10613   %
10614   \DeclareUnicodeCharacter{021E}{\v{H}}%
10615   \DeclareUnicodeCharacter{021F}{\v{h}}%
10616   %
10617   \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
10618   \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
10619   \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
10620   \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
10621   \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
10622   \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
10623   %
10624   \DeclareUnicodeCharacter{0232}{\=Y}%
10625   \DeclareUnicodeCharacter{0233}{\=y}%
10626   \DeclareUnicodeCharacter{0237}{\dotless{j}}%
10627   %
10628   \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
10629   %
10630   % Greek letters upper case
10631   \DeclareUnicodeCharacter{0391}{{\it A}}%
10632   \DeclareUnicodeCharacter{0392}{{\it B}}%
10633   \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
10634   \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
10635   \DeclareUnicodeCharacter{0395}{{\it E}}%
10636   \DeclareUnicodeCharacter{0396}{{\it Z}}%
10637   \DeclareUnicodeCharacter{0397}{{\it H}}%
10638   \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
10639   \DeclareUnicodeCharacter{0399}{{\it I}}%
10640   \DeclareUnicodeCharacter{039A}{{\it K}}%
10641   \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
10642   \DeclareUnicodeCharacter{039C}{{\it M}}%
10643   \DeclareUnicodeCharacter{039D}{{\it N}}%
10644   \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
10645   \DeclareUnicodeCharacter{039F}{{\it O}}%
10646   \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
10647   \DeclareUnicodeCharacter{03A1}{{\it P}}%
10648   %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
10649   \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
10650   \DeclareUnicodeCharacter{03A4}{{\it T}}%
10651   \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
10652   \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
10653   \DeclareUnicodeCharacter{03A7}{{\it X}}%
10654   \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
10655   \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
10656   %
10657   % Vowels with accents
10658   \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
10659   \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
10660   \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
10661   \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
10662   \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
10663   \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
10664   %
10665   % Standalone accent
10666   \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
10667   %
10668   % Greek letters lower case
10669   \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
10670   \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
10671   \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
10672   \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
10673   \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
10674   \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
10675   \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
10676   \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
10677   \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
10678   \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
10679   \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
10680   \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
10681   \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
10682   \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
10683   \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
10684   \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
10685   \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
10686   \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
10687   \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
10688   \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
10689   \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
10690   \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
10691   \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
10692   \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
10693   \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
10694   %
10695   % More Greek vowels with accents
10696   \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
10697   \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
10698   \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
10699   \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
10700   \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
10701   %
10702   % Variant Greek letters
10703   \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
10704   \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
10705   \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
10706   %
10707   \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
10708   \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
10709   \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
10710   \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
10711   \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
10712   \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
10713   \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
10714   \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
10715   \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
10716   \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
10717   \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
10718   \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
10719   %
10720   \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
10721   \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
10722   %
10723   \DeclareUnicodeCharacter{1E20}{\=G}%
10724   \DeclareUnicodeCharacter{1E21}{\=g}%
10725   \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
10726   \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
10727   \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
10728   \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
10729   \DeclareUnicodeCharacter{1E26}{\"H}%
10730   \DeclareUnicodeCharacter{1E27}{\"h}%
10731   %
10732   \DeclareUnicodeCharacter{1E30}{\'K}%
10733   \DeclareUnicodeCharacter{1E31}{\'k}%
10734   \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
10735   \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
10736   \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
10737   \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
10738   \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
10739   \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
10740   \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
10741   \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
10742   \DeclareUnicodeCharacter{1E3E}{\'M}%
10743   \DeclareUnicodeCharacter{1E3F}{\'m}%
10744   %
10745   \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
10746   \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
10747   \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
10748   \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
10749   \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
10750   \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
10751   \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
10752   \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
10753   \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
10754   \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
10755   %
10756   \DeclareUnicodeCharacter{1E54}{\'P}%
10757   \DeclareUnicodeCharacter{1E55}{\'p}%
10758   \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
10759   \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
10760   \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
10761   \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
10762   \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
10763   \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
10764   \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
10765   \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
10766   %
10767   \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
10768   \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
10769   \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
10770   \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
10771   \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
10772   \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
10773   \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
10774   \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
10775   \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
10776   \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
10777   %
10778   \DeclareUnicodeCharacter{1E7C}{\~V}%
10779   \DeclareUnicodeCharacter{1E7D}{\~v}%
10780   \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
10781   \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
10782   %
10783   \DeclareUnicodeCharacter{1E80}{\`W}%
10784   \DeclareUnicodeCharacter{1E81}{\`w}%
10785   \DeclareUnicodeCharacter{1E82}{\'W}%
10786   \DeclareUnicodeCharacter{1E83}{\'w}%
10787   \DeclareUnicodeCharacter{1E84}{\"W}%
10788   \DeclareUnicodeCharacter{1E85}{\"w}%
10789   \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
10790   \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
10791   \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
10792   \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
10793   \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
10794   \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
10795   \DeclareUnicodeCharacter{1E8C}{\"X}%
10796   \DeclareUnicodeCharacter{1E8D}{\"x}%
10797   \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
10798   \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
10799   %
10800   \DeclareUnicodeCharacter{1E90}{\^Z}%
10801   \DeclareUnicodeCharacter{1E91}{\^z}%
10802   \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
10803   \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
10804   \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
10805   \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
10806   \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
10807   \DeclareUnicodeCharacter{1E97}{\"t}%
10808   \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
10809   \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
10810   %
10811   \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
10812   \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
10813   %
10814   \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
10815   \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
10816   \DeclareUnicodeCharacter{1EBC}{\~E}%
10817   \DeclareUnicodeCharacter{1EBD}{\~e}%
10818   %
10819   \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
10820   \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
10821   \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
10822   \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
10823   %
10824   \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
10825   \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
10826   %
10827   \DeclareUnicodeCharacter{1EF2}{\`Y}%
10828   \DeclareUnicodeCharacter{1EF3}{\`y}%
10829   \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
10830   %
10831   \DeclareUnicodeCharacter{1EF8}{\~Y}%
10832   \DeclareUnicodeCharacter{1EF9}{\~y}%
10833   %
10834   % Punctuation
10835   \DeclareUnicodeCharacter{2013}{--}%
10836   \DeclareUnicodeCharacter{2014}{---}%
10837   \DeclareUnicodeCharacter{2018}{\quoteleft}%
10838   \DeclareUnicodeCharacter{2019}{\quoteright}%
10839   \DeclareUnicodeCharacter{201A}{\quotesinglbase}%
10840   \DeclareUnicodeCharacter{201C}{\quotedblleft}%
10841   \DeclareUnicodeCharacter{201D}{\quotedblright}%
10842   \DeclareUnicodeCharacter{201E}{\quotedblbase}%
10843   \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
10844   \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
10845   \DeclareUnicodeCharacter{2022}{\bullet}%
10846   \DeclareUnicodeCharacter{202F}{\thinspace}%
10847   \DeclareUnicodeCharacter{2026}{\dots}%
10848   \DeclareUnicodeCharacter{2039}{\guilsinglleft}%
10849   \DeclareUnicodeCharacter{203A}{\guilsinglright}%
10850   %
10851   \DeclareUnicodeCharacter{20AC}{\euro}%
10852   %
10853   \DeclareUnicodeCharacter{2192}{\expansion}%
10854   \DeclareUnicodeCharacter{21D2}{\result}%
10855   %
10856   % Mathematical symbols
10857   \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
10858   \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
10859   \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
10860   \DeclareUnicodeCharacter{2212}{\minus}%
10861   \DeclareUnicodeCharacter{2217}{\ast}%
10862   \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
10863   \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
10864   \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
10865   \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
10866   \DeclareUnicodeCharacter{2261}{\equiv}%
10867   \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
10868   \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
10869   \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
10870   \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
10871   %
10872   \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
10873   \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
10874   \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
10875   \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
10876   \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
10877   \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
10878   \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
10879   \DeclareUnicodeCharacter{2127}{\ensuremath\mho}%
10880   \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
10881   \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
10882   \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
10883   \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
10884   \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
10885   \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
10886   \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
10887   \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
10888   \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
10889   \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
10890   \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
10891   \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
10892   \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
10893   \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
10894   \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
10895   \DeclareUnicodeCharacter{21BE}{\ensuremath\upharpoonright}%
10896   \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
10897   \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
10898   \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
10899   \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
10900   \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
10901   \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
10902   \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
10903   \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
10904   \DeclareUnicodeCharacter{21DD}{\ensuremath\leadsto}%
10905   \DeclareUnicodeCharacter{2201}{\ensuremath\complement}%
10906   \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
10907   \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
10908   \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
10909   \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
10910   \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
10911   \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
10912   \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
10913   \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
10914   \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
10915   \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
10916   \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
10917   \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
10918   \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
10919   \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
10920   \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
10921   \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
10922   \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
10923   \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
10924   \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
10925   \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
10926   \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
10927   \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
10928   \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
10929   \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
10930   \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
10931   \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
10932   \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
10933   \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
10934   \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
10935   \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
10936   \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
10937   \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
10938   \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
10939   \DeclareUnicodeCharacter{228F}{\ensuremath\sqsubset}%
10940   \DeclareUnicodeCharacter{2290}{\ensuremath\sqsupset}%
10941   \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
10942   \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
10943   \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
10944   \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
10945   \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
10946   \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
10947   \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
10948   \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
10949   \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
10950   \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
10951   \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
10952   \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
10953   \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
10954   \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
10955   \DeclareUnicodeCharacter{22B4}{\ensuremath\unlhd}%
10956   \DeclareUnicodeCharacter{22B5}{\ensuremath\unrhd}%
10957   \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
10958   \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
10959   \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
10960   \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
10961   \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
10962   \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
10963   \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
10964   \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
10965   \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
10966   \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
10967   \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
10968   \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
10969   \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
10970   \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
10971   %
10972   \DeclareUnicodeCharacter{25A1}{\ensuremath\Box}%
10973   \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
10974   \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
10975   \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
10976   \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
10977   \DeclareUnicodeCharacter{25C7}{\ensuremath\Diamond}%
10978   \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
10979   \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
10980   \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
10981   \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
10982   \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
10983   \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
10984   \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
10985   \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
10986   \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
10987   \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
10988   \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
10989   \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
10990   \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
10991   \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
10992   \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
10993   \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
10994   \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
10995   \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
10996   \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
10997   \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
10998   \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
10999   \DeclareUnicodeCharacter{2A1D}{\ensuremath\Join}%
11000   \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
11001   \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
11002   \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
11003   %
11004   \global\mathchardef\checkmark="1370% actually the square root sign
11005   \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
11006 }% end of \unicodechardefs
11007
11008 % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
11009 % It makes the setting that replace UTF-8 byte sequence.
11010 \def\utfeightchardefs{%
11011   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
11012   \unicodechardefs
11013 }
11014
11015 % Whether the active definitions of non-ASCII characters expand to
11016 % non-active tokens with the same character code.  This is used to
11017 % write characters literally, instead of using active definitions for
11018 % printing the correct glyphs.
11019 \newif\ifpassthroughchars
11020 \passthroughcharsfalse
11021
11022 % For native Unicode (XeTeX and LuaTeX)
11023 % Definition macro to replace / pass-through the Unicode character
11024 %
11025 \def\DeclareUnicodeCharacterNative#1#2{%
11026   \catcode"#1=\active
11027   \def\dodeclareunicodecharacternative##1##2##3{%
11028     \begingroup
11029       \uccode`\~="##2\relax
11030       \uppercase{\gdef~}{%
11031         \ifpassthroughchars
11032           ##1%
11033         \else
11034           ##3%
11035         \fi
11036       }
11037     \endgroup
11038   }
11039   \begingroup
11040     \uccode`\.="#1\relax
11041     \uppercase{\def\UTFNativeTmp{.}}%
11042     \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
11043   \endgroup
11044 }
11045
11046 % Native Unicode (XeTeX and LuaTeX) character replacing definitions
11047 % It makes the setting that replace the Unicode characters.
11048 \def\nativeunicodechardefs{%
11049   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
11050   \unicodechardefs
11051 }
11052
11053 % For native Unicode (XeTeX and LuaTeX).  Make the character token expand
11054 % to the sequences given in \unicodechardefs for printing.
11055 \def\DeclareUnicodeCharacterNativeAtU#1#2{%
11056   \def\UTFAtUTmp{#2}
11057   \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
11058 }
11059
11060 % Native Unicode (XeTeX and LuaTeX) @U command definitions
11061 \def\nativeunicodechardefsatu{%
11062   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
11063   \unicodechardefs
11064 }
11065
11066 % US-ASCII character definitions.
11067 \def\asciichardefs{% nothing need be done
11068    \relax
11069 }
11070
11071 % define all the unicode characters we know about, for the sake of @U.
11072 \iftxinativeunicodecapable
11073   \nativeunicodechardefsatu
11074 \else
11075   \utfeightchardefs
11076 \fi
11077
11078
11079 % Make non-ASCII characters printable again for compatibility with
11080 % existing Texinfo documents that may use them, even without declaring a
11081 % document encoding.
11082 %
11083 \setnonasciicharscatcode \other
11084
11085
11086 \message{formatting,}
11087
11088 \newdimen\defaultparindent \defaultparindent = 15pt
11089
11090 \chapheadingskip = 15pt plus 4pt minus 2pt
11091 \secheadingskip = 12pt plus 3pt minus 2pt
11092 \subsecheadingskip = 9pt plus 2pt minus 2pt
11093
11094 % Prevent underfull vbox error messages.
11095 \vbadness = 10000
11096
11097 % Don't be very finicky about underfull hboxes, either.
11098 \hbadness = 6666
11099
11100 % Following George Bush, get rid of widows and orphans.
11101 \widowpenalty=10000
11102 \clubpenalty=10000
11103
11104 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
11105 % using an old version of TeX, don't do anything.  We want the amount of
11106 % stretch added to depend on the line length, hence the dependence on
11107 % \hsize.  We call this whenever the paper size is set.
11108 %
11109 \def\setemergencystretch{%
11110   \ifx\emergencystretch\thisisundefined
11111     % Allow us to assign to \emergencystretch anyway.
11112     \def\emergencystretch{\dimen0}%
11113   \else
11114     \emergencystretch = .15\hsize
11115   \fi
11116 }
11117
11118 % Parameters in order: 1) textheight; 2) textwidth;
11119 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
11120 % 7) physical page height; 8) physical page width.
11121 %
11122 % We also call \setleading{\textleading}, so the caller should define
11123 % \textleading.  The caller should also set \parskip.
11124 %
11125 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
11126   \voffset = #3\relax
11127   \topskip = #6\relax
11128   \splittopskip = \topskip
11129   %
11130   \vsize = #1\relax
11131   \advance\vsize by \topskip
11132   \outervsize = \vsize
11133   \advance\outervsize by 2\topandbottommargin
11134   \txipageheight = \vsize
11135   %
11136   \hsize = #2\relax
11137   \outerhsize = \hsize
11138   \advance\outerhsize by 0.5in
11139   \txipagewidth = \hsize
11140   %
11141   \normaloffset = #4\relax
11142   \bindingoffset = #5\relax
11143   %
11144   \ifpdf
11145     \pdfpageheight #7\relax
11146     \pdfpagewidth #8\relax
11147     % if we don't reset these, they will remain at "1 true in" of
11148     % whatever layout pdftex was dumped with.
11149     \pdfhorigin = 1 true in
11150     \pdfvorigin = 1 true in
11151   \else
11152     \ifx\XeTeXrevision\thisisundefined
11153     \else
11154       \pdfpageheight #7\relax
11155       \pdfpagewidth #8\relax
11156       % XeTeX does not have \pdfhorigin and \pdfvorigin.
11157     \fi
11158   \fi
11159   %
11160   \setleading{\textleading}
11161   %
11162   \parindent = \defaultparindent
11163   \setemergencystretch
11164 }
11165
11166 % @letterpaper (the default).
11167 \def\letterpaper{{\globaldefs = 1
11168   \parskip = 3pt plus 2pt minus 1pt
11169   \textleading = 13.2pt
11170   %
11171   % If page is nothing but text, make it come out even.
11172   \internalpagesizes{607.2pt}{6in}% that's 46 lines
11173                     {\voffset}{.25in}%
11174                     {\bindingoffset}{36pt}%
11175                     {11in}{8.5in}%
11176 }}
11177
11178 % Use @smallbook to reset parameters for 7x9.25 trim size.
11179 \def\smallbook{{\globaldefs = 1
11180   \parskip = 2pt plus 1pt
11181   \textleading = 12pt
11182   %
11183   \internalpagesizes{7.5in}{5in}%
11184                     {-.2in}{0in}%
11185                     {\bindingoffset}{16pt}%
11186                     {9.25in}{7in}%
11187   %
11188   \lispnarrowing = 0.3in
11189   \tolerance = 700
11190   \hfuzz = 1pt
11191   \contentsrightmargin = 0pt
11192   \defbodyindent = .5cm
11193 }}
11194
11195 % Use @smallerbook to reset parameters for 6x9 trim size.
11196 % (Just testing, parameters still in flux.)
11197 \def\smallerbook{{\globaldefs = 1
11198   \parskip = 1.5pt plus 1pt
11199   \textleading = 12pt
11200   %
11201   \internalpagesizes{7.4in}{4.8in}%
11202                     {-.2in}{-.4in}%
11203                     {0pt}{14pt}%
11204                     {9in}{6in}%
11205   %
11206   \lispnarrowing = 0.25in
11207   \tolerance = 700
11208   \hfuzz = 1pt
11209   \contentsrightmargin = 0pt
11210   \defbodyindent = .4cm
11211 }}
11212
11213 % Use @afourpaper to print on European A4 paper.
11214 \def\afourpaper{{\globaldefs = 1
11215   \parskip = 3pt plus 2pt minus 1pt
11216   \textleading = 13.2pt
11217   %
11218   % Double-side printing via postscript on Laserjet 4050
11219   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
11220   % To change the settings for a different printer or situation, adjust
11221   % \normaloffset until the front-side and back-side texts align.  Then
11222   % do the same for \bindingoffset.  You can set these for testing in
11223   % your texinfo source file like this:
11224   % @tex
11225   % \global\normaloffset = -6mm
11226   % \global\bindingoffset = 10mm
11227   % @end tex
11228   \internalpagesizes{673.2pt}{160mm}% that's 51 lines
11229                     {\voffset}{\hoffset}%
11230                     {\bindingoffset}{44pt}%
11231                     {297mm}{210mm}%
11232   %
11233   \tolerance = 700
11234   \hfuzz = 1pt
11235   \contentsrightmargin = 0pt
11236   \defbodyindent = 5mm
11237 }}
11238
11239 % Use @afivepaper to print on European A5 paper.
11240 % From romildo@urano.iceb.ufop.br, 2 July 2000.
11241 % He also recommends making @example and @lisp be small.
11242 \def\afivepaper{{\globaldefs = 1
11243   \parskip = 2pt plus 1pt minus 0.1pt
11244   \textleading = 12.5pt
11245   %
11246   \internalpagesizes{160mm}{120mm}%
11247                     {\voffset}{\hoffset}%
11248                     {\bindingoffset}{8pt}%
11249                     {210mm}{148mm}%
11250   %
11251   \lispnarrowing = 0.2in
11252   \tolerance = 800
11253   \hfuzz = 1.2pt
11254   \contentsrightmargin = 0pt
11255   \defbodyindent = 2mm
11256   \tableindent = 12mm
11257 }}
11258
11259 % A specific text layout, 24x15cm overall, intended for A4 paper.
11260 \def\afourlatex{{\globaldefs = 1
11261   \afourpaper
11262   \internalpagesizes{237mm}{150mm}%
11263                     {\voffset}{4.6mm}%
11264                     {\bindingoffset}{7mm}%
11265                     {297mm}{210mm}%
11266   %
11267   % Must explicitly reset to 0 because we call \afourpaper.
11268   \globaldefs = 0
11269 }}
11270
11271 % Use @afourwide to print on A4 paper in landscape format.
11272 \def\afourwide{{\globaldefs = 1
11273   \afourpaper
11274   \internalpagesizes{241mm}{165mm}%
11275                     {\voffset}{-2.95mm}%
11276                     {\bindingoffset}{7mm}%
11277                     {297mm}{210mm}%
11278   \globaldefs = 0
11279 }}
11280
11281 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
11282 % Perhaps we should allow setting the margins, \topskip, \parskip,
11283 % and/or leading, also. Or perhaps we should compute them somehow.
11284 %
11285 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
11286 \def\pagesizesyyy#1,#2,#3\finish{{%
11287   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
11288   \globaldefs = 1
11289   %
11290   \parskip = 3pt plus 2pt minus 1pt
11291   \setleading{\textleading}%
11292   %
11293   \dimen0 = #1\relax
11294   \advance\dimen0 by \voffset
11295   %
11296   \dimen2 = \hsize
11297   \advance\dimen2 by \normaloffset
11298   %
11299   \internalpagesizes{#1}{\hsize}%
11300                     {\voffset}{\normaloffset}%
11301                     {\bindingoffset}{44pt}%
11302                     {\dimen0}{\dimen2}%
11303 }}
11304
11305 % Set default to letter.
11306 %
11307 \letterpaper
11308
11309
11310 \message{and turning on texinfo input format.}
11311
11312 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
11313
11314 % DEL is a comment character, in case @c does not suffice.
11315 \catcode`\^^? = 14
11316
11317 % Define macros to output various characters with catcode for normal text.
11318 \catcode`\"=\other \def\normaldoublequote{"}
11319 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
11320 \catcode`\+=\other \def\normalplus{+}
11321 \catcode`\<=\other \def\normalless{<}
11322 \catcode`\>=\other \def\normalgreater{>}
11323 \catcode`\^=\other \def\normalcaret{^}
11324 \catcode`\_=\other \def\normalunderscore{_}
11325 \catcode`\|=\other \def\normalverticalbar{|}
11326 \catcode`\~=\other \def\normaltilde{~}
11327
11328 % This macro is used to make a character print one way in \tt
11329 % (where it can probably be output as-is), and another way in other fonts,
11330 % where something hairier probably needs to be done.
11331 %
11332 % #1 is what to print if we are indeed using \tt; #2 is what to print
11333 % otherwise.  Since all the Computer Modern typewriter fonts have zero
11334 % interword stretch (and shrink), and it is reasonable to expect all
11335 % typewriter fonts to have this, we can check that font parameter.
11336 %
11337 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
11338
11339 % Same as above, but check for italic font.  Actually this also catches
11340 % non-italic slanted fonts since it is impossible to distinguish them from
11341 % italic fonts.  But since this is only used by $ and it uses \sl anyway
11342 % this is not a problem.
11343 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
11344
11345 % Set catcodes for Texinfo file
11346
11347 % Active characters for printing the wanted glyph.
11348 % Most of these we simply print from the \tt font, but for some, we can
11349 % use math or other variants that look better in normal text.
11350 %
11351 \catcode`\"=\active
11352 \def\activedoublequote{{\tt\char34}}
11353 \let"=\activedoublequote
11354 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
11355 \chardef\hatchar=`\^
11356 \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
11357
11358 \catcode`\_=\active
11359 \def_{\ifusingtt\normalunderscore\_}
11360 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
11361 \let\realunder=_
11362
11363 \catcode`\|=\active \def|{{\tt\char124}}
11364
11365 \chardef \less=`\<
11366 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
11367 \chardef \gtr=`\>
11368 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
11369 \catcode`\+=\active \def+{{\tt \char 43}}
11370 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
11371 \catcode`\-=\active \let-=\normaldash
11372
11373
11374 % used for headline/footline in the output routine, in case the page
11375 % breaks in the middle of an @tex block.
11376 \def\texinfochars{%
11377   \let< = \activeless
11378   \let> = \activegtr
11379   \let~ = \activetilde 
11380   \let^ = \activehat
11381   \markupsetuplqdefault \markupsetuprqdefault 
11382   \let\b = \strong
11383   \let\i = \smartitalic
11384   % in principle, all other definitions in \tex have to be undone too.
11385 }
11386
11387 % Used sometimes to turn off (effectively) the active characters even after
11388 % parsing them.
11389 \def\turnoffactive{%
11390   \normalturnoffactive
11391   \otherbackslash
11392 }
11393
11394 \catcode`\@=0
11395
11396 % \backslashcurfont outputs one backslash character in current font,
11397 % as in \char`\\.
11398 \global\chardef\backslashcurfont=`\\
11399 \global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
11400
11401 % \realbackslash is an actual character `\' with catcode other, and
11402 % \doublebackslash is two of them (for the pdf outlines).
11403 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
11404
11405 % In Texinfo, backslash is an active character; it prints the backslash
11406 % in fixed width font.
11407 \catcode`\\=\active  % @ for escape char from now on.
11408
11409 % Print a typewriter backslash.  For math mode, we can't simply use
11410 % \backslashcurfont: the story here is that in math mode, the \char
11411 % of \backslashcurfont ends up printing the roman \ from the math symbol
11412 % font (because \char in math mode uses the \mathcode, and plain.tex
11413 % sets \mathcode`\\="026E).  Hence we use an explicit \mathchar,
11414 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
11415 % ignored family value; char position "5C).  We can't use " for the
11416 % usual hex value because it has already been made active.
11417
11418 @def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
11419 @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
11420
11421 % \rawbackslash defines an active \ to do \backslashcurfont.
11422 % \otherbackslash defines an active \ to be a literal `\' character with
11423 % catcode other.  We switch back and forth between these.
11424 @gdef@rawbackslash{@let\=@backslashcurfont}
11425 @gdef@otherbackslash{@let\=@realbackslash}
11426
11427 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
11428 % the literal character `\'.
11429 %
11430 {@catcode`- = @active
11431  @gdef@normalturnoffactive{%
11432    @passthroughcharstrue
11433    @let-=@normaldash
11434    @let"=@normaldoublequote
11435    @let$=@normaldollar %$ font-lock fix
11436    @let+=@normalplus
11437    @let<=@normalless
11438    @let>=@normalgreater
11439    @let^=@normalcaret
11440    @let_=@normalunderscore
11441    @let|=@normalverticalbar
11442    @let~=@normaltilde
11443    @let\=@ttbackslash
11444    @markupsetuplqdefault
11445    @markupsetuprqdefault
11446    @unsepspaces
11447  }
11448 }
11449
11450 % If a .fmt file is being used, characters that might appear in a file
11451 % name cannot be active until we have parsed the command line.
11452 % So turn them off again, and have @fixbackslash turn them back on.
11453 @catcode`+=@other @catcode`@_=@other
11454
11455 % \enablebackslashhack - allow file to begin `\input texinfo'
11456 %
11457 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
11458 % That is what \eatinput is for; after that, the `\' should revert to printing
11459 % a backslash.
11460 % If the file did not have a `\input texinfo', then it is turned off after
11461 % the first line; otherwise the first `\' in the file would cause an error.
11462 % This is used on the very last line of this file, texinfo.tex.
11463 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
11464 {
11465 @catcode`@^=7
11466 @catcode`@^^M=13@gdef@enablebackslashhack{%
11467   @global@let\ = @eatinput%
11468   @catcode`@^^M=13%
11469   @def@c{@fixbackslash@c}%
11470   % Definition for the newline at the end of this file.
11471   @def ^^M{@let^^M@secondlinenl}%
11472   % Definition for a newline in the main Texinfo file.
11473   @gdef @secondlinenl{@fixbackslash}%
11474 }}
11475
11476 {@catcode`@^=7 @catcode`@^^M=13%
11477 @gdef@eatinput input texinfo#1^^M{@fixbackslash}}
11478
11479 % Emergency active definition of newline, in case an active newline token
11480 % appears by mistake.
11481 {@catcode`@^=7 @catcode13=13%
11482 @gdef@enableemergencynewline{%
11483   @gdef^^M{%
11484     @par%
11485     %<warning: active newline>@par%
11486 }}}
11487
11488
11489 @gdef@fixbackslash{%
11490   @ifx\@eatinput @let\ = @ttbackslash @fi
11491   @catcode13=5 % regular end of line
11492   @enableemergencynewline
11493   @let@c=@texinfoc
11494   % Also turn back on active characters that might appear in the input
11495   % file name, in case not using a pre-dumped format.
11496   @catcode`+=@active
11497   @catcode`@_=@active
11498   %
11499   % If texinfo.cnf is present on the system, read it.
11500   % Useful for site-wide @afourpaper, etc.  This macro, @fixbackslash, gets
11501   % called at the beginning of every Texinfo file.  Not opening texinfo.cnf
11502   % directly in this file, texinfo.tex, makes it possible to make a format
11503   % file for Texinfo.
11504   %
11505   @openin 1 texinfo.cnf
11506   @ifeof 1 @else @input texinfo.cnf @fi
11507   @closein 1
11508 }
11509
11510
11511 % Say @foo, not \foo, in error messages.
11512 @escapechar = `@@
11513
11514 % These (along with & and #) are made active for url-breaking, so need
11515 % active definitions as the normal characters.
11516 @def@normaldot{.}
11517 @def@normalquest{?}
11518 @def@normalslash{/}
11519
11520 % These look ok in all fonts, so just make them not special.
11521 % @hashchar{} gets its own user-level command, because of #line.
11522 @catcode`@& = @other @def@normalamp{&}
11523 @catcode`@# = @other @def@normalhash{#}
11524 @catcode`@% = @other @def@normalpercent{%}
11525
11526 @let @hashchar = @normalhash
11527
11528 @c Finally, make ` and ' active, so that txicodequoteundirected and
11529 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
11530 @c don't make ` and ' active, @code will not get them as active chars.
11531 @c Do this last of all since we use ` in the previous @catcode assignments.
11532 @catcode`@'=@active
11533 @catcode`@`=@active
11534 @markupsetuplqdefault
11535 @markupsetuprqdefault
11536
11537 @c Local variables:
11538 @c eval: (add-hook 'write-file-hooks 'time-stamp)
11539 @c page-delimiter: "^\\\\message\\|emacs-page"
11540 @c time-stamp-start: "def\\\\texinfoversion{"
11541 @c time-stamp-format: "%:y-%02m-%02d.%02H"
11542 @c time-stamp-end: "}"
11543 @c End:
11544
11545 @c vim:sw=2:
11546
11547 @ignore
11548    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
11549 @end ignore
11550 @enablebackslashhack