Imported Upstream version 4.4
[platform/upstream/make.git] / build-aux / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2022-04-09.08}
7 %
8 % Copyright 1985, 1986, 1988, 1990-2022 Free Software Foundation, Inc.
9 %
10 % This texinfo.tex file is free software: you can redistribute it and/or
11 % modify it under the terms of the GNU General Public License as
12 % published by the Free Software Foundation, either version 3 of the
13 % License, or (at your option) any later version.
14 %
15 % This texinfo.tex file is distributed in the hope that it will be
16 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 % General Public License for more details.
19 %
20 % You should have received a copy of the GNU General Public License
21 % along with this program.  If not, see <https://www.gnu.org/licenses/>.
22 %
23 % As a special exception, when this file is read by TeX when processing
24 % a Texinfo source document, you may use the result without
25 % restriction. This Exception is an additional permission under section 7
26 % of the GNU General Public License, version 3 ("GPLv3").
27 %
28 % Please try the latest version of texinfo.tex before submitting bug
29 % reports; you can get the latest version from:
30 %   https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
31 %   https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
32 %   https://www.gnu.org/software/texinfo/ (the Texinfo home page)
33 % The texinfo.tex in any given distribution could well be out
34 % of date, so if that's what you're using, please check.
35 %
36 % Send bug reports to bug-texinfo@gnu.org.  Please include a
37 % complete document in each bug report with which we can reproduce the
38 % problem.  Patches are, of course, greatly appreciated.
39 %
40 % To process a Texinfo manual with TeX, it's most reliable to use the
41 % texi2dvi shell script that comes with the distribution.  For a simple
42 % manual foo.texi, however, you can get away with this:
43 %   tex foo.texi
44 %   texindex foo.??
45 %   tex foo.texi
46 %   tex foo.texi
47 %   dvips foo.dvi -o  # or whatever; this makes foo.ps.
48 % The extra TeX runs get the cross-reference information correct.
49 % Sometimes one run after texindex suffices, and sometimes you need more
50 % than two; texi2dvi does it as many times as necessary.
51 %
52 % It is possible to adapt texinfo.tex for other languages, to some
53 % extent.  You can get the existing language-specific files from the
54 % full Texinfo distribution.
55 %
56 % The GNU Texinfo home page is https://www.gnu.org/software/texinfo.
57
58
59 \message{Loading texinfo [version \texinfoversion]:}
60
61 % If in a .fmt file, print the version number
62 % and turn on active characters that we couldn't do earlier because
63 % they might have appeared in the input file name.
64 \everyjob{\message{[Texinfo version \texinfoversion]}%
65   \catcode`+=\active \catcode`\_=\active}
66
67 % LaTeX's \typeout.  This ensures that the messages it is used for
68 % are identical in format to the corresponding ones from latex/pdflatex.
69 \def\typeout{\immediate\write17}%
70
71 \chardef\other=12
72
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
76
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
93 \let\ptexlbrace=\{
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
97 \let\ptexplus=+
98 \let\ptexraggedright=\raggedright
99 \let\ptexrbrace=\}
100 \let\ptexslash=\/
101 \let\ptexsp=\sp
102 \let\ptexstar=\*
103 \let\ptexsup=\sup
104 \let\ptext=\t
105 \let\ptextop=\top
106 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
107
108 % If this character appears in an error message or help string, it
109 % starts a new line in the output.
110 \newlinechar = `^^J
111
112 % Use TeX 3.0's \inputlineno to get the line number, for better error
113 % messages, but if we're using an old version of TeX, don't do anything.
114 %
115 \ifx\inputlineno\thisisundefined
116   \let\linenumber = \empty % Pre-3.0.
117 \else
118   \def\linenumber{l.\the\inputlineno:\space}
119 \fi
120
121 % Set up fixed words for English if not already set.
122 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
123 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
124 \ifx\putworderror\undefined     \gdef\putworderror{error}\fi
125 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
126 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
127 \ifx\putwordIndexIsEmpty\undefined       \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
128 \ifx\putwordIndexNonexistent\undefined   \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
129 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
130 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
131 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
132 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
133 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
134 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
135 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
136 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
137 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
138 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
139 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
140 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
141 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
142 %
143 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
144 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
145 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
146 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
147 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
148 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
149 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
150 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
151 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
152 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
153 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
154 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
155 %
156 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
157 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
158 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
159 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
160 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
161
162 % Give the space character the catcode for a space.
163 \def\spaceisspace{\catcode`\ =10\relax}
164
165 % Likewise for ^^M, the end of line character.
166 \def\endlineisspace{\catcode13=10\relax}
167
168 \chardef\dashChar  = `\-
169 \chardef\slashChar = `\/
170 \chardef\underChar = `\_
171
172 % Ignore a token.
173 %
174 \def\gobble#1{}
175
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
178
179 % Hyphenation fixes.
180 \hyphenation{
181   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182   ap-pen-dix bit-map bit-maps
183   data-base data-bases eshell fall-ing half-way long-est man-u-script
184   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186   spell-ing spell-ings
187   stand-alone strong-est time-stamp time-stamps which-ever white-space
188   wide-spread wrap-around
189 }
190
191 % Sometimes it is convenient to have everything in the transcript file
192 % and nothing on the terminal.  We don't just call \tracingall here,
193 % since that produces some useless output on the terminal.  We also make
194 % some effort to order the tracing commands to reduce output in the log
195 % file; cf. trace.sty in LaTeX.
196 %
197 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
198 \def\loggingall{%
199   \tracingstats2
200   \tracingpages1
201   \tracinglostchars2  % 2 gives us more in etex
202   \tracingparagraphs1
203   \tracingoutput1
204   \tracingmacros2
205   \tracingrestores1
206   \showboxbreadth\maxdimen \showboxdepth\maxdimen
207   \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
208     \tracingscantokens1
209     \tracingifs1
210     \tracinggroups1
211     \tracingnesting2
212     \tracingassigns1
213   \fi
214   \tracingcommands3  % 3 gives us more in etex
215   \errorcontextlines16
216 }%
217
218 % @errormsg{MSG}.  Do the index-like expansions on MSG, but if things
219 % aren't perfect, it's not the end of the world, being an error message,
220 % after all.
221 %
222 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
223 \def\doerrormsg#1{\errmessage{#1}}
224
225 % add check for \lastpenalty to plain's definitions.  If the last thing
226 % we did was a \nobreak, we don't want to insert more space.
227 %
228 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
229   \removelastskip\penalty-50\smallskip\fi\fi}
230 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
231   \removelastskip\penalty-100\medskip\fi\fi}
232 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
233   \removelastskip\penalty-200\bigskip\fi\fi}
234
235 %\f Output routine
236 %
237
238 % For a final copy, take out the rectangles
239 % that mark overfull boxes (in case you have decided
240 % that the text looks ok even though it passes the margin).
241 %
242 \def\finalout{\overfullrule=0pt }
243
244 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
245 \newdimen\topandbottommargin \topandbottommargin=.75in
246
247 % Output a mark which sets \thischapter, \thissection and \thiscolor.
248 % We dump everything together because we only have one kind of mark.
249 % This works because we only use \botmark / \topmark, not \firstmark.
250 %
251 % A mark contains a subexpression of the \ifcase ... \fi construct.
252 % \get*marks macros below extract the needed part using \ifcase.
253 %
254 % Another complication is to let the user choose whether \thischapter
255 % (\thissection) refers to the chapter (section) in effect at the top
256 % of a page, or that at the bottom of a page.
257
258 % \domark is called twice inside \chapmacro, to add one
259 % mark before the section break, and one after.
260 %   In the second call \prevchapterdefs is the same as \currentchapterdefs,
261 % and \prevsectiondefs is the same as \currentsectiondefs.
262 %   Then if the page is not broken at the mark, some of the previous
263 % section appears on the page, and we can get the name of this section
264 % from \firstmark for @everyheadingmarks top.
265 %   @everyheadingmarks bottom uses \botmark.
266 %
267 % See page 260 of The TeXbook.
268 \def\domark{%
269   \toks0=\expandafter{\currentchapterdefs}%
270   \toks2=\expandafter{\currentsectiondefs}%
271   \toks4=\expandafter{\prevchapterdefs}%
272   \toks6=\expandafter{\prevsectiondefs}%
273   \toks8=\expandafter{\currentcolordefs}%
274   \mark{%
275                    \the\toks0 \the\toks2  % 0: marks for @everyheadingmarks top
276       \noexpand\or \the\toks4 \the\toks6  % 1: for @everyheadingmarks bottom
277     \noexpand\else \the\toks8             % 2: color marks
278   }%
279 }
280
281 % \gettopheadingmarks, \getbottomheadingmarks,
282 % \getcolormarks - extract needed part of mark.
283 %
284 % \topmark doesn't work for the very first chapter (after the title
285 % page or the contents), so we use \firstmark there -- this gets us
286 % the mark with the chapter defs, unless the user sneaks in, e.g.,
287 % @setcolor (or @url, or @link, etc.) between @contents and the very
288 % first @chapter.
289 \def\gettopheadingmarks{%
290   \ifcase0\the\savedtopmark\fi
291   \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
292 }
293 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
294 \def\getcolormarks{\ifcase2\the\savedtopmark\fi}
295
296 % Avoid "undefined control sequence" errors.
297 \def\currentchapterdefs{}
298 \def\currentsectiondefs{}
299 \def\currentsection{}
300 \def\prevchapterdefs{}
301 \def\prevsectiondefs{}
302 \def\currentcolordefs{}
303
304 % Margin to add to right of even pages, to left of odd pages.
305 \newdimen\bindingoffset
306 \newdimen\normaloffset
307 \newdimen\txipagewidth \newdimen\txipageheight
308
309 % Main output routine.
310 %
311 \chardef\PAGE = 255
312 \newtoks\defaultoutput
313 \defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}}
314 \output=\expandafter{\the\defaultoutput}
315
316 \newbox\headlinebox
317 \newbox\footlinebox
318
319 % When outputting the double column layout for indices, an output routine
320 % is run several times, which hides the original value of \topmark.  This
321 % can lead to a page heading being output and duplicating the chapter heading
322 % of the index.  Hence, save the contents of \topmark at the beginning of
323 % the output routine.  The saved contents are valid until we actually
324 % \shipout a page.
325 %
326 % (We used to run a short output routine to actually set \topmark and
327 % \firstmark to the right values, but if this was called with an empty page
328 % containing whatsits for writing index entries, the whatsits would be thrown
329 % away and the index auxiliary file would remain empty.)
330 %
331 \newtoks\savedtopmark
332 \newif\iftopmarksaved
333 \topmarksavedtrue
334 \def\savetopmark{%
335   \iftopmarksaved\else
336     \global\savedtopmark=\expandafter{\topmark}%
337     \global\topmarksavedtrue
338   \fi
339 }
340
341 % \onepageout takes a vbox as an argument.
342 % \shipout a vbox for a single page, adding an optional header, footer
343 % and footnote.  This also causes index entries for this page to be written
344 % to the auxiliary files.
345 %
346 \def\onepageout#1{%
347   \hoffset=\normaloffset
348   %
349   \ifodd\pageno  \advance\hoffset by \bindingoffset
350   \else \advance\hoffset by -\bindingoffset\fi
351   %
352   \checkchapterpage
353   %
354   % Retrieve the information for the headings from the marks in the page,
355   % and call Plain TeX's \makeheadline and \makefootline, which use the
356   % values in \headline and \footline.
357   %
358   % Common context changes for both heading and footing.
359   % Do this outside of the \shipout so @code etc. will be expanded in
360   % the headline as they should be, not taken literally (outputting ''code).
361   \def\commonheadfootline{\let\hsize=\txipagewidth \texinfochars}
362   %
363   \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
364   \global\setbox\headlinebox = \vbox{\commonheadfootline \makeheadline}%
365   \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
366   \global\setbox\footlinebox = \vbox{\commonheadfootline \makefootline}%
367   %
368   {%
369     % Set context for writing to auxiliary files like index files.
370     % Have to do this stuff outside the \shipout because we want it to
371     % take effect in \write's, yet the group defined by the \vbox ends
372     % before the \shipout runs.
373     %
374     \atdummies         % don't expand commands in the output.
375     \turnoffactive
376     \shipout\vbox{%
377       % Do this early so pdf references go to the beginning of the page.
378       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
379       %
380       \unvbox\headlinebox
381       \pagebody{#1}%
382       \ifdim\ht\footlinebox > 0pt
383         % Only leave this space if the footline is nonempty.
384         % (We lessened \vsize for it in \oddfootingyyy.)
385         % The \baselineskip=24pt in plain's \makefootline has no effect.
386         \vskip 24pt
387         \unvbox\footlinebox
388       \fi
389       %
390     }%
391   }%
392   \global\topmarksavedfalse
393   \advancepageno
394   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
395 }
396
397 \newinsert\margin \dimen\margin=\maxdimen
398
399 % Main part of page, including any footnotes
400 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
401 {\catcode`\@ =11
402 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
403 % marginal hacks, juha@viisa.uucp (Juha Takala)
404 \ifvoid\margin\else % marginal info is present
405   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
406 \dimen@=\dp#1\relax \unvbox#1\relax
407 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
408 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
409 }
410
411 % Check if we are on the first page of a chapter.  Used for printing headings.
412 \newif\ifchapterpage
413 \def\checkchapterpage{%
414   % Get the chapter that was current at the end of the last page
415   \ifcase1\the\savedtopmark\fi
416   \let\prevchaptername\thischaptername
417   %
418   \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
419   \let\curchaptername\thischaptername
420   %
421   \ifx\curchaptername\prevchaptername
422     \chapterpagefalse
423   \else
424     \chapterpagetrue
425   \fi
426 }
427
428 % Argument parsing
429
430 % Parse an argument, then pass it to #1.  The argument is the rest of
431 % the input line (except we remove a trailing comment).  #1 should be a
432 % macro which expects an ordinary undelimited TeX argument.
433 % For example, \def\foo{\parsearg\fooxxx}.
434 %
435 \def\parsearg{\parseargusing{}}
436 \def\parseargusing#1#2{%
437   \def\argtorun{#2}%
438   \begingroup
439     \obeylines
440     \spaceisspace
441     #1%
442     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
443 }
444
445 {\obeylines %
446   \gdef\parseargline#1^^M{%
447     \endgroup % End of the group started in \parsearg.
448     \argremovecomment #1\comment\ArgTerm%
449   }%
450 }
451
452 % First remove any @comment, then any @c comment.  Pass the result on to
453 % \argcheckspaces.
454 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
455 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
456
457 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
458 %
459 % \argremovec might leave us with trailing space, e.g.,
460 %    @end itemize  @c foo
461 % This space token undergoes the same procedure and is eventually removed
462 % by \finishparsearg.
463 %
464 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
465 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
466 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
467   \def\temp{#3}%
468   \ifx\temp\empty
469     % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
470     \let\temp\finishparsearg
471   \else
472     \let\temp\argcheckspaces
473   \fi
474   % Put the space token in:
475   \temp#1 #3\ArgTerm
476 }
477
478 % If a _delimited_ argument is enclosed in braces, they get stripped; so
479 % to get _exactly_ the rest of the line, we had to prevent such situation.
480 % We prepended an \empty token at the very beginning and we expand it now,
481 % just before passing the control to \argtorun.
482 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
483 % either the null string, or it ends with \^^M---thus there is no danger
484 % that a pair of braces would be stripped.
485 %
486 % But first, we have to remove the trailing space token.
487 %
488 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
489
490
491 % \parseargdef - define a command taking an argument on the line
492 %
493 % \parseargdef\foo{...}
494 %       is roughly equivalent to
495 % \def\foo{\parsearg\Xfoo}
496 % \def\Xfoo#1{...}
497 \def\parseargdef#1{%
498   \expandafter \doparseargdef \csname\string#1\endcsname #1%
499 }
500 \def\doparseargdef#1#2{%
501   \def#2{\parsearg#1}%
502   \def#1##1%
503 }
504
505 % Several utility definitions with active space:
506 {
507   \obeyspaces
508   \gdef\obeyedspace{ }
509
510   % Make each space character in the input produce a normal interword
511   % space in the output.  Don't allow a line break at this space, as this
512   % is used only in environments like @example, where each line of input
513   % should produce a line of output anyway.
514   %
515   \gdef\sepspaces{\obeyspaces\let =\tie}
516
517   % If an index command is used in an @example environment, any spaces
518   % therein should become regular spaces in the raw index file, not the
519   % expansion of \tie (\leavevmode \penalty \@M \ ).
520   \gdef\unsepspaces{\let =\space}
521 }
522
523
524 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
525
526 % Define the framework for environments in texinfo.tex.  It's used like this:
527 %
528 %   \envdef\foo{...}
529 %   \def\Efoo{...}
530 %
531 % It's the responsibility of \envdef to insert \begingroup before the
532 % actual body; @end closes the group after calling \Efoo.  \envdef also
533 % defines \thisenv, so the current environment is known; @end checks
534 % whether the environment name matches.  The \checkenv macro can also be
535 % used to check whether the current environment is the one expected.
536 %
537 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
538 % are not treated as environments; they don't open a group.  (The
539 % implementation of @end takes care not to call \endgroup in this
540 % special case.)
541
542
543 % At run-time, environments start with this:
544 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
545 % initialize
546 \let\thisenv\empty
547
548 % ... but they get defined via ``\envdef\foo{...}'':
549 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
550 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
551
552 % Check whether we're in the right environment:
553 \def\checkenv#1{%
554   \def\temp{#1}%
555   \ifx\thisenv\temp
556   \else
557     \badenverr
558   \fi
559 }
560
561 % Environment mismatch, #1 expected:
562 \def\badenverr{%
563   \errhelp = \EMsimple
564   \errmessage{This command can appear only \inenvironment\temp,
565     not \inenvironment\thisenv}%
566 }
567 \def\inenvironment#1{%
568   \ifx#1\empty
569     outside of any environment%
570   \else
571     in environment \expandafter\string#1%
572   \fi
573 }
574
575
576 % @end foo calls \checkenv and executes the definition of \Efoo.
577 \parseargdef\end{%
578   \if 1\csname iscond.#1\endcsname
579   \else
580     % The general wording of \badenverr may not be ideal.
581     \expandafter\checkenv\csname#1\endcsname
582     \csname E#1\endcsname
583     \endgroup
584   \fi
585 }
586
587 \newhelp\EMsimple{Press RETURN to continue.}
588
589
590 % Be sure we're in horizontal mode when doing a tie, since we make space
591 % equivalent to this in @example-like environments. Otherwise, a space
592 % at the beginning of a line will start with \penalty -- and
593 % since \penalty is valid in vertical mode, we'd end up putting the
594 % penalty on the vertical list instead of in the new paragraph.
595 {\catcode`@ = 11
596  % Avoid using \@M directly, because that causes trouble
597  % if the definition is written into an index file.
598  \global\let\tiepenalty = \@M
599  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
600 }
601
602 % @: forces normal size whitespace following.
603 \def\:{\spacefactor=1000 }
604
605 % @* forces a line break.
606 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
607
608 % @/ allows a line break.
609 \let\/=\allowbreak
610
611 % @. is an end-of-sentence period.
612 \def\.{.\spacefactor=\endofsentencespacefactor\space}
613
614 % @! is an end-of-sentence bang.
615 \def\!{!\spacefactor=\endofsentencespacefactor\space}
616
617 % @? is an end-of-sentence query.
618 \def\?{?\spacefactor=\endofsentencespacefactor\space}
619
620 % @frenchspacing on|off  says whether to put extra space after punctuation.
621 %
622 \def\onword{on}
623 \def\offword{off}
624 %
625 \parseargdef\frenchspacing{%
626   \def\temp{#1}%
627   \ifx\temp\onword \plainfrenchspacing
628   \else\ifx\temp\offword \plainnonfrenchspacing
629   \else
630     \errhelp = \EMsimple
631     \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
632   \fi\fi
633 }
634
635 % @w prevents a word break.  Without the \leavevmode, @w at the
636 % beginning of a paragraph, when TeX is still in vertical mode, would
637 % produce a whole line of output instead of starting the paragraph.
638 \def\w#1{\leavevmode\hbox{#1}}
639
640 % @group ... @end group forces ... to be all on one page, by enclosing
641 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
642 % to keep its height that of a normal line.  According to the rules for
643 % \topskip (p.114 of the TeXbook), the glue inserted is
644 % max (\topskip - \ht (first item), 0).  If that height is large,
645 % therefore, no glue is inserted, and the space between the headline and
646 % the text is small, which looks bad.
647 %
648 % Another complication is that the group might be very large.  This can
649 % cause the glue on the previous page to be unduly stretched, because it
650 % does not have much material.  In this case, it's better to add an
651 % explicit \vfill so that the extra space is at the bottom.  The
652 % threshold for doing this is if the group is more than \vfilllimit
653 % percent of a page (\vfilllimit can be changed inside of @tex).
654 %
655 \newbox\groupbox
656 \def\vfilllimit{0.7}
657 %
658 \envdef\group{%
659   \ifnum\catcode`\^^M=\active \else
660     \errhelp = \groupinvalidhelp
661     \errmessage{@group invalid in context where filling is enabled}%
662   \fi
663   \startsavinginserts
664   %
665   \setbox\groupbox = \vtop\bgroup
666     % Do @comment since we are called inside an environment such as
667     % @example, where each end-of-line in the input causes an
668     % end-of-line in the output.  We don't want the end-of-line after
669     % the `@group' to put extra space in the output.  Since @group
670     % should appear on a line by itself (according to the Texinfo
671     % manual), we don't worry about eating any user text.
672     \comment
673 }
674 %
675 % The \vtop produces a box with normal height and large depth; thus, TeX puts
676 % \baselineskip glue before it, and (when the next line of text is done)
677 % \lineskip glue after it.  Thus, space below is not quite equal to space
678 % above.  But it's pretty close.
679 \def\Egroup{%
680     % To get correct interline space between the last line of the group
681     % and the first line afterwards, we have to propagate \prevdepth.
682     \endgraf % Not \par, as it may have been set to \lisppar.
683     \global\dimen1 = \prevdepth
684   \egroup           % End the \vtop.
685   \addgroupbox
686   \prevdepth = \dimen1
687   \checkinserts
688 }
689
690 \def\addgroupbox{
691   % \dimen0 is the vertical size of the group's box.
692   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
693   % \dimen2 is how much space is left on the page (more or less).
694   \dimen2 = \txipageheight   \advance\dimen2 by -\pagetotal
695   % if the group doesn't fit on the current page, and it's a big big
696   % group, force a page break.
697   \ifdim \dimen0 > \dimen2
698     \ifdim \pagetotal < \vfilllimit\txipageheight
699       \page
700     \fi
701   \fi
702   \box\groupbox
703 }
704
705 %
706 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
707 % message, so this ends up printing `@group can only ...'.
708 %
709 \newhelp\groupinvalidhelp{%
710 group can only be used in environments such as @example,^^J%
711 where each line of input produces a line of output.}
712
713 % @need space-in-mils
714 % forces a page break if there is not space-in-mils remaining.
715
716 \newdimen\mil  \mil=0.001in
717
718 \parseargdef\need{%
719   % Ensure vertical mode, so we don't make a big box in the middle of a
720   % paragraph.
721   \par
722   %
723   % If the @need value is less than one line space, it's useless.
724   \dimen0 = #1\mil
725   \dimen2 = \ht\strutbox
726   \advance\dimen2 by \dp\strutbox
727   \ifdim\dimen0 > \dimen2
728     %
729     % Do a \strut just to make the height of this box be normal, so the
730     % normal leading is inserted relative to the preceding line.
731     % And a page break here is fine.
732     \vtop to #1\mil{\strut\vfil}%
733     %
734     % TeX does not even consider page breaks if a penalty added to the
735     % main vertical list is 10000 or more.  But in order to see if the
736     % empty box we just added fits on the page, we must make it consider
737     % page breaks.  On the other hand, we don't want to actually break the
738     % page after the empty box.  So we use a penalty of 9999.
739     %
740     % There is an extremely small chance that TeX will actually break the
741     % page at this \penalty, if there are no other feasible breakpoints in
742     % sight.  (If the user is using lots of big @group commands, which
743     % almost-but-not-quite fill up a page, TeX will have a hard time doing
744     % good page breaking, for example.)  However, I could not construct an
745     % example where a page broke at this \penalty; if it happens in a real
746     % document, then we can reconsider our strategy.
747     \penalty9999
748     %
749     % Back up by the size of the box, whether we did a page break or not.
750     \kern -#1\mil
751     %
752     % Do not allow a page break right after this kern.
753     \nobreak
754   \fi
755 }
756
757 % @br   forces paragraph break (and is undocumented).
758
759 \let\br = \par
760
761 % @page forces the start of a new page.
762 %
763 \def\page{\par\vfill\supereject}
764
765 % @exdent text....
766 % outputs text on separate line in roman font, starting at standard page margin
767
768 % This records the amount of indent in the innermost environment.
769 % That's how much \exdent should take out.
770 \newskip\exdentamount
771
772 % This defn is used inside fill environments such as @defun.
773 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
774
775 % This defn is used inside nofill environments such as @example.
776 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
777   \leftline{\hskip\leftskip{\rm#1}}}}
778
779 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
780 % paragraph.  For more general purposes, use the \margin insertion
781 % class.  WHICH is `l' or `r'.  Not documented, written for gawk manual.
782 %
783 \newskip\inmarginspacing \inmarginspacing=1cm
784 \def\strutdepth{\dp\strutbox}
785 %
786 \def\doinmargin#1#2{\strut\vadjust{%
787   \nobreak
788   \kern-\strutdepth
789   \vtop to \strutdepth{%
790     \baselineskip=\strutdepth
791     \vss
792     % if you have multiple lines of stuff to put here, you'll need to
793     % make the vbox yourself of the appropriate size.
794     \ifx#1l%
795       \llap{\ignorespaces #2\hskip\inmarginspacing}%
796     \else
797       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
798     \fi
799     \null
800   }%
801 }}
802 \def\inleftmargin{\doinmargin l}
803 \def\inrightmargin{\doinmargin r}
804 %
805 % @inmargin{TEXT [, RIGHT-TEXT]}
806 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
807 % else use TEXT for both).
808 %
809 \def\inmargin#1{\parseinmargin #1,,\finish}
810 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
811   \setbox0 = \hbox{\ignorespaces #2}%
812   \ifdim\wd0 > 0pt
813     \def\lefttext{#1}%  have both texts
814     \def\righttext{#2}%
815   \else
816     \def\lefttext{#1}%  have only one text
817     \def\righttext{#1}%
818   \fi
819   %
820   \ifodd\pageno
821     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
822   \else
823     \def\temp{\inleftmargin\lefttext}%
824   \fi
825   \temp
826 }
827
828 % @include FILE -- \input text of FILE.
829 %
830 \def\include{\parseargusing\filenamecatcodes\includezzz}
831 \def\includezzz#1{%
832   \pushthisfilestack
833   \def\thisfile{#1}%
834   {%
835     \makevalueexpandable  % we want to expand any @value in FILE.
836     \turnoffactive        % and allow special characters in the expansion
837     \indexnofonts         % Allow `@@' and other weird things in file names.
838     \wlog{texinfo.tex: doing @include of #1^^J}%
839     \edef\temp{\noexpand\input #1 }%
840     %
841     % This trickery is to read FILE outside of a group, in case it makes
842     % definitions, etc.
843     \expandafter
844   }\temp
845   \popthisfilestack
846 }
847 \def\filenamecatcodes{%
848   \catcode`\\=\other
849   \catcode`~=\other
850   \catcode`^=\other
851   \catcode`_=\other
852   \catcode`|=\other
853   \catcode`<=\other
854   \catcode`>=\other
855   \catcode`+=\other
856   \catcode`-=\other
857   \catcode`\`=\other
858   \catcode`\'=\other
859 }
860
861 \def\pushthisfilestack{%
862   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
863 }
864 \def\pushthisfilestackX{%
865   \expandafter\pushthisfilestackY\thisfile\StackTerm
866 }
867 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
868   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
869 }
870
871 \def\popthisfilestack{\errthisfilestackempty}
872 \def\errthisfilestackempty{\errmessage{Internal error:
873   the stack of filenames is empty.}}
874 %
875 \def\thisfile{}
876
877 % @center line
878 % outputs that line, centered.
879 %
880 \parseargdef\center{%
881   \ifhmode
882     \let\centersub\centerH
883   \else
884     \let\centersub\centerV
885   \fi
886   \centersub{\hfil \ignorespaces#1\unskip \hfil}%
887   \let\centersub\relax % don't let the definition persist, just in case
888 }
889 \def\centerH#1{{%
890   \hfil\break
891   \advance\hsize by -\leftskip
892   \advance\hsize by -\rightskip
893   \line{#1}%
894   \break
895 }}
896 %
897 \newcount\centerpenalty
898 \def\centerV#1{%
899   % The idea here is the same as in \startdefun, \cartouche, etc.: if
900   % @center is the first thing after a section heading, we need to wipe
901   % out the negative parskip inserted by \sectionheading, but still
902   % prevent a page break here.
903   \centerpenalty = \lastpenalty
904   \ifnum\centerpenalty>10000 \vskip\parskip \fi
905   \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
906   \line{\kern\leftskip #1\kern\rightskip}%
907 }
908
909 % @sp n   outputs n lines of vertical space
910 %
911 \parseargdef\sp{\vskip #1\baselineskip}
912
913 % @comment ...line which is ignored...
914 % @c is the same as @comment
915 % @ignore ... @end ignore  is another way to write a comment
916
917
918 \def\c{\begingroup \catcode`\^^M=\active%
919 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
920 \cxxx}
921 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
922 %
923 \let\comment\c
924
925 % @paragraphindent NCHARS
926 % We'll use ems for NCHARS, close enough.
927 % NCHARS can also be the word `asis' or `none'.
928 % We cannot feasibly implement @paragraphindent asis, though.
929 %
930 \def\asisword{asis} % no translation, these are keywords
931 \def\noneword{none}
932 %
933 \parseargdef\paragraphindent{%
934   \def\temp{#1}%
935   \ifx\temp\asisword
936   \else
937     \ifx\temp\noneword
938       \defaultparindent = 0pt
939     \else
940       \defaultparindent = #1em
941     \fi
942   \fi
943   \parindent = \defaultparindent
944 }
945
946 % @exampleindent NCHARS
947 % We'll use ems for NCHARS like @paragraphindent.
948 % It seems @exampleindent asis isn't necessary, but
949 % I preserve it to make it similar to @paragraphindent.
950 \parseargdef\exampleindent{%
951   \def\temp{#1}%
952   \ifx\temp\asisword
953   \else
954     \ifx\temp\noneword
955       \lispnarrowing = 0pt
956     \else
957       \lispnarrowing = #1em
958     \fi
959   \fi
960 }
961
962 % @firstparagraphindent WORD
963 % If WORD is `none', then suppress indentation of the first paragraph
964 % after a section heading.  If WORD is `insert', then do indent at such
965 % paragraphs.
966 %
967 % The paragraph indentation is suppressed or not by calling
968 % \suppressfirstparagraphindent, which the sectioning commands do.
969 % We switch the definition of this back and forth according to WORD.
970 % By default, we suppress indentation.
971 %
972 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
973 \def\insertword{insert}
974 %
975 \parseargdef\firstparagraphindent{%
976   \def\temp{#1}%
977   \ifx\temp\noneword
978     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
979   \else\ifx\temp\insertword
980     \let\suppressfirstparagraphindent = \relax
981   \else
982     \errhelp = \EMsimple
983     \errmessage{Unknown @firstparagraphindent option `\temp'}%
984   \fi\fi
985 }
986
987 % Here is how we actually suppress indentation.  Redefine \everypar to
988 % \kern backwards by \parindent, and then reset itself to empty.
989 %
990 % We also make \indent itself not actually do anything until the next
991 % paragraph.
992 %
993 \gdef\dosuppressfirstparagraphindent{%
994   \gdef\indent  {\restorefirstparagraphindent \indent}%
995   \gdef\noindent{\restorefirstparagraphindent \noindent}%
996   \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
997 }
998 %
999 \gdef\restorefirstparagraphindent{%
1000   \global\let\indent = \ptexindent
1001   \global\let\noindent = \ptexnoindent
1002   \global\everypar = {}%
1003 }
1004
1005 % leave vertical mode without cancelling any first paragraph indent
1006 \gdef\imageindent{%
1007   \toks0=\everypar
1008   \everypar={}%
1009   \ptexnoindent
1010   \global\everypar=\toks0
1011 }
1012
1013
1014 % @refill is a no-op.
1015 \let\refill=\relax
1016
1017 % @setfilename INFO-FILENAME - ignored
1018 \let\setfilename=\comment
1019
1020 % @bye.
1021 \outer\def\bye{\chappager\pagelabels\tracingstats=1\ptexend}
1022
1023
1024 \message{pdf,}
1025 % adobe `portable' document format
1026 \newcount\tempnum
1027 \newcount\lnkcount
1028 \newtoks\filename
1029 \newcount\filenamelength
1030 \newcount\pgn
1031 \newtoks\toksA
1032 \newtoks\toksB
1033 \newtoks\toksC
1034 \newtoks\toksD
1035 \newbox\boxA
1036 \newbox\boxB
1037 \newcount\countA
1038 \newif\ifpdf
1039 \newif\ifpdfmakepagedest
1040
1041 %
1042 % For LuaTeX
1043 %
1044
1045 \newif\iftxiuseunicodedestname
1046 \txiuseunicodedestnamefalse % For pdfTeX etc.
1047
1048 \ifx\luatexversion\thisisundefined
1049 \else
1050   % Use Unicode destination names
1051   \txiuseunicodedestnametrue
1052   % Escape PDF strings with converting UTF-16 from UTF-8
1053   \begingroup
1054     \catcode`\%=12
1055     \directlua{
1056       function UTF16oct(str)
1057         tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
1058         for c in string.utfvalues(str) do
1059           if c < 0x10000 then
1060             tex.sprint(
1061               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1062                             string.char(0x5c) .. string.char(0x25) .. '03o',
1063                             math.floor(c / 256), math.floor(c % 256)))
1064           else
1065             c = c - 0x10000
1066             local c_hi = c / 1024 + 0xd800
1067             local c_lo = c % 1024 + 0xdc00
1068             tex.sprint(
1069               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1070                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
1071                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
1072                             string.char(0x5c) .. string.char(0x25) .. '03o',
1073                             math.floor(c_hi / 256), math.floor(c_hi % 256),
1074                             math.floor(c_lo / 256), math.floor(c_lo % 256)))
1075           end
1076         end
1077       end
1078     }
1079   \endgroup
1080   \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
1081   % Escape PDF strings without converting
1082   \begingroup
1083     \directlua{
1084       function PDFescstr(str)
1085         for c in string.bytes(str) do
1086           if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
1087             tex.sprint(-2,
1088               string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
1089                             c))
1090           else
1091             tex.sprint(-2, string.char(c))
1092           end
1093         end
1094       end
1095     }
1096     % The -2 in the arguments here gives all the input to TeX catcode 12
1097     % (other) or 10 (space), preventing undefined control sequence errors. See
1098     % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
1099     %
1100   \endgroup
1101   \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
1102   \ifnum\luatexversion>84
1103     % For LuaTeX >= 0.85
1104     \def\pdfdest{\pdfextension dest}
1105     \let\pdfoutput\outputmode
1106     \def\pdfliteral{\pdfextension literal}
1107     \def\pdfcatalog{\pdfextension catalog}
1108     \def\pdftexversion{\numexpr\pdffeedback version\relax}
1109     \let\pdfximage\saveimageresource
1110     \let\pdfrefximage\useimageresource
1111     \let\pdflastximage\lastsavedimageresourceindex
1112     \def\pdfendlink{\pdfextension endlink\relax}
1113     \def\pdfoutline{\pdfextension outline}
1114     \def\pdfstartlink{\pdfextension startlink}
1115     \def\pdffontattr{\pdfextension fontattr}
1116     \def\pdfobj{\pdfextension obj}
1117     \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
1118     \let\pdfpagewidth\pagewidth
1119     \let\pdfpageheight\pageheight
1120     \edef\pdfhorigin{\pdfvariable horigin}
1121     \edef\pdfvorigin{\pdfvariable vorigin}
1122   \fi
1123 \fi
1124
1125 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1126 % can be set).  So we test for \relax and 0 as well as being undefined.
1127 \ifx\pdfoutput\thisisundefined
1128 \else
1129   \ifx\pdfoutput\relax
1130   \else
1131     \ifcase\pdfoutput
1132     \else
1133       \pdftrue
1134     \fi
1135   \fi
1136 \fi
1137
1138 \newif\ifpdforxetex
1139 \pdforxetexfalse
1140 \ifpdf
1141   \pdforxetextrue
1142 \fi
1143 \ifx\XeTeXrevision\thisisundefined\else
1144   \pdforxetextrue
1145 \fi
1146
1147
1148 % Output page labels information.
1149 % See PDF reference v.1.7 p.594, section 8.3.1.
1150 \ifpdf
1151 \def\pagelabels{%
1152   \def\title{0 << /P (T-) /S /D >>}%
1153   \edef\roman{\the\romancount << /S /r >>}%
1154   \edef\arabic{\the\arabiccount << /S /D >>}%
1155   %
1156   % Page label ranges must be increasing.  Remove any duplicates.
1157   % (There is a slight chance of this being wrong if e.g. there is
1158   % a @contents but no @titlepage, etc.)
1159   %
1160   \ifnum\romancount=0 \def\roman{}\fi
1161   \ifnum\arabiccount=0 \def\title{}%
1162   \else
1163     \ifnum\romancount=\arabiccount \def\roman{}\fi
1164   \fi
1165   %
1166   \ifnum\romancount<\arabiccount
1167     \pdfcatalog{/PageLabels << /Nums [\title \roman \arabic ] >> }\relax
1168   \else
1169     \pdfcatalog{/PageLabels << /Nums [\title \arabic \roman ] >> }\relax
1170   \fi
1171 }
1172 \else
1173   \let\pagelabels\relax
1174 \fi
1175
1176 \newcount\pagecount \pagecount=0
1177 \newcount\romancount \romancount=0
1178 \newcount\arabiccount \arabiccount=0
1179 \ifpdf
1180   \let\ptxadvancepageno\advancepageno
1181   \def\advancepageno{%
1182     \ptxadvancepageno\global\advance\pagecount by 1
1183   }
1184 \fi
1185
1186
1187 % PDF uses PostScript string constants for the names of xref targets,
1188 % for display in the outlines, and in other places.  Thus, we have to
1189 % double any backslashes.  Otherwise, a name like "\node" will be
1190 % interpreted as a newline (\n), followed by o, d, e.  Not good.
1191 %
1192 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1193 % related messages.  The final outcome is that it is up to the TeX user
1194 % to double the backslashes and otherwise make the string valid, so
1195 % that's what we do.  pdftex 1.30.0 (ca.2005) introduced a primitive to
1196 % do this reliably, so we use it.
1197
1198 % #1 is a control sequence in which to do the replacements,
1199 % which we \xdef.
1200 \def\txiescapepdf#1{%
1201   \ifx\pdfescapestring\thisisundefined
1202     % No primitive available; should we give a warning or log?
1203     % Many times it won't matter.
1204     \xdef#1{#1}%
1205   \else
1206     % The expandable \pdfescapestring primitive escapes parentheses,
1207     % backslashes, and other special chars.
1208     \xdef#1{\pdfescapestring{#1}}%
1209   \fi
1210 }
1211 \def\txiescapepdfutfsixteen#1{%
1212   \ifx\pdfescapestrutfsixteen\thisisundefined
1213     % No UTF-16 converting macro available.
1214     \txiescapepdf{#1}%
1215   \else
1216     \xdef#1{\pdfescapestrutfsixteen{#1}}%
1217   \fi
1218 }
1219
1220 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1221 with PDF output, and none of those formats could be found.  (.eps cannot
1222 be supported due to the design of the PDF format; use regular TeX (DVI
1223 output) for that.)}
1224
1225 \ifpdf
1226   %
1227   % Color manipulation macros using ideas from pdfcolor.tex,
1228   % except using rgb instead of cmyk; the latter is said to render as a
1229   % very dark gray on-screen and a very dark halftone in print, instead
1230   % of actual black. The dark red here is dark enough to print on paper as
1231   % nearly black, but still distinguishable for online viewing.  We use
1232   % black by default, though.
1233   \def\rgbDarkRed{0.50 0.09 0.12}
1234   \def\rgbBlack{0 0 0}
1235   %
1236   % rg sets the color for filling (usual text, etc.);
1237   % RG sets the color for stroking (thin rules, e.g., normal _'s).
1238   \def\pdfsetcolor#1{\pdfliteral{#1 rg  #1 RG}}
1239   %
1240   % Set color, and create a mark which defines \thiscolor accordingly,
1241   % so that \makeheadline knows which color to restore.
1242   \def\setcolor#1{%
1243     \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1244     \domark
1245     \pdfsetcolor{#1}%
1246   }
1247   %
1248   \def\maincolor{\rgbBlack}
1249   \pdfsetcolor{\maincolor}
1250   \edef\thiscolor{\maincolor}
1251   \def\currentcolordefs{}
1252   %
1253   \def\makefootline{%
1254     \baselineskip24pt
1255     \line{\pdfsetcolor{\maincolor}\the\footline}%
1256   }
1257   %
1258   \def\makeheadline{%
1259     \vbox to 0pt{%
1260       \vskip-22.5pt
1261       \line{%
1262         \vbox to8.5pt{}%
1263         % Extract \thiscolor definition from the marks.
1264         \getcolormarks
1265         % Typeset the headline with \maincolor, then restore the color.
1266         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1267       }%
1268       \vss
1269     }%
1270     \nointerlineskip
1271   }
1272   %
1273   %
1274   \pdfcatalog{/PageMode /UseOutlines}
1275   %
1276   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1277   \def\dopdfimage#1#2#3{%
1278     \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1279     \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1280     %
1281     % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1282     % others).  Let's try in that order, PDF first since if
1283     % someone has a scalable image, presumably better to use that than a
1284     % bitmap.
1285     \let\pdfimgext=\empty
1286     \begingroup
1287       \openin 1 #1.pdf \ifeof 1
1288         \openin 1 #1.PDF \ifeof 1
1289           \openin 1 #1.png \ifeof 1
1290             \openin 1 #1.jpg \ifeof 1
1291               \openin 1 #1.jpeg \ifeof 1
1292                 \openin 1 #1.JPG \ifeof 1
1293                   \errhelp = \nopdfimagehelp
1294                   \errmessage{Could not find image file #1 for pdf}%
1295                 \else \gdef\pdfimgext{JPG}%
1296                 \fi
1297               \else \gdef\pdfimgext{jpeg}%
1298               \fi
1299             \else \gdef\pdfimgext{jpg}%
1300             \fi
1301           \else \gdef\pdfimgext{png}%
1302           \fi
1303         \else \gdef\pdfimgext{PDF}%
1304         \fi
1305       \else \gdef\pdfimgext{pdf}%
1306       \fi
1307       \closein 1
1308     \endgroup
1309     %
1310     % without \immediate, ancient pdftex seg faults when the same image is
1311     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1312     \ifnum\pdftexversion < 14
1313       \immediate\pdfimage
1314     \else
1315       \immediate\pdfximage
1316     \fi
1317       \ifdim \wd0 >0pt width \pdfimagewidth \fi
1318       \ifdim \wd2 >0pt height \pdfimageheight \fi
1319       \ifnum\pdftexversion<13
1320          #1.\pdfimgext
1321        \else
1322          {#1.\pdfimgext}%
1323        \fi
1324     \ifnum\pdftexversion < 14 \else
1325       \pdfrefximage \pdflastximage
1326     \fi}
1327   %
1328   \def\setpdfdestname#1{{%
1329     % We have to set dummies so commands such as @code, and characters
1330     % such as \, aren't expanded when present in a section title.
1331     \indexnofonts
1332     \makevalueexpandable
1333     \turnoffactive
1334     \iftxiuseunicodedestname
1335       \ifx \declaredencoding \latone
1336         % Pass through Latin-1 characters.
1337         % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
1338       \else
1339         \ifx \declaredencoding \utfeight
1340           % Pass through Unicode characters.
1341         \else
1342           % Use ASCII approximations in destination names.
1343           \passthroughcharsfalse
1344         \fi
1345       \fi
1346     \else
1347       % Use ASCII approximations in destination names.
1348       \passthroughcharsfalse
1349     \fi
1350     \def\pdfdestname{#1}%
1351     \txiescapepdf\pdfdestname
1352   }}
1353   %
1354   \def\setpdfoutlinetext#1{{%
1355     \indexnofonts
1356     \makevalueexpandable
1357     \turnoffactive
1358     \ifx \declaredencoding \latone
1359       % The PDF format can use an extended form of Latin-1 in bookmark
1360       % strings.  See Appendix D of the PDF Reference, Sixth Edition, for
1361       % the "PDFDocEncoding".
1362       \passthroughcharstrue
1363       % Pass through Latin-1 characters.
1364       %   LuaTeX: Convert to Unicode
1365       %   pdfTeX: Use Latin-1 as PDFDocEncoding
1366       \def\pdfoutlinetext{#1}%
1367     \else
1368       \ifx \declaredencoding \utfeight
1369         \ifx\luatexversion\thisisundefined
1370           % For pdfTeX  with UTF-8.
1371           % TODO: the PDF format can use UTF-16 in bookmark strings,
1372           % but the code for this isn't done yet.
1373           % Use ASCII approximations.
1374           \passthroughcharsfalse
1375           \def\pdfoutlinetext{#1}%
1376         \else
1377           % For LuaTeX with UTF-8.
1378           % Pass through Unicode characters for title texts.
1379           \passthroughcharstrue
1380           \def\pdfoutlinetext{#1}%
1381         \fi
1382       \else
1383         % For non-Latin-1 or non-UTF-8 encodings.
1384         % Use ASCII approximations.
1385         \passthroughcharsfalse
1386         \def\pdfoutlinetext{#1}%
1387       \fi
1388     \fi
1389     % LuaTeX: Convert to UTF-16
1390     % pdfTeX: Use Latin-1 as PDFDocEncoding
1391     \txiescapepdfutfsixteen\pdfoutlinetext
1392   }}
1393   %
1394   \def\pdfmkdest#1{%
1395     \setpdfdestname{#1}%
1396     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1397   }
1398   %
1399   % used to mark target names; must be expandable.
1400   \def\pdfmkpgn#1{#1}
1401   %
1402   % by default, use black for everything.
1403   \def\urlcolor{\rgbBlack}
1404   \def\linkcolor{\rgbBlack}
1405   \def\endlink{\setcolor{\maincolor}\pdfendlink}
1406   %
1407   % Adding outlines to PDF; macros for calculating structure of outlines
1408   % come from Petr Olsak
1409   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1410     \else \csname#1\endcsname \fi}
1411   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1412     \advance\tempnum by 1
1413     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1414   %
1415   % #1 is the section text, which is what will be displayed in the
1416   % outline by the pdf viewer.  #2 is the pdf expression for the number
1417   % of subentries (or empty, for subsubsections).  #3 is the node text,
1418   % which might be empty if this toc entry had no corresponding node.
1419   % #4 is the page number
1420   %
1421   \def\dopdfoutline#1#2#3#4{%
1422     % Generate a link to the node text if that exists; else, use the
1423     % page number.  We could generate a destination for the section
1424     % text in the case where a section has no node, but it doesn't
1425     % seem worth the trouble, since most documents are normally structured.
1426     \setpdfoutlinetext{#1}
1427     \setpdfdestname{#3}
1428     \ifx\pdfdestname\empty
1429       \def\pdfdestname{#4}%
1430     \fi
1431     %
1432     \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
1433   }
1434   %
1435   \def\pdfmakeoutlines{%
1436     \begingroup
1437       % Read toc silently, to get counts of subentries for \pdfoutline.
1438       \def\partentry##1##2##3##4{}% ignore parts in the outlines
1439       \def\numchapentry##1##2##3##4{%
1440         \def\thischapnum{##2}%
1441         \def\thissecnum{0}%
1442         \def\thissubsecnum{0}%
1443       }%
1444       \def\numsecentry##1##2##3##4{%
1445         \advancenumber{chap\thischapnum}%
1446         \def\thissecnum{##2}%
1447         \def\thissubsecnum{0}%
1448       }%
1449       \def\numsubsecentry##1##2##3##4{%
1450         \advancenumber{sec\thissecnum}%
1451         \def\thissubsecnum{##2}%
1452       }%
1453       \def\numsubsubsecentry##1##2##3##4{%
1454         \advancenumber{subsec\thissubsecnum}%
1455       }%
1456       \def\thischapnum{0}%
1457       \def\thissecnum{0}%
1458       \def\thissubsecnum{0}%
1459       %
1460       % use \def rather than \let here because we redefine \chapentry et
1461       % al. a second time, below.
1462       \def\appentry{\numchapentry}%
1463       \def\appsecentry{\numsecentry}%
1464       \def\appsubsecentry{\numsubsecentry}%
1465       \def\appsubsubsecentry{\numsubsubsecentry}%
1466       \def\unnchapentry{\numchapentry}%
1467       \def\unnsecentry{\numsecentry}%
1468       \def\unnsubsecentry{\numsubsecentry}%
1469       \def\unnsubsubsecentry{\numsubsubsecentry}%
1470       \readdatafile{toc}%
1471       %
1472       % Read toc second time, this time actually producing the outlines.
1473       % The `-' means take the \expnumber as the absolute number of
1474       % subentries, which we calculated on our first read of the .toc above.
1475       %
1476       % We use the node names as the destinations.
1477       %
1478       % Currently we prefix the section name with the section number
1479       % for chapter and appendix headings only in order to avoid too much
1480       % horizontal space being required in the PDF viewer.
1481       \def\numchapentry##1##2##3##4{%
1482         \dopdfoutline{##2 ##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1483       \def\unnchapentry##1##2##3##4{%
1484         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1485       \def\numsecentry##1##2##3##4{%
1486         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1487       \def\numsubsecentry##1##2##3##4{%
1488         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1489       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1490         \dopdfoutline{##1}{}{##3}{##4}}%
1491       %
1492       % PDF outlines are displayed using system fonts, instead of
1493       % document fonts.  Therefore we cannot use special characters,
1494       % since the encoding is unknown.  For example, the eogonek from
1495       % Latin 2 (0xea) gets translated to a | character.  Info from
1496       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1497       %
1498       % TODO this right, we have to translate 8-bit characters to
1499       % their "best" equivalent, based on the @documentencoding.  Too
1500       % much work for too little return.  Just use the ASCII equivalents
1501       % we use for the index sort strings.
1502       %
1503       \indexnofonts
1504       \setupdatafile
1505       % We can have normal brace characters in the PDF outlines, unlike
1506       % Texinfo index files.  So set that up.
1507       \def\{{\lbracecharliteral}%
1508       \def\}{\rbracecharliteral}%
1509       \catcode`\\=\active \otherbackslash
1510       \input \tocreadfilename
1511     \endgroup
1512   }
1513   {\catcode`[=1 \catcode`]=2
1514    \catcode`{=\other \catcode`}=\other
1515    \gdef\lbracecharliteral[{]%
1516    \gdef\rbracecharliteral[}]%
1517   ]
1518   %
1519   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1520     \ifx\PP\D\let\nextsp\relax
1521     \else\let\nextsp\skipspaces
1522       \addtokens{\filename}{\PP}%
1523       \advance\filenamelength by 1
1524     \fi
1525     \nextsp}
1526   \def\getfilename#1{%
1527     \filenamelength=0
1528     % If we don't expand the argument now, \skipspaces will get
1529     % snagged on things like "@value{foo}".
1530     \edef\temp{#1}%
1531     \expandafter\skipspaces\temp|\relax
1532   }
1533   \ifnum\pdftexversion < 14
1534     \let \startlink \pdfannotlink
1535   \else
1536     \let \startlink \pdfstartlink
1537   \fi
1538   % make a live url in pdf output.
1539   \def\pdfurl#1{%
1540     \begingroup
1541       % it seems we really need yet another set of dummies; have not
1542       % tried to figure out what each command should do in the context
1543       % of @url.  for now, just make @/ a no-op, that's the only one
1544       % people have actually reported a problem with.
1545       %
1546       \normalturnoffactive
1547       \def\@{@}%
1548       \let\/=\empty
1549       \makevalueexpandable
1550       % do we want to go so far as to use \indexnofonts instead of just
1551       % special-casing \var here?
1552       \def\var##1{##1}%
1553       %
1554       \leavevmode\setcolor{\urlcolor}%
1555       \startlink attr{/Border [0 0 0]}%
1556         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1557     \endgroup}
1558   % \pdfgettoks - Surround page numbers in #1 with @pdflink.  #1 may
1559   % be a simple number, or a list of numbers in the case of an index
1560   % entry.
1561   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1562   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1563   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1564   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1565   \def\maketoks{%
1566     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1567     \ifx\first0\adn0
1568     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1569     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1570     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1571     \else
1572       \ifnum0=\countA\else\makelink\fi
1573       \ifx\first.\let\next=\done\else
1574         \let\next=\maketoks
1575         \addtokens{\toksB}{\the\toksD}
1576         \ifx\first,\addtokens{\toksB}{\space}\fi
1577       \fi
1578     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1579     \next}
1580   \def\makelink{\addtokens{\toksB}%
1581     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1582   \def\pdflink#1{%
1583     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1584     \setcolor{\linkcolor}#1\endlink}
1585   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1586 \else
1587   % non-pdf mode
1588   \let\pdfmkdest = \gobble
1589   \let\pdfurl = \gobble
1590   \let\endlink = \relax
1591   \let\setcolor = \gobble
1592   \let\pdfsetcolor = \gobble
1593   \let\pdfmakeoutlines = \relax
1594 \fi  % \ifx\pdfoutput
1595
1596 %
1597 % For XeTeX
1598 %
1599 \ifx\XeTeXrevision\thisisundefined
1600 \else
1601   %
1602   % XeTeX version check
1603   %
1604   \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
1605     % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
1606     % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
1607     % For avoiding PDF destination name replacement, we use this special
1608     % instead of xdvipdfmx's command line option `-C 0x0010'.
1609     \special{dvipdfmx:config C 0x0010}
1610     % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
1611     % It can handle Unicode destination names for PDF.
1612     \txiuseunicodedestnametrue
1613   \else
1614     % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
1615     % `dvipdfmx:config' special.
1616     % So for avoiding PDF destination name replacement,
1617     % xdvipdfmx's command line option `-C 0x0010' is necessary.
1618     %
1619     % XeTeX < 0.99995 can not handle Unicode destination names for PDF
1620     % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
1621     % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1622     \txiuseunicodedestnamefalse
1623   \fi
1624   %
1625   % Color support
1626   %
1627   \def\rgbDarkRed{0.50 0.09 0.12}
1628   \def\rgbBlack{0 0 0}
1629   %
1630   \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
1631   %
1632   % Set color, and create a mark which defines \thiscolor accordingly,
1633   % so that \makeheadline knows which color to restore.
1634   \def\setcolor#1{%
1635     \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1636     \domark
1637     \pdfsetcolor{#1}%
1638   }
1639   %
1640   \def\maincolor{\rgbBlack}
1641   \pdfsetcolor{\maincolor}
1642   \edef\thiscolor{\maincolor}
1643   \def\currentcolordefs{}
1644   %
1645   \def\makefootline{%
1646     \baselineskip24pt
1647     \line{\pdfsetcolor{\maincolor}\the\footline}%
1648   }
1649   %
1650   \def\makeheadline{%
1651     \vbox to 0pt{%
1652       \vskip-22.5pt
1653       \line{%
1654         \vbox to8.5pt{}%
1655         % Extract \thiscolor definition from the marks.
1656         \getcolormarks
1657         % Typeset the headline with \maincolor, then restore the color.
1658         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1659       }%
1660       \vss
1661     }%
1662     \nointerlineskip
1663   }
1664   %
1665   % PDF outline support
1666   %
1667   % Emulate pdfTeX primitive
1668   \def\pdfdest name#1 xyz{%
1669     \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
1670   }
1671   %
1672   \def\setpdfdestname#1{{%
1673     % We have to set dummies so commands such as @code, and characters
1674     % such as \, aren't expanded when present in a section title.
1675     \indexnofonts
1676     \makevalueexpandable
1677     \turnoffactive
1678     \iftxiuseunicodedestname
1679       % Pass through Unicode characters.
1680     \else
1681       % Use ASCII approximations in destination names.
1682       \passthroughcharsfalse
1683     \fi
1684     \def\pdfdestname{#1}%
1685     \txiescapepdf\pdfdestname
1686   }}
1687   %
1688   \def\setpdfoutlinetext#1{{%
1689     \turnoffactive
1690     % Always use Unicode characters in title texts.
1691     \def\pdfoutlinetext{#1}%
1692     % For XeTeX, xdvipdfmx converts to UTF-16.
1693     % So we do not convert.
1694     \txiescapepdf\pdfoutlinetext
1695   }}
1696   %
1697   \def\pdfmkdest#1{%
1698     \setpdfdestname{#1}%
1699     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1700   }
1701   %
1702   % by default, use black for everything.
1703   \def\urlcolor{\rgbBlack}
1704   \def\linkcolor{\rgbBlack}
1705   \def\endlink{\setcolor{\maincolor}\pdfendlink}
1706   %
1707   \def\dopdfoutline#1#2#3#4{%
1708     \setpdfoutlinetext{#1}
1709     \setpdfdestname{#3}
1710     \ifx\pdfdestname\empty
1711       \def\pdfdestname{#4}%
1712     \fi
1713     %
1714     \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1715       << /S /GoTo /D (\pdfdestname) >> >> }%
1716   }
1717   %
1718   \def\pdfmakeoutlines{%
1719     \begingroup
1720       %
1721       % For XeTeX, counts of subentries are not necessary.
1722       % Therefore, we read toc only once.
1723       %
1724       % We use node names as destinations.
1725       %
1726       % Currently we prefix the section name with the section number
1727       % for chapter and appendix headings only in order to avoid too much
1728       % horizontal space being required in the PDF viewer.
1729       \def\partentry##1##2##3##4{}% ignore parts in the outlines
1730       \def\numchapentry##1##2##3##4{%
1731         \dopdfoutline{##2 ##1}{1}{##3}{##4}}%
1732       \def\numsecentry##1##2##3##4{%
1733         \dopdfoutline{##1}{2}{##3}{##4}}%
1734       \def\numsubsecentry##1##2##3##4{%
1735         \dopdfoutline{##1}{3}{##3}{##4}}%
1736       \def\numsubsubsecentry##1##2##3##4{%
1737         \dopdfoutline{##1}{4}{##3}{##4}}%
1738       %
1739       \let\appentry\numchapentry%
1740       \let\appsecentry\numsecentry%
1741       \let\appsubsecentry\numsubsecentry%
1742       \let\appsubsubsecentry\numsubsubsecentry%
1743       \def\unnchapentry##1##2##3##4{%
1744         \dopdfoutline{##1}{1}{##3}{##4}}%
1745       \let\unnsecentry\numsecentry%
1746       \let\unnsubsecentry\numsubsecentry%
1747       \let\unnsubsubsecentry\numsubsubsecentry%
1748       %
1749       % For XeTeX, xdvipdfmx converts strings to UTF-16.
1750       % Therefore, the encoding and the language may not be considered.
1751       %
1752       \indexnofonts
1753       \setupdatafile
1754       % We can have normal brace characters in the PDF outlines, unlike
1755       % Texinfo index files.  So set that up.
1756       \def\{{\lbracecharliteral}%
1757       \def\}{\rbracecharliteral}%
1758       \catcode`\\=\active \otherbackslash
1759       \input \tocreadfilename
1760     \endgroup
1761   }
1762   {\catcode`[=1 \catcode`]=2
1763    \catcode`{=\other \catcode`}=\other
1764    \gdef\lbracecharliteral[{]%
1765    \gdef\rbracecharliteral[}]%
1766   ]
1767
1768   \special{pdf:docview << /PageMode /UseOutlines >> }
1769   % ``\special{pdf:tounicode ...}'' is not necessary
1770   % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1771   % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
1772   % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
1773   % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1774 %
1775   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1776     \ifx\PP\D\let\nextsp\relax
1777     \else\let\nextsp\skipspaces
1778       \addtokens{\filename}{\PP}%
1779       \advance\filenamelength by 1
1780     \fi
1781     \nextsp}
1782   \def\getfilename#1{%
1783     \filenamelength=0
1784     % If we don't expand the argument now, \skipspaces will get
1785     % snagged on things like "@value{foo}".
1786     \edef\temp{#1}%
1787     \expandafter\skipspaces\temp|\relax
1788   }
1789   % make a live url in pdf output.
1790   \def\pdfurl#1{%
1791     \begingroup
1792       % it seems we really need yet another set of dummies; have not
1793       % tried to figure out what each command should do in the context
1794       % of @url.  for now, just make @/ a no-op, that's the only one
1795       % people have actually reported a problem with.
1796       %
1797       \normalturnoffactive
1798       \def\@{@}%
1799       \let\/=\empty
1800       \makevalueexpandable
1801       % do we want to go so far as to use \indexnofonts instead of just
1802       % special-casing \var here?
1803       \def\var##1{##1}%
1804       %
1805       \leavevmode\setcolor{\urlcolor}%
1806       \special{pdf:bann << /Border [0 0 0]
1807         /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
1808     \endgroup}
1809   \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
1810   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1811   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1812   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1813   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1814   \def\maketoks{%
1815     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1816     \ifx\first0\adn0
1817     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1818     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1819     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1820     \else
1821       \ifnum0=\countA\else\makelink\fi
1822       \ifx\first.\let\next=\done\else
1823         \let\next=\maketoks
1824         \addtokens{\toksB}{\the\toksD}
1825         \ifx\first,\addtokens{\toksB}{\space}\fi
1826       \fi
1827     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1828     \next}
1829   \def\makelink{\addtokens{\toksB}%
1830     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1831   \def\pdflink#1{%
1832     \special{pdf:bann << /Border [0 0 0]
1833       /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
1834     \setcolor{\linkcolor}#1\endlink}
1835   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1836 %
1837   %
1838   % @image support
1839   %
1840   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1841   \def\doxeteximage#1#2#3{%
1842     \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1843     \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1844     %
1845     % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
1846     % others).  Let's try in that order, PDF first since if
1847     % someone has a scalable image, presumably better to use that than a
1848     % bitmap.
1849     \let\xeteximgext=\empty
1850     \begingroup
1851       \openin 1 #1.pdf \ifeof 1
1852         \openin 1 #1.PDF \ifeof 1
1853           \openin 1 #1.png \ifeof 1
1854             \openin 1 #1.jpg \ifeof 1
1855               \openin 1 #1.jpeg \ifeof 1
1856                 \openin 1 #1.JPG \ifeof 1
1857                   \errmessage{Could not find image file #1 for XeTeX}%
1858                 \else \gdef\xeteximgext{JPG}%
1859                 \fi
1860               \else \gdef\xeteximgext{jpeg}%
1861               \fi
1862             \else \gdef\xeteximgext{jpg}%
1863             \fi
1864           \else \gdef\xeteximgext{png}%
1865           \fi
1866         \else \gdef\xeteximgext{PDF}%
1867         \fi
1868       \else \gdef\xeteximgext{pdf}%
1869       \fi
1870       \closein 1
1871     \endgroup
1872     %
1873     % Putting an \hbox around the image can prevent an over-long line
1874     % after the image.
1875     \hbox\bgroup
1876       \def\xetexpdfext{pdf}%
1877       \ifx\xeteximgext\xetexpdfext
1878         \XeTeXpdffile "#1".\xeteximgext ""
1879       \else
1880         \def\xetexpdfext{PDF}%
1881         \ifx\xeteximgext\xetexpdfext
1882           \XeTeXpdffile "#1".\xeteximgext ""
1883         \else
1884           \XeTeXpicfile "#1".\xeteximgext ""
1885         \fi
1886       \fi
1887       \ifdim \wd0 >0pt width \xeteximagewidth \fi
1888       \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
1889     \egroup
1890   }
1891 \fi
1892
1893
1894 %
1895 \message{fonts,}
1896
1897 % Set the baselineskip to #1, and the lineskip and strut size
1898 % correspondingly.  There is no deep meaning behind these magic numbers
1899 % used as factors; they just match (closely enough) what Knuth defined.
1900 %
1901 \def\lineskipfactor{.08333}
1902 \def\strutheightpercent{.70833}
1903 \def\strutdepthpercent {.29167}
1904 %
1905 % can get a sort of poor man's double spacing by redefining this.
1906 \def\baselinefactor{1}
1907 %
1908 \newdimen\textleading
1909 \def\setleading#1{%
1910   \dimen0 = #1\relax
1911   \normalbaselineskip = \baselinefactor\dimen0
1912   \normallineskip = \lineskipfactor\normalbaselineskip
1913   \normalbaselines
1914   \setbox\strutbox =\hbox{%
1915     \vrule width0pt height\strutheightpercent\baselineskip
1916                     depth \strutdepthpercent \baselineskip
1917   }%
1918 }
1919
1920 % PDF CMaps.  See also LaTeX's t1.cmap.
1921 %
1922 % do nothing with this by default.
1923 \expandafter\let\csname cmapOT1\endcsname\gobble
1924 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1925 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1926
1927 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1928 % (\pdffontattr was introduced many years ago, but people still run
1929 % older pdftex's; it's easy to conditionalize, so we do.)
1930 \ifpdf \ifx\pdffontattr\thisisundefined \else
1931   \begingroup
1932     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1933     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1934 %%DocumentNeededResources: ProcSet (CIDInit)
1935 %%IncludeResource: ProcSet (CIDInit)
1936 %%BeginResource: CMap (TeX-OT1-0)
1937 %%Title: (TeX-OT1-0 TeX OT1 0)
1938 %%Version: 1.000
1939 %%EndComments
1940 /CIDInit /ProcSet findresource begin
1941 12 dict begin
1942 begincmap
1943 /CIDSystemInfo
1944 << /Registry (TeX)
1945 /Ordering (OT1)
1946 /Supplement 0
1947 >> def
1948 /CMapName /TeX-OT1-0 def
1949 /CMapType 2 def
1950 1 begincodespacerange
1951 <00> <7F>
1952 endcodespacerange
1953 8 beginbfrange
1954 <00> <01> <0393>
1955 <09> <0A> <03A8>
1956 <23> <26> <0023>
1957 <28> <3B> <0028>
1958 <3F> <5B> <003F>
1959 <5D> <5E> <005D>
1960 <61> <7A> <0061>
1961 <7B> <7C> <2013>
1962 endbfrange
1963 40 beginbfchar
1964 <02> <0398>
1965 <03> <039B>
1966 <04> <039E>
1967 <05> <03A0>
1968 <06> <03A3>
1969 <07> <03D2>
1970 <08> <03A6>
1971 <0B> <00660066>
1972 <0C> <00660069>
1973 <0D> <0066006C>
1974 <0E> <006600660069>
1975 <0F> <00660066006C>
1976 <10> <0131>
1977 <11> <0237>
1978 <12> <0060>
1979 <13> <00B4>
1980 <14> <02C7>
1981 <15> <02D8>
1982 <16> <00AF>
1983 <17> <02DA>
1984 <18> <00B8>
1985 <19> <00DF>
1986 <1A> <00E6>
1987 <1B> <0153>
1988 <1C> <00F8>
1989 <1D> <00C6>
1990 <1E> <0152>
1991 <1F> <00D8>
1992 <21> <0021>
1993 <22> <201D>
1994 <27> <2019>
1995 <3C> <00A1>
1996 <3D> <003D>
1997 <3E> <00BF>
1998 <5C> <201C>
1999 <5F> <02D9>
2000 <60> <2018>
2001 <7D> <02DD>
2002 <7E> <007E>
2003 <7F> <00A8>
2004 endbfchar
2005 endcmap
2006 CMapName currentdict /CMap defineresource pop
2007 end
2008 end
2009 %%EndResource
2010 %%EOF
2011     }\endgroup
2012   \expandafter\edef\csname cmapOT1\endcsname#1{%
2013     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2014   }%
2015 %
2016 % \cmapOT1IT
2017   \begingroup
2018     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2019     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2020 %%DocumentNeededResources: ProcSet (CIDInit)
2021 %%IncludeResource: ProcSet (CIDInit)
2022 %%BeginResource: CMap (TeX-OT1IT-0)
2023 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
2024 %%Version: 1.000
2025 %%EndComments
2026 /CIDInit /ProcSet findresource begin
2027 12 dict begin
2028 begincmap
2029 /CIDSystemInfo
2030 << /Registry (TeX)
2031 /Ordering (OT1IT)
2032 /Supplement 0
2033 >> def
2034 /CMapName /TeX-OT1IT-0 def
2035 /CMapType 2 def
2036 1 begincodespacerange
2037 <00> <7F>
2038 endcodespacerange
2039 8 beginbfrange
2040 <00> <01> <0393>
2041 <09> <0A> <03A8>
2042 <25> <26> <0025>
2043 <28> <3B> <0028>
2044 <3F> <5B> <003F>
2045 <5D> <5E> <005D>
2046 <61> <7A> <0061>
2047 <7B> <7C> <2013>
2048 endbfrange
2049 42 beginbfchar
2050 <02> <0398>
2051 <03> <039B>
2052 <04> <039E>
2053 <05> <03A0>
2054 <06> <03A3>
2055 <07> <03D2>
2056 <08> <03A6>
2057 <0B> <00660066>
2058 <0C> <00660069>
2059 <0D> <0066006C>
2060 <0E> <006600660069>
2061 <0F> <00660066006C>
2062 <10> <0131>
2063 <11> <0237>
2064 <12> <0060>
2065 <13> <00B4>
2066 <14> <02C7>
2067 <15> <02D8>
2068 <16> <00AF>
2069 <17> <02DA>
2070 <18> <00B8>
2071 <19> <00DF>
2072 <1A> <00E6>
2073 <1B> <0153>
2074 <1C> <00F8>
2075 <1D> <00C6>
2076 <1E> <0152>
2077 <1F> <00D8>
2078 <21> <0021>
2079 <22> <201D>
2080 <23> <0023>
2081 <24> <00A3>
2082 <27> <2019>
2083 <3C> <00A1>
2084 <3D> <003D>
2085 <3E> <00BF>
2086 <5C> <201C>
2087 <5F> <02D9>
2088 <60> <2018>
2089 <7D> <02DD>
2090 <7E> <007E>
2091 <7F> <00A8>
2092 endbfchar
2093 endcmap
2094 CMapName currentdict /CMap defineresource pop
2095 end
2096 end
2097 %%EndResource
2098 %%EOF
2099     }\endgroup
2100   \expandafter\edef\csname cmapOT1IT\endcsname#1{%
2101     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2102   }%
2103 %
2104 % \cmapOT1TT
2105   \begingroup
2106     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2107     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2108 %%DocumentNeededResources: ProcSet (CIDInit)
2109 %%IncludeResource: ProcSet (CIDInit)
2110 %%BeginResource: CMap (TeX-OT1TT-0)
2111 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
2112 %%Version: 1.000
2113 %%EndComments
2114 /CIDInit /ProcSet findresource begin
2115 12 dict begin
2116 begincmap
2117 /CIDSystemInfo
2118 << /Registry (TeX)
2119 /Ordering (OT1TT)
2120 /Supplement 0
2121 >> def
2122 /CMapName /TeX-OT1TT-0 def
2123 /CMapType 2 def
2124 1 begincodespacerange
2125 <00> <7F>
2126 endcodespacerange
2127 5 beginbfrange
2128 <00> <01> <0393>
2129 <09> <0A> <03A8>
2130 <21> <26> <0021>
2131 <28> <5F> <0028>
2132 <61> <7E> <0061>
2133 endbfrange
2134 32 beginbfchar
2135 <02> <0398>
2136 <03> <039B>
2137 <04> <039E>
2138 <05> <03A0>
2139 <06> <03A3>
2140 <07> <03D2>
2141 <08> <03A6>
2142 <0B> <2191>
2143 <0C> <2193>
2144 <0D> <0027>
2145 <0E> <00A1>
2146 <0F> <00BF>
2147 <10> <0131>
2148 <11> <0237>
2149 <12> <0060>
2150 <13> <00B4>
2151 <14> <02C7>
2152 <15> <02D8>
2153 <16> <00AF>
2154 <17> <02DA>
2155 <18> <00B8>
2156 <19> <00DF>
2157 <1A> <00E6>
2158 <1B> <0153>
2159 <1C> <00F8>
2160 <1D> <00C6>
2161 <1E> <0152>
2162 <1F> <00D8>
2163 <20> <2423>
2164 <27> <2019>
2165 <60> <2018>
2166 <7F> <00A8>
2167 endbfchar
2168 endcmap
2169 CMapName currentdict /CMap defineresource pop
2170 end
2171 end
2172 %%EndResource
2173 %%EOF
2174     }\endgroup
2175   \expandafter\edef\csname cmapOT1TT\endcsname#1{%
2176     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2177   }%
2178 \fi\fi
2179
2180
2181 % Set the font macro #1 to the font named \fontprefix#2.
2182 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2183 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2184 % Example:
2185 % #1 = \textrm
2186 % #2 = \rmshape
2187 % #3 = 10
2188 % #4 = \mainmagstep
2189 % #5 = OT1
2190 %
2191 \def\setfont#1#2#3#4#5{%
2192   \font#1=\fontprefix#2#3 scaled #4
2193   \csname cmap#5\endcsname#1%
2194 }
2195 % This is what gets called when #5 of \setfont is empty.
2196 \let\cmap\gobble
2197 %
2198 % (end of cmaps)
2199
2200 % Use cm as the default font prefix.
2201 % To specify the font prefix, you must define \fontprefix
2202 % before you read in texinfo.tex.
2203 \ifx\fontprefix\thisisundefined
2204 \def\fontprefix{cm}
2205 \fi
2206 % Support font families that don't use the same naming scheme as CM.
2207 \def\rmshape{r}
2208 \def\rmbshape{bx}               % where the normal face is bold
2209 \def\bfshape{b}
2210 \def\bxshape{bx}
2211 \def\ttshape{tt}
2212 \def\ttbshape{tt}
2213 \def\ttslshape{sltt}
2214 \def\itshape{ti}
2215 \def\itbshape{bxti}
2216 \def\slshape{sl}
2217 \def\slbshape{bxsl}
2218 \def\sfshape{ss}
2219 \def\sfbshape{ss}
2220 \def\scshape{csc}
2221 \def\scbshape{csc}
2222
2223 % Definitions for a main text size of 11pt.  (The default in Texinfo.)
2224 %
2225 \def\definetextfontsizexi{%
2226 % Text fonts (11.2pt, magstep1).
2227 \def\textnominalsize{11pt}
2228 \edef\mainmagstep{\magstephalf}
2229 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2230 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2231 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2232 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2233 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2234 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2235 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2236 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2237 \font\texti=cmmi10 scaled \mainmagstep
2238 \font\textsy=cmsy10 scaled \mainmagstep
2239 \def\textecsize{1095}
2240
2241 % A few fonts for @defun names and args.
2242 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2243 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2244 \setfont\defsl\slshape{10}{\magstep1}{OT1}
2245 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2246 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2247 \let\ttslfont=\defttsl \let\slfont=\defsl \bf}
2248
2249 % Fonts for indices, footnotes, small examples (9pt).
2250 \def\smallnominalsize{9pt}
2251 \setfont\smallrm\rmshape{9}{1000}{OT1}
2252 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2253 \setfont\smallbf\bfshape{10}{900}{OT1}
2254 \setfont\smallit\itshape{9}{1000}{OT1IT}
2255 \setfont\smallsl\slshape{9}{1000}{OT1}
2256 \setfont\smallsf\sfshape{9}{1000}{OT1}
2257 \setfont\smallsc\scshape{10}{900}{OT1}
2258 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2259 \font\smalli=cmmi9
2260 \font\smallsy=cmsy9
2261 \def\smallecsize{0900}
2262
2263 % Fonts for small examples (8pt).
2264 \def\smallernominalsize{8pt}
2265 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2266 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2267 \setfont\smallerbf\bfshape{10}{800}{OT1}
2268 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2269 \setfont\smallersl\slshape{8}{1000}{OT1}
2270 \setfont\smallersf\sfshape{8}{1000}{OT1}
2271 \setfont\smallersc\scshape{10}{800}{OT1}
2272 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2273 \font\smalleri=cmmi8
2274 \font\smallersy=cmsy8
2275 \def\smallerecsize{0800}
2276
2277 % Fonts for math mode superscripts (7pt).
2278 \def\sevennominalsize{7pt}
2279 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2280 \setfont\seventt\ttshape{10}{700}{OT1TT}
2281 \setfont\sevenbf\bfshape{10}{700}{OT1}
2282 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2283 \setfont\sevensl\slshape{10}{700}{OT1}
2284 \setfont\sevensf\sfshape{10}{700}{OT1}
2285 \setfont\sevensc\scshape{10}{700}{OT1}
2286 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2287 \font\seveni=cmmi7
2288 \font\sevensy=cmsy7
2289 \def\sevenecsize{0700}
2290
2291 % Fonts for title page (20.4pt):
2292 \def\titlenominalsize{20pt}
2293 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2294 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2295 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2296 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2297 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2298 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2299 \let\titlebf=\titlerm
2300 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2301 \font\titlei=cmmi12 scaled \magstep3
2302 \font\titlesy=cmsy10 scaled \magstep4
2303 \def\titleecsize{2074}
2304
2305 % Chapter (and unnumbered) fonts (17.28pt).
2306 \def\chapnominalsize{17pt}
2307 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2308 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2309 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2310 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2311 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2312 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2313 \let\chapbf=\chaprm
2314 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2315 \font\chapi=cmmi12 scaled \magstep2
2316 \font\chapsy=cmsy10 scaled \magstep3
2317 \def\chapecsize{1728}
2318
2319 % Section fonts (14.4pt).
2320 \def\secnominalsize{14pt}
2321 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2322 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
2323 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2324 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2325 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2326 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2327 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2328 \let\secbf\secrm
2329 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2330 \font\seci=cmmi12 scaled \magstep1
2331 \font\secsy=cmsy10 scaled \magstep2
2332 \def\sececsize{1440}
2333
2334 % Subsection fonts (13.15pt).
2335 \def\ssecnominalsize{13pt}
2336 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2337 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2338 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2339 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2340 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2341 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2342 \let\ssecbf\ssecrm
2343 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2344 \font\sseci=cmmi12 scaled \magstephalf
2345 \font\ssecsy=cmsy10 scaled 1315
2346 \def\ssececsize{1200}
2347
2348 % Reduced fonts for @acronym in text (10pt).
2349 \def\reducednominalsize{10pt}
2350 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2351 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2352 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2353 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2354 \setfont\reducedsl\slshape{10}{1000}{OT1}
2355 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2356 \setfont\reducedsc\scshape{10}{1000}{OT1}
2357 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2358 \font\reducedi=cmmi10
2359 \font\reducedsy=cmsy10
2360 \def\reducedecsize{1000}
2361
2362 \textleading = 13.2pt % line spacing for 11pt CM
2363 \textfonts            % reset the current fonts
2364 \rm
2365 } % end of 11pt text font size definitions, \definetextfontsizexi
2366
2367
2368 % Definitions to make the main text be 10pt Computer Modern, with
2369 % section, chapter, etc., sizes following suit.  This is for the GNU
2370 % Press printing of the Emacs 22 manual.  Maybe other manuals in the
2371 % future.  Used with @smallbook, which sets the leading to 12pt.
2372 %
2373 \def\definetextfontsizex{%
2374 % Text fonts (10pt).
2375 \def\textnominalsize{10pt}
2376 \edef\mainmagstep{1000}
2377 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2378 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2379 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2380 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2381 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2382 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2383 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2384 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2385 \font\texti=cmmi10 scaled \mainmagstep
2386 \font\textsy=cmsy10 scaled \mainmagstep
2387 \def\textecsize{1000}
2388
2389 % A few fonts for @defun names and args.
2390 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2391 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2392 \setfont\defsl\slshape{10}{\magstephalf}{OT1}
2393 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2394 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2395 \let\slfont=\defsl \let\ttslfont=\defttsl \bf}
2396
2397 % Fonts for indices, footnotes, small examples (9pt).
2398 \def\smallnominalsize{9pt}
2399 \setfont\smallrm\rmshape{9}{1000}{OT1}
2400 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2401 \setfont\smallbf\bfshape{10}{900}{OT1}
2402 \setfont\smallit\itshape{9}{1000}{OT1IT}
2403 \setfont\smallsl\slshape{9}{1000}{OT1}
2404 \setfont\smallsf\sfshape{9}{1000}{OT1}
2405 \setfont\smallsc\scshape{10}{900}{OT1}
2406 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2407 \font\smalli=cmmi9
2408 \font\smallsy=cmsy9
2409 \def\smallecsize{0900}
2410
2411 % Fonts for small examples (8pt).
2412 \def\smallernominalsize{8pt}
2413 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2414 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2415 \setfont\smallerbf\bfshape{10}{800}{OT1}
2416 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2417 \setfont\smallersl\slshape{8}{1000}{OT1}
2418 \setfont\smallersf\sfshape{8}{1000}{OT1}
2419 \setfont\smallersc\scshape{10}{800}{OT1}
2420 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2421 \font\smalleri=cmmi8
2422 \font\smallersy=cmsy8
2423 \def\smallerecsize{0800}
2424
2425 % Fonts for math mode superscripts (7pt).
2426 \def\sevennominalsize{7pt}
2427 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2428 \setfont\seventt\ttshape{10}{700}{OT1TT}
2429 \setfont\sevenbf\bfshape{10}{700}{OT1}
2430 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2431 \setfont\sevensl\slshape{10}{700}{OT1}
2432 \setfont\sevensf\sfshape{10}{700}{OT1}
2433 \setfont\sevensc\scshape{10}{700}{OT1}
2434 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2435 \font\seveni=cmmi7
2436 \font\sevensy=cmsy7
2437 \def\sevenecsize{0700}
2438
2439 % Fonts for title page (20.4pt):
2440 \def\titlenominalsize{20pt}
2441 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2442 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2443 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2444 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2445 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2446 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2447 \let\titlebf=\titlerm
2448 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2449 \font\titlei=cmmi12 scaled \magstep3
2450 \font\titlesy=cmsy10 scaled \magstep4
2451 \def\titleecsize{2074}
2452
2453 % Chapter fonts (14.4pt).
2454 \def\chapnominalsize{14pt}
2455 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2456 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2457 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2458 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2459 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2460 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2461 \let\chapbf\chaprm
2462 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2463 \font\chapi=cmmi12 scaled \magstep1
2464 \font\chapsy=cmsy10 scaled \magstep2
2465 \def\chapecsize{1440}
2466
2467 % Section fonts (12pt).
2468 \def\secnominalsize{12pt}
2469 \setfont\secrm\rmbshape{12}{1000}{OT1}
2470 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2471 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2472 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2473 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2474 \setfont\secsf\sfbshape{12}{1000}{OT1}
2475 \let\secbf\secrm
2476 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2477 \font\seci=cmmi12
2478 \font\secsy=cmsy10 scaled \magstep1
2479 \def\sececsize{1200}
2480
2481 % Subsection fonts (10pt).
2482 \def\ssecnominalsize{10pt}
2483 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2484 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2485 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2486 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2487 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2488 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2489 \let\ssecbf\ssecrm
2490 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2491 \font\sseci=cmmi10
2492 \font\ssecsy=cmsy10
2493 \def\ssececsize{1000}
2494
2495 % Reduced fonts for @acronym in text (9pt).
2496 \def\reducednominalsize{9pt}
2497 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2498 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2499 \setfont\reducedbf\bfshape{10}{900}{OT1}
2500 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2501 \setfont\reducedsl\slshape{9}{1000}{OT1}
2502 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2503 \setfont\reducedsc\scshape{10}{900}{OT1}
2504 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2505 \font\reducedi=cmmi9
2506 \font\reducedsy=cmsy9
2507 \def\reducedecsize{0900}
2508
2509 \divide\parskip by 2  % reduce space between paragraphs
2510 \textleading = 12pt   % line spacing for 10pt CM
2511 \textfonts            % reset the current fonts
2512 \rm
2513 } % end of 10pt text font size definitions, \definetextfontsizex
2514
2515 % Fonts for short table of contents.
2516 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2517 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1}  % no cmb12
2518 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2519 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2520
2521
2522 % We provide the user-level command
2523 %   @fonttextsize 10
2524 % (or 11) to redefine the text font size.  pt is assumed.
2525 %
2526 \def\xiword{11}
2527 \def\xword{10}
2528 \def\xwordpt{10pt}
2529 %
2530 \parseargdef\fonttextsize{%
2531   \def\textsizearg{#1}%
2532   %\wlog{doing @fonttextsize \textsizearg}%
2533   %
2534   % Set \globaldefs so that documents can use this inside @tex, since
2535   % makeinfo 4.8 does not support it, but we need it nonetheless.
2536   %
2537  \begingroup \globaldefs=1
2538   \ifx\textsizearg\xword \definetextfontsizex
2539   \else \ifx\textsizearg\xiword \definetextfontsizexi
2540   \else
2541     \errhelp=\EMsimple
2542     \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2543   \fi\fi
2544  \endgroup
2545 }
2546
2547 %
2548 % Change the current font style to #1, remembering it in \curfontstyle.
2549 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
2550 % italics, not bold italics.
2551 %
2552 \def\setfontstyle#1{%
2553   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
2554   \csname #1font\endcsname  % change the current font
2555 }
2556
2557 \def\rm{\fam=0 \setfontstyle{rm}}
2558 \def\it{\fam=\itfam \setfontstyle{it}}
2559 \def\sl{\fam=\slfam \setfontstyle{sl}}
2560 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
2561 \def\tt{\fam=\ttfam \setfontstyle{tt}}\def\ttstylename{tt}
2562
2563 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
2564 % So we set up a \sf.
2565 \newfam\sffam
2566 \def\sf{\fam=\sffam \setfontstyle{sf}}
2567
2568 % We don't need math for this font style.
2569 \def\ttsl{\setfontstyle{ttsl}}
2570
2571
2572 % In order for the font changes to affect most math symbols and letters,
2573 % we have to define the \textfont of the standard families.
2574 % We don't bother to reset \scriptscriptfont; awaiting user need.
2575 %
2576 \def\resetmathfonts{%
2577   \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
2578   \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
2579   \textfont\ttfam=\ttfont \textfont\sffam=\sffont
2580   %
2581   % Fonts for superscript.  Note that the 7pt fonts are used regardless
2582   % of the current font size.
2583   \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
2584   \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
2585   \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
2586   \scriptfont\sffam=\sevensf
2587 }
2588
2589 %
2590
2591 % The font-changing commands (all called \...fonts) redefine the meanings
2592 % of \STYLEfont, instead of just \STYLE.  We do this because \STYLE needs
2593 % to also set the current \fam for math mode.  Our \STYLE (e.g., \rm)
2594 % commands hardwire \STYLEfont to set the current font.
2595 %
2596 % The fonts used for \ifont are for "math italics"  (\itfont is for italics
2597 % in regular text).  \syfont is also used in math mode only.
2598 %
2599 % Each font-changing command also sets the names \lsize (one size lower)
2600 % and \lllsize (three sizes lower).  These relative commands are used
2601 % in, e.g., the LaTeX logo and acronyms.
2602 %
2603 % This all needs generalizing, badly.
2604 %
2605
2606 \def\assignfonts#1{%
2607   \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
2608   \expandafter\let\expandafter\itfont\csname #1it\endcsname
2609   \expandafter\let\expandafter\slfont\csname #1sl\endcsname
2610   \expandafter\let\expandafter\bffont\csname #1bf\endcsname
2611   \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
2612   \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
2613   \expandafter\let\expandafter\sffont  \csname #1sf\endcsname
2614   \expandafter\let\expandafter\ifont   \csname #1i\endcsname
2615   \expandafter\let\expandafter\syfont  \csname #1sy\endcsname
2616   \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
2617 }
2618
2619 \newif\ifrmisbold
2620
2621 % Select smaller font size with the current style.  Used to change font size
2622 % in, e.g., the LaTeX logo and acronyms.  If we are using bold fonts for
2623 % normal roman text, also use bold fonts for roman text in the smaller size.
2624 \def\switchtolllsize{%
2625    \expandafter\assignfonts\expandafter{\lllsize}%
2626    \ifrmisbold
2627      \let\rmfont\bffont
2628    \fi
2629    \csname\curfontstyle\endcsname
2630 }%
2631
2632 \def\switchtolsize{%
2633    \expandafter\assignfonts\expandafter{\lsize}%
2634    \ifrmisbold
2635      \let\rmfont\bffont
2636    \fi
2637    \csname\curfontstyle\endcsname
2638 }%
2639
2640 \def\definefontsetatsize#1#2#3#4#5{%
2641 \expandafter\def\csname #1fonts\endcsname{%
2642   \def\curfontsize{#1}%
2643   \def\lsize{#2}\def\lllsize{#3}%
2644   \csname rmisbold#5\endcsname
2645   \assignfonts{#1}%
2646   \resetmathfonts
2647   \setleading{#4}%
2648 }}
2649
2650 \definefontsetatsize{text}   {reduced}{smaller}{\textleading}{false}
2651 \definefontsetatsize{title}  {chap}   {subsec} {27pt}  {true}
2652 \definefontsetatsize{chap}   {sec}    {text}   {19pt}  {true}
2653 \definefontsetatsize{sec}    {subsec} {reduced}{17pt}  {true}
2654 \definefontsetatsize{ssec}   {text}   {small}  {15pt}  {true}
2655 \definefontsetatsize{reduced}{small}  {smaller}{10.5pt}{false}
2656 \definefontsetatsize{small}  {smaller}{smaller}{10.5pt}{false}
2657 \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
2658
2659 \def\titlefont#1{{\titlefonts\rm #1}}
2660 \let\subsecfonts = \ssecfonts
2661 \let\subsubsecfonts = \ssecfonts
2662
2663 % Define these just so they can be easily changed for other fonts.
2664 \def\angleleft{$\langle$}
2665 \def\angleright{$\rangle$}
2666
2667 % Set the fonts to use with the @small... environments.
2668 \let\smallexamplefonts = \smallfonts
2669
2670 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
2671 % can fit this many characters:
2672 %   8.5x11=86   smallbook=72  a4=90  a5=69
2673 % If we use \scriptfonts (8pt), then we can fit this many characters:
2674 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
2675 % For me, subjectively, the few extra characters that fit aren't worth
2676 % the additional smallness of 8pt.  So I'm making the default 9pt.
2677 %
2678 % By the way, for comparison, here's what fits with @example (10pt):
2679 %   8.5x11=71  smallbook=60  a4=75  a5=58
2680 % --karl, 24jan03.
2681
2682 % Set up the default fonts, so we can use them for creating boxes.
2683 %
2684 \definetextfontsizexi
2685
2686
2687 % Check if we are currently using a typewriter font.  Since all the
2688 % Computer Modern typewriter fonts have zero interword stretch (and
2689 % shrink), and it is reasonable to expect all typewriter fonts to have
2690 % this property, we can check that font parameter.
2691 %
2692 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2693
2694 {
2695 \catcode`\'=\active
2696 \catcode`\`=\active
2697
2698 \gdef\setcodequotes{\let`\codequoteleft \let'\codequoteright}
2699 \gdef\setregularquotes{\let`\lq \let'\rq}
2700 }
2701
2702 % Allow an option to not use regular directed right quote/apostrophe
2703 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2704 % The undirected quote is ugly, so don't make it the default, but it
2705 % works for pasting with more pdf viewers (at least evince), the
2706 % lilypond developers report.  xpdf does work with the regular 0x27.
2707 %
2708 \def\codequoteright{%
2709   \ifmonospace
2710     \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2711       \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2712         '%
2713       \else \char'15 \fi
2714     \else \char'15 \fi
2715    \else
2716      '%
2717    \fi
2718 }
2719 %
2720 % and a similar option for the left quote char vs. a grave accent.
2721 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2722 % the code environments to do likewise.
2723 %
2724 \def\codequoteleft{%
2725   \ifmonospace
2726     \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2727       \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2728         % [Knuth] pp. 380,381,391
2729         % \relax disables Spanish ligatures ?` and !` of \tt font.
2730         \relax`%
2731       \else \char'22 \fi
2732     \else \char'22 \fi
2733    \else
2734      \relax`%
2735    \fi
2736 }
2737
2738 % Commands to set the quote options.
2739 %
2740 \parseargdef\codequoteundirected{%
2741   \def\temp{#1}%
2742   \ifx\temp\onword
2743     \expandafter\let\csname SETtxicodequoteundirected\endcsname
2744       = t%
2745   \else\ifx\temp\offword
2746     \expandafter\let\csname SETtxicodequoteundirected\endcsname
2747       = \relax
2748   \else
2749     \errhelp = \EMsimple
2750     \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2751   \fi\fi
2752 }
2753 %
2754 \parseargdef\codequotebacktick{%
2755   \def\temp{#1}%
2756   \ifx\temp\onword
2757     \expandafter\let\csname SETtxicodequotebacktick\endcsname
2758       = t%
2759   \else\ifx\temp\offword
2760     \expandafter\let\csname SETtxicodequotebacktick\endcsname
2761       = \relax
2762   \else
2763     \errhelp = \EMsimple
2764     \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2765   \fi\fi
2766 }
2767
2768 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2769 \def\noligaturesquoteleft{\relax\lq}
2770
2771 % Count depth in font-changes, for error checks
2772 \newcount\fontdepth \fontdepth=0
2773
2774 % Font commands.
2775
2776 % #1 is the font command (\sl or \it), #2 is the text to slant.
2777 % If we are in a monospaced environment, however, 1) always use \ttsl,
2778 % and 2) do not add an italic correction.
2779 \def\dosmartslant#1#2{%
2780   \ifusingtt
2781     {{\ttsl #2}\let\next=\relax}%
2782     {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2783   \next
2784 }
2785 \def\smartslanted{\dosmartslant\sl}
2786 \def\smartitalic{\dosmartslant\it}
2787
2788 % Output an italic correction unless \next (presumed to be the following
2789 % character) is such as not to need one.
2790 \def\smartitaliccorrection{%
2791   \ifx\next,%
2792   \else\ifx\next-%
2793   \else\ifx\next.%
2794   \else\ifx\next\.%
2795   \else\ifx\next\comma%
2796   \else\ptexslash
2797   \fi\fi\fi\fi\fi
2798   \aftersmartic
2799 }
2800
2801 % Unconditional use \ttsl, and no ic.  @var is set to this for defuns.
2802 \def\ttslanted#1{{\ttsl #1}}
2803
2804 % @cite is like \smartslanted except unconditionally use \sl.  We never want
2805 % ttsl for book titles, do we?
2806 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2807
2808 \def\aftersmartic{}
2809 \def\var#1{%
2810   \let\saveaftersmartic = \aftersmartic
2811   \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2812   \smartslanted{#1}%
2813 }
2814
2815 \let\i=\smartitalic
2816 \let\slanted=\smartslanted
2817 \let\dfn=\smartslanted
2818 \let\emph=\smartitalic
2819
2820 % Explicit font changes: @r, @sc, undocumented @ii.
2821 \def\r#1{{\rm #1}}              % roman font
2822 \def\sc#1{{\smallcaps#1}}       % smallcaps font
2823 \def\ii#1{{\it #1}}             % italic font
2824
2825 % @b, explicit bold.  Also @strong.
2826 \def\b#1{{\bf #1}}
2827 \let\strong=\b
2828
2829 % @sansserif, explicit sans.
2830 \def\sansserif#1{{\sf #1}}
2831
2832 % We can't just use \exhyphenpenalty, because that only has effect at
2833 % the end of a paragraph.  Restore normal hyphenation at the end of the
2834 % group within which \nohyphenation is presumably called.
2835 %
2836 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
2837 \def\restorehyphenation{\hyphenchar\font = `- }
2838
2839 % Set sfcode to normal for the chars that usually have another value.
2840 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2841 % sometimes \x has an active definition that messes things up.
2842 %
2843 \catcode`@=11
2844   \def\plainfrenchspacing{%
2845     \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
2846     \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
2847     \def\endofsentencespacefactor{1000}% for @. and friends
2848   }
2849   \def\plainnonfrenchspacing{%
2850     \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2851     \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2852     \def\endofsentencespacefactor{3000}% for @. and friends
2853   }
2854 \catcode`@=\other
2855 \def\endofsentencespacefactor{3000}% default
2856
2857 % @t, explicit typewriter.
2858 \def\t#1{%
2859   {\tt \plainfrenchspacing #1}%
2860   \null
2861 }
2862
2863 % @samp.
2864 \def\samp#1{{\setcodequotes\lq\tclose{#1}\rq\null}}
2865
2866 % @indicateurl is \samp, that is, with quotes.
2867 \let\indicateurl=\samp
2868
2869 % @code (and similar) prints in typewriter, but with spaces the same
2870 % size as normal in the surrounding text, without hyphenation, etc.
2871 % This is a subroutine for that.
2872 \def\tclose#1{%
2873   {%
2874     % Change normal interword space to be same as for the current font.
2875     \spaceskip = \fontdimen2\font
2876     %
2877     % Switch to typewriter.
2878     \tt
2879     %
2880     % But `\ ' produces the large typewriter interword space.
2881     \def\ {{\spaceskip = 0pt{} }}%
2882     %
2883     % Turn off hyphenation.
2884     \nohyphenation
2885     %
2886     \plainfrenchspacing
2887     #1%
2888   }%
2889   \null % reset spacefactor to 1000
2890 }
2891
2892 % We *must* turn on hyphenation at `-' and `_' in @code.
2893 % (But see \codedashfinish below.)
2894 % Otherwise, it is too hard to avoid overfull hboxes
2895 % in the Emacs manual, the Library manual, etc.
2896 %
2897 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2898 % both hyphenation at - and hyphenation within words.
2899 % We must therefore turn them both off (\tclose does that)
2900 % and arrange explicitly to hyphenate at a dash. -- rms.
2901 {
2902   \catcode`\-=\active \catcode`\_=\active
2903   \catcode`\'=\active \catcode`\`=\active
2904   \global\let'=\rq \global\let`=\lq  % default definitions
2905   %
2906   \global\def\code{\begingroup
2907     \setcodequotes
2908     \catcode\dashChar=\active  \catcode\underChar=\active
2909     \ifallowcodebreaks
2910      \let-\codedash
2911      \let_\codeunder
2912     \else
2913      \let-\normaldash
2914      \let_\realunder
2915     \fi
2916     % Given -foo (with a single dash), we do not want to allow a break
2917     % after the hyphen.
2918     \global\let\codedashprev=\codedash
2919     %
2920     \codex
2921   }
2922   %
2923   \gdef\codedash{\futurelet\next\codedashfinish}
2924   \gdef\codedashfinish{%
2925     \normaldash % always output the dash character itself.
2926     %
2927     % Now, output a discretionary to allow a line break, unless
2928     % (a) the next character is a -, or
2929     % (b) the preceding character is a -.
2930     % E.g., given --posix, we do not want to allow a break after either -.
2931     % Given --foo-bar, we do want to allow a break between the - and the b.
2932     \ifx\next\codedash \else
2933       \ifx\codedashprev\codedash
2934       \else \discretionary{}{}{}\fi
2935     \fi
2936     % we need the space after the = for the case when \next itself is a
2937     % space token; it would get swallowed otherwise.  As in @code{- a}.
2938     \global\let\codedashprev= \next
2939   }
2940 }
2941 \def\normaldash{-}
2942 %
2943 \def\codex #1{\tclose{#1}\endgroup}
2944
2945 \def\codeunder{%
2946   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
2947   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2948   % will therefore expand the active definition of _, which is us
2949   % (inside @code that is), therefore an endless loop.
2950   \ifusingtt{\ifmmode
2951                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2952              \else\normalunderscore \fi
2953              \discretionary{}{}{}}%
2954             {\_}%
2955 }
2956
2957 % An additional complication: the above will allow breaks after, e.g.,
2958 % each of the four underscores in __typeof__.  This is bad.
2959 % @allowcodebreaks provides a document-level way to turn breaking at -
2960 % and _ on and off.
2961 %
2962 \newif\ifallowcodebreaks  \allowcodebreakstrue
2963
2964 \def\keywordtrue{true}
2965 \def\keywordfalse{false}
2966
2967 \parseargdef\allowcodebreaks{%
2968   \def\txiarg{#1}%
2969   \ifx\txiarg\keywordtrue
2970     \allowcodebreakstrue
2971   \else\ifx\txiarg\keywordfalse
2972     \allowcodebreaksfalse
2973   \else
2974     \errhelp = \EMsimple
2975     \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2976   \fi\fi
2977 }
2978
2979 % For @command, @env, @file, @option quotes seem unnecessary,
2980 % so use \code rather than \samp.
2981 \let\command=\code
2982 \let\env=\code
2983 \let\file=\code
2984 \let\option=\code
2985
2986 % @uref (abbreviation for `urlref') aka @url takes an optional
2987 % (comma-separated) second argument specifying the text to display and
2988 % an optional third arg as text to display instead of (rather than in
2989 % addition to) the url itself.  First (mandatory) arg is the url.
2990
2991 % TeX-only option to allow changing PDF output to show only the second
2992 % arg (if given), and not the url (which is then just the link target).
2993 \newif\ifurefurlonlylink
2994
2995 % The default \pretolerance setting stops the penalty inserted in
2996 % \urefallowbreak being a discouragement to line breaking.  Set it to
2997 % a negative value for this paragraph only.  Hopefully this does not
2998 % conflict with redefinitions of \par done elsewhere.
2999 \def\nopretolerance{%
3000 \pretolerance=-1
3001 \def\par{\endgraf\pretolerance=100 \let\par\endgraf}%
3002 }
3003
3004 % The main macro is \urefbreak, which allows breaking at expected
3005 % places within the url.
3006 \def\urefbreak{\nopretolerance \begingroup \urefcatcodes \dourefbreak}
3007 \let\uref=\urefbreak
3008 %
3009 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
3010 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
3011   \unsepspaces
3012   \pdfurl{#1}%
3013   \setbox0 = \hbox{\ignorespaces #3}%
3014   \ifdim\wd0 > 0pt
3015     \unhbox0 % third arg given, show only that
3016   \else
3017     \setbox0 = \hbox{\ignorespaces #2}% look for second arg
3018     \ifdim\wd0 > 0pt
3019       \ifpdf
3020         % For pdfTeX and LuaTeX
3021         \ifurefurlonlylink
3022           % PDF plus option to not display url, show just arg
3023           \unhbox0
3024         \else
3025           % PDF, normally display both arg and url for consistency,
3026           % visibility, if the pdf is eventually used to print, etc.
3027           \unhbox0\ (\urefcode{#1})%
3028         \fi
3029       \else
3030         \ifx\XeTeXrevision\thisisundefined
3031           \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
3032         \else
3033           % For XeTeX
3034           \ifurefurlonlylink
3035             % PDF plus option to not display url, show just arg
3036             \unhbox0
3037           \else
3038             % PDF, normally display both arg and url for consistency,
3039             % visibility, if the pdf is eventually used to print, etc.
3040             \unhbox0\ (\urefcode{#1})%
3041           \fi
3042         \fi
3043       \fi
3044     \else
3045       \urefcode{#1}% only url given, so show it
3046     \fi
3047   \fi
3048   \endlink
3049 \endgroup}
3050
3051 % Allow line breaks around only a few characters (only).
3052 \def\urefcatcodes{%
3053   \catcode`\&=\active \catcode`\.=\active
3054   \catcode`\#=\active \catcode`\?=\active
3055   \catcode`\/=\active
3056 }
3057 {
3058   \urefcatcodes
3059   %
3060   \global\def\urefcode{\begingroup
3061     \setcodequotes
3062     \urefcatcodes
3063     \let&\urefcodeamp
3064     \let.\urefcodedot
3065     \let#\urefcodehash
3066     \let?\urefcodequest
3067     \let/\urefcodeslash
3068     \codex
3069   }
3070   %
3071   % By default, they are just regular characters.
3072   \global\def&{\normalamp}
3073   \global\def.{\normaldot}
3074   \global\def#{\normalhash}
3075   \global\def?{\normalquest}
3076   \global\def/{\normalslash}
3077 }
3078
3079 \def\urefcodeamp{\urefprebreak \&\urefpostbreak}
3080 \def\urefcodedot{\urefprebreak .\urefpostbreak}
3081 \def\urefcodehash{\urefprebreak \#\urefpostbreak}
3082 \def\urefcodequest{\urefprebreak ?\urefpostbreak}
3083 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
3084 {
3085   \catcode`\/=\active
3086   \global\def\urefcodeslashfinish{%
3087     \urefprebreak \slashChar
3088     % Allow line break only after the final / in a sequence of
3089     % slashes, to avoid line break between the slashes in http://.
3090     \ifx\next/\else \urefpostbreak \fi
3091   }
3092 }
3093
3094 % By default we'll break after the special characters, but some people like to
3095 % break before the special chars, so allow that.  Also allow no breaking at
3096 % all, for manual control.
3097 %
3098 \parseargdef\urefbreakstyle{%
3099   \def\txiarg{#1}%
3100   \ifx\txiarg\wordnone
3101     \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
3102   \else\ifx\txiarg\wordbefore
3103     \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak}
3104   \else\ifx\txiarg\wordafter
3105     \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak}
3106   \else
3107     \errhelp = \EMsimple
3108     \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
3109   \fi\fi\fi
3110 }
3111 \def\wordafter{after}
3112 \def\wordbefore{before}
3113 \def\wordnone{none}
3114
3115 % Allow a ragged right output to aid breaking long URL's.  There can
3116 % be a break at the \allowbreak with no extra glue (if the existing stretch in
3117 % the line is sufficient), a break at the \penalty with extra glue added
3118 % at the end of the line, or no break at all here.
3119 %   Changing the value of the penalty and/or the amount of stretch affects how
3120 % preferable one choice is over the other.
3121 \def\urefallowbreak{%
3122   \penalty0\relax
3123   \hskip 0pt plus 2 em\relax
3124   \penalty1000\relax
3125   \hskip 0pt plus -2 em\relax
3126 }
3127
3128 \urefbreakstyle after
3129
3130 % @url synonym for @uref, since that's how everyone uses it.
3131 %
3132 \let\url=\uref
3133
3134 % rms does not like angle brackets --karl, 17may97.
3135 % So now @email is just like @uref, unless we are pdf.
3136 %
3137 %\def\email#1{\angleleft{\tt #1}\angleright}
3138 \ifpdforxetex
3139   \def\email#1{\doemail#1,,\finish}
3140   \def\doemail#1,#2,#3\finish{\begingroup
3141     \unsepspaces
3142     \pdfurl{mailto:#1}%
3143     \setbox0 = \hbox{\ignorespaces #2}%
3144     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3145     \endlink
3146   \endgroup}
3147 \else
3148   \let\email=\uref
3149 \fi
3150
3151 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3152 %   `example' (@kbd uses ttsl only inside of @example and friends),
3153 %   or `code' (@kbd uses normal tty font always).
3154 \parseargdef\kbdinputstyle{%
3155   \def\txiarg{#1}%
3156   \ifx\txiarg\worddistinct
3157     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
3158   \else\ifx\txiarg\wordexample
3159     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
3160   \else\ifx\txiarg\wordcode
3161     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
3162   \else
3163     \errhelp = \EMsimple
3164     \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
3165   \fi\fi\fi
3166 }
3167 \def\worddistinct{distinct}
3168 \def\wordexample{example}
3169 \def\wordcode{code}
3170
3171 % Default is `distinct'.
3172 \kbdinputstyle distinct
3173
3174 \def\kbd#1{%
3175   \tclose{\kbdfont\setcodequotes#1}%
3176 }
3177
3178 % definition of @key that produces a lozenge.  Doesn't adjust to text size.
3179 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3180 %\font\keysy=cmsy9
3181 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3182 %  \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3183 %    \vbox{\hrule\kern-0.4pt
3184 %     \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3185 %    \kern-0.4pt\hrule}%
3186 %  \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3187
3188 % definition of @key with no lozenge.
3189 %
3190 \def\key#1{{\setregularquotes \nohyphenation \tt #1}\null}
3191
3192 % @clicksequence{File @click{} Open ...}
3193 \def\clicksequence#1{\begingroup #1\endgroup}
3194
3195 % @clickstyle @arrow   (by default)
3196 \parseargdef\clickstyle{\def\click{#1}}
3197 \def\click{\arrow}
3198
3199 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
3200 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
3201 %
3202 \def\dmn#1{\thinspace #1}
3203
3204 % @acronym for "FBI", "NATO", and the like.
3205 % We print this one point size smaller, since it's intended for
3206 % all-uppercase.
3207 %
3208 \def\acronym#1{\doacronym #1,,\finish}
3209 \def\doacronym#1,#2,#3\finish{%
3210   {\switchtolsize #1}%
3211   \def\temp{#2}%
3212   \ifx\temp\empty \else
3213     \space ({\unsepspaces \ignorespaces \temp \unskip})%
3214   \fi
3215   \null % reset \spacefactor=1000
3216 }
3217
3218 % @abbr for "Comput. J." and the like.
3219 % No font change, but don't do end-of-sentence spacing.
3220 %
3221 \def\abbr#1{\doabbr #1,,\finish}
3222 \def\doabbr#1,#2,#3\finish{%
3223   {\plainfrenchspacing #1}%
3224   \def\temp{#2}%
3225   \ifx\temp\empty \else
3226     \space ({\unsepspaces \ignorespaces \temp \unskip})%
3227   \fi
3228   \null % reset \spacefactor=1000
3229 }
3230
3231 % @asis just yields its argument.  Used with @table, for example.
3232 %
3233 \def\asis#1{#1}
3234
3235 % @math outputs its argument in math mode.
3236 %
3237 % One complication: _ usually means subscripts, but it could also mean
3238 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
3239 % _ active, and distinguish by seeing if the current family is \slfam,
3240 % which is what @var uses.
3241 {
3242   \catcode`\_ = \active
3243   \gdef\mathunderscore{%
3244     \catcode`\_=\active
3245     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
3246   }
3247 }
3248 % Another complication: we want \\ (and @\) to output a math (or tt) \.
3249 % FYI, plain.tex uses \\ as a temporary control sequence (for no
3250 % particular reason), but this is not advertised and we don't care.
3251 %
3252 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
3253 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
3254 %
3255 \def\math{%
3256   \ifmmode\else % only go into math if not in math mode already
3257     \tex
3258     \mathunderscore
3259     \let\\ = \mathbackslash
3260     \mathactive
3261     % make the texinfo accent commands work in math mode
3262     \let\"=\ddot
3263     \let\'=\acute
3264     \let\==\bar
3265     \let\^=\hat
3266     \let\`=\grave
3267     \let\u=\breve
3268     \let\v=\check
3269     \let\~=\tilde
3270     \let\dotaccent=\dot
3271     % have to provide another name for sup operator
3272     \let\mathopsup=\sup
3273   $\expandafter\finishmath\fi
3274 }
3275 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
3276
3277 % Some active characters (such as <) are spaced differently in math.
3278 % We have to reset their definitions in case the @math was an argument
3279 % to a command which sets the catcodes (such as @item or @section).
3280 %
3281 {
3282   \catcode`^ = \active
3283   \catcode`< = \active
3284   \catcode`> = \active
3285   \catcode`+ = \active
3286   \catcode`' = \active
3287   \gdef\mathactive{%
3288     \let^ = \ptexhat
3289     \let< = \ptexless
3290     \let> = \ptexgtr
3291     \let+ = \ptexplus
3292     \let' = \ptexquoteright
3293   }
3294 }
3295
3296 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
3297 % If in text, use math to place as sub/superscript, but switch
3298 % into text mode, with smaller fonts.  This is a different font than the
3299 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
3300 % fix it (significant additions to font machinery) until someone notices.
3301 %
3302 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
3303 \def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
3304 %
3305 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
3306 \def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
3307
3308 % provide this command from LaTeX as it is very common
3309 \def\frac#1#2{{{#1}\over{#2}}}
3310
3311 % @displaymath.
3312 % \globaldefs is needed to recognize the end lines in \tex and
3313 % \end tex.  Set \thisenv as @end displaymath is seen before @end tex.
3314 {\obeylines
3315 \globaldefs=1
3316 \envdef\displaymath{%
3317 \tex%
3318 \def\thisenv{\displaymath}%
3319 \begingroup\let\end\displaymathend%
3320 $$%
3321 }
3322
3323 \def\displaymathend{$$\endgroup\end}%
3324
3325 \def\Edisplaymath{%
3326 \def\thisenv{\tex}%
3327 \end tex
3328 }}
3329
3330
3331 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3332 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3333 % except specified as a normal braced arg, so no newlines to worry about.
3334 %
3335 \def\outfmtnametex{tex}
3336 %
3337 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
3338 \long\def\doinlinefmt#1,#2,\finish{%
3339   \def\inlinefmtname{#1}%
3340   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
3341 }
3342 %
3343 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3344 % FMTNAME is tex, else ELSE-TEXT.
3345 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
3346 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
3347   \def\inlinefmtname{#1}%
3348   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
3349 }
3350 %
3351 % For raw, must switch into @tex before parsing the argument, to avoid
3352 % setting catcodes prematurely.  Doing it this way means that, for
3353 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3354 % ignored.  But this isn't important because if people want a literal
3355 % *right* brace they would have to use a command anyway, so they may as
3356 % well use a command to get a left brace too.  We could re-use the
3357 % delimiter character idea from \verb, but it seems like overkill.
3358 %
3359 \long\def\inlineraw{\tex \doinlineraw}
3360 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
3361 \def\doinlinerawtwo#1,#2,\finish{%
3362   \def\inlinerawname{#1}%
3363   \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
3364   \endgroup % close group opened by \tex.
3365 }
3366
3367 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3368 %
3369 \long\def\inlineifset#1{\doinlineifset #1,\finish}
3370 \long\def\doinlineifset#1,#2,\finish{%
3371   \def\inlinevarname{#1}%
3372   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
3373   \else\ignorespaces#2\fi
3374 }
3375
3376 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3377 %
3378 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
3379 \long\def\doinlineifclear#1,#2,\finish{%
3380   \def\inlinevarname{#1}%
3381   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
3382 }
3383
3384
3385 \message{glyphs,}
3386 % and logos.
3387
3388 % @@ prints an @, as does @atchar{}.
3389 \def\@{\char64 }
3390 \let\atchar=\@
3391
3392 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3393 \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
3394 \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
3395 \let\{=\lbracechar
3396 \let\}=\rbracechar
3397
3398 % @comma{} to avoid , parsing problems.
3399 \let\comma = ,
3400
3401 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3402 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3403 \let\, = \ptexc
3404 \let\dotaccent = \ptexdot
3405 \def\ringaccent#1{{\accent23 #1}}
3406 \let\tieaccent = \ptext
3407 \let\ubaraccent = \ptexb
3408 \let\udotaccent = \d
3409
3410 % Other special characters: @questiondown @exclamdown @ordf @ordm
3411 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3412 \def\questiondown{?`}
3413 \def\exclamdown{!`}
3414 \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
3415 \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
3416
3417 % Dotless i and dotless j, used for accents.
3418 \def\imacro{i}
3419 \def\jmacro{j}
3420 \def\dotless#1{%
3421   \def\temp{#1}%
3422   \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3423   \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3424   \else \errmessage{@dotless can be used only with i or j}%
3425   \fi\fi
3426 }
3427
3428 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3429 % period following counts as ending a sentence.  (Idea found in latex.)
3430 %
3431 \edef\TeX{\TeX \spacefactor=1000 }
3432
3433 % @LaTeX{} logo.  Not quite the same results as the definition in
3434 % latex.ltx, since we use a different font for the raised A; it's most
3435 % convenient for us to use an explicitly smaller font, rather than using
3436 % the \scriptstyle font (since we don't reset \scriptstyle and
3437 % \scriptscriptstyle).
3438 %
3439 \def\LaTeX{%
3440   L\kern-.36em
3441   {\setbox0=\hbox{T}%
3442    \vbox to \ht0{\hbox{%
3443      \ifx\textnominalsize\xwordpt
3444        % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
3445        % Revert to plain's \scriptsize, which is 7pt.
3446        \count255=\the\fam $\fam\count255 \scriptstyle A$%
3447      \else
3448        % For 11pt, we can use our lllsize.
3449        \switchtolllsize A%
3450      \fi
3451      }%
3452      \vss
3453   }}%
3454   \kern-.15em
3455   \TeX
3456 }
3457
3458 % Some math mode symbols.  Define \ensuremath to switch into math mode
3459 % unless we are already there.  Expansion tricks may not be needed here,
3460 % but safer, and can't hurt.
3461 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3462 \def\ensuredmath#1{$\relax#1$}
3463 %
3464 \def\bullet{\ensuremath\ptexbullet}
3465 \def\geq{\ensuremath\ge}
3466 \def\leq{\ensuremath\le}
3467 \def\minus{\ensuremath-}
3468
3469 % @dots{} outputs an ellipsis using the current font.
3470 % We do .5em per period so that it has the same spacing in the cm
3471 % typewriter fonts as three actual period characters; on the other hand,
3472 % in other typewriter fonts three periods are wider than 1.5em.  So do
3473 % whichever is larger.
3474 %
3475 \def\dots{%
3476   \leavevmode
3477   \setbox0=\hbox{...}% get width of three periods
3478   \ifdim\wd0 > 1.5em
3479     \dimen0 = \wd0
3480   \else
3481     \dimen0 = 1.5em
3482   \fi
3483   \hbox to \dimen0{%
3484     \hskip 0pt plus.25fil
3485     .\hskip 0pt plus1fil
3486     .\hskip 0pt plus1fil
3487     .\hskip 0pt plus.5fil
3488   }%
3489 }
3490
3491 % @enddots{} is an end-of-sentence ellipsis.
3492 %
3493 \def\enddots{%
3494   \dots
3495   \spacefactor=\endofsentencespacefactor
3496 }
3497
3498 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3499 %
3500 % Since these characters are used in examples, they should be an even number of
3501 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3502 %
3503 \def\point{$\star$}
3504 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3505 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3506 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3507 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3508 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3509
3510 % The @error{} command.
3511 % Adapted from the TeXbook's \boxit.
3512 %
3513 \newbox\errorbox
3514 %
3515 {\ttfont \global\dimen0 = 3em}% Width of the box.
3516 \dimen2 = .55pt % Thickness of rules
3517 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3518 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3519 %
3520 \setbox\errorbox=\hbox to \dimen0{\hfil
3521    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3522    \advance\hsize by -2\dimen2 % Rules.
3523    \vbox{%
3524       \hrule height\dimen2
3525       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
3526          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3527          \kern3pt\vrule width\dimen2}% Space to right.
3528       \hrule height\dimen2}
3529     \hfil}
3530 %
3531 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3532
3533 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3534 %
3535 \def\pounds{\ifmonospace{\ecfont\char"BF}\else{\it\$}\fi}
3536
3537 % @euro{} comes from a separate font, depending on the current style.
3538 % We use the free feym* fonts from the eurosym package by Henrik
3539 % Theiling, which support regular, slanted, bold and bold slanted (and
3540 % "outlined" (blackboard board, sort of) versions, which we don't need).
3541 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3542 %
3543 % Although only regular is the truly official Euro symbol, we ignore
3544 % that.  The Euro is designed to be slightly taller than the regular
3545 % font height.
3546 %
3547 % feymr - regular
3548 % feymo - slanted
3549 % feybr - bold
3550 % feybo - bold slanted
3551 %
3552 % There is no good (free) typewriter version, to my knowledge.
3553 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3554 % Hmm.
3555 %
3556 % Also doesn't work in math.  Do we need to do math with euro symbols?
3557 % Hope not.
3558 %
3559 %
3560 \def\euro{{\eurofont e}}
3561 \def\eurofont{%
3562   % We set the font at each command, rather than predefining it in
3563   % \textfonts and the other font-switching commands, so that
3564   % installations which never need the symbol don't have to have the
3565   % font installed.
3566   %
3567   % There is only one designed size (nominal 10pt), so we always scale
3568   % that to the current nominal size.
3569   %
3570   % By the way, simply using "at 1em" works for cmr10 and the like, but
3571   % does not work for cmbx10 and other extended/shrunken fonts.
3572   %
3573   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3574   %
3575   \ifx\curfontstyle\bfstylename
3576     % bold:
3577     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3578   \else
3579     % regular:
3580     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3581   \fi
3582   \thiseurofont
3583 }
3584
3585 % Glyphs from the EC fonts.  We don't use \let for the aliases, because
3586 % sometimes we redefine the original macro, and the alias should reflect
3587 % the redefinition.
3588 %
3589 % Use LaTeX names for the Icelandic letters.
3590 \def\DH{{\ecfont \char"D0}} % Eth
3591 \def\dh{{\ecfont \char"F0}} % eth
3592 \def\TH{{\ecfont \char"DE}} % Thorn
3593 \def\th{{\ecfont \char"FE}} % thorn
3594 %
3595 \def\guillemetleft{{\ecfont \char"13}}
3596 \def\guillemotleft{\guillemetleft}
3597 \def\guillemetright{{\ecfont \char"14}}
3598 \def\guillemotright{\guillemetright}
3599 \def\guilsinglleft{{\ecfont \char"0E}}
3600 \def\guilsinglright{{\ecfont \char"0F}}
3601 \def\quotedblbase{{\ecfont \char"12}}
3602 \def\quotesinglbase{{\ecfont \char"0D}}
3603 %
3604 \def\L{{\ecfont \char"8A}} % L with stroke
3605 \def\l{{\ecfont \char"AA}} % l with stroke
3606 %
3607 % This positioning is not perfect (see the ogonek LaTeX package), but
3608 % we have the precomposed glyphs for the most common cases.  We put the
3609 % tests to use those glyphs in the single \ogonek macro so we have fewer
3610 % dummy definitions to worry about for index entries, etc.
3611 %
3612 % ogonek is also used with other letters in Lithuanian (IOU), but using
3613 % the precomposed glyphs for those is not so easy since they aren't in
3614 % the same EC font.
3615 \def\ogonek#1{{%
3616   \def\temp{#1}%
3617   \ifx\temp\macrocharA\Aogonek
3618   \else\ifx\temp\macrochara\aogonek
3619   \else\ifx\temp\macrocharE\Eogonek
3620   \else\ifx\temp\macrochare\eogonek
3621   \else
3622     \ecfont \setbox0=\hbox{#1}%
3623     \ifdim\ht0=1ex\accent"0C #1%
3624     \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3625     \fi
3626   \fi\fi\fi\fi
3627   }%
3628 }
3629 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3630 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3631 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3632 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3633 %
3634 % Use the European Computer Modern fonts (cm-super in outline format)
3635 % for non-CM glyphs.  That is ec* for regular text and tc* for the text
3636 % companion symbols (LaTeX TS1 encoding).  Both are part of the ec
3637 % package and follow the same conventions.
3638 %
3639 \def\ecfont{\etcfont{e}}
3640 \def\tcfont{\etcfont{t}}
3641 %
3642 \def\etcfont#1{%
3643   % We can't distinguish serif/sans and italic/slanted, but this
3644   % is used for crude hacks anyway (like adding French and German
3645   % quotes to documents typeset with CM, where we lose kerning), so
3646   % hopefully nobody will notice/care.
3647   \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3648   \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3649   \ifmonospace
3650     % typewriter:
3651     \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3652   \else
3653     \ifx\curfontstyle\bfstylename
3654       % bold:
3655       \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3656     \else
3657       % regular:
3658       \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3659     \fi
3660   \fi
3661   \thisecfont
3662 }
3663
3664 % @registeredsymbol - R in a circle.  The font for the R should really
3665 % be smaller yet, but lllsize is the best we can do for now.
3666 % Adapted from the plain.tex definition of \copyright.
3667 %
3668 \def\registeredsymbol{%
3669   $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
3670                \hfil\crcr\Orb}}%
3671     }$%
3672 }
3673
3674 % @textdegree - the normal degrees sign.
3675 %
3676 \def\textdegree{$^\circ$}
3677
3678 % Laurent Siebenmann reports \Orb undefined with:
3679 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
3680 % so we'll define it if necessary.
3681 %
3682 \ifx\Orb\thisisundefined
3683 \def\Orb{\mathhexbox20D}
3684 \fi
3685
3686 % Quotes.
3687 \chardef\quoteleft=`\`
3688 \chardef\quoteright=`\'
3689
3690 % only change font for tt for correct kerning and to avoid using
3691 % \ecfont unless necessary.
3692 \def\quotedblleft{%
3693   \ifmonospace{\ecfont\char"10}\else{\char"5C}\fi
3694 }
3695
3696 \def\quotedblright{%
3697   \ifmonospace{\ecfont\char"11}\else{\char`\"}\fi
3698 }
3699
3700
3701 \message{page headings,}
3702
3703 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3704 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3705
3706 % First the title page.  Must do @settitle before @titlepage.
3707 \newif\ifseenauthor
3708 \newif\iffinishedtitlepage
3709
3710 % @setcontentsaftertitlepage used to do an implicit @contents or
3711 % @shortcontents after @end titlepage, but it is now obsolete.
3712 \def\setcontentsaftertitlepage{%
3713   \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
3714               command; move your @contents command if you want the contents
3715               after the title page.}}%
3716 \def\setshortcontentsaftertitlepage{%
3717   \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
3718               command; move your @shortcontents and @contents commands if you
3719               want the contents after the title page.}}%
3720
3721 \parseargdef\shorttitlepage{%
3722   \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3723   \endgroup\page\hbox{}\page}
3724
3725 \envdef\titlepage{%
3726   % Open one extra group, as we want to close it in the middle of \Etitlepage.
3727   \begingroup
3728     \parindent=0pt \textfonts
3729     % Leave some space at the very top of the page.
3730     \vglue\titlepagetopglue
3731     % No rule at page bottom unless we print one at the top with @title.
3732     \finishedtitlepagetrue
3733     %
3734     % Most title ``pages'' are actually two pages long, with space
3735     % at the top of the second.  We don't want the ragged left on the second.
3736     \let\oldpage = \page
3737     \def\page{%
3738       \iffinishedtitlepage\else
3739          \finishtitlepage
3740       \fi
3741       \let\page = \oldpage
3742       \page
3743       \null
3744     }%
3745 }
3746
3747 \def\Etitlepage{%
3748     \iffinishedtitlepage\else
3749         \finishtitlepage
3750     \fi
3751     % It is important to do the page break before ending the group,
3752     % because the headline and footline are only empty inside the group.
3753     % If we use the new definition of \page, we always get a blank page
3754     % after the title page, which we certainly don't want.
3755     \oldpage
3756   \endgroup
3757   %
3758   % Need this before the \...aftertitlepage checks so that if they are
3759   % in effect the toc pages will come out with page numbers.
3760   \HEADINGSon
3761 }
3762
3763 \def\finishtitlepage{%
3764   \vskip4pt \hrule height 2pt width \hsize
3765   \vskip\titlepagebottomglue
3766   \finishedtitlepagetrue
3767 }
3768
3769 % Settings used for typesetting titles: no hyphenation, no indentation,
3770 % don't worry much about spacing, ragged right.  This should be used
3771 % inside a \vbox, and fonts need to be set appropriately first. \par should
3772 % be specified before the end of the \vbox, since a vbox is a group.
3773 %
3774 \def\raggedtitlesettings{%
3775   \rm
3776   \hyphenpenalty=10000
3777   \parindent=0pt
3778   \tolerance=5000
3779   \ptexraggedright
3780 }
3781
3782 % Macros to be used within @titlepage:
3783
3784 \let\subtitlerm=\rmfont
3785 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3786
3787 \parseargdef\title{%
3788   \checkenv\titlepage
3789   \vbox{\titlefonts \raggedtitlesettings #1\par}%
3790   % print a rule at the page bottom also.
3791   \finishedtitlepagefalse
3792   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3793 }
3794
3795 \parseargdef\subtitle{%
3796   \checkenv\titlepage
3797   {\subtitlefont \rightline{#1}}%
3798 }
3799
3800 % @author should come last, but may come many times.
3801 % It can also be used inside @quotation.
3802 %
3803 \parseargdef\author{%
3804   \def\temp{\quotation}%
3805   \ifx\thisenv\temp
3806     \def\quotationauthor{#1}% printed in \Equotation.
3807   \else
3808     \checkenv\titlepage
3809     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3810     {\secfonts\rm \leftline{#1}}%
3811   \fi
3812 }
3813
3814
3815 % Set up page headings and footings.
3816
3817 \let\thispage=\folio
3818
3819 \newtoks\evenheadline    % headline on even pages
3820 \newtoks\oddheadline     % headline on odd pages
3821 \newtoks\evenchapheadline% headline on even pages with a new chapter
3822 \newtoks\oddchapheadline % headline on odd pages with a new chapter
3823 \newtoks\evenfootline    % footline on even pages
3824 \newtoks\oddfootline     % footline on odd pages
3825
3826 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3827 \headline={{\textfonts\rm
3828             \ifchapterpage
3829               \ifodd\pageno\the\oddchapheadline\else\the\evenchapheadline\fi
3830             \else
3831               \ifodd\pageno\the\oddheadline\else\the\evenheadline\fi
3832             \fi}}
3833
3834 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3835                             \else \the\evenfootline \fi}\HEADINGShook}
3836 \let\HEADINGShook=\relax
3837
3838 % Commands to set those variables.
3839 % For example, this is what  @headings on  does
3840 % @evenheading @thistitle|@thispage|@thischapter
3841 % @oddheading @thischapter|@thispage|@thistitle
3842 % @evenfooting @thisfile||
3843 % @oddfooting ||@thisfile
3844
3845
3846 \def\evenheading{\parsearg\evenheadingxxx}
3847 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3848 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3849   \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
3850   \global\evenchapheadline=\evenheadline}
3851
3852 \def\oddheading{\parsearg\oddheadingxxx}
3853 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3854 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3855   \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3856   \global\oddchapheadline=\oddheadline}
3857
3858 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3859
3860 \def\evenfooting{\parsearg\evenfootingxxx}
3861 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3862 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3863 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3864
3865 \def\oddfooting{\parsearg\oddfootingxxx}
3866 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3867 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3868   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3869   %
3870   % Leave some space for the footline.  Hopefully ok to assume
3871   % @evenfooting will not be used by itself.
3872   \global\advance\txipageheight by -12pt
3873   \global\advance\vsize by -12pt
3874 }
3875
3876 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3877
3878 % @evenheadingmarks top     \thischapter <- chapter at the top of a page
3879 % @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
3880 %
3881 % The same set of arguments for:
3882 %
3883 % @oddheadingmarks
3884 % @evenfootingmarks
3885 % @oddfootingmarks
3886 % @everyheadingmarks
3887 % @everyfootingmarks
3888
3889 % These define \getoddheadingmarks, \getevenheadingmarks,
3890 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3891 % \gettopheadingmarks, \getbottomheadingmarks.
3892 %
3893 \def\evenheadingmarks{\headingmarks{even}{heading}}
3894 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3895 \def\evenfootingmarks{\headingmarks{even}{footing}}
3896 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3897 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
3898                           \headingmarks{odd}{heading}{#1} }
3899 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
3900                           \headingmarks{odd}{footing}{#1} }
3901 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3902 \def\headingmarks#1#2#3 {%
3903   \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3904   \global\expandafter\let\csname get#1#2marks\endcsname \temp
3905 }
3906
3907 \everyheadingmarks bottom
3908 \everyfootingmarks bottom
3909
3910 % @headings double      turns headings on for double-sided printing.
3911 % @headings single      turns headings on for single-sided printing.
3912 % @headings off         turns them off.
3913 % @headings on          same as @headings double, retained for compatibility.
3914 % @headings after       turns on double-sided headings after this page.
3915 % @headings doubleafter turns on double-sided headings after this page.
3916 % @headings singleafter turns on single-sided headings after this page.
3917 % By default, they are off at the start of a document,
3918 % and turned `on' after @end titlepage.
3919
3920 \parseargdef\headings{\csname HEADINGS#1\endcsname}
3921
3922 \def\headingsoff{% non-global headings elimination
3923   \evenheadline={\hfil}\evenfootline={\hfil}\evenchapheadline={\hfil}%
3924    \oddheadline={\hfil}\oddfootline={\hfil}\oddchapheadline={\hfil}%
3925 }
3926
3927 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3928 \HEADINGSoff  % it's the default
3929
3930 % When we turn headings on, set the page number to 1.
3931 \def\pageone{
3932   \global\pageno=1
3933   \global\arabiccount = \pagecount
3934 }
3935
3936 % For double-sided printing, put current file name in lower left corner,
3937 % chapter name on inside top of right hand pages, document
3938 % title on inside top of left hand pages, and page numbers on outside top
3939 % edge of all pages.
3940 \def\HEADINGSdouble{%
3941 \pageone
3942 \HEADINGSdoublex
3943 }
3944 \let\contentsalignmacro = \chappager
3945
3946 % For single-sided printing, chapter title goes across top left of page,
3947 % page number on top right.
3948 \def\HEADINGSsingle{%
3949 \pageone
3950 \HEADINGSsinglex
3951 }
3952 \def\HEADINGSon{\HEADINGSdouble}
3953
3954 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3955 \let\HEADINGSdoubleafter=\HEADINGSafter
3956 \def\HEADINGSdoublex{%
3957 \global\evenfootline={\hfil}
3958 \global\oddfootline={\hfil}
3959 \global\evenheadline={\line{\folio\hfil\thistitle}}
3960 \global\oddheadline={\line{\thischapter\hfil\folio}}
3961 \global\evenchapheadline={\line{\folio\hfil}}
3962 \global\oddchapheadline={\line{\hfil\folio}}
3963 \global\let\contentsalignmacro = \chapoddpage
3964 }
3965
3966 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3967 \def\HEADINGSsinglex{%
3968 \global\evenfootline={\hfil}
3969 \global\oddfootline={\hfil}
3970 \global\evenheadline={\line{\thischapter\hfil\folio}}
3971 \global\oddheadline={\line{\thischapter\hfil\folio}}
3972 \global\evenchapheadline={\line{\hfil\folio}}
3973 \global\oddchapheadline={\line{\hfil\folio}}
3974 \global\let\contentsalignmacro = \chappager
3975 }
3976
3977 % for @setchapternewpage off
3978 \def\HEADINGSsinglechapoff{%
3979 \pageone
3980 \global\evenfootline={\hfil}
3981 \global\oddfootline={\hfil}
3982 \global\evenheadline={\line{\thischapter\hfil\folio}}
3983 \global\oddheadline={\line{\thischapter\hfil\folio}}
3984 \global\evenchapheadline=\evenheadline
3985 \global\oddchapheadline=\oddheadline
3986 \global\let\contentsalignmacro = \chappager
3987 }
3988
3989 % Subroutines used in generating headings
3990 % This produces Day Month Year style of output.
3991 % Only define if not already defined, in case a txi-??.tex file has set
3992 % up a different format (e.g., txi-cs.tex does this).
3993 \ifx\today\thisisundefined
3994 \def\today{%
3995   \number\day\space
3996   \ifcase\month
3997   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3998   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3999   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
4000   \fi
4001   \space\number\year}
4002 \fi
4003
4004 % @settitle line...  specifies the title of the document, for headings.
4005 % It generates no output of its own.
4006 \def\thistitle{\putwordNoTitle}
4007 \def\settitle{\parsearg{\gdef\thistitle}}
4008
4009
4010 \message{tables,}
4011 % Tables -- @table, @ftable, @vtable, @item(x).
4012
4013 % default indentation of table text
4014 \newdimen\tableindent \tableindent=.8in
4015 % default indentation of @itemize and @enumerate text
4016 \newdimen\itemindent  \itemindent=.3in
4017 % margin between end of table item and start of table text.
4018 \newdimen\itemmargin  \itemmargin=.1in
4019
4020 % used internally for \itemindent minus \itemmargin
4021 \newdimen\itemmax
4022
4023 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
4024 % these defs.
4025 % They also define \itemindex
4026 % to index the item name in whatever manner is desired (perhaps none).
4027
4028 \newif\ifitemxneedsnegativevskip
4029
4030 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
4031
4032 \def\internalBitem{\smallbreak \parsearg\itemzzz}
4033 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
4034
4035 \def\itemzzz #1{\begingroup %
4036   \advance\hsize by -\rightskip
4037   \advance\hsize by -\tableindent
4038   \setbox0=\hbox{\itemindicate{#1}}%
4039   \itemindex{#1}%
4040   \nobreak % This prevents a break before @itemx.
4041   %
4042   % If the item text does not fit in the space we have, put it on a line
4043   % by itself, and do not allow a page break either before or after that
4044   % line.  We do not start a paragraph here because then if the next
4045   % command is, e.g., @kindex, the whatsit would get put into the
4046   % horizontal list on a line by itself, resulting in extra blank space.
4047   \ifdim \wd0>\itemmax
4048     %
4049     % Make this a paragraph so we get the \parskip glue and wrapping,
4050     % but leave it ragged-right.
4051     \begingroup
4052       \advance\leftskip by-\tableindent
4053       \advance\hsize by\tableindent
4054       \advance\rightskip by0pt plus1fil\relax
4055       \leavevmode\unhbox0\par
4056     \endgroup
4057     %
4058     % We're going to be starting a paragraph, but we don't want the
4059     % \parskip glue -- logically it's part of the @item we just started.
4060     \nobreak \vskip-\parskip
4061     %
4062     % Stop a page break at the \parskip glue coming up.  However, if
4063     % what follows is an environment such as @example, there will be no
4064     % \parskip glue; then the negative vskip we just inserted would
4065     % cause the example and the item to crash together.  So we use this
4066     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
4067     % \parskip glue after all.  Section titles are handled this way also.
4068     %
4069     \penalty 10001
4070     \endgroup
4071     \itemxneedsnegativevskipfalse
4072   \else
4073     % The item text fits into the space.  Start a paragraph, so that the
4074     % following text (if any) will end up on the same line.
4075     \noindent
4076     % Do this with kerns and \unhbox so that if there is a footnote in
4077     % the item text, it can migrate to the main vertical list and
4078     % eventually be printed.
4079     \nobreak\kern-\tableindent
4080     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
4081     \unhbox0
4082     \nobreak\kern\dimen0
4083     \endgroup
4084     \itemxneedsnegativevskiptrue
4085   \fi
4086 }
4087
4088 \def\item{\errmessage{@item while not in a list environment}}
4089 \def\itemx{\errmessage{@itemx while not in a list environment}}
4090
4091 % @table, @ftable, @vtable.
4092 \envdef\table{%
4093   \let\itemindex\gobble
4094   \tablecheck{table}%
4095 }
4096 \envdef\ftable{%
4097   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
4098   \tablecheck{ftable}%
4099 }
4100 \envdef\vtable{%
4101   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
4102   \tablecheck{vtable}%
4103 }
4104 \def\tablecheck#1{%
4105   \ifnum \the\catcode`\^^M=\active
4106     \endgroup
4107     \errmessage{This command won't work in this context; perhaps the problem is
4108       that we are \inenvironment\thisenv}%
4109     \def\next{\doignore{#1}}%
4110   \else
4111     \let\next\tablex
4112   \fi
4113   \next
4114 }
4115 \def\tablex#1{%
4116   \def\itemindicate{#1}%
4117   \parsearg\tabley
4118 }
4119 \def\tabley#1{%
4120   {%
4121     \makevalueexpandable
4122     \edef\temp{\noexpand\tablez #1\space\space\space}%
4123     \expandafter
4124   }\temp \endtablez
4125 }
4126 \def\tablez #1 #2 #3 #4\endtablez{%
4127   \aboveenvbreak
4128   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
4129   \ifnum 0#2>0 \tableindent=#2\mil \fi
4130   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
4131   \itemmax=\tableindent
4132   \advance \itemmax by -\itemmargin
4133   \advance \leftskip by \tableindent
4134   \exdentamount=\tableindent
4135   \parindent = 0pt
4136   \parskip = \smallskipamount
4137   \ifdim \parskip=0pt \parskip=2pt \fi
4138   \let\item = \internalBitem
4139   \let\itemx = \internalBitemx
4140 }
4141 \def\Etable{\endgraf\afterenvbreak}
4142 \let\Eftable\Etable
4143 \let\Evtable\Etable
4144 \let\Eitemize\Etable
4145 \let\Eenumerate\Etable
4146
4147 % This is the counter used by @enumerate, which is really @itemize
4148
4149 \newcount \itemno
4150
4151 \envdef\itemize{\parsearg\doitemize}
4152
4153 \def\doitemize#1{%
4154   \aboveenvbreak
4155   \itemmax=\itemindent
4156   \advance\itemmax by -\itemmargin
4157   \advance\leftskip by \itemindent
4158   \exdentamount=\itemindent
4159   \parindent=0pt
4160   \parskip=\smallskipamount
4161   \ifdim\parskip=0pt \parskip=2pt \fi
4162   %
4163   % Try typesetting the item mark so that if the document erroneously says
4164   % something like @itemize @samp (intending @table), there's an error
4165   % right away at the @itemize.  It's not the best error message in the
4166   % world, but it's better than leaving it to the @item.  This means if
4167   % the user wants an empty mark, they have to say @w{} not just @w.
4168   \def\itemcontents{#1}%
4169   \setbox0 = \hbox{\itemcontents}%
4170   %
4171   % @itemize with no arg is equivalent to @itemize @bullet.
4172   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
4173   %
4174   \let\item=\itemizeitem
4175 }
4176
4177 % Definition of @item while inside @itemize and @enumerate.
4178 %
4179 \def\itemizeitem{%
4180   \advance\itemno by 1  % for enumerations
4181   {\let\par=\endgraf \smallbreak}% reasonable place to break
4182   {%
4183    % If the document has an @itemize directly after a section title, a
4184    % \nobreak will be last on the list, and \sectionheading will have
4185    % done a \vskip-\parskip.  In that case, we don't want to zero
4186    % parskip, or the item text will crash with the heading.  On the
4187    % other hand, when there is normal text preceding the item (as there
4188    % usually is), we do want to zero parskip, or there would be too much
4189    % space.  In that case, we won't have a \nobreak before.  At least
4190    % that's the theory.
4191    \ifnum\lastpenalty<10000 \parskip=0in \fi
4192    \noindent
4193    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
4194    %
4195    \ifinner\else
4196      \vadjust{\penalty 1200}% not good to break after first line of item.
4197    \fi
4198    % We can be in inner vertical mode in a footnote, although an
4199    % @itemize looks awful there.
4200   }%
4201   \flushcr
4202 }
4203
4204 % \splitoff TOKENS\endmark defines \first to be the first token in
4205 % TOKENS, and \rest to be the remainder.
4206 %
4207 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
4208
4209 % Allow an optional argument of an uppercase letter, lowercase letter,
4210 % or number, to specify the first label in the enumerated list.  No
4211 % argument is the same as `1'.
4212 %
4213 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
4214 \def\enumeratey #1 #2\endenumeratey{%
4215   % If we were given no argument, pretend we were given `1'.
4216   \def\thearg{#1}%
4217   \ifx\thearg\empty \def\thearg{1}\fi
4218   %
4219   % Detect if the argument is a single token.  If so, it might be a
4220   % letter.  Otherwise, the only valid thing it can be is a number.
4221   % (We will always have one token, because of the test we just made.
4222   % This is a good thing, since \splitoff doesn't work given nothing at
4223   % all -- the first parameter is undelimited.)
4224   \expandafter\splitoff\thearg\endmark
4225   \ifx\rest\empty
4226     % Only one token in the argument.  It could still be anything.
4227     % A ``lowercase letter'' is one whose \lccode is nonzero.
4228     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4229     %   not equal to itself.
4230     % Otherwise, we assume it's a number.
4231     %
4232     % We need the \relax at the end of the \ifnum lines to stop TeX from
4233     % continuing to look for a <number>.
4234     %
4235     \ifnum\lccode\expandafter`\thearg=0\relax
4236       \numericenumerate % a number (we hope)
4237     \else
4238       % It's a letter.
4239       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
4240         \lowercaseenumerate % lowercase letter
4241       \else
4242         \uppercaseenumerate % uppercase letter
4243       \fi
4244     \fi
4245   \else
4246     % Multiple tokens in the argument.  We hope it's a number.
4247     \numericenumerate
4248   \fi
4249 }
4250
4251 % An @enumerate whose labels are integers.  The starting integer is
4252 % given in \thearg.
4253 %
4254 \def\numericenumerate{%
4255   \itemno = \thearg
4256   \startenumeration{\the\itemno}%
4257 }
4258
4259 % The starting (lowercase) letter is in \thearg.
4260 \def\lowercaseenumerate{%
4261   \itemno = \expandafter`\thearg
4262   \startenumeration{%
4263     % Be sure we're not beyond the end of the alphabet.
4264     \ifnum\itemno=0
4265       \errmessage{No more lowercase letters in @enumerate; get a bigger
4266                   alphabet}%
4267     \fi
4268     \char\lccode\itemno
4269   }%
4270 }
4271
4272 % The starting (uppercase) letter is in \thearg.
4273 \def\uppercaseenumerate{%
4274   \itemno = \expandafter`\thearg
4275   \startenumeration{%
4276     % Be sure we're not beyond the end of the alphabet.
4277     \ifnum\itemno=0
4278       \errmessage{No more uppercase letters in @enumerate; get a bigger
4279                   alphabet}
4280     \fi
4281     \char\uccode\itemno
4282   }%
4283 }
4284
4285 % Call \doitemize, adding a period to the first argument and supplying the
4286 % common last two arguments.  Also subtract one from the initial value in
4287 % \itemno, since @item increments \itemno.
4288 %
4289 \def\startenumeration#1{%
4290   \advance\itemno by -1
4291   \doitemize{#1.}\flushcr
4292 }
4293
4294
4295 % @multitable macros
4296
4297 % Macros used to set up halign preamble:
4298 %
4299 \let\endsetuptable\relax
4300 \def\xendsetuptable{\endsetuptable}
4301 \let\columnfractions\relax
4302 \def\xcolumnfractions{\columnfractions}
4303 \newif\ifsetpercent
4304
4305 % #1 is the @columnfraction, usually a decimal number like .5, but might
4306 % be just 1.  We just use it, whatever it is.
4307 %
4308 \def\pickupwholefraction#1 {%
4309   \global\advance\colcount by 1
4310   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
4311   \setuptable
4312 }
4313
4314 \newcount\colcount
4315 \def\setuptable#1{%
4316   \def\firstarg{#1}%
4317   \ifx\firstarg\xendsetuptable
4318     \let\go = \relax
4319   \else
4320     \ifx\firstarg\xcolumnfractions
4321       \global\setpercenttrue
4322     \else
4323       \ifsetpercent
4324          \let\go\pickupwholefraction
4325       \else
4326          \global\advance\colcount by 1
4327          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
4328                    % separator; typically that is always in the input, anyway.
4329          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
4330       \fi
4331     \fi
4332     \ifx\go\pickupwholefraction
4333       % Put the argument back for the \pickupwholefraction call, so
4334       % we'll always have a period there to be parsed.
4335       \def\go{\pickupwholefraction#1}%
4336     \else
4337       \let\go = \setuptable
4338     \fi%
4339   \fi
4340   \go
4341 }
4342
4343 % @headitem starts a heading row, which we typeset in bold.  Assignments
4344 % have to be global since we are inside the implicit group of an
4345 % alignment entry.  \everycr below resets \everytab so we don't have to
4346 % undo it ourselves.
4347 \def\headitemfont{\b}% for people to use in the template row; not changeable
4348 \def\headitem{%
4349   \checkenv\multitable
4350   \crcr
4351   \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
4352   \global\everytab={\bf}% can't use \headitemfont since the parsing differs
4353   \the\everytab % for the first item
4354 }%
4355 %
4356 % default for tables with no headings.
4357 \let\headitemcrhook=\relax
4358 %
4359 \def\tab{\checkenv\multitable &\the\everytab}%
4360
4361 \newtoks\everytab  % insert after every tab.
4362 %
4363 \envdef\multitable{%
4364   \vskip\parskip
4365   \startsavinginserts
4366   %
4367   % @item within a multitable starts a normal row.
4368   % We use \def instead of \let so that if one of the multitable entries
4369   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4370   % \endtemplate) expanding \doitemize.
4371   \def\item{\crcr}%
4372   %
4373   \tolerance=9500
4374   \hbadness=9500
4375   \parskip=0pt
4376   \parindent=6pt
4377   \overfullrule=0pt
4378   \global\colcount=0
4379   %
4380   \everycr = {%
4381     \noalign{%
4382       \global\everytab={}% Reset from possible headitem.
4383       \global\colcount=0 % Reset the column counter.
4384       %
4385       % Check for saved footnotes, etc.:
4386       \checkinserts
4387       %
4388       % Perhaps a \nobreak, then reset:
4389       \headitemcrhook
4390       \global\let\headitemcrhook=\relax
4391     }%
4392   }%
4393   %
4394   \parsearg\domultitable
4395 }
4396 \def\domultitable#1{%
4397   % To parse everything between @multitable and @item:
4398   \setuptable#1 \endsetuptable
4399   %
4400   % This preamble sets up a generic column definition, which will
4401   % be used as many times as user calls for columns.
4402   % \vtop will set a single line and will also let text wrap and
4403   % continue for many paragraphs if desired.
4404   \halign\bgroup &%
4405     \global\advance\colcount by 1
4406     \strut
4407     \vtop{%
4408       \advance\hsize by -1\leftskip
4409       % Find the correct column width
4410       \hsize=\expandafter\csname col\the\colcount\endcsname
4411       %
4412       \advance\rightskip by -1\rightskip % Zero leaving only any stretch
4413       \ifnum\colcount=1
4414         \advance\hsize by\leftskip % Add indent of surrounding text
4415       \else
4416         % In order to keep entries from bumping into each other.
4417         \leftskip=12pt
4418         \ifsetpercent \else
4419           % If a template has been used
4420           \advance\hsize by \leftskip
4421         \fi
4422       \fi
4423       \noindent\ignorespaces##\unskip\strut
4424     }\cr
4425 }
4426 \def\Emultitable{%
4427   \crcr
4428   \egroup % end the \halign
4429   \global\setpercentfalse
4430 }
4431
4432
4433 \message{conditionals,}
4434
4435 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4436 % @ifnotxml always succeed.  They currently do nothing; we don't
4437 % attempt to check whether the conditionals are properly nested.  But we
4438 % have to remember that they are conditionals, so that @end doesn't
4439 % attempt to close an environment group.
4440 %
4441 \def\makecond#1{%
4442   \expandafter\let\csname #1\endcsname = \relax
4443   \expandafter\let\csname iscond.#1\endcsname = 1
4444 }
4445 \makecond{iftex}
4446 \makecond{ifnotdocbook}
4447 \makecond{ifnothtml}
4448 \makecond{ifnotinfo}
4449 \makecond{ifnotplaintext}
4450 \makecond{ifnotxml}
4451
4452 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4453 %
4454 \def\direntry{\doignore{direntry}}
4455 \def\documentdescription{\doignore{documentdescription}}
4456 \def\docbook{\doignore{docbook}}
4457 \def\html{\doignore{html}}
4458 \def\ifdocbook{\doignore{ifdocbook}}
4459 \def\ifhtml{\doignore{ifhtml}}
4460 \def\ifinfo{\doignore{ifinfo}}
4461 \def\ifnottex{\doignore{ifnottex}}
4462 \def\ifplaintext{\doignore{ifplaintext}}
4463 \def\ifxml{\doignore{ifxml}}
4464 \def\ignore{\doignore{ignore}}
4465 \def\menu{\doignore{menu}}
4466 \def\xml{\doignore{xml}}
4467
4468 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4469 %
4470 % A count to remember the depth of nesting.
4471 \newcount\doignorecount
4472
4473 \def\doignore#1{\begingroup
4474   % Scan in ``verbatim'' mode:
4475   \obeylines
4476   \catcode`\@ = \other
4477   \catcode`\{ = \other
4478   \catcode`\} = \other
4479   %
4480   % Make sure that spaces turn into tokens that match what \doignoretext wants.
4481   \spaceisspace
4482   %
4483   % Count number of #1's that we've seen.
4484   \doignorecount = 0
4485   %
4486   % Swallow text until we reach the matching `@end #1'.
4487   \dodoignore{#1}%
4488 }
4489
4490 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4491   \obeylines %
4492   %
4493   \gdef\dodoignore#1{%
4494     % #1 contains the command name as a string, e.g., `ifinfo'.
4495     %
4496     % Define a command to find the next `@end #1'.
4497     \long\def\doignoretext##1^^M@end #1{%
4498       \doignoretextyyy##1^^M@#1\_STOP_}%
4499     %
4500     % And this command to find another #1 command, at the beginning of a
4501     % line.  (Otherwise, we would consider a line `@c @ifset', for
4502     % example, to count as an @ifset for nesting.)
4503     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4504     %
4505     % And now expand that command.
4506     \doignoretext ^^M%
4507   }%
4508 }
4509
4510 \def\doignoreyyy#1{%
4511   \def\temp{#1}%
4512   \ifx\temp\empty                       % Nothing found.
4513     \let\next\doignoretextzzz
4514   \else                                 % Found a nested condition, ...
4515     \advance\doignorecount by 1
4516     \let\next\doignoretextyyy           % ..., look for another.
4517     % If we're here, #1 ends with ^^M\ifinfo (for example).
4518   \fi
4519   \next #1% the token \_STOP_ is present just after this macro.
4520 }
4521
4522 % We have to swallow the remaining "\_STOP_".
4523 %
4524 \def\doignoretextzzz#1{%
4525   \ifnum\doignorecount = 0      % We have just found the outermost @end.
4526     \let\next\enddoignore
4527   \else                         % Still inside a nested condition.
4528     \advance\doignorecount by -1
4529     \let\next\doignoretext      % Look for the next @end.
4530   \fi
4531   \next
4532 }
4533
4534 % Finish off ignored text.
4535 { \obeylines%
4536   % Ignore anything after the last `@end #1'; this matters in verbatim
4537   % environments, where otherwise the newline after an ignored conditional
4538   % would result in a blank line in the output.
4539   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4540 }
4541
4542
4543 % @set VAR sets the variable VAR to an empty value.
4544 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4545 %
4546 % Since we want to separate VAR from REST-OF-LINE (which might be
4547 % empty), we can't just use \parsearg; we have to insert a space of our
4548 % own to delimit the rest of the line, and then take it out again if we
4549 % didn't need it.
4550 % We rely on the fact that \parsearg sets \catcode`\ =10.
4551 %
4552 \parseargdef\set{\setyyy#1 \endsetyyy}
4553 \def\setyyy#1 #2\endsetyyy{%
4554   {%
4555     \makevalueexpandable
4556     \def\temp{#2}%
4557     \edef\next{\gdef\makecsname{SET#1}}%
4558     \ifx\temp\empty
4559       \next{}%
4560     \else
4561       \setzzz#2\endsetzzz
4562     \fi
4563   }%
4564 }
4565 % Remove the trailing space \setxxx inserted.
4566 \def\setzzz#1 \endsetzzz{\next{#1}}
4567
4568 % @clear VAR clears (i.e., unsets) the variable VAR.
4569 %
4570 \parseargdef\clear{%
4571   {%
4572     \makevalueexpandable
4573     \global\expandafter\let\csname SET#1\endcsname=\relax
4574   }%
4575 }
4576
4577 % @value{foo} gets the text saved in variable foo.
4578 \def\value{\begingroup\makevalueexpandable\valuexxx}
4579 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4580 {
4581   \catcode`\-=\active \catcode`\_=\active
4582   %
4583   \gdef\makevalueexpandable{%
4584     \let\value = \expandablevalue
4585     % We don't want these characters active, ...
4586     \catcode`\-=\other \catcode`\_=\other
4587     % ..., but we might end up with active ones in the argument if
4588     % we're called from @code, as @code{@value{foo-bar_}}, though.
4589     % So \let them to their normal equivalents.
4590     \let-\normaldash \let_\normalunderscore
4591   }
4592 }
4593
4594 \def\expandablevalue#1{%
4595   \expandafter\ifx\csname SET#1\endcsname\relax
4596     {[No value for ``#1'']}%
4597     \message{Variable `#1', used in @value, is not set.}%
4598   \else
4599     \csname SET#1\endcsname
4600   \fi
4601 }
4602
4603 % Like \expandablevalue, but completely expandable (the \message in the
4604 % definition above operates at the execution level of TeX).  Used when
4605 % writing to auxiliary files, due to the expansion that \write does.
4606 % If flag is undefined, pass through an unexpanded @value command: maybe it
4607 % will be set by the time it is read back in.
4608 %
4609 % NB flag names containing - or _ may not work here.
4610 \def\dummyvalue#1{%
4611   \expandafter\ifx\csname SET#1\endcsname\relax
4612     \string\value{#1}%
4613   \else
4614     \csname SET#1\endcsname
4615   \fi
4616 }
4617
4618 % Used for @value's in index entries to form the sort key: expand the @value
4619 % if possible, otherwise sort late.
4620 \def\indexnofontsvalue#1{%
4621   \expandafter\ifx\csname SET#1\endcsname\relax
4622     ZZZZZZZ%
4623   \else
4624     \csname SET#1\endcsname
4625   \fi
4626 }
4627
4628 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4629 % with @set.
4630 %
4631 % To get the special treatment we need for `@end ifset,' we call
4632 % \makecond and then redefine.
4633 %
4634 \makecond{ifset}
4635 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4636 \def\doifset#1#2{%
4637   {%
4638     \makevalueexpandable
4639     \let\next=\empty
4640     \expandafter\ifx\csname SET#2\endcsname\relax
4641       #1% If not set, redefine \next.
4642     \fi
4643     \expandafter
4644   }\next
4645 }
4646 \def\ifsetfail{\doignore{ifset}}
4647
4648 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4649 % defined with @set, or has been undefined with @clear.
4650 %
4651 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4652 % above code: if the variable is not set, do nothing, if it is set,
4653 % then redefine \next to \ifclearfail.
4654 %
4655 \makecond{ifclear}
4656 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4657 \def\ifclearfail{\doignore{ifclear}}
4658
4659 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4660 % without the @) is in fact defined.  We can only feasibly check at the
4661 % TeX level, so something like `mathcode' is going to considered
4662 % defined even though it is not a Texinfo command.
4663 %
4664 \makecond{ifcommanddefined}
4665 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4666 %
4667 \def\doifcmddefined#1#2{{%
4668     \makevalueexpandable
4669     \let\next=\empty
4670     \expandafter\ifx\csname #2\endcsname\relax
4671       #1% If not defined, \let\next as above.
4672     \fi
4673     \expandafter
4674   }\next
4675 }
4676 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4677
4678 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4679 \makecond{ifcommandnotdefined}
4680 \def\ifcommandnotdefined{%
4681   \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4682 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4683
4684 % Set the `txicommandconditionals' variable, so documents have a way to
4685 % test if the @ifcommand...defined conditionals are available.
4686 \set txicommandconditionals
4687
4688 % @dircategory CATEGORY  -- specify a category of the dir file
4689 % which this file should belong to.  Ignore this in TeX.
4690 \let\dircategory=\comment
4691
4692 % @defininfoenclose.
4693 \let\definfoenclose=\comment
4694
4695
4696 \message{indexing,}
4697 % Index generation facilities
4698
4699 % Define \newwrite to be identical to plain tex's \newwrite
4700 % except not \outer, so it can be used within macros and \if's.
4701 \edef\newwrite{\makecsname{ptexnewwrite}}
4702
4703 % \newindex {foo} defines an index named IX.
4704 % It automatically defines \IXindex such that
4705 % \IXindex ...rest of line... puts an entry in the index IX.
4706 % It also defines \IXindfile to be the number of the output channel for
4707 % the file that accumulates this index.  The file's extension is IX.
4708 % The name of an index should be no more than 2 characters long
4709 % for the sake of vms.
4710 %
4711 \def\newindex#1{%
4712   \expandafter\chardef\csname#1indfile\endcsname=0
4713   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
4714     \noexpand\doindex{#1}}
4715 }
4716
4717 % @defindex foo  ==  \newindex{foo}
4718 %
4719 \def\defindex{\parsearg\newindex}
4720
4721 % Define @defcodeindex, like @defindex except put all entries in @code.
4722 %
4723 \def\defcodeindex{\parsearg\newcodeindex}
4724 %
4725 \def\newcodeindex#1{%
4726   \expandafter\chardef\csname#1indfile\endcsname=0
4727   \expandafter\xdef\csname#1index\endcsname{%
4728     \noexpand\docodeindex{#1}}%
4729 }
4730
4731 % The default indices:
4732 \newindex{cp}%      concepts,
4733 \newcodeindex{fn}%  functions,
4734 \newcodeindex{vr}%  variables,
4735 \newcodeindex{tp}%  types,
4736 \newcodeindex{ky}%  keys
4737 \newcodeindex{pg}%  and programs.
4738
4739
4740 % @synindex foo bar    makes index foo feed into index bar.
4741 % Do this instead of @defindex foo if you don't want it as a separate index.
4742 %
4743 % @syncodeindex foo bar   similar, but put all entries made for index foo
4744 % inside @code.
4745 %
4746 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4747 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4748
4749 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4750 % #3 the target index (bar).
4751 \def\dosynindex#1#2#3{%
4752   \requireopenindexfile{#3}%
4753   % redefine \fooindfile:
4754   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4755   \expandafter\let\csname#2indfile\endcsname=\temp
4756   % redefine \fooindex:
4757   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4758 }
4759
4760 % Define \doindex, the driver for all index macros.
4761 % Argument #1 is generated by the calling \fooindex macro,
4762 % and it is the two-letter name of the index.
4763
4764 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4765 \def\doindexxxx #1{\doind{\indexname}{#1}}
4766
4767 % like the previous two, but they put @code around the argument.
4768 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4769 \def\docodeindexxxx #1{\docind{\indexname}{#1}}
4770
4771
4772 % Used for the aux, toc and index files to prevent expansion of Texinfo
4773 % commands.
4774 %
4775 \def\atdummies{%
4776   \definedummyletter\@%
4777   \definedummyletter\ %
4778   \definedummyletter\{%
4779   \definedummyletter\}%
4780   \definedummyletter\&%
4781   %
4782   % Do the redefinitions.
4783   \definedummies
4784   \otherbackslash
4785 }
4786
4787 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4788 % preventing its expansion.  This is used only for control words,
4789 % not control letters, because the \space would be incorrect for
4790 % control characters, but is needed to separate the control word
4791 % from whatever follows.
4792 %
4793 % These can be used both for control words that take an argument and
4794 % those that do not.  If it is followed by {arg} in the input, then
4795 % that will dutifully get written to the index (or wherever).
4796 %
4797 % For control letters, we have \definedummyletter, which omits the
4798 % space.
4799 %
4800 \def\definedummyword  #1{\def#1{\string#1\space}}%
4801 \def\definedummyletter#1{\def#1{\string#1}}%
4802 \let\definedummyaccent\definedummyletter
4803
4804 % Called from \atdummies to prevent the expansion of commands.
4805 %
4806 \def\definedummies{%
4807   %
4808   \let\commondummyword\definedummyword
4809   \let\commondummyletter\definedummyletter
4810   \let\commondummyaccent\definedummyaccent
4811   \commondummiesnofonts
4812   %
4813   \definedummyletter\_%
4814   \definedummyletter\-%
4815   %
4816   % Non-English letters.
4817   \definedummyword\AA
4818   \definedummyword\AE
4819   \definedummyword\DH
4820   \definedummyword\L
4821   \definedummyword\O
4822   \definedummyword\OE
4823   \definedummyword\TH
4824   \definedummyword\aa
4825   \definedummyword\ae
4826   \definedummyword\dh
4827   \definedummyword\exclamdown
4828   \definedummyword\l
4829   \definedummyword\o
4830   \definedummyword\oe
4831   \definedummyword\ordf
4832   \definedummyword\ordm
4833   \definedummyword\questiondown
4834   \definedummyword\ss
4835   \definedummyword\th
4836   %
4837   % Although these internal commands shouldn't show up, sometimes they do.
4838   \definedummyword\bf
4839   \definedummyword\gtr
4840   \definedummyword\hat
4841   \definedummyword\less
4842   \definedummyword\sf
4843   \definedummyword\sl
4844   \definedummyword\tclose
4845   \definedummyword\tt
4846   %
4847   \definedummyword\LaTeX
4848   \definedummyword\TeX
4849   %
4850   % Assorted special characters.
4851   \definedummyword\ampchar
4852   \definedummyword\atchar
4853   \definedummyword\arrow
4854   \definedummyword\backslashchar
4855   \definedummyword\bullet
4856   \definedummyword\comma
4857   \definedummyword\copyright
4858   \definedummyword\registeredsymbol
4859   \definedummyword\dots
4860   \definedummyword\enddots
4861   \definedummyword\entrybreak
4862   \definedummyword\equiv
4863   \definedummyword\error
4864   \definedummyword\euro
4865   \definedummyword\expansion
4866   \definedummyword\geq
4867   \definedummyword\guillemetleft
4868   \definedummyword\guillemetright
4869   \definedummyword\guilsinglleft
4870   \definedummyword\guilsinglright
4871   \definedummyword\lbracechar
4872   \definedummyword\leq
4873   \definedummyword\mathopsup
4874   \definedummyword\minus
4875   \definedummyword\ogonek
4876   \definedummyword\pounds
4877   \definedummyword\point
4878   \definedummyword\print
4879   \definedummyword\quotedblbase
4880   \definedummyword\quotedblleft
4881   \definedummyword\quotedblright
4882   \definedummyword\quoteleft
4883   \definedummyword\quoteright
4884   \definedummyword\quotesinglbase
4885   \definedummyword\rbracechar
4886   \definedummyword\result
4887   \definedummyword\sub
4888   \definedummyword\sup
4889   \definedummyword\textdegree
4890   %
4891   \definedummyword\subentry
4892   %
4893   % We want to disable all macros so that they are not expanded by \write.
4894   \macrolist
4895   \let\value\dummyvalue
4896   %
4897   \normalturnoffactive
4898 }
4899
4900 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
4901 % Define \commondummyletter, \commondummyaccent and \commondummyword before
4902 % using.  Used for accents, font commands, and various control letters.
4903 %
4904 \def\commondummiesnofonts{%
4905   % Control letters and accents.
4906   \commondummyletter\!%
4907   \commondummyaccent\"%
4908   \commondummyaccent\'%
4909   \commondummyletter\*%
4910   \commondummyaccent\,%
4911   \commondummyletter\.%
4912   \commondummyletter\/%
4913   \commondummyletter\:%
4914   \commondummyaccent\=%
4915   \commondummyletter\?%
4916   \commondummyaccent\^%
4917   \commondummyaccent\`%
4918   \commondummyaccent\~%
4919   \commondummyword\u
4920   \commondummyword\v
4921   \commondummyword\H
4922   \commondummyword\dotaccent
4923   \commondummyword\ogonek
4924   \commondummyword\ringaccent
4925   \commondummyword\tieaccent
4926   \commondummyword\ubaraccent
4927   \commondummyword\udotaccent
4928   \commondummyword\dotless
4929   %
4930   % Texinfo font commands.
4931   \commondummyword\b
4932   \commondummyword\i
4933   \commondummyword\r
4934   \commondummyword\sansserif
4935   \commondummyword\sc
4936   \commondummyword\slanted
4937   \commondummyword\t
4938   %
4939   % Commands that take arguments.
4940   \commondummyword\abbr
4941   \commondummyword\acronym
4942   \commondummyword\anchor
4943   \commondummyword\cite
4944   \commondummyword\code
4945   \commondummyword\command
4946   \commondummyword\dfn
4947   \commondummyword\dmn
4948   \commondummyword\email
4949   \commondummyword\emph
4950   \commondummyword\env
4951   \commondummyword\file
4952   \commondummyword\image
4953   \commondummyword\indicateurl
4954   \commondummyword\inforef
4955   \commondummyword\kbd
4956   \commondummyword\key
4957   \commondummyword\math
4958   \commondummyword\option
4959   \commondummyword\pxref
4960   \commondummyword\ref
4961   \commondummyword\samp
4962   \commondummyword\strong
4963   \commondummyword\tie
4964   \commondummyword\U
4965   \commondummyword\uref
4966   \commondummyword\url
4967   \commondummyword\var
4968   \commondummyword\verb
4969   \commondummyword\w
4970   \commondummyword\xref
4971 }
4972
4973 \let\indexlbrace\relax
4974 \let\indexrbrace\relax
4975 \let\indexatchar\relax
4976 \let\indexbackslash\relax
4977
4978 {\catcode`\@=0
4979 \catcode`\\=13
4980   @gdef@backslashdisappear{@def\{}}
4981 }
4982
4983 {
4984 \catcode`\<=13
4985 \catcode`\-=13
4986 \catcode`\`=13
4987   \gdef\indexnonalnumdisappear{%
4988     \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
4989       % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
4990       % (Introduced for FSFS 2nd ed.)
4991       \let`=\empty
4992     \fi
4993     %
4994     \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
4995       \backslashdisappear
4996     \fi
4997     %
4998     \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
4999       \def-{}%
5000     \fi
5001     \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
5002       \def<{}%
5003     \fi
5004     \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
5005       \def\@{}%
5006     \fi
5007   }
5008
5009   \gdef\indexnonalnumreappear{%
5010     \let-\normaldash
5011     \let<\normalless
5012   }
5013 }
5014
5015
5016 % \indexnofonts is used when outputting the strings to sort the index
5017 % by, and when constructing control sequence names.  It eliminates all
5018 % control sequences and just writes whatever the best ASCII sort string
5019 % would be for a given command (usually its argument).
5020 %
5021 \def\indexnofonts{%
5022   % Accent commands should become @asis.
5023   \def\commondummyaccent##1{\let##1\asis}%
5024   % We can just ignore other control letters.
5025   \def\commondummyletter##1{\let##1\empty}%
5026   % All control words become @asis by default; overrides below.
5027   \let\commondummyword\commondummyaccent
5028   \commondummiesnofonts
5029   %
5030   % Don't no-op \tt, since it isn't a user-level command
5031   % and is used in the definitions of the active chars like <, >, |, etc.
5032   % Likewise with the other plain tex font commands.
5033   %\let\tt=\asis
5034   %
5035   \def\ { }%
5036   \def\@{@}%
5037   \def\_{\normalunderscore}%
5038   \def\-{}% @- shouldn't affect sorting
5039   %
5040   \uccode`\1=`\{ \uppercase{\def\{{1}}%
5041   \uccode`\1=`\} \uppercase{\def\}{1}}%
5042   \let\lbracechar\{%
5043   \let\rbracechar\}%
5044   %
5045   % Non-English letters.
5046   \def\AA{AA}%
5047   \def\AE{AE}%
5048   \def\DH{DZZ}%
5049   \def\L{L}%
5050   \def\OE{OE}%
5051   \def\O{O}%
5052   \def\TH{TH}%
5053   \def\aa{aa}%
5054   \def\ae{ae}%
5055   \def\dh{dzz}%
5056   \def\exclamdown{!}%
5057   \def\l{l}%
5058   \def\oe{oe}%
5059   \def\ordf{a}%
5060   \def\ordm{o}%
5061   \def\o{o}%
5062   \def\questiondown{?}%
5063   \def\ss{ss}%
5064   \def\th{th}%
5065   %
5066   \let\do\indexnofontsdef
5067   %
5068   \do\LaTeX{LaTeX}%
5069   \do\TeX{TeX}%
5070   %
5071   % Assorted special characters.
5072   \do\atchar{@}%
5073   \do\arrow{->}%
5074   \do\bullet{bullet}%
5075   \do\comma{,}%
5076   \do\copyright{copyright}%
5077   \do\dots{...}%
5078   \do\enddots{...}%
5079   \do\equiv{==}%
5080   \do\error{error}%
5081   \do\euro{euro}%
5082   \do\expansion{==>}%
5083   \do\geq{>=}%
5084   \do\guillemetleft{<<}%
5085   \do\guillemetright{>>}%
5086   \do\guilsinglleft{<}%
5087   \do\guilsinglright{>}%
5088   \do\leq{<=}%
5089   \do\lbracechar{\{}%
5090   \do\minus{-}%
5091   \do\point{.}%
5092   \do\pounds{pounds}%
5093   \do\print{-|}%
5094   \do\quotedblbase{"}%
5095   \do\quotedblleft{"}%
5096   \do\quotedblright{"}%
5097   \do\quoteleft{`}%
5098   \do\quoteright{'}%
5099   \do\quotesinglbase{,}%
5100   \do\rbracechar{\}}%
5101   \do\registeredsymbol{R}%
5102   \do\result{=>}%
5103   \do\textdegree{o}%
5104   %
5105   % We need to get rid of all macros, leaving only the arguments (if present).
5106   % Of course this is not nearly correct, but it is the best we can do for now.
5107   % makeinfo does not expand macros in the argument to @deffn, which ends up
5108   % writing an index entry, and texindex isn't prepared for an index sort entry
5109   % that starts with \.
5110   %
5111   % Since macro invocations are followed by braces, we can just redefine them
5112   % to take a single TeX argument.  The case of a macro invocation that
5113   % goes to end-of-line is not handled.
5114   %
5115   \macrolist
5116   \let\value\indexnofontsvalue
5117 }
5118
5119 % Give the control sequence a definition that removes the {} that follows
5120 % its use, e.g. @AA{} -> AA
5121 \def\indexnofontsdef#1#2{\def#1##1{#2}}%
5122
5123
5124
5125
5126 % #1 is the index name, #2 is the entry text.
5127 \def\doind#1#2{%
5128   \iflinks
5129   {%
5130     %
5131     \requireopenindexfile{#1}%
5132     \edef\writeto{\csname#1indfile\endcsname}%
5133     %
5134     \def\indextext{#2}%
5135     \safewhatsit\doindwrite
5136   }%
5137   \fi
5138 }
5139
5140 % Same as \doind, but for code indices
5141 \def\docind#1#2{%
5142   \iflinks
5143   {%
5144     %
5145     \requireopenindexfile{#1}%
5146     \edef\writeto{\csname#1indfile\endcsname}%
5147     %
5148     \def\indextext{#2}%
5149     \safewhatsit\docindwrite
5150   }%
5151   \fi
5152 }
5153
5154 % Check if an index file has been opened, and if not, open it.
5155 \def\requireopenindexfile#1{%
5156 \ifnum\csname #1indfile\endcsname=0
5157   \expandafter\newwrite \csname#1indfile\endcsname
5158   \edef\suffix{#1}%
5159   % A .fls suffix would conflict with the file extension for the output
5160   % of -recorder, so use .f1s instead.
5161   \ifx\suffix\indexisfl\def\suffix{f1}\fi
5162   % Open the file
5163   \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
5164   % Using \immediate above here prevents an object entering into the current
5165   % box, which could confound checks such as those in \safewhatsit for
5166   % preceding skips.
5167   \typeout{Writing index file \jobname.\suffix}%
5168 \fi}
5169 \def\indexisfl{fl}
5170
5171 % Definition for writing index entry sort key.
5172 {
5173 \catcode`\-=13
5174 \gdef\indexwritesortas{%
5175   \begingroup
5176   \indexnonalnumreappear
5177   \indexwritesortasxxx}
5178 \gdef\indexwritesortasxxx#1{%
5179   \xdef\indexsortkey{#1}\endgroup}
5180 }
5181
5182 \def\indexwriteseealso#1{
5183   \gdef\pagenumbertext{\string\seealso{#1}}%
5184 }
5185 \def\indexwriteseeentry#1{
5186   \gdef\pagenumbertext{\string\seeentry{#1}}%
5187 }
5188
5189 % The default definitions
5190 \def\sortas#1{}%
5191 \def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only
5192 \def\putwordSeeAlso{See also}
5193 \def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only
5194
5195
5196 % Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
5197 %   * Set \bracedtext to "{aaa}{bbb}"
5198 %   * Set \fullindexsortkey to "aaa @subentry ZZZ"
5199 %   * If @seealso occurs, set \pagenumbertext
5200 %
5201 \def\splitindexentry#1{%
5202   \gdef\fullindexsortkey{}%
5203   \xdef\bracedtext{}%
5204   \def\sep{}%
5205   \def\seealso##1{}%
5206   \def\seeentry##1{}%
5207   \expandafter\doindexsegment#1\subentry\finish\subentry
5208 }
5209
5210 % append the results from the next segment
5211 \def\doindexsegment#1\subentry{%
5212   \def\segment{#1}%
5213   \ifx\segment\isfinish
5214   \else
5215     %
5216     % Fully expand the segment, throwing away any @sortas directives, and
5217     % trim spaces.
5218     \edef\trimmed{\segment}%
5219     \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5220     \ifincodeindex
5221       \edef\trimmed{\noexpand\code{\trimmed}}%
5222     \fi
5223     %
5224     \xdef\bracedtext{\bracedtext{\trimmed}}%
5225     %
5226     % Get the string to sort by.  Process the segment with all
5227     % font commands turned off.
5228     \bgroup
5229       \let\sortas\indexwritesortas
5230       \let\seealso\indexwriteseealso
5231       \let\seeentry\indexwriteseeentry
5232       \indexnofonts
5233       % The braces around the commands are recognized by texindex.
5234       \def\lbracechar{{\string\indexlbrace}}%
5235       \def\rbracechar{{\string\indexrbrace}}%
5236       \let\{=\lbracechar
5237       \let\}=\rbracechar
5238       \def\@{{\string\indexatchar}}%
5239       \def\atchar##1{\@}%
5240       \def\backslashchar{{\string\indexbackslash}}%
5241       \uccode`\~=`\\ \uppercase{\let~\backslashchar}%
5242       %
5243       \let\indexsortkey\empty
5244       \global\let\pagenumbertext\empty
5245       % Execute the segment and throw away the typeset output.  This executes
5246       % any @sortas or @seealso commands in this segment.
5247       \setbox\dummybox = \hbox{\segment}%
5248       \ifx\indexsortkey\empty{%
5249         \indexnonalnumdisappear
5250         \xdef\trimmed{\segment}%
5251         \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5252         \xdef\indexsortkey{\trimmed}%
5253         \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
5254       }\fi
5255       %
5256       % Append to \fullindexsortkey.
5257       \edef\tmp{\gdef\noexpand\fullindexsortkey{%
5258                   \fullindexsortkey\sep\indexsortkey}}%
5259       \tmp
5260     \egroup
5261     \def\sep{\subentry}%
5262     %
5263     \expandafter\doindexsegment
5264   \fi
5265 }
5266 \def\isfinish{\finish}%
5267 \newbox\dummybox % used above
5268
5269 \let\subentry\relax
5270
5271 % Use \ instead of @ in index files.  To support old texi2dvi and texindex.
5272 % This works without changing the escape character used in the toc or aux
5273 % files because the index entries are fully expanded here, and \string uses
5274 % the current value of \escapechar.
5275 \def\escapeisbackslash{\escapechar=`\\}
5276
5277 % Use \ in index files by default.  texi2dvi didn't support @ as the escape
5278 % character (as it checked for "\entry" in the files, and not "@entry").  When
5279 % the new version of texi2dvi has had a chance to become more prevalent, then
5280 % the escape character can change back to @ again.  This should be an easy
5281 % change to make now because both @ and \ are only used as escape characters in
5282 % index files, never standing for themselves.
5283 %
5284 \set txiindexescapeisbackslash
5285
5286 % Write the entry in \indextext to the index file.
5287 %
5288
5289 \newif\ifincodeindex
5290 \def\doindwrite{\incodeindexfalse\doindwritex}
5291 \def\docindwrite{\incodeindextrue\doindwritex}
5292
5293 \def\doindwritex{%
5294   \maybemarginindex
5295   %
5296   \atdummies
5297   %
5298   \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax\else
5299     \escapeisbackslash
5300   \fi
5301   %
5302   % For texindex which always views { and } as separators.
5303   \def\{{\lbracechar{}}%
5304   \def\}{\rbracechar{}}%
5305   \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}%
5306   %
5307   % Split the entry into primary entry and any subentries, and get the index
5308   % sort key.
5309   \splitindexentry\indextext
5310   %
5311   % Set up the complete index entry, with both the sort key and
5312   % the original text, including any font commands.  We write
5313   % three arguments to \entry to the .?? file (four in the
5314   % subentry case), texindex reduces to two when writing the .??s
5315   % sorted result.
5316   %
5317   \edef\temp{%
5318     \write\writeto{%
5319       \string\entry{\fullindexsortkey}%
5320         {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}%
5321         \bracedtext}%
5322   }%
5323   \temp
5324 }
5325
5326 % Put the index entry in the margin if desired (undocumented).
5327 \def\maybemarginindex{%
5328   \ifx\SETmarginindex\relax\else
5329     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}%
5330   \fi
5331 }
5332 \let\SETmarginindex=\relax
5333
5334
5335 % Take care of unwanted page breaks/skips around a whatsit:
5336 %
5337 % If a skip is the last thing on the list now, preserve it
5338 % by backing up by \lastskip, doing the \write, then inserting
5339 % the skip again.  Otherwise, the whatsit generated by the
5340 % \write or \pdfdest will make \lastskip zero.  The result is that
5341 % sequences like this:
5342 % @end defun
5343 % @tindex whatever
5344 % @defun ...
5345 % will have extra space inserted, because the \medbreak in the
5346 % start of the @defun won't see the skip inserted by the @end of
5347 % the previous defun.
5348 %
5349 % But don't do any of this if we're not in vertical mode.  We
5350 % don't want to do a \vskip and prematurely end a paragraph.
5351 %
5352 % Avoid page breaks due to these extra skips, too.
5353 %
5354 % But wait, there is a catch there:
5355 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
5356 % sufficient for this purpose, as it ignores stretch and shrink parts
5357 % of the skip.  The only way seems to be to check the textual
5358 % representation of the skip.
5359 %
5360 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5361 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5362 %
5363 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
5364 %
5365 \newskip\whatsitskip
5366 \newcount\whatsitpenalty
5367 %
5368 % ..., ready, GO:
5369 %
5370 \def\safewhatsit#1{\ifhmode
5371   #1%
5372  \else
5373   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5374   \whatsitskip = \lastskip
5375   \edef\lastskipmacro{\the\lastskip}%
5376   \whatsitpenalty = \lastpenalty
5377   %
5378   % If \lastskip is nonzero, that means the last item was a
5379   % skip.  And since a skip is discardable, that means this
5380   % -\whatsitskip glue we're inserting is preceded by a
5381   % non-discardable item, therefore it is not a potential
5382   % breakpoint, therefore no \nobreak needed.
5383   \ifx\lastskipmacro\zeroskipmacro
5384   \else
5385     \vskip-\whatsitskip
5386   \fi
5387   %
5388   #1%
5389   %
5390   \ifx\lastskipmacro\zeroskipmacro
5391     % If \lastskip was zero, perhaps the last item was a penalty, and
5392     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
5393     % to re-insert the same penalty (values >10000 are used for various
5394     % signals); since we just inserted a non-discardable item, any
5395     % following glue (such as a \parskip) would be a breakpoint.  For example:
5396     %   @deffn deffn-whatever
5397     %   @vindex index-whatever
5398     %   Description.
5399     % would allow a break between the index-whatever whatsit
5400     % and the "Description." paragraph.
5401     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
5402   \else
5403     % On the other hand, if we had a nonzero \lastskip,
5404     % this make-up glue would be preceded by a non-discardable item
5405     % (the whatsit from the \write), so we must insert a \nobreak.
5406     \nobreak\vskip\whatsitskip
5407   \fi
5408 \fi}
5409
5410 % The index entry written in the file actually looks like
5411 %  \entry {sortstring}{page}{topic}
5412 % or
5413 %  \entry {sortstring}{page}{topic}{subtopic}
5414 % The texindex program reads in these files and writes files
5415 % containing these kinds of lines:
5416 %  \initial {c}
5417 %     before the first topic whose initial is c
5418 %  \entry {topic}{pagelist}
5419 %     for a topic that is used without subtopics
5420 %  \primary {topic}
5421 %  \entry {topic}{}
5422 %     for the beginning of a topic that is used with subtopics
5423 %  \secondary {subtopic}{pagelist}
5424 %     for each subtopic.
5425 %  \secondary {subtopic}{}
5426 %     for a subtopic with sub-subtopics
5427 %  \tertiary {subtopic}{subsubtopic}{pagelist}
5428 %     for each sub-subtopic.
5429
5430 % Define the user-accessible indexing commands
5431 % @findex, @vindex, @kindex, @cindex.
5432
5433 \def\findex {\fnindex}
5434 \def\kindex {\kyindex}
5435 \def\cindex {\cpindex}
5436 \def\vindex {\vrindex}
5437 \def\tindex {\tpindex}
5438 \def\pindex {\pgindex}
5439
5440 % Define the macros used in formatting output of the sorted index material.
5441
5442 % @printindex causes a particular index (the ??s file) to get printed.
5443 % It does not print any chapter heading (usually an @unnumbered).
5444 %
5445 \parseargdef\printindex{\begingroup
5446   \dobreak \chapheadingskip{10000}%
5447   %
5448   \smallfonts \rm
5449   \tolerance = 9500
5450   \plainfrenchspacing
5451   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
5452   %
5453   % See comment in \requireopenindexfile.
5454   \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
5455   %
5456   % See if the index file exists and is nonempty.
5457   \openin 1 \jobname.\indexname s
5458   \ifeof 1
5459     % \enddoublecolumns gets confused if there is no text in the index,
5460     % and it loses the chapter title and the aux file entries for the
5461     % index.  The easiest way to prevent this problem is to make sure
5462     % there is some text.
5463     \putwordIndexNonexistent
5464     \typeout{No file \jobname.\indexname s.}%
5465   \else
5466     % If the index file exists but is empty, then \openin leaves \ifeof
5467     % false.  We have to make TeX try to read something from the file, so
5468     % it can discover if there is anything in it.
5469     \read 1 to \thisline
5470     \ifeof 1
5471       \putwordIndexIsEmpty
5472     \else
5473       \expandafter\printindexzz\thisline\relax\relax\finish%
5474     \fi
5475   \fi
5476   \closein 1
5477 \endgroup}
5478
5479 % If the index file starts with a backslash, forgo reading the index
5480 % file altogether.  If somebody upgrades texinfo.tex they may still have
5481 % old index files using \ as the escape character.  Reading this would
5482 % at best lead to typesetting garbage, at worst a TeX syntax error.
5483 \def\printindexzz#1#2\finish{%
5484   \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax
5485     \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1
5486       \expandafter\ifx\csname SETtxiskipindexfileswithbackslash\endcsname\relax
5487 \errmessage{%
5488 ERROR: A sorted index file in an obsolete format was skipped.
5489 To fix this problem, please upgrade your version of 'texi2dvi'
5490 or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
5491 If you are using an old version of 'texindex' (part of the Texinfo
5492 distribution), you may also need to upgrade to a newer version (at least 6.0).
5493 You may be able to typeset the index if you run
5494 'texindex \jobname.\indexname' yourself.
5495 You could also try setting the 'txiindexescapeisbackslash' flag by
5496 running a command like
5497 'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'.  If you do
5498 this, Texinfo will try to use index files in the old format.
5499 If you continue to have problems, deleting the index files and starting again
5500 might help (with 'rm \jobname.?? \jobname.??s')%
5501 }%
5502       \else
5503         (Skipped sorted index file in obsolete format)
5504       \fi
5505     \else
5506       \begindoublecolumns
5507       \input \jobname.\indexname s
5508       \enddoublecolumns
5509     \fi
5510   \else
5511     \begindoublecolumns
5512     \catcode`\\=0\relax
5513     %
5514     % Make @ an escape character to give macros a chance to work.  This
5515     % should work because we (hopefully) don't otherwise use @ in index files.
5516     %\catcode`\@=12\relax
5517     \catcode`\@=0\relax
5518     \input \jobname.\indexname s
5519     \enddoublecolumns
5520   \fi
5521 }
5522
5523 % These macros are used by the sorted index file itself.
5524 % Change them to control the appearance of the index.
5525
5526 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5527 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5528 \catcode`\$=3
5529 \gdef\initialglyphs{%
5530   % special control sequences used in the index sort key
5531   \let\indexlbrace\{%
5532   \let\indexrbrace\}%
5533   \let\indexatchar\@%
5534   \def\indexbackslash{\math{\backslash}}%
5535   %
5536   % Some changes for non-alphabetic characters.  Using the glyphs from the
5537   % math fonts looks more consistent than the typewriter font used elsewhere
5538   % for these characters.
5539   \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}}
5540   %
5541   % In case @\ is used for backslash
5542   \uppercase{\let\\=~}
5543   % Can't get bold backslash so don't use bold forward slash
5544   \catcode`\/=13
5545   \def/{{\secrmnotbold \normalslash}}%
5546   \def-{{\normaldash\normaldash}}% en dash `--'
5547   \def^{{\chapbf \normalcaret}}%
5548   \def~{{\chapbf \normaltilde}}%
5549   \def\_{%
5550      \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
5551   \def|{$\vert$}%
5552   \def<{$\less$}%
5553   \def>{$\gtr$}%
5554   \def+{$\normalplus$}%
5555 }}
5556
5557 \def\initial{%
5558   \bgroup
5559   \initialglyphs
5560   \initialx
5561 }
5562
5563 \def\initialx#1{%
5564   % Remove any glue we may have, we'll be inserting our own.
5565   \removelastskip
5566   %
5567   % We like breaks before the index initials, so insert a bonus.
5568   % The glue before the bonus allows a little bit of space at the
5569   % bottom of a column to reduce an increase in inter-line spacing.
5570   \nobreak
5571   \vskip 0pt plus 5\baselineskip
5572   \penalty -300
5573   \vskip 0pt plus -5\baselineskip
5574   %
5575   % Typeset the initial.  Making this add up to a whole number of
5576   % baselineskips increases the chance of the dots lining up from column
5577   % to column.  It still won't often be perfect, because of the stretch
5578   % we need before each entry, but it's better.
5579   %
5580   % No shrink because it confuses \balancecolumns.
5581   \vskip 1.67\baselineskip plus 1\baselineskip
5582   \leftline{\secfonts \kern-0.05em \secbf #1}%
5583   % \secfonts is inside the argument of \leftline so that the change of
5584   % \baselineskip will not affect any glue inserted before the vbox that
5585   % \leftline creates.
5586   % Do our best not to break after the initial.
5587   \nobreak
5588   \vskip .33\baselineskip plus .1\baselineskip
5589   \egroup % \initialglyphs
5590 }
5591
5592 \newdimen\entryrightmargin
5593 \entryrightmargin=0pt
5594
5595 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5596 % then page number (#2) flushed to the right margin.  It is used for index
5597 % and table of contents entries.  The paragraph is indented by \leftskip.
5598 %
5599 \def\entry{%
5600   \begingroup
5601     %
5602     % Start a new paragraph if necessary, so our assignments below can't
5603     % affect previous text.
5604     \par
5605     %
5606     % No extra space above this paragraph.
5607     \parskip = 0in
5608     %
5609     % When reading the text of entry, convert explicit line breaks
5610     % from @* into spaces.  The user might give these in long section
5611     % titles, for instance.
5612     \def\*{\unskip\space\ignorespaces}%
5613     \def\entrybreak{\hfil\break}% An undocumented command
5614     %
5615     % Swallow the left brace of the text (first parameter):
5616     \afterassignment\doentry
5617     \let\temp =
5618 }
5619 \def\entrybreak{\unskip\space\ignorespaces}%
5620 \def\doentry{%
5621     % Save the text of the entry
5622     \global\setbox\boxA=\hbox\bgroup
5623     \bgroup % Instead of the swallowed brace.
5624       \noindent
5625       \aftergroup\finishentry
5626       % And now comes the text of the entry.
5627       % Not absorbing as a macro argument reduces the chance of problems
5628       % with catcodes occurring.
5629 }
5630 {\catcode`\@=11
5631 \gdef\finishentry#1{%
5632     \egroup % end box A
5633     \dimen@ = \wd\boxA % Length of text of entry
5634     \global\setbox\boxA=\hbox\bgroup
5635       \unhbox\boxA
5636       % #1 is the page number.
5637       %
5638       % Get the width of the page numbers, and only use
5639       % leaders if they are present.
5640       \global\setbox\boxB = \hbox{#1}%
5641       \ifdim\wd\boxB = 0pt
5642         \null\nobreak\hfill\ %
5643       \else
5644         %
5645         \null\nobreak\indexdotfill % Have leaders before the page number.
5646         %
5647         \ifpdforxetex
5648           \pdfgettoks#1.%
5649           \hskip\skip\thinshrinkable\the\toksA
5650         \else
5651           \hskip\skip\thinshrinkable #1%
5652         \fi
5653       \fi
5654     \egroup % end \boxA
5655     \ifdim\wd\boxB = 0pt
5656       \noindent\unhbox\boxA\par
5657       \nobreak
5658     \else\bgroup
5659       % We want the text of the entries to be aligned to the left, and the
5660       % page numbers to be aligned to the right.
5661       %
5662       \parindent = 0pt
5663       \advance\leftskip by 0pt plus 1fil
5664       \advance\leftskip by 0pt plus -1fill
5665       \rightskip = 0pt plus -1fil
5666       \advance\rightskip by 0pt plus 1fill
5667       % Cause last line, which could consist of page numbers on their own
5668       % if the list of page numbers is long, to be aligned to the right.
5669       \parfillskip=0pt plus -1fill
5670       %
5671       \advance\rightskip by \entryrightmargin
5672       % Determine how far we can stretch into the margin.
5673       % This allows, e.g., "Appendix H  GNU Free Documentation License" to
5674       % fit on one line in @letterpaper format.
5675       \ifdim\entryrightmargin>2.1em
5676         \dimen@i=2.1em
5677       \else
5678         \dimen@i=0em
5679       \fi
5680       \advance \parfillskip by 0pt minus 1\dimen@i
5681       %
5682       \dimen@ii = \hsize
5683       \advance\dimen@ii by -1\leftskip
5684       \advance\dimen@ii by -1\entryrightmargin
5685       \advance\dimen@ii by 1\dimen@i
5686       \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
5687       \ifdim\dimen@ > 0.8\dimen@ii   % due to long index text
5688         % Try to split the text roughly evenly.  \dimen@ will be the length of
5689         % the first line.
5690         \dimen@ = 0.7\dimen@
5691         \dimen@ii = \hsize
5692         \ifnum\dimen@>\dimen@ii
5693           % If the entry is too long (for example, if it needs more than
5694           % two lines), use all the space in the first line.
5695           \dimen@ = \dimen@ii
5696         \fi
5697         \advance\leftskip by 0pt plus 1fill % ragged right
5698         \advance \dimen@ by 1\rightskip
5699         \parshape = 2 0pt \dimen@ 0em \dimen@ii
5700         % Ideally we'd add a finite glue at the end of the first line only,
5701         % instead of using \parshape with explicit line lengths, but TeX
5702         % doesn't seem to provide a way to do such a thing.
5703         %
5704         % Indent all lines but the first one.
5705         \advance\leftskip by 1em
5706         \advance\parindent by -1em
5707       \fi\fi
5708       \indent % start paragraph
5709       \unhbox\boxA
5710       %
5711       % Do not prefer a separate line ending with a hyphen to fewer lines.
5712       \finalhyphendemerits = 0
5713       %
5714       % Word spacing - no stretch
5715       \spaceskip=\fontdimen2\font minus \fontdimen4\font
5716       %
5717       \linepenalty=1000  % Discourage line breaks.
5718       \hyphenpenalty=5000  % Discourage hyphenation.
5719       %
5720       \par % format the paragraph
5721     \egroup % The \vbox
5722     \fi
5723   \endgroup
5724 }}
5725
5726 \newskip\thinshrinkable
5727 \skip\thinshrinkable=.15em minus .15em
5728
5729 % Like plain.tex's \dotfill, except uses up at least 1 em.
5730 % The filll stretch here overpowers both the fil and fill stretch to push
5731 % the page number to the right.
5732 \def\indexdotfill{\cleaders
5733   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
5734
5735
5736 \def\primary #1{\line{#1\hfil}}
5737
5738 \def\secondary{\indententry{0.5cm}}
5739 \def\tertiary{\indententry{1cm}}
5740
5741 \def\indententry#1#2#3{%
5742   \bgroup
5743   \leftskip=#1
5744   \entry{#2}{#3}%
5745   \egroup
5746 }
5747
5748 % Define two-column mode, which we use to typeset indexes.
5749 % Adapted from the TeXbook, page 416, which is to say,
5750 % the manmac.tex format used to print the TeXbook itself.
5751 \catcode`\@=11  % private names
5752
5753 \newbox\partialpage
5754 \newdimen\doublecolumnhsize
5755
5756 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5757   % If not much space left on page, start a new page.
5758   \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
5759   %
5760   % Grab any single-column material above us.
5761   \output = {%
5762     \savetopmark
5763     %
5764     \global\setbox\partialpage = \vbox{%
5765       % Unvbox the main output page.
5766       \unvbox\PAGE
5767       \kern-\topskip \kern\baselineskip
5768     }%
5769   }%
5770   \eject % run that output routine to set \partialpage
5771   %
5772   % Use the double-column output routine for subsequent pages.
5773   \output = {\doublecolumnout}%
5774   %
5775   % Change the page size parameters.  We could do this once outside this
5776   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5777   % format, but then we repeat the same computation.  Repeating a couple
5778   % of assignments once per index is clearly meaningless for the
5779   % execution time, so we may as well do it in one place.
5780   %
5781   % First we halve the line length, less a little for the gutter between
5782   % the columns.  We compute the gutter based on the line length, so it
5783   % changes automatically with the paper format.  The magic constant
5784   % below is chosen so that the gutter has the same value (well, +-<1pt)
5785   % as it did when we hard-coded it.
5786   %
5787   % We put the result in a separate register, \doublecolumhsize, so we
5788   % can restore it in \pagesofar, after \hsize itself has (potentially)
5789   % been clobbered.
5790   %
5791   \doublecolumnhsize = \hsize
5792     \advance\doublecolumnhsize by -.04154\hsize
5793     \divide\doublecolumnhsize by 2
5794   \hsize = \doublecolumnhsize
5795   %
5796   % Get the available space for the double columns -- the normal
5797   % (undoubled) page height minus any material left over from the
5798   % previous page.
5799   \advance\vsize by -\ht\partialpage
5800   \vsize = 2\vsize
5801   %
5802   % For the benefit of balancing columns
5803   \advance\baselineskip by 0pt plus 0.5pt
5804 }
5805
5806 % The double-column output routine for all double-column pages except
5807 % the last, which is done by \balancecolumns.
5808 %
5809 \def\doublecolumnout{%
5810   %
5811   \savetopmark
5812   \splittopskip=\topskip \splitmaxdepth=\maxdepth
5813   \dimen@ = \vsize
5814   \divide\dimen@ by 2
5815   %
5816   % box0 will be the left-hand column, box2 the right.
5817   \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
5818   \global\advance\vsize by 2\ht\partialpage
5819   \onepageout\pagesofar % empty except for the first time we are called
5820   \unvbox\PAGE
5821   \penalty\outputpenalty
5822 }
5823 %
5824 % Re-output the contents of the output page -- any previous material,
5825 % followed by the two boxes we just split, in box0 and box2.
5826 \def\pagesofar{%
5827   \unvbox\partialpage
5828   %
5829   \hsize = \doublecolumnhsize
5830   \wd0=\hsize \wd2=\hsize
5831   \hbox to\txipagewidth{\box0\hfil\box2}%
5832 }
5833
5834
5835 % Finished with double columns.
5836 \def\enddoublecolumns{%
5837   % The following penalty ensures that the page builder is exercised
5838   % _before_ we change the output routine.  This is necessary in the
5839   % following situation:
5840   %
5841   % The last section of the index consists only of a single entry.
5842   % Before this section, \pagetotal is less than \pagegoal, so no
5843   % break occurs before the last section starts.  However, the last
5844   % section, consisting of \initial and the single \entry, does not
5845   % fit on the page and has to be broken off.  Without the following
5846   % penalty the page builder will not be exercised until \eject
5847   % below, and by that time we'll already have changed the output
5848   % routine to the \balancecolumns version, so the next-to-last
5849   % double-column page will be processed with \balancecolumns, which
5850   % is wrong:  The two columns will go to the main vertical list, with
5851   % the broken-off section in the recent contributions.  As soon as
5852   % the output routine finishes, TeX starts reconsidering the page
5853   % break.  The two columns and the broken-off section both fit on the
5854   % page, because the two columns now take up only half of the page
5855   % goal.  When TeX sees \eject from below which follows the final
5856   % section, it invokes the new output routine that we've set after
5857   % \balancecolumns below; \onepageout will try to fit the two columns
5858   % and the final section into the vbox of \txipageheight (see
5859   % \pagebody), causing an overfull box.
5860   %
5861   % Note that glue won't work here, because glue does not exercise the
5862   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5863   \penalty0
5864   %
5865   \output = {%
5866     % Split the last of the double-column material.
5867     \savetopmark
5868     \balancecolumns
5869   }%
5870   \eject % call the \output just set
5871   \ifdim\pagetotal=0pt
5872     % Having called \balancecolumns once, we do not
5873     % want to call it again.  Therefore, reset \output to its normal
5874     % definition right away.
5875     \global\output=\expandafter{\the\defaultoutput}
5876     %
5877     \endgroup % started in \begindoublecolumns
5878     % Leave the double-column material on the current page, no automatic
5879     % page break.
5880     \box\balancedcolumns
5881     %
5882     % \pagegoal was set to the doubled \vsize above, since we restarted
5883     % the current page.  We're now back to normal single-column
5884     % typesetting, so reset \pagegoal to the normal \vsize.
5885     \global\vsize = \txipageheight %
5886     \pagegoal = \txipageheight %
5887   \else
5888     % We had some left-over material.  This might happen when \doublecolumnout
5889     % is called in \balancecolumns.  Try again.
5890     \expandafter\enddoublecolumns
5891   \fi
5892 }
5893 \newbox\balancedcolumns
5894 \setbox\balancedcolumns=\vbox{shouldnt see this}%
5895 %
5896 % Only called for the last of the double column material.  \doublecolumnout
5897 % does the others.
5898 \def\balancecolumns{%
5899   \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
5900   \dimen@ = \ht0
5901   \ifdim\dimen@<7\baselineskip
5902     % Don't split a short final column in two.
5903     \setbox2=\vbox{}%
5904     \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5905   \else
5906     % double the leading vertical space
5907     \advance\dimen@ by \topskip
5908     \advance\dimen@ by-\baselineskip
5909     \divide\dimen@ by 2 % target to split to
5910     \dimen@ii = \dimen@
5911     \splittopskip = \topskip
5912     % Loop until left column is at least as high as the right column.
5913     {%
5914       \vbadness = 10000
5915       \loop
5916         \global\setbox3 = \copy0
5917         \global\setbox1 = \vsplit3 to \dimen@
5918       \ifdim\ht1<\ht3
5919         \global\advance\dimen@ by 1pt
5920       \repeat
5921     }%
5922     % Now the left column is in box 1, and the right column in box 3.
5923     %
5924     % Check whether the left column has come out higher than the page itself.
5925     % (Note that we have doubled \vsize for the double columns, so
5926     % the actual height of the page is 0.5\vsize).
5927     \ifdim2\ht1>\vsize
5928       % It appears that we have been called upon to balance too much material.
5929       % Output some of it with \doublecolumnout, leaving the rest on the page.
5930       \setbox\PAGE=\box0
5931       \doublecolumnout
5932     \else
5933       % Compare the heights of the two columns.
5934       \ifdim4\ht1>5\ht3
5935         % Column heights are too different, so don't make their bottoms
5936         % flush with each other.
5937         \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
5938         \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
5939       \else
5940         % Make column bottoms flush with each other.
5941         \setbox2=\vbox to\ht1{\unvbox3\unskip}%
5942         \setbox0=\vbox to\ht1{\unvbox1\unskip}%
5943       \fi
5944       \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5945     \fi
5946   \fi
5947   %
5948 }
5949 \catcode`\@ = \other
5950
5951
5952 \message{sectioning,}
5953 % Chapters, sections, etc.
5954
5955 % Let's start with @part.
5956 \parseargdef\part{\partzzz{#1}}
5957 \def\partzzz#1{%
5958   \chapoddpage
5959   \null
5960   \vskip.3\vsize  % move it down on the page a bit
5961   \begingroup
5962     \noindent \titlefonts\rm #1\par % the text
5963     \let\lastnode=\empty      % no node to associate with
5964     \writetocentry{part}{#1}{}% but put it in the toc
5965     \headingsoff              % no headline or footline on the part page
5966     % This outputs a mark at the end of the page that clears \thischapter
5967     % and \thissection, as is done in \startcontents.
5968     \let\pchapsepmacro\relax
5969     \chapmacro{}{Yomitfromtoc}{}%
5970     \chapoddpage
5971   \endgroup
5972 }
5973
5974 % \unnumberedno is an oxymoron.  But we count the unnumbered
5975 % sections so that we can refer to them unambiguously in the pdf
5976 % outlines by their "section number".  We avoid collisions with chapter
5977 % numbers by starting them at 10000.  (If a document ever has 10000
5978 % chapters, we're in trouble anyway, I'm sure.)
5979 \newcount\unnumberedno \unnumberedno = 10000
5980 \newcount\chapno
5981 \newcount\secno        \secno=0
5982 \newcount\subsecno     \subsecno=0
5983 \newcount\subsubsecno  \subsubsecno=0
5984
5985 % This counter is funny since it counts through charcodes of letters A, B, ...
5986 \newcount\appendixno  \appendixno = `\@
5987 %
5988 % \def\appendixletter{\char\the\appendixno}
5989 % We do the following ugly conditional instead of the above simple
5990 % construct for the sake of pdftex, which needs the actual
5991 % letter in the expansion, not just typeset.
5992 %
5993 \def\appendixletter{%
5994   \ifnum\appendixno=`A A%
5995   \else\ifnum\appendixno=`B B%
5996   \else\ifnum\appendixno=`C C%
5997   \else\ifnum\appendixno=`D D%
5998   \else\ifnum\appendixno=`E E%
5999   \else\ifnum\appendixno=`F F%
6000   \else\ifnum\appendixno=`G G%
6001   \else\ifnum\appendixno=`H H%
6002   \else\ifnum\appendixno=`I I%
6003   \else\ifnum\appendixno=`J J%
6004   \else\ifnum\appendixno=`K K%
6005   \else\ifnum\appendixno=`L L%
6006   \else\ifnum\appendixno=`M M%
6007   \else\ifnum\appendixno=`N N%
6008   \else\ifnum\appendixno=`O O%
6009   \else\ifnum\appendixno=`P P%
6010   \else\ifnum\appendixno=`Q Q%
6011   \else\ifnum\appendixno=`R R%
6012   \else\ifnum\appendixno=`S S%
6013   \else\ifnum\appendixno=`T T%
6014   \else\ifnum\appendixno=`U U%
6015   \else\ifnum\appendixno=`V V%
6016   \else\ifnum\appendixno=`W W%
6017   \else\ifnum\appendixno=`X X%
6018   \else\ifnum\appendixno=`Y Y%
6019   \else\ifnum\appendixno=`Z Z%
6020   % The \the is necessary, despite appearances, because \appendixletter is
6021   % expanded while writing the .toc file.  \char\appendixno is not
6022   % expandable, thus it is written literally, thus all appendixes come out
6023   % with the same letter (or @) in the toc without it.
6024   \else\char\the\appendixno
6025   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6026   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
6027
6028 % Each @chapter defines these (using marks) as the number+name, number
6029 % and name of the chapter.  Page headings and footings can use
6030 % these.  @section does likewise.
6031 \def\thischapter{}
6032 \def\thischapternum{}
6033 \def\thischaptername{}
6034 \def\thissection{}
6035 \def\thissectionnum{}
6036 \def\thissectionname{}
6037
6038 \newcount\absseclevel % used to calculate proper heading level
6039 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
6040
6041 % @raisesections: treat @section as chapter, @subsection as section, etc.
6042 \def\raisesections{\global\advance\secbase by -1}
6043
6044 % @lowersections: treat @chapter as section, @section as subsection, etc.
6045 \def\lowersections{\global\advance\secbase by 1}
6046
6047 % we only have subsub.
6048 \chardef\maxseclevel = 3
6049 %
6050 % A numbered section within an unnumbered changes to unnumbered too.
6051 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6052 \chardef\unnlevel = \maxseclevel
6053 %
6054 % Trace whether the current chapter is an appendix or not:
6055 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6056 \def\chapheadtype{N}
6057
6058 % Choose a heading macro
6059 % #1 is heading type
6060 % #2 is heading level
6061 % #3 is text for heading
6062 \def\genhead#1#2#3{%
6063   % Compute the abs. sec. level:
6064   \absseclevel=#2
6065   \advance\absseclevel by \secbase
6066   % Make sure \absseclevel doesn't fall outside the range:
6067   \ifnum \absseclevel < 0
6068     \absseclevel = 0
6069   \else
6070     \ifnum \absseclevel > 3
6071       \absseclevel = 3
6072     \fi
6073   \fi
6074   % The heading type:
6075   \def\headtype{#1}%
6076   \if \headtype U%
6077     \ifnum \absseclevel < \unnlevel
6078       \chardef\unnlevel = \absseclevel
6079     \fi
6080   \else
6081     % Check for appendix sections:
6082     \ifnum \absseclevel = 0
6083       \edef\chapheadtype{\headtype}%
6084     \else
6085       \if \headtype A\if \chapheadtype N%
6086         \errmessage{@appendix... within a non-appendix chapter}%
6087       \fi\fi
6088     \fi
6089     % Check for numbered within unnumbered:
6090     \ifnum \absseclevel > \unnlevel
6091       \def\headtype{U}%
6092     \else
6093       \chardef\unnlevel = 3
6094     \fi
6095   \fi
6096   % Now print the heading:
6097   \if \headtype U%
6098     \ifcase\absseclevel
6099         \unnumberedzzz{#3}%
6100     \or \unnumberedseczzz{#3}%
6101     \or \unnumberedsubseczzz{#3}%
6102     \or \unnumberedsubsubseczzz{#3}%
6103     \fi
6104   \else
6105     \if \headtype A%
6106       \ifcase\absseclevel
6107           \appendixzzz{#3}%
6108       \or \appendixsectionzzz{#3}%
6109       \or \appendixsubseczzz{#3}%
6110       \or \appendixsubsubseczzz{#3}%
6111       \fi
6112     \else
6113       \ifcase\absseclevel
6114           \chapterzzz{#3}%
6115       \or \seczzz{#3}%
6116       \or \numberedsubseczzz{#3}%
6117       \or \numberedsubsubseczzz{#3}%
6118       \fi
6119     \fi
6120   \fi
6121   \suppressfirstparagraphindent
6122 }
6123
6124 % an interface:
6125 \def\numhead{\genhead N}
6126 \def\apphead{\genhead A}
6127 \def\unnmhead{\genhead U}
6128
6129 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
6130 % all lower-level sectioning counters to zero.
6131 %
6132 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6133 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
6134 \let\chaplevelprefix = \empty
6135 %
6136 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
6137 \def\chapterzzz#1{%
6138   % section resetting is \global in case the chapter is in a group, such
6139   % as an @include file.
6140   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6141     \global\advance\chapno by 1
6142   %
6143   % Used for \float.
6144   \gdef\chaplevelprefix{\the\chapno.}%
6145   \resetallfloatnos
6146   %
6147   % \putwordChapter can contain complex things in translations.
6148   \toks0=\expandafter{\putwordChapter}%
6149   \message{\the\toks0 \space \the\chapno}%
6150   %
6151   % Write the actual heading.
6152   \chapmacro{#1}{Ynumbered}{\the\chapno}%
6153   %
6154   % So @section and the like are numbered underneath this chapter.
6155   \global\let\section = \numberedsec
6156   \global\let\subsection = \numberedsubsec
6157   \global\let\subsubsection = \numberedsubsubsec
6158 }
6159
6160 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
6161 %
6162 \def\appendixzzz#1{%
6163   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6164     \global\advance\appendixno by 1
6165   \gdef\chaplevelprefix{\appendixletter.}%
6166   \resetallfloatnos
6167   %
6168   % \putwordAppendix can contain complex things in translations.
6169   \toks0=\expandafter{\putwordAppendix}%
6170   \message{\the\toks0 \space \appendixletter}%
6171   %
6172   \chapmacro{#1}{Yappendix}{\appendixletter}%
6173   %
6174   \global\let\section = \appendixsec
6175   \global\let\subsection = \appendixsubsec
6176   \global\let\subsubsection = \appendixsubsubsec
6177 }
6178
6179 % normally unnmhead0 calls unnumberedzzz:
6180 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
6181 \def\unnumberedzzz#1{%
6182   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6183     \global\advance\unnumberedno by 1
6184   %
6185   % Since an unnumbered has no number, no prefix for figures.
6186   \global\let\chaplevelprefix = \empty
6187   \resetallfloatnos
6188   %
6189   % This used to be simply \message{#1}, but TeX fully expands the
6190   % argument to \message.  Therefore, if #1 contained @-commands, TeX
6191   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
6192   % expanded @cite (which turns out to cause errors because \cite is meant
6193   % to be executed, not expanded).
6194   %
6195   % Anyway, we don't want the fully-expanded definition of @cite to appear
6196   % as a result of the \message, we just want `@cite' itself.  We use
6197   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6198   % simply yielding the contents of <toks register>.  (We also do this for
6199   % the toc entries.)
6200   \toks0 = {#1}%
6201   \message{(\the\toks0)}%
6202   %
6203   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
6204   %
6205   \global\let\section = \unnumberedsec
6206   \global\let\subsection = \unnumberedsubsec
6207   \global\let\subsubsection = \unnumberedsubsubsec
6208 }
6209
6210 % @centerchap is like @unnumbered, but the heading is centered.
6211 \outer\parseargdef\centerchap{%
6212   \let\centerparametersmaybe = \centerparameters
6213   \unnmhead0{#1}%
6214   \let\centerparametersmaybe = \relax
6215 }
6216
6217 % @top is like @unnumbered.
6218 \let\top\unnumbered
6219
6220 % Sections.
6221 %
6222 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
6223 \def\seczzz#1{%
6224   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6225   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
6226 }
6227
6228 % normally calls appendixsectionzzz:
6229 \outer\parseargdef\appendixsection{\apphead1{#1}}
6230 \def\appendixsectionzzz#1{%
6231   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6232   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
6233 }
6234 \let\appendixsec\appendixsection
6235
6236 % normally calls unnumberedseczzz:
6237 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
6238 \def\unnumberedseczzz#1{%
6239   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
6240   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
6241 }
6242
6243 % Subsections.
6244 %
6245 % normally calls numberedsubseczzz:
6246 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
6247 \def\numberedsubseczzz#1{%
6248   \global\subsubsecno=0  \global\advance\subsecno by 1
6249   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
6250 }
6251
6252 % normally calls appendixsubseczzz:
6253 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
6254 \def\appendixsubseczzz#1{%
6255   \global\subsubsecno=0  \global\advance\subsecno by 1
6256   \sectionheading{#1}{subsec}{Yappendix}%
6257                  {\appendixletter.\the\secno.\the\subsecno}%
6258 }
6259
6260 % normally calls unnumberedsubseczzz:
6261 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
6262 \def\unnumberedsubseczzz#1{%
6263   \global\subsubsecno=0  \global\advance\subsecno by 1
6264   \sectionheading{#1}{subsec}{Ynothing}%
6265                  {\the\unnumberedno.\the\secno.\the\subsecno}%
6266 }
6267
6268 % Subsubsections.
6269 %
6270 % normally numberedsubsubseczzz:
6271 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
6272 \def\numberedsubsubseczzz#1{%
6273   \global\advance\subsubsecno by 1
6274   \sectionheading{#1}{subsubsec}{Ynumbered}%
6275                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
6276 }
6277
6278 % normally appendixsubsubseczzz:
6279 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
6280 \def\appendixsubsubseczzz#1{%
6281   \global\advance\subsubsecno by 1
6282   \sectionheading{#1}{subsubsec}{Yappendix}%
6283                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
6284 }
6285
6286 % normally unnumberedsubsubseczzz:
6287 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
6288 \def\unnumberedsubsubseczzz#1{%
6289   \global\advance\subsubsecno by 1
6290   \sectionheading{#1}{subsubsec}{Ynothing}%
6291                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
6292 }
6293
6294 % These macros control what the section commands do, according
6295 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
6296 % Define them by default for a numbered chapter.
6297 \let\section = \numberedsec
6298 \let\subsection = \numberedsubsec
6299 \let\subsubsection = \numberedsubsubsec
6300
6301 % Define @majorheading, @heading and @subheading
6302
6303 \def\majorheading{%
6304   {\advance\chapheadingskip by 10pt \chapbreak }%
6305   \parsearg\chapheadingzzz
6306 }
6307
6308 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
6309 \def\chapheadingzzz#1{%
6310   \vbox{\chapfonts \raggedtitlesettings #1\par}%
6311   \nobreak\bigskip \nobreak
6312   \suppressfirstparagraphindent
6313 }
6314
6315 % @heading, @subheading, @subsubheading.
6316 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
6317   \suppressfirstparagraphindent}
6318 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
6319   \suppressfirstparagraphindent}
6320 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
6321   \suppressfirstparagraphindent}
6322
6323 % These macros generate a chapter, section, etc. heading only
6324 % (including whitespace, linebreaking, etc. around it),
6325 % given all the information in convenient, parsed form.
6326
6327 % Args are the skip and penalty (usually negative)
6328 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
6329
6330 % Parameter controlling skip before chapter headings (if needed)
6331 \newskip\chapheadingskip
6332
6333 % Define plain chapter starts, and page on/off switching for it.
6334 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
6335
6336 % Start a new page
6337 \def\chappager{\par\vfill\supereject}
6338
6339 % \chapoddpage - start on an odd page for a new chapter
6340 % Because \domark is called before \chapoddpage, the filler page will
6341 % get the headings for the next chapter, which is wrong.  But we don't
6342 % care -- we just disable all headings on the filler page.
6343 \def\chapoddpage{%
6344   \chappager
6345   \ifodd\pageno \else
6346     \begingroup
6347       \headingsoff
6348       \null
6349       \chappager
6350     \endgroup
6351   \fi
6352 }
6353
6354 \parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname}
6355
6356 \def\CHAPPAGoff{%
6357 \global\let\contentsalignmacro = \chappager
6358 \global\let\pchapsepmacro=\chapbreak
6359 \global\def\HEADINGSon{\HEADINGSsinglechapoff}}
6360
6361 \def\CHAPPAGon{%
6362 \global\let\contentsalignmacro = \chappager
6363 \global\let\pchapsepmacro=\chappager
6364 \global\def\HEADINGSon{\HEADINGSsingle}}
6365
6366 \def\CHAPPAGodd{%
6367 \global\let\contentsalignmacro = \chapoddpage
6368 \global\let\pchapsepmacro=\chapoddpage
6369 \global\def\HEADINGSon{\HEADINGSdouble}}
6370
6371 \CHAPPAGon
6372
6373 % \chapmacro - Chapter opening.
6374 %
6375 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
6376 % Yappendix, Yomitfromtoc), #3 the chapter number.
6377 % Not used for @heading series.
6378 %
6379 % To test against our argument.
6380 \def\Ynothingkeyword{Ynothing}
6381 \def\Yappendixkeyword{Yappendix}
6382 \def\Yomitfromtockeyword{Yomitfromtoc}
6383 %
6384 \def\chapmacro#1#2#3{%
6385   \expandafter\ifx\thisenv\titlepage\else
6386     \checkenv{}% chapters, etc., should not start inside an environment.
6387   \fi
6388   % Insert the first mark before the heading break (see notes for \domark).
6389   \let\prevchapterdefs=\currentchapterdefs
6390   \let\prevsectiondefs=\currentsectiondefs
6391   \gdef\currentsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
6392                         \gdef\thissection{}}%
6393   %
6394   \def\temptype{#2}%
6395   \ifx\temptype\Ynothingkeyword
6396     \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6397                           \gdef\thischapter{\thischaptername}}%
6398   \else\ifx\temptype\Yomitfromtockeyword
6399     \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6400                           \gdef\thischapter{}}%
6401   \else\ifx\temptype\Yappendixkeyword
6402     \toks0={#1}%
6403     \xdef\currentchapterdefs{%
6404       \gdef\noexpand\thischaptername{\the\toks0}%
6405       \gdef\noexpand\thischapternum{\appendixletter}%
6406       % \noexpand\putwordAppendix avoids expanding indigestible
6407       % commands in some of the translations.
6408       \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
6409                                  \noexpand\thischapternum:
6410                                  \noexpand\thischaptername}%
6411     }%
6412   \else
6413     \toks0={#1}%
6414     \xdef\currentchapterdefs{%
6415       \gdef\noexpand\thischaptername{\the\toks0}%
6416       \gdef\noexpand\thischapternum{\the\chapno}%
6417       % \noexpand\putwordChapter avoids expanding indigestible
6418       % commands in some of the translations.
6419       \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
6420                                  \noexpand\thischapternum:
6421                                  \noexpand\thischaptername}%
6422     }%
6423   \fi\fi\fi
6424   %
6425   % Output the mark.  Pass it through \safewhatsit, to take care of
6426   % the preceding space.
6427   \safewhatsit\domark
6428   %
6429   % Insert the chapter heading break.
6430   \pchapsepmacro
6431   %
6432   % Now the second mark, after the heading break.  No break points
6433   % between here and the heading.
6434   \let\prevchapterdefs=\currentchapterdefs
6435   \let\prevsectiondefs=\currentsectiondefs
6436   \domark
6437   %
6438   {%
6439     \chapfonts \rm
6440     \let\footnote=\errfootnoteheading % give better error message
6441     %
6442     % Have to define \currentsection before calling \donoderef, because the
6443     % xref code eventually uses it.  On the other hand, it has to be called
6444     % after \pchapsepmacro, or the headline will change too soon.
6445     \gdef\currentsection{#1}%
6446     %
6447     % Only insert the separating space if we have a chapter/appendix
6448     % number, and don't print the unnumbered ``number''.
6449     \ifx\temptype\Ynothingkeyword
6450       \setbox0 = \hbox{}%
6451       \def\toctype{unnchap}%
6452     \else\ifx\temptype\Yomitfromtockeyword
6453       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
6454       \def\toctype{omit}%
6455     \else\ifx\temptype\Yappendixkeyword
6456       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
6457       \def\toctype{app}%
6458     \else
6459       \setbox0 = \hbox{#3\enspace}%
6460       \def\toctype{numchap}%
6461     \fi\fi\fi
6462     %
6463     % Write the toc entry for this chapter.  Must come before the
6464     % \donoderef, because we include the current node name in the toc
6465     % entry, and \donoderef resets it to empty.
6466     \writetocentry{\toctype}{#1}{#3}%
6467     %
6468     % For pdftex, we have to write out the node definition (aka, make
6469     % the pdfdest) after any page break, but before the actual text has
6470     % been typeset.  If the destination for the pdf outline is after the
6471     % text, then jumping from the outline may wind up with the text not
6472     % being visible, for instance under high magnification.
6473     \donoderef{#2}%
6474     %
6475     % Typeset the actual heading.
6476     \nobreak % Avoid page breaks at the interline glue.
6477     \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
6478           \unhbox0 #1\par}%
6479   }%
6480   \nobreak\bigskip % no page break after a chapter title
6481   \nobreak
6482 }
6483
6484 % @centerchap -- centered and unnumbered.
6485 \let\centerparametersmaybe = \relax
6486 \def\centerparameters{%
6487   \advance\rightskip by 3\rightskip
6488   \leftskip = \rightskip
6489   \parfillskip = 0pt
6490 }
6491
6492
6493 % Section titles.  These macros combine the section number parts and
6494 % call the generic \sectionheading to do the printing.
6495 %
6496 \newskip\secheadingskip
6497 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
6498
6499 % Subsection titles.
6500 \newskip\subsecheadingskip
6501 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
6502
6503 % Subsubsection titles.
6504 \def\subsubsecheadingskip{\subsecheadingskip}
6505 \def\subsubsecheadingbreak{\subsecheadingbreak}
6506
6507
6508 % Print any size, any type, section title.
6509 %
6510 % #1 is the text of the title,
6511 % #2 is the section level (sec/subsec/subsubsec),
6512 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6513 % #4 is the section number.
6514 %
6515 \def\seckeyword{sec}
6516 %
6517 \def\sectionheading#1#2#3#4{%
6518   {%
6519     \def\sectionlevel{#2}%
6520     \def\temptype{#3}%
6521     %
6522     % It is ok for the @heading series commands to appear inside an
6523     % environment (it's been historically allowed, though the logic is
6524     % dubious), but not the others.
6525     \ifx\temptype\Yomitfromtockeyword\else
6526       \checkenv{}% non-@*heading should not be in an environment.
6527     \fi
6528     \let\footnote=\errfootnoteheading
6529     %
6530     % Switch to the right set of fonts.
6531     \csname #2fonts\endcsname \rm
6532     %
6533     % Insert first mark before the heading break (see notes for \domark).
6534     \let\prevsectiondefs=\currentsectiondefs
6535     \ifx\temptype\Ynothingkeyword
6536       \ifx\sectionlevel\seckeyword
6537         \gdef\currentsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
6538                               \gdef\thissection{\thissectionname}}%
6539       \fi
6540     \else\ifx\temptype\Yomitfromtockeyword
6541       % Don't redefine \thissection.
6542     \else\ifx\temptype\Yappendixkeyword
6543       \ifx\sectionlevel\seckeyword
6544         \toks0={#1}%
6545         \xdef\currentsectiondefs{%
6546           \gdef\noexpand\thissectionname{\the\toks0}%
6547           \gdef\noexpand\thissectionnum{#4}%
6548           % \noexpand\putwordSection avoids expanding indigestible
6549           % commands in some of the translations.
6550           \gdef\noexpand\thissection{\noexpand\putwordSection{}
6551                                      \noexpand\thissectionnum:
6552                                      \noexpand\thissectionname}%
6553         }%
6554       \fi
6555     \else
6556       \ifx\sectionlevel\seckeyword
6557         \toks0={#1}%
6558         \xdef\currentsectiondefs{%
6559           \gdef\noexpand\thissectionname{\the\toks0}%
6560           \gdef\noexpand\thissectionnum{#4}%
6561           % \noexpand\putwordSection avoids expanding indigestible
6562           % commands in some of the translations.
6563           \gdef\noexpand\thissection{\noexpand\putwordSection{}
6564                                      \noexpand\thissectionnum:
6565                                      \noexpand\thissectionname}%
6566         }%
6567       \fi
6568     \fi\fi\fi
6569     %
6570     % Go into vertical mode.  Usually we'll already be there, but we
6571     % don't want the following whatsit to end up in a preceding paragraph
6572     % if the document didn't happen to have a blank line.
6573     \par
6574     %
6575     % Output the mark.  Pass it through \safewhatsit, to take care of
6576     % the preceding space.
6577     \safewhatsit\domark
6578     %
6579     % Insert space above the heading.
6580     \csname #2headingbreak\endcsname
6581     %
6582     % Now the second mark, after the heading break.  No break points
6583     % between here and the heading.
6584     \global\let\prevsectiondefs=\currentsectiondefs
6585     \domark
6586     %
6587     % Only insert the space after the number if we have a section number.
6588     \ifx\temptype\Ynothingkeyword
6589       \setbox0 = \hbox{}%
6590       \def\toctype{unn}%
6591       \gdef\currentsection{#1}%
6592     \else\ifx\temptype\Yomitfromtockeyword
6593       % for @headings -- no section number, don't include in toc,
6594       % and don't redefine \currentsection.
6595       \setbox0 = \hbox{}%
6596       \def\toctype{omit}%
6597       \let\sectionlevel=\empty
6598     \else\ifx\temptype\Yappendixkeyword
6599       \setbox0 = \hbox{#4\enspace}%
6600       \def\toctype{app}%
6601       \gdef\currentsection{#1}%
6602     \else
6603       \setbox0 = \hbox{#4\enspace}%
6604       \def\toctype{num}%
6605       \gdef\currentsection{#1}%
6606     \fi\fi\fi
6607     %
6608     % Write the toc entry (before \donoderef).  See comments in \chapmacro.
6609     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6610     %
6611     % Write the node reference (= pdf destination for pdftex).
6612     % Again, see comments in \chapmacro.
6613     \donoderef{#3}%
6614     %
6615     % Interline glue will be inserted when the vbox is completed.
6616     % That glue will be a valid breakpoint for the page, since it'll be
6617     % preceded by a whatsit (usually from the \donoderef, or from the
6618     % \writetocentry if there was no node).  We don't want to allow that
6619     % break, since then the whatsits could end up on page n while the
6620     % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
6621     \nobreak
6622     %
6623     % Output the actual section heading.
6624     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6625           \hangindent=\wd0  % zero if no section number
6626           \unhbox0 #1}%
6627   }%
6628   % Add extra space after the heading -- half of whatever came above it.
6629   % Don't allow stretch, though.
6630   \kern .5 \csname #2headingskip\endcsname
6631   %
6632   % Do not let the kern be a potential breakpoint, as it would be if it
6633   % was followed by glue.
6634   \nobreak
6635   %
6636   % We'll almost certainly start a paragraph next, so don't let that
6637   % glue accumulate.  (Not a breakpoint because it's preceded by a
6638   % discardable item.)  However, when a paragraph is not started next
6639   % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6640   % or the negative glue will cause weirdly wrong output, typically
6641   % obscuring the section heading with something else.
6642   \vskip-\parskip
6643   %
6644   % This is so the last item on the main vertical list is a known
6645   % \penalty > 10000, so \startdefun, etc., can recognize the situation
6646   % and do the needful.
6647   \penalty 10001
6648 }
6649
6650
6651 \message{toc,}
6652 % Table of contents.
6653 \newwrite\tocfile
6654
6655 % Write an entry to the toc file, opening it if necessary.
6656 % Called from @chapter, etc.
6657 %
6658 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6659 % We append the current node name (if any) and page number as additional
6660 % arguments for the \{chap,sec,...}entry macros which will eventually
6661 % read this.  The node name is used in the pdf outlines as the
6662 % destination to jump to.
6663 %
6664 % We open the .toc file for writing here instead of at @setfilename (or
6665 % any other fixed time) so that @contents can be anywhere in the document.
6666 % But if #1 is `omit', then we don't do anything.  This is used for the
6667 % table of contents chapter openings themselves.
6668 %
6669 \newif\iftocfileopened
6670 \def\omitkeyword{omit}%
6671 %
6672 \def\writetocentry#1#2#3{%
6673   \edef\writetoctype{#1}%
6674   \ifx\writetoctype\omitkeyword \else
6675     \iftocfileopened\else
6676       \immediate\openout\tocfile = \jobname.toc
6677       \global\tocfileopenedtrue
6678     \fi
6679     %
6680     \iflinks
6681       {\atdummies
6682        \edef\temp{%
6683          \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6684        \temp
6685       }%
6686     \fi
6687   \fi
6688   %
6689   % Tell \shipout to create a pdf destination on each page, if we're
6690   % writing pdf.  These are used in the table of contents.  We can't
6691   % just write one on every page because the title pages are numbered
6692   % 1 and 2 (the page numbers aren't printed), and so are the first
6693   % two pages of the document.  Thus, we'd have two destinations named
6694   % `1', and two named `2'.
6695   \ifpdforxetex
6696     \global\pdfmakepagedesttrue
6697   \fi
6698 }
6699
6700
6701 % These characters do not print properly in the Computer Modern roman
6702 % fonts, so we must take special care.  This is more or less redundant
6703 % with the Texinfo input format setup at the end of this file.
6704 %
6705 \def\activecatcodes{%
6706   \catcode`\"=\active
6707   \catcode`\$=\active
6708   \catcode`\<=\active
6709   \catcode`\>=\active
6710   \catcode`\\=\active
6711   \catcode`\^=\active
6712   \catcode`\_=\active
6713   \catcode`\|=\active
6714   \catcode`\~=\active
6715 }
6716
6717
6718 % Read the toc file, which is essentially Texinfo input.
6719 \def\readtocfile{%
6720   \setupdatafile
6721   \activecatcodes
6722   \input \tocreadfilename
6723 }
6724
6725 \newskip\contentsrightmargin \contentsrightmargin=1in
6726 \newcount\savepageno
6727 \newcount\lastnegativepageno \lastnegativepageno = -1
6728
6729 % Prepare to read what we've written to \tocfile.
6730 %
6731 \def\startcontents#1{%
6732   % If @setchapternewpage on, and @headings double, the contents should
6733   % start on an odd page, unlike chapters.
6734   \contentsalignmacro
6735   \immediate\closeout\tocfile
6736   %
6737   % Don't need to put `Contents' or `Short Contents' in the headline.
6738   % It is abundantly clear what they are.
6739   \chapmacro{#1}{Yomitfromtoc}{}%
6740   %
6741   \savepageno = \pageno
6742   \begingroup                  % Set up to handle contents files properly.
6743     \raggedbottom              % Worry more about breakpoints than the bottom.
6744     \entryrightmargin=\contentsrightmargin % Don't use the full line length.
6745     %
6746     % Roman numerals for page numbers.
6747     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6748     \def\thistitle{}% no title in double-sided headings
6749     % Record where the Roman numerals started.
6750     \ifnum\romancount=0 \global\romancount=\pagecount \fi
6751 }
6752
6753 % redefined for the two-volume lispref.  We always output on
6754 % \jobname.toc even if this is redefined.
6755 %
6756 \def\tocreadfilename{\jobname.toc}
6757
6758 % Normal (long) toc.
6759 %
6760 \def\contents{%
6761   \startcontents{\putwordTOC}%
6762     \openin 1 \tocreadfilename\space
6763     \ifeof 1 \else
6764       \readtocfile
6765     \fi
6766     \vfill \eject
6767     \contentsalignmacro % in case @setchapternewpage odd is in effect
6768     \ifeof 1 \else
6769       \pdfmakeoutlines
6770     \fi
6771     \closein 1
6772   \endgroup
6773   \contentsendroman
6774 }
6775
6776 % And just the chapters.
6777 \def\summarycontents{%
6778   \startcontents{\putwordShortTOC}%
6779     %
6780     \let\partentry = \shortpartentry
6781     \let\numchapentry = \shortchapentry
6782     \let\appentry = \shortchapentry
6783     \let\unnchapentry = \shortunnchapentry
6784     % We want a true roman here for the page numbers.
6785     \secfonts
6786     \let\rm=\shortcontrm \let\bf=\shortcontbf
6787     \let\sl=\shortcontsl \let\tt=\shortconttt
6788     \rm
6789     \hyphenpenalty = 10000
6790     \advance\baselineskip by 1pt % Open it up a little.
6791     \def\numsecentry##1##2##3##4{}
6792     \let\appsecentry = \numsecentry
6793     \let\unnsecentry = \numsecentry
6794     \let\numsubsecentry = \numsecentry
6795     \let\appsubsecentry = \numsecentry
6796     \let\unnsubsecentry = \numsecentry
6797     \let\numsubsubsecentry = \numsecentry
6798     \let\appsubsubsecentry = \numsecentry
6799     \let\unnsubsubsecentry = \numsecentry
6800     \openin 1 \tocreadfilename\space
6801     \ifeof 1 \else
6802       \readtocfile
6803     \fi
6804     \closein 1
6805     \vfill \eject
6806     \contentsalignmacro % in case @setchapternewpage odd is in effect
6807   \endgroup
6808   \contentsendroman
6809 }
6810 \let\shortcontents = \summarycontents
6811
6812 % Get ready to use Arabic numerals again
6813 \def\contentsendroman{%
6814   \lastnegativepageno = \pageno
6815   \global\pageno = \savepageno
6816   %
6817   % If \romancount > \arabiccount, the contents are at the end of the
6818   % document.  Otherwise, advance where the Arabic numerals start for
6819   % the page numbers.
6820   \ifnum\romancount>\arabiccount\else\global\arabiccount=\pagecount\fi
6821 }
6822
6823 % Typeset the label for a chapter or appendix for the short contents.
6824 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6825 %
6826 \def\shortchaplabel#1{%
6827   % This space should be enough, since a single number is .5em, and the
6828   % widest letter (M) is 1em, at least in the Computer Modern fonts.
6829   % But use \hss just in case.
6830   % (This space doesn't include the extra space that gets added after
6831   % the label; that gets put in by \shortchapentry above.)
6832   %
6833   % We'd like to right-justify chapter numbers, but that looks strange
6834   % with appendix letters.  And right-justifying numbers and
6835   % left-justifying letters looks strange when there is less than 10
6836   % chapters.  Have to read the whole toc once to know how many chapters
6837   % there are before deciding ...
6838   \hbox to 1em{#1\hss}%
6839 }
6840
6841 % These macros generate individual entries in the table of contents.
6842 % The first argument is the chapter or section name.
6843 % The last argument is the page number.
6844 % The arguments in between are the chapter number, section number, ...
6845
6846 % Parts, in the main contents.  Replace the part number, which doesn't
6847 % exist, with an empty box.  Let's hope all the numbers have the same width.
6848 % Also ignore the page number, which is conventionally not printed.
6849 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6850 \def\partentry#1#2#3#4{%
6851   % Add stretch and a bonus for breaking the page before the part heading.
6852   % This reduces the chance of the page being broken immediately after the
6853   % part heading, before a following chapter heading.
6854   \vskip 0pt plus 5\baselineskip
6855   \penalty-300
6856   \vskip 0pt plus -5\baselineskip
6857   \dochapentry{\numeralbox\labelspace#1}{}%
6858 }
6859 %
6860 % Parts, in the short toc.
6861 \def\shortpartentry#1#2#3#4{%
6862   \penalty-300
6863   \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6864   \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6865 }
6866
6867 % Chapters, in the main contents.
6868 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6869
6870 % Chapters, in the short toc.
6871 % See comments in \dochapentry re vbox and related settings.
6872 \def\shortchapentry#1#2#3#4{%
6873   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6874 }
6875
6876 % Appendices, in the main contents.
6877 % Need the word Appendix, and a fixed-size box.
6878 %
6879 \def\appendixbox#1{%
6880   % We use M since it's probably the widest letter.
6881   \setbox0 = \hbox{\putwordAppendix{} M}%
6882   \hbox to \wd0{\putwordAppendix{} #1\hss}}
6883 %
6884 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
6885
6886 % Unnumbered chapters.
6887 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6888 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6889
6890 % Sections.
6891 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6892 \let\appsecentry=\numsecentry
6893 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6894
6895 % Subsections.
6896 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6897 \let\appsubsecentry=\numsubsecentry
6898 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6899
6900 % And subsubsections.
6901 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6902 \let\appsubsubsecentry=\numsubsubsecentry
6903 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6904
6905 % This parameter controls the indentation of the various levels.
6906 % Same as \defaultparindent.
6907 \newdimen\tocindent \tocindent = 15pt
6908
6909 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6910 % page number.
6911 %
6912 % If the toc has to be broken over pages, we want it to be at chapters
6913 % if at all possible; hence the \penalty.
6914 \def\dochapentry#1#2{%
6915    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6916    \begingroup
6917      % Move the page numbers slightly to the right
6918      \advance\entryrightmargin by -0.05em
6919      \chapentryfonts
6920      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6921    \endgroup
6922    \nobreak\vskip .25\baselineskip plus.1\baselineskip
6923 }
6924
6925 \def\dosecentry#1#2{\begingroup
6926   \secentryfonts \leftskip=\tocindent
6927   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6928 \endgroup}
6929
6930 \def\dosubsecentry#1#2{\begingroup
6931   \subsecentryfonts \leftskip=2\tocindent
6932   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6933 \endgroup}
6934
6935 \def\dosubsubsecentry#1#2{\begingroup
6936   \subsubsecentryfonts \leftskip=3\tocindent
6937   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6938 \endgroup}
6939
6940 % We use the same \entry macro as for the index entries.
6941 \let\tocentry = \entry
6942
6943 % Space between chapter (or whatever) number and the title.
6944 \def\labelspace{\hskip1em \relax}
6945
6946 \def\dopageno#1{{\rm #1}}
6947 \def\doshortpageno#1{{\rm #1}}
6948
6949 \def\chapentryfonts{\secfonts \rm}
6950 \def\secentryfonts{\textfonts}
6951 \def\subsecentryfonts{\textfonts}
6952 \def\subsubsecentryfonts{\textfonts}
6953
6954
6955 \message{environments,}
6956 % @foo ... @end foo.
6957
6958 % @tex ... @end tex    escapes into raw TeX temporarily.
6959 % One exception: @ is still an escape character, so that @end tex works.
6960 % But \@ or @@ will get a plain @ character.
6961
6962 \envdef\tex{%
6963   \setregularquotes
6964   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6965   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6966   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6967   \catcode `\%=14
6968   \catcode `\+=\other
6969   \catcode `\"=\other
6970   \catcode `\|=\other
6971   \catcode `\<=\other
6972   \catcode `\>=\other
6973   \catcode `\`=\other
6974   \catcode `\'=\other
6975   %
6976   % ' is active in math mode (mathcode"8000).  So reset it, and all our
6977   % other math active characters (just in case), to plain's definitions.
6978   \mathactive
6979   %
6980   % Inverse of the list at the beginning of the file.
6981   \let\b=\ptexb
6982   \let\bullet=\ptexbullet
6983   \let\c=\ptexc
6984   \let\,=\ptexcomma
6985   \let\.=\ptexdot
6986   \let\dots=\ptexdots
6987   \let\equiv=\ptexequiv
6988   \let\!=\ptexexclam
6989   \let\i=\ptexi
6990   \let\indent=\ptexindent
6991   \let\noindent=\ptexnoindent
6992   \let\{=\ptexlbrace
6993   \let\+=\tabalign
6994   \let\}=\ptexrbrace
6995   \let\/=\ptexslash
6996   \let\sp=\ptexsp
6997   \let\*=\ptexstar
6998   %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6999   \let\t=\ptext
7000   \expandafter \let\csname top\endcsname=\ptextop  % we've made it outer
7001   \let\frenchspacing=\plainfrenchspacing
7002   %
7003   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
7004   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
7005   \def\@{@}%
7006 }
7007 % There is no need to define \Etex.
7008
7009 % Define @lisp ... @end lisp.
7010 % @lisp environment forms a group so it can rebind things,
7011 % including the definition of @end lisp (which normally is erroneous).
7012
7013 % Amount to narrow the margins by for @lisp.
7014 \newskip\lispnarrowing \lispnarrowing=0.4in
7015
7016 % This is the definition that ^^M gets inside @lisp, @example, and other
7017 % such environments.  \null is better than a space, since it doesn't
7018 % have any width.
7019 \def\lisppar{\null\endgraf}
7020
7021 % This space is always present above and below environments.
7022 \newskip\envskipamount \envskipamount = 0pt
7023
7024 % Make spacing and below environment symmetrical.  We use \parskip here
7025 % to help in doing that, since in @example-like environments \parskip
7026 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
7027 % start of the next paragraph will insert \parskip.
7028 %
7029 \def\aboveenvbreak{{%
7030   % =10000 instead of <10000 because of a special case in \itemzzz and
7031   % \sectionheading, q.v.
7032   \ifnum \lastpenalty=10000 \else
7033     \advance\envskipamount by \parskip
7034     \endgraf
7035     \ifdim\lastskip<\envskipamount
7036       \removelastskip
7037       \ifnum\lastpenalty<10000
7038         % Penalize breaking before the environment, because preceding text
7039         % often leads into it.
7040         \penalty100
7041       \fi
7042       \vskip\envskipamount
7043     \fi
7044   \fi
7045 }}
7046
7047 \def\afterenvbreak{{%
7048   % =10000 instead of <10000 because of a special case in \itemzzz and
7049   % \sectionheading, q.v.
7050   \ifnum \lastpenalty=10000 \else
7051     \advance\envskipamount by \parskip
7052     \endgraf
7053     \ifdim\lastskip<\envskipamount
7054       \removelastskip
7055       % it's not a good place to break if the last penalty was \nobreak
7056       % or better ...
7057       \ifnum\lastpenalty<10000 \penalty-50 \fi
7058       \vskip\envskipamount
7059     \fi
7060   \fi
7061 }}
7062
7063 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
7064 % also clear it, so that its embedded environments do the narrowing again.
7065 \let\nonarrowing=\relax
7066
7067 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
7068 % environment contents.
7069
7070 %
7071 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
7072 \def\ctr{{\hskip 6pt\circle\char'010}}
7073 \def\cbl{{\circle\char'012\hskip -6pt}}
7074 \def\cbr{{\hskip 6pt\circle\char'011}}
7075 \def\carttop{\hbox to \cartouter{\hskip\lskip
7076         \ctl\leaders\hrule height\circthick\hfil\ctr
7077         \hskip\rskip}}
7078 \def\cartbot{\hbox to \cartouter{\hskip\lskip
7079         \cbl\leaders\hrule height\circthick\hfil\cbr
7080         \hskip\rskip}}
7081 %
7082 \newskip\lskip\newskip\rskip
7083
7084 % only require the font if @cartouche is actually used
7085 \def\cartouchefontdefs{%
7086   \font\circle=lcircle10\relax
7087   \circthick=\fontdimen8\circle
7088 }
7089 \newdimen\circthick
7090 \newdimen\cartouter\newdimen\cartinner
7091 \newskip\normbskip\newskip\normpskip\newskip\normlskip
7092
7093
7094 \envdef\cartouche{%
7095   \cartouchefontdefs
7096   \ifhmode\par\fi  % can't be in the midst of a paragraph.
7097   \startsavinginserts
7098   \lskip=\leftskip \rskip=\rightskip
7099   \leftskip=0pt\rightskip=0pt % we want these *outside*.
7100   \cartinner=\hsize \advance\cartinner by-\lskip
7101   \advance\cartinner by-\rskip
7102   \cartouter=\hsize
7103   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
7104                                 % side, and for 6pt waste from
7105                                 % each corner char, and rule thickness
7106   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
7107   %
7108   % If this cartouche directly follows a sectioning command, we need the
7109   % \parskip glue (backspaced over by default) or the cartouche can
7110   % collide with the section heading.
7111   \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
7112   %
7113   \setbox\groupbox=\vbox\bgroup
7114       \baselineskip=0pt\parskip=0pt\lineskip=0pt
7115       \carttop
7116       \hbox\bgroup
7117           \hskip\lskip
7118           \vrule\kern3pt
7119           \vbox\bgroup
7120               \kern3pt
7121               \hsize=\cartinner
7122               \baselineskip=\normbskip
7123               \lineskip=\normlskip
7124               \parskip=\normpskip
7125               \vskip -\parskip
7126               \comment % For explanation, see the end of def\group.
7127 }
7128 \def\Ecartouche{%
7129               \ifhmode\par\fi
7130               \kern3pt
7131           \egroup
7132           \kern3pt\vrule
7133           \hskip\rskip
7134       \egroup
7135       \cartbot
7136   \egroup
7137   \addgroupbox
7138   \checkinserts
7139 }
7140
7141
7142 % This macro is called at the beginning of all the @example variants,
7143 % inside a group.
7144 \newdimen\nonfillparindent
7145 \def\nonfillstart{%
7146   \aboveenvbreak
7147   \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
7148   \sepspaces % Make spaces be word-separators rather than space tokens.
7149   \let\par = \lisppar % don't ignore blank lines
7150   \obeylines % each line of input is a line of output
7151   \parskip = 0pt
7152   % Turn off paragraph indentation but redefine \indent to emulate
7153   % the normal \indent.
7154   \nonfillparindent=\parindent
7155   \parindent = 0pt
7156   \let\indent\nonfillindent
7157   %
7158   \emergencystretch = 0pt % don't try to avoid overfull boxes
7159   \ifx\nonarrowing\relax
7160     \advance \leftskip by \lispnarrowing
7161     \exdentamount=\lispnarrowing
7162   \else
7163     \let\nonarrowing = \relax
7164   \fi
7165   \let\exdent=\nofillexdent
7166 }
7167
7168 \begingroup
7169 \obeyspaces
7170 % We want to swallow spaces (but not other tokens) after the fake
7171 % @indent in our nonfill-environments, where spaces are normally
7172 % active and set to @tie, resulting in them not being ignored after
7173 % @indent.
7174 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
7175 \gdef\nonfillindentcheck{%
7176 \ifx\temp %
7177 \expandafter\nonfillindentgobble%
7178 \else%
7179 \leavevmode\nonfillindentbox%
7180 \fi%
7181 }%
7182 \endgroup
7183 \def\nonfillindentgobble#1{\nonfillindent}
7184 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
7185
7186 % If you want all examples etc. small: @set dispenvsize small.
7187 % If you want even small examples the full size: @set dispenvsize nosmall.
7188 % This affects the following displayed environments:
7189 %    @example, @display, @format, @lisp, @verbatim
7190 %
7191 \def\smallword{small}
7192 \def\nosmallword{nosmall}
7193 \let\SETdispenvsize\relax
7194 \def\setnormaldispenv{%
7195   \ifx\SETdispenvsize\smallword
7196     % end paragraph for sake of leading, in case document has no blank
7197     % line.  This is redundant with what happens in \aboveenvbreak, but
7198     % we need to do it before changing the fonts, and it's inconvenient
7199     % to change the fonts afterward.
7200     \ifnum \lastpenalty=10000 \else \endgraf \fi
7201     \smallexamplefonts \rm
7202   \fi
7203 }
7204 \def\setsmalldispenv{%
7205   \ifx\SETdispenvsize\nosmallword
7206   \else
7207     \ifnum \lastpenalty=10000 \else \endgraf \fi
7208     \smallexamplefonts \rm
7209   \fi
7210 }
7211
7212 % We often define two environments, @foo and @smallfoo.
7213 % Let's do it in one command.  #1 is the env name, #2 the definition.
7214 \def\makedispenvdef#1#2{%
7215   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
7216   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
7217   \expandafter\let\csname E#1\endcsname \afterenvbreak
7218   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
7219 }
7220
7221 % Define two environment synonyms (#1 and #2) for an environment.
7222 \def\maketwodispenvdef#1#2#3{%
7223   \makedispenvdef{#1}{#3}%
7224   \makedispenvdef{#2}{#3}%
7225 }
7226 %
7227 % @lisp: indented, narrowed, typewriter font;
7228 % @example: same as @lisp.
7229 %
7230 % @smallexample and @smalllisp: use smaller fonts.
7231 % Originally contributed by Pavel@xerox.
7232 %
7233 \maketwodispenvdef{lisp}{example}{%
7234   \nonfillstart
7235   \tt\setcodequotes
7236   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
7237   \parsearg\gobble
7238 }
7239 % @display/@smalldisplay: same as @lisp except keep current font.
7240 %
7241 \makedispenvdef{display}{%
7242   \nonfillstart
7243   \gobble
7244 }
7245
7246 % @format/@smallformat: same as @display except don't narrow margins.
7247 %
7248 \makedispenvdef{format}{%
7249   \let\nonarrowing = t%
7250   \nonfillstart
7251   \gobble
7252 }
7253
7254 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
7255 \envdef\flushleft{%
7256   \let\nonarrowing = t%
7257   \nonfillstart
7258   \gobble
7259 }
7260 \let\Eflushleft = \afterenvbreak
7261
7262 % @flushright.
7263 %
7264 \envdef\flushright{%
7265   \let\nonarrowing = t%
7266   \nonfillstart
7267   \advance\leftskip by 0pt plus 1fill\relax
7268   \gobble
7269 }
7270 \let\Eflushright = \afterenvbreak
7271
7272
7273 % @raggedright does more-or-less normal line breaking but no right
7274 % justification.  From plain.tex.
7275 \envdef\raggedright{%
7276   \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
7277 }
7278 \let\Eraggedright\par
7279
7280 \envdef\raggedleft{%
7281   \parindent=0pt \leftskip0pt plus2em
7282   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7283   \hbadness=10000 % Last line will usually be underfull, so turn off
7284                   % badness reporting.
7285 }
7286 \let\Eraggedleft\par
7287
7288 \envdef\raggedcenter{%
7289   \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
7290   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7291   \hbadness=10000 % Last line will usually be underfull, so turn off
7292                   % badness reporting.
7293 }
7294 \let\Eraggedcenter\par
7295
7296
7297 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
7298 % and narrows the margins.  We keep \parskip nonzero in general, since
7299 % we're doing normal filling.  So, when using \aboveenvbreak and
7300 % \afterenvbreak, temporarily make \parskip 0.
7301 %
7302 \makedispenvdef{quotation}{\quotationstart}
7303 %
7304 \def\quotationstart{%
7305   \indentedblockstart % same as \indentedblock, but increase right margin too.
7306   \ifx\nonarrowing\relax
7307     \advance\rightskip by \lispnarrowing
7308   \fi
7309   \parsearg\quotationlabel
7310 }
7311
7312 % We have retained a nonzero parskip for the environment, since we're
7313 % doing normal filling.
7314 %
7315 \def\Equotation{%
7316   \par
7317   \ifx\quotationauthor\thisisundefined\else
7318     % indent a bit.
7319     \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
7320   \fi
7321   {\parskip=0pt \afterenvbreak}%
7322 }
7323 \def\Esmallquotation{\Equotation}
7324
7325 % If we're given an argument, typeset it in bold with a colon after.
7326 \def\quotationlabel#1{%
7327   \def\temp{#1}%
7328   \ifx\temp\empty \else
7329     {\bf #1: }%
7330   \fi
7331 }
7332
7333 % @indentedblock is like @quotation, but indents only on the left and
7334 % has no optional argument.
7335 %
7336 \makedispenvdef{indentedblock}{\indentedblockstart}
7337 %
7338 \def\indentedblockstart{%
7339   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
7340   \parindent=0pt
7341   %
7342   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
7343   \ifx\nonarrowing\relax
7344     \advance\leftskip by \lispnarrowing
7345     \exdentamount = \lispnarrowing
7346   \else
7347     \let\nonarrowing = \relax
7348   \fi
7349 }
7350
7351 % Keep a nonzero parskip for the environment, since we're doing normal filling.
7352 %
7353 \def\Eindentedblock{%
7354   \par
7355   {\parskip=0pt \afterenvbreak}%
7356 }
7357 \def\Esmallindentedblock{\Eindentedblock}
7358
7359
7360 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
7361 % If we want to allow any <char> as delimiter,
7362 % we need the curly braces so that makeinfo sees the @verb command, eg:
7363 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
7364 %
7365 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
7366 %
7367 % [Knuth] p.344; only we need to do the other characters Texinfo sets
7368 % active too.  Otherwise, they get lost as the first character on a
7369 % verbatim line.
7370 \def\dospecials{%
7371   \do\ \do\\\do\{\do\}\do\$\do\&%
7372   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
7373   \do\<\do\>\do\|\do\@\do+\do\"%
7374   % Don't do the quotes -- if we do, @set txicodequoteundirected and
7375   % @set txicodequotebacktick will not have effect on @verb and
7376   % @verbatim, and ?` and !` ligatures won't get disabled.
7377   %\do\`\do\'%
7378 }
7379 %
7380 % [Knuth] p. 380
7381 \def\uncatcodespecials{%
7382   \def\do##1{\catcode`##1=\other}\dospecials}
7383 %
7384 % Setup for the @verb command.
7385 %
7386 % Eight spaces for a tab
7387 \begingroup
7388   \catcode`\^^I=\active
7389   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
7390 \endgroup
7391 %
7392 \def\setupverb{%
7393   \tt  % easiest (and conventionally used) font for verbatim
7394   \def\par{\leavevmode\endgraf}%
7395   \setcodequotes
7396   \tabeightspaces
7397   % Respect line breaks,
7398   % print special symbols as themselves, and
7399   % make each space count
7400   % must do in this order:
7401   \obeylines \uncatcodespecials \sepspaces
7402 }
7403
7404 % Setup for the @verbatim environment
7405 %
7406 % Real tab expansion.
7407 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
7408 %
7409 % We typeset each line of the verbatim in an \hbox, so we can handle
7410 % tabs.
7411 \newbox\verbbox
7412 \def\starttabbox{\setbox\verbbox=\hbox\bgroup}
7413 %
7414 \begingroup
7415   \catcode`\^^I=\active
7416   \gdef\tabexpand{%
7417     \catcode`\^^I=\active
7418     \def^^I{\leavevmode\egroup
7419       \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
7420       \divide\dimen\verbbox by\tabw
7421       \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
7422       \advance\dimen\verbbox by\tabw  % advance to next multiple of \tabw
7423       \wd\verbbox=\dimen\verbbox
7424       \leavevmode\box\verbbox \starttabbox
7425     }%
7426   }
7427 \endgroup
7428
7429 % start the verbatim environment.
7430 \def\setupverbatim{%
7431   \let\nonarrowing = t%
7432   \nonfillstart
7433   \tt % easiest (and conventionally used) font for verbatim
7434   \def\par{\egroup\leavevmode\box\verbbox\endgraf\starttabbox}%
7435   \tabexpand
7436   \setcodequotes
7437   % Respect line breaks,
7438   % print special symbols as themselves, and
7439   % make each space count.
7440   % Must do in this order:
7441   \obeylines \uncatcodespecials \sepspaces
7442 }
7443
7444 % Do the @verb magic: verbatim text is quoted by unique
7445 % delimiter characters.  Before first delimiter expect a
7446 % right brace, after last delimiter expect closing brace:
7447 %
7448 %    \def\doverb'{'<char>#1<char>'}'{#1}
7449 %
7450 % [Knuth] p. 382; only eat outer {}
7451 \begingroup
7452   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
7453   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
7454 \endgroup
7455 %
7456 \def\verb{\begingroup\setupverb\doverb}
7457 %
7458 %
7459 % Do the @verbatim magic: define the macro \doverbatim so that
7460 % the (first) argument ends when '@end verbatim' is reached, ie:
7461 %
7462 %     \def\doverbatim#1@end verbatim{#1}
7463 %
7464 % For Texinfo it's a lot easier than for LaTeX,
7465 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
7466 % we need not redefine '\', '{' and '}'.
7467 %
7468 % Inspired by LaTeX's verbatim command set [latex.ltx]
7469 %
7470 \begingroup
7471   \catcode`\ =\active
7472   \obeylines %
7473   % ignore everything up to the first ^^M, that's the newline at the end
7474   % of the @verbatim input line itself.  Otherwise we get an extra blank
7475   % line in the output.
7476   \xdef\doverbatim#1^^M#2@end verbatim{%
7477     \starttabbox#2\egroup\noexpand\end\gobble verbatim}%
7478   % We really want {...\end verbatim} in the body of the macro, but
7479   % without the active space; thus we have to use \xdef and \gobble.
7480   % The \egroup ends the \verbbox started at the end of the last line in
7481   % the block.
7482 \endgroup
7483 %
7484 \envdef\verbatim{%
7485     \setnormaldispenv\setupverbatim\doverbatim
7486 }
7487 \let\Everbatim = \afterenvbreak
7488
7489
7490 % @verbatiminclude FILE - insert text of file in verbatim environment.
7491 %
7492 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
7493 %
7494 \def\doverbatiminclude#1{%
7495   {%
7496     \makevalueexpandable
7497     \setupverbatim
7498     {%
7499       \indexnofonts       % Allow `@@' and other weird things in file names.
7500       \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
7501       \edef\tmp{\noexpand\input #1 }
7502       \expandafter
7503     }\expandafter\starttabbox\tmp\egroup
7504     \afterenvbreak
7505   }%
7506 }
7507
7508 % @copying ... @end copying.
7509 % Save the text away for @insertcopying later.
7510 %
7511 % We save the uninterpreted tokens, rather than creating a box.
7512 % Saving the text in a box would be much easier, but then all the
7513 % typesetting commands (@smallbook, font changes, etc.) have to be done
7514 % beforehand -- and a) we want @copying to be done first in the source
7515 % file; b) letting users define the frontmatter in as flexible order as
7516 % possible is desirable.
7517 %
7518 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
7519 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
7520 %
7521 \def\insertcopying{%
7522   \begingroup
7523     \parindent = 0pt  % paragraph indentation looks wrong on title page
7524     \scanexp\copyingtext
7525   \endgroup
7526 }
7527
7528
7529 \message{defuns,}
7530 % @defun etc.
7531
7532 \newskip\defbodyindent \defbodyindent=.4in
7533 \newskip\defargsindent \defargsindent=50pt
7534 \newskip\deflastargmargin \deflastargmargin=18pt
7535 \newcount\defunpenalty
7536
7537 % Start the processing of @deffn:
7538 \def\startdefun{%
7539   \ifnum\lastpenalty<10000
7540     \medbreak
7541     \defunpenalty=10003 % Will keep this @deffn together with the
7542                         % following @def command, see below.
7543   \else
7544     % If there are two @def commands in a row, we'll have a \nobreak,
7545     % which is there to keep the function description together with its
7546     % header.  But if there's nothing but headers, we need to allow a
7547     % break somewhere.  Check specifically for penalty 10002, inserted
7548     % by \printdefunline, instead of 10000, since the sectioning
7549     % commands also insert a nobreak penalty, and we don't want to allow
7550     % a break between a section heading and a defun.
7551     %
7552     % As a further refinement, we avoid "club" headers by signalling
7553     % with penalty of 10003 after the very first @deffn in the
7554     % sequence (see above), and penalty of 10002 after any following
7555     % @def command.
7556     \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
7557     %
7558     % Similarly, after a section heading, do not allow a break.
7559     % But do insert the glue.
7560     \medskip  % preceded by discardable penalty, so not a breakpoint
7561   \fi
7562   %
7563   \parindent=0in
7564   \advance\leftskip by \defbodyindent
7565   \exdentamount=\defbodyindent
7566 }
7567
7568 \def\dodefunx#1{%
7569   % First, check whether we are in the right environment:
7570   \checkenv#1%
7571   %
7572   % As above, allow line break if we have multiple x headers in a row.
7573   % It's not a great place, though.
7574   \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
7575   %
7576   % And now, it's time to reuse the body of the original defun:
7577   \expandafter\gobbledefun#1%
7578 }
7579 \def\gobbledefun#1\startdefun{}
7580
7581 % \printdefunline \deffnheader{text}
7582 %
7583 \def\printdefunline#1#2{%
7584   \begingroup
7585     \plainfrenchspacing
7586     % call \deffnheader:
7587     #1#2 \endheader
7588     % common ending:
7589     \interlinepenalty = 10000
7590     \advance\rightskip by 0pt plus 1fil\relax
7591     \endgraf
7592     \nobreak\vskip -\parskip
7593     \penalty\defunpenalty  % signal to \startdefun and \dodefunx
7594     % Some of the @defun-type tags do not enable magic parentheses,
7595     % rendering the following check redundant.  But we don't optimize.
7596     \checkparencounts
7597   \endgroup
7598 }
7599
7600 \def\Edefun{\endgraf\medbreak}
7601
7602 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7603 % the only thing remaining is to define \deffnheader.
7604 %
7605 \def\makedefun#1{%
7606   \expandafter\let\csname E#1\endcsname = \Edefun
7607   \edef\temp{\noexpand\domakedefun
7608     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
7609   \temp
7610 }
7611
7612 % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
7613 %
7614 % Define \deffn and \deffnx, without parameters.
7615 % \deffnheader has to be defined explicitly.
7616 %
7617 \def\domakedefun#1#2#3{%
7618   \envdef#1{%
7619     \startdefun
7620     \doingtypefnfalse    % distinguish typed functions from all else
7621     \parseargusing\activeparens{\printdefunline#3}%
7622   }%
7623   \def#2{\dodefunx#1}%
7624   \def#3%
7625 }
7626
7627 \newif\ifdoingtypefn       % doing typed function?
7628 \newif\ifrettypeownline    % typeset return type on its own line?
7629
7630 % @deftypefnnewline on|off says whether the return type of typed functions
7631 % are printed on their own line.  This affects @deftypefn, @deftypefun,
7632 % @deftypeop, and @deftypemethod.
7633 %
7634 \parseargdef\deftypefnnewline{%
7635   \def\temp{#1}%
7636   \ifx\temp\onword
7637     \expandafter\let\csname SETtxideftypefnnl\endcsname
7638       = \empty
7639   \else\ifx\temp\offword
7640     \expandafter\let\csname SETtxideftypefnnl\endcsname
7641       = \relax
7642   \else
7643     \errhelp = \EMsimple
7644     \errmessage{Unknown @txideftypefnnl value `\temp',
7645                 must be on|off}%
7646   \fi\fi
7647 }
7648
7649 % \dosubind {index}{topic}{subtopic}
7650 %
7651 % If SUBTOPIC is present, precede it with a space, and call \doind.
7652 % (At some time during the 20th century, this made a two-level entry in an
7653 % index such as the operation index.  Nobody seemed to notice the change in
7654 % behaviour though.)
7655 \def\dosubind#1#2#3{%
7656   \def\thirdarg{#3}%
7657   \ifx\thirdarg\empty
7658     \doind{#1}{#2}%
7659   \else
7660     \doind{#1}{#2\space#3}%
7661   \fi
7662 }
7663
7664 % Untyped functions:
7665
7666 % @deffn category name args
7667 \makedefun{deffn}{\deffngeneral{}}
7668
7669 % @deffn category class name args
7670 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7671
7672 % \defopon {category on}class name args
7673 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7674
7675 % \deffngeneral {subind}category name args
7676 %
7677 \def\deffngeneral#1#2 #3 #4\endheader{%
7678   \dosubind{fn}{\code{#3}}{#1}%
7679   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7680 }
7681
7682 % Typed functions:
7683
7684 % @deftypefn category type name args
7685 \makedefun{deftypefn}{\deftypefngeneral{}}
7686
7687 % @deftypeop category class type name args
7688 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7689
7690 % \deftypeopon {category on}class type name args
7691 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7692
7693 % \deftypefngeneral {subind}category type name args
7694 %
7695 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7696   \dosubind{fn}{\code{#4}}{#1}%
7697   \doingtypefntrue
7698   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7699 }
7700
7701 % Typed variables:
7702
7703 % @deftypevr category type var args
7704 \makedefun{deftypevr}{\deftypecvgeneral{}}
7705
7706 % @deftypecv category class type var args
7707 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7708
7709 % \deftypecvof {category of}class type var args
7710 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7711
7712 % \deftypecvgeneral {subind}category type var args
7713 %
7714 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7715   \dosubind{vr}{\code{#4}}{#1}%
7716   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7717 }
7718
7719 % Untyped variables:
7720
7721 % @defvr category var args
7722 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7723
7724 % @defcv category class var args
7725 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7726
7727 % \defcvof {category of}class var args
7728 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7729
7730 % Types:
7731
7732 % @deftp category name args
7733 \makedefun{deftp}#1 #2 #3\endheader{%
7734   \doind{tp}{\code{#2}}%
7735   \defname{#1}{}{#2}\defunargs{#3\unskip}%
7736 }
7737
7738 % Remaining @defun-like shortcuts:
7739 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7740 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7741 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7742 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7743 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7744 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7745 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7746 \makedefun{defmethod}{\defopon\putwordMethodon}
7747 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7748 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7749 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7750
7751 % \defname, which formats the name of the @def (not the args).
7752 % #1 is the category, such as "Function".
7753 % #2 is the return type, if any.
7754 % #3 is the function name.
7755 %
7756 % We are followed by (but not passed) the arguments, if any.
7757 %
7758 \def\defname#1#2#3{%
7759   \par
7760   % Get the values of \leftskip and \rightskip as they were outside the @def...
7761   \advance\leftskip by -\defbodyindent
7762   %
7763   % Determine if we are typesetting the return type of a typed function
7764   % on a line by itself.
7765   \rettypeownlinefalse
7766   \ifdoingtypefn  % doing a typed function specifically?
7767     % then check user option for putting return type on its own line:
7768     \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7769       \rettypeownlinetrue
7770     \fi
7771   \fi
7772   %
7773   % How we'll format the category name.  Putting it in brackets helps
7774   % distinguish it from the body text that may end up on the next line
7775   % just below it.
7776   \def\temp{#1}%
7777   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7778   %
7779   % Figure out line sizes for the paragraph shape.  We'll always have at
7780   % least two.
7781   \tempnum = 2
7782   %
7783   % The first line needs space for \box0; but if \rightskip is nonzero,
7784   % we need only space for the part of \box0 which exceeds it:
7785   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
7786   %
7787   % If doing a return type on its own line, we'll have another line.
7788   \ifrettypeownline
7789     \advance\tempnum by 1
7790     \def\maybeshapeline{0in \hsize}%
7791   \else
7792     \def\maybeshapeline{}%
7793   \fi
7794   %
7795   % The continuations:
7796   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
7797   %
7798   % The final paragraph shape:
7799   \parshape \tempnum  0in \dimen0  \maybeshapeline  \defargsindent \dimen2
7800   %
7801   % Put the category name at the right margin.
7802   \noindent
7803   \hbox to 0pt{%
7804     \hfil\box0 \kern-\hsize
7805     % \hsize has to be shortened this way:
7806     \kern\leftskip
7807     % Intentionally do not respect \rightskip, since we need the space.
7808   }%
7809   %
7810   % Allow all lines to be underfull without complaint:
7811   \tolerance=10000 \hbadness=10000
7812   \exdentamount=\defbodyindent
7813   {%
7814     % defun fonts. We use typewriter by default (used to be bold) because:
7815     % . we're printing identifiers, they should be in tt in principle.
7816     % . in languages with many accents, such as Czech or French, it's
7817     %   common to leave accents off identifiers.  The result looks ok in
7818     %   tt, but exceedingly strange in rm.
7819     % . we don't want -- and --- to be treated as ligatures.
7820     % . this still does not fix the ?` and !` ligatures, but so far no
7821     %   one has made identifiers using them :).
7822     \df \tt
7823     \def\temp{#2}% text of the return type
7824     \ifx\temp\empty\else
7825       \tclose{\temp}% typeset the return type
7826       \ifrettypeownline
7827         % put return type on its own line; prohibit line break following:
7828         \hfil\vadjust{\nobreak}\break
7829       \else
7830         \space  % type on same line, so just followed by a space
7831       \fi
7832     \fi           % no return type
7833     #3% output function name
7834   }%
7835   {\rm\enskip}% hskip 0.5 em of \rmfont
7836   %
7837   \boldbrax
7838   % arguments will be output next, if any.
7839 }
7840
7841 % Print arguments in slanted roman (not ttsl), inconsistently with using
7842 % tt for the name.  This is because literal text is sometimes needed in
7843 % the argument list (groff manual), and ttsl and tt are not very
7844 % distinguishable.  Prevent hyphenation at `-' chars.
7845 %
7846 \def\defunargs#1{%
7847   % use sl by default (not ttsl),
7848   % tt for the names.
7849   \df \sl \hyphenchar\font=0
7850   %
7851   % On the other hand, if an argument has two dashes (for instance), we
7852   % want a way to get ttsl.  We used to recommend @var for that, so
7853   % leave the code in, but it's strange for @var to lead to typewriter.
7854   % Nowadays we recommend @code, since the difference between a ttsl hyphen
7855   % and a tt hyphen is pretty tiny.  @code also disables ?` !`.
7856   \def\var##1{{\setregularquotes\ttslanted{##1}}}%
7857   #1%
7858   \sl\hyphenchar\font=45
7859 }
7860
7861 % We want ()&[] to print specially on the defun line.
7862 %
7863 \def\activeparens{%
7864   \catcode`\(=\active \catcode`\)=\active
7865   \catcode`\[=\active \catcode`\]=\active
7866   \catcode`\&=\active
7867 }
7868
7869 % Make control sequences which act like normal parenthesis chars.
7870 \let\lparen = ( \let\rparen = )
7871
7872 % Be sure that we always have a definition for `(', etc.  For example,
7873 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7874 % so TeX would otherwise complain about undefined control sequence.
7875 {
7876   \activeparens
7877   \global\let(=\lparen \global\let)=\rparen
7878   \global\let[=\lbrack \global\let]=\rbrack
7879   \global\let& = \&
7880
7881   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7882   \gdef\magicamp{\let&=\amprm}
7883 }
7884 \let\ampchar\&
7885
7886 \newcount\parencount
7887
7888 % If we encounter &foo, then turn on ()-hacking afterwards
7889 \newif\ifampseen
7890 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7891
7892 \def\parenfont{%
7893   \ifampseen
7894     % At the first level, print parens in roman,
7895     % otherwise use the default font.
7896     \ifnum \parencount=1 \rm \fi
7897   \else
7898     % The \sf parens (in \boldbrax) actually are a little bolder than
7899     % the contained text.  This is especially needed for [ and ] .
7900     \sf
7901   \fi
7902 }
7903 \def\infirstlevel#1{%
7904   \ifampseen
7905     \ifnum\parencount=1
7906       #1%
7907     \fi
7908   \fi
7909 }
7910 \def\bfafterword#1 {#1 \bf}
7911
7912 \def\opnr{%
7913   \global\advance\parencount by 1
7914   {\parenfont(}%
7915   \infirstlevel \bfafterword
7916 }
7917 \def\clnr{%
7918   {\parenfont)}%
7919   \infirstlevel \sl
7920   \global\advance\parencount by -1
7921 }
7922
7923 \newcount\brackcount
7924 \def\lbrb{%
7925   \global\advance\brackcount by 1
7926   {\bf[}%
7927 }
7928 \def\rbrb{%
7929   {\bf]}%
7930   \global\advance\brackcount by -1
7931 }
7932
7933 \def\checkparencounts{%
7934   \ifnum\parencount=0 \else \badparencount \fi
7935   \ifnum\brackcount=0 \else \badbrackcount \fi
7936 }
7937 % these should not use \errmessage; the glibc manual, at least, actually
7938 % has such constructs (when documenting function pointers).
7939 \def\badparencount{%
7940   \message{Warning: unbalanced parentheses in @def...}%
7941   \global\parencount=0
7942 }
7943 \def\badbrackcount{%
7944   \message{Warning: unbalanced square brackets in @def...}%
7945   \global\brackcount=0
7946 }
7947
7948
7949 \message{macros,}
7950 % @macro.
7951
7952 % To do this right we need a feature of e-TeX, \scantokens,
7953 % which we arrange to emulate with a temporary file in ordinary TeX.
7954 \ifx\eTeXversion\thisisundefined
7955   \newwrite\macscribble
7956   \def\scantokens#1{%
7957     \toks0={#1}%
7958     \immediate\openout\macscribble=\jobname.tmp
7959     \immediate\write\macscribble{\the\toks0}%
7960     \immediate\closeout\macscribble
7961     \input \jobname.tmp
7962   }
7963 \fi
7964
7965 \let\E=\expandafter
7966
7967 % Used at the time of macro expansion.
7968 % Argument is macro body with arguments substituted
7969 \def\scanmacro#1{%
7970   \newlinechar`\^^M
7971   % expand the expansion of \eatleadingcr twice to maybe remove a leading
7972   % newline (and \else and \fi tokens), then call \eatspaces on the result.
7973   \def\xeatspaces##1{%
7974     \E\E\E\E\E\E\E\eatspaces\E\E\E\E\E\E\E{\eatleadingcr##1%
7975   }}%
7976   \def\xempty##1{}%
7977   %
7978   % Process the macro body under the current catcode regime.
7979   \scantokens{#1@comment}%
7980   %
7981   % The \comment is to remove the \newlinechar added by \scantokens, and
7982   % can be noticed by \parsearg.  Note \c isn't used because this means cedilla
7983   % in math mode.
7984 }
7985
7986 % Used for copying and captions
7987 \def\scanexp#1{%
7988   \expandafter\scanmacro\expandafter{#1}%
7989 }
7990
7991 \newcount\paramno   % Count of parameters
7992 \newtoks\macname    % Macro name
7993 \newif\ifrecursive  % Is it recursive?
7994
7995 % List of all defined macros in the form
7996 %    \commondummyword\macro1\commondummyword\macro2...
7997 % Currently is also contains all @aliases; the list can be split
7998 % if there is a need.
7999 \def\macrolist{}
8000
8001 % Add the macro to \macrolist
8002 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
8003 \def\addtomacrolistxxx#1{%
8004      \toks0 = \expandafter{\macrolist\commondummyword#1}%
8005      \xdef\macrolist{\the\toks0}%
8006 }
8007
8008 % Utility routines.
8009 % This does \let #1 = #2, with \csnames; that is,
8010 %   \let \csname#1\endcsname = \csname#2\endcsname
8011 % (except of course we have to play expansion games).
8012 %
8013 \def\cslet#1#2{%
8014   \expandafter\let
8015   \csname#1\expandafter\endcsname
8016   \csname#2\endcsname
8017 }
8018
8019 % Trim leading and trailing spaces off a string.
8020 % Concepts from aro-bend problem 15 (see CTAN).
8021 {\catcode`\@=11
8022 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
8023 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
8024 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
8025 \def\unbrace#1{#1}
8026 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
8027 }
8028
8029 {\catcode`\^^M=\other%
8030 \gdef\eatleadingcr#1{\if\noexpand#1\noexpand^^M\else\E#1\fi}}%
8031 % Warning: this won't work for a delimited argument
8032 % or for an empty argument
8033
8034 % Trim a single trailing ^^M off a string.
8035 {\catcode`\^^M=\other \catcode`\Q=3%
8036 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
8037 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
8038 \gdef\eatcrb#1Q#2Q{#1}%
8039 }
8040
8041 % Macro bodies are absorbed as an argument in a context where
8042 % all characters are catcode 10, 11 or 12, except \ which is active
8043 % (as in normal texinfo). It is necessary to change the definition of \
8044 % to recognize macro arguments; this is the job of \mbodybackslash.
8045 %
8046 % Non-ASCII encodings make 8-bit characters active, so un-activate
8047 % them to avoid their expansion.  Must do this non-globally, to
8048 % confine the change to the current group.
8049 %
8050 % It's necessary to have hard CRs when the macro is executed. This is
8051 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
8052 % body, and then making it the \newlinechar in \scanmacro.
8053 %
8054 \def\scanctxt{% used as subroutine
8055   \catcode`\"=\other
8056   \catcode`\+=\other
8057   \catcode`\<=\other
8058   \catcode`\>=\other
8059   \catcode`\^=\other
8060   \catcode`\_=\other
8061   \catcode`\|=\other
8062   \catcode`\~=\other
8063   \passthroughcharstrue
8064 }
8065
8066 \def\scanargctxt{% used for copying and captions, not macros.
8067   \scanctxt
8068   \catcode`\@=\other
8069   \catcode`\\=\other
8070   \catcode`\^^M=\other
8071 }
8072
8073 \def\macrobodyctxt{% used for @macro definitions
8074   \scanctxt
8075   \catcode`\ =\other
8076   \catcode`\@=\other
8077   \catcode`\{=\other
8078   \catcode`\}=\other
8079   \catcode`\^^M=\other
8080   \usembodybackslash
8081 }
8082
8083 % Used when scanning braced macro arguments.  Note, however, that catcode
8084 % changes here are ineffectual if the macro invocation was nested inside
8085 % an argument to another Texinfo command.
8086 \def\macroargctxt{%
8087   \scanctxt
8088   \catcode`\ =\active
8089   \catcode`\@=\other
8090   \catcode`\^^M=\other
8091   \catcode`\\=\active
8092 }
8093
8094 \def\macrolineargctxt{% used for whole-line arguments without braces
8095   \scanctxt
8096   \catcode`\@=\other
8097   \catcode`\{=\other
8098   \catcode`\}=\other
8099 }
8100
8101 % \mbodybackslash is the definition of \ in @macro bodies.
8102 % It maps \foo\ => \csname macarg.foo\endcsname => #N
8103 % where N is the macro parameter number.
8104 % We define \csname macarg.\endcsname to be \realbackslash, so
8105 % \\ in macro replacement text gets you a backslash.
8106 %
8107 {\catcode`@=0 @catcode`@\=@active
8108  @gdef@usembodybackslash{@let\=@mbodybackslash}
8109  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
8110 }
8111 \expandafter\def\csname macarg.\endcsname{\realbackslash}
8112
8113 \def\margbackslash#1{\char`\#1 }
8114
8115 \def\macro{\recursivefalse\parsearg\macroxxx}
8116 \def\rmacro{\recursivetrue\parsearg\macroxxx}
8117
8118 \def\macroxxx#1{%
8119   \getargs{#1}% now \macname is the macname and \argl the arglist
8120   \ifx\argl\empty       % no arguments
8121      \paramno=0\relax
8122   \else
8123      \expandafter\parsemargdef \argl;%
8124      \if\paramno>256\relax
8125        \ifx\eTeXversion\thisisundefined
8126          \errhelp = \EMsimple
8127          \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
8128        \fi
8129      \fi
8130   \fi
8131   \if1\csname ismacro.\the\macname\endcsname
8132      \message{Warning: redefining \the\macname}%
8133   \else
8134      \expandafter\ifx\csname \the\macname\endcsname \relax
8135      \else \errmessage{Macro name \the\macname\space already defined}\fi
8136      \global\cslet{macsave.\the\macname}{\the\macname}%
8137      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
8138      \addtomacrolist{\the\macname}%
8139   \fi
8140   \begingroup \macrobodyctxt
8141   \ifrecursive \expandafter\parsermacbody
8142   \else \expandafter\parsemacbody
8143   \fi}
8144
8145 \parseargdef\unmacro{%
8146   \if1\csname ismacro.#1\endcsname
8147     \global\cslet{#1}{macsave.#1}%
8148     \global\expandafter\let \csname ismacro.#1\endcsname=0%
8149     % Remove the macro name from \macrolist:
8150     \begingroup
8151       \expandafter\let\csname#1\endcsname \relax
8152       \let\commondummyword\unmacrodo
8153       \xdef\macrolist{\macrolist}%
8154     \endgroup
8155   \else
8156     \errmessage{Macro #1 not defined}%
8157   \fi
8158 }
8159
8160 % Called by \do from \dounmacro on each macro.  The idea is to omit any
8161 % macro definitions that have been changed to \relax.
8162 %
8163 \def\unmacrodo#1{%
8164   \ifx #1\relax
8165     % remove this
8166   \else
8167     \noexpand\commondummyword \noexpand#1%
8168   \fi
8169 }
8170
8171 % \getargs -- Parse the arguments to a @macro line.  Set \macname to
8172 % the name of the macro, and \argl to the braced argument list.
8173 \def\getargs#1{\getargsxxx#1{}}
8174 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
8175 \def\getmacname#1 #2\relax{\macname={#1}}
8176 \def\getmacargs#1{\def\argl{#1}}
8177 % This made use of the feature that if the last token of a
8178 % <parameter list> is #, then the preceding argument is delimited by
8179 % an opening brace, and that opening brace is not consumed.
8180
8181 % Parse the optional {params} list to @macro or @rmacro.
8182 % Set \paramno to the number of arguments,
8183 % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
8184 % three-param macro.)  Define \macarg.BLAH for each BLAH in the params
8185 % list to some hook where the argument is to be expanded.  If there are
8186 % less than 10 arguments that hook is to be replaced by ##N where N
8187 % is the position in that list, that is to say the macro arguments are to be
8188 % defined `a la TeX in the macro body.
8189 %
8190 % That gets used by \mbodybackslash (above).
8191 %
8192 % If there are 10 or more arguments, a different technique is used: see
8193 % \parsemmanyargdef.
8194 %
8195 \def\parsemargdef#1;{%
8196   \paramno=0\def\paramlist{}%
8197   \let\hash\relax
8198   % \hash is redefined to `#' later to get it into definitions
8199   \let\xeatspaces\relax
8200   \let\xempty\relax
8201   \parsemargdefxxx#1,;,%
8202   \ifnum\paramno<10\relax\else
8203     \paramno0\relax
8204     \parsemmanyargdef@@#1,;,% 10 or more arguments
8205   \fi
8206 }
8207 \def\parsemargdefxxx#1,{%
8208   \if#1;\let\next=\relax
8209   \else \let\next=\parsemargdefxxx
8210     \advance\paramno by 1
8211     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
8212         {\xeatspaces{\hash\the\paramno\noexpand\xempty{}}}%
8213     \edef\paramlist{\paramlist\hash\the\paramno,}%
8214   \fi\next}
8215 % the \xempty{} is to give \eatleadingcr an argument in the case of an
8216 % empty macro argument.
8217
8218 % \parsemacbody, \parsermacbody
8219 %
8220 % Read recursive and nonrecursive macro bodies. (They're different since
8221 % rec and nonrec macros end differently.)
8222 %
8223 % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro
8224 % body to be transformed.
8225 % Set \macrobody to the body of the macro, and call \defmacro.
8226 %
8227 {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
8228 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8229 {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
8230 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8231
8232 % Make @ a letter, so that we can make private-to-Texinfo macro names.
8233 \edef\texiatcatcode{\the\catcode`\@}
8234 \catcode `@=11\relax
8235
8236 %%%%%%%%%%%%%% Code for > 10 arguments only   %%%%%%%%%%%%%%%%%%
8237
8238 % If there are 10 or more arguments, a different technique is used, where the
8239 % hook remains in the body, and when macro is to be expanded the body is
8240 % processed again to replace the arguments.
8241 %
8242 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
8243 % argument N value and then \edef the body (nothing else will expand because of
8244 % the catcode regime under which the body was input).
8245 %
8246 % If you compile with TeX (not eTeX), and you have macros with 10 or more
8247 % arguments, no macro can have more than 256 arguments (else error).
8248 %
8249 % In case that there are 10 or more arguments we parse again the arguments
8250 % list to set new definitions for the \macarg.BLAH macros corresponding to
8251 % each BLAH argument. It was anyhow needed to parse already once this list
8252 % in order to count the arguments, and as macros with at most 9 arguments
8253 % are by far more frequent than macro with 10 or more arguments, defining
8254 % twice the \macarg.BLAH macros does not cost too much processing power.
8255 \def\parsemmanyargdef@@#1,{%
8256   \if#1;\let\next=\relax
8257   \else
8258     \let\next=\parsemmanyargdef@@
8259     \edef\tempb{\eatspaces{#1}}%
8260     \expandafter\def\expandafter\tempa
8261        \expandafter{\csname macarg.\tempb\endcsname}%
8262     % Note that we need some extra \noexpand\noexpand, this is because we
8263     % don't want \the  to be expanded in the \parsermacbody  as it uses an
8264     % \xdef .
8265     \expandafter\edef\tempa
8266       {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
8267     \advance\paramno by 1\relax
8268   \fi\next}
8269
8270
8271 \let\endargs@\relax
8272 \let\nil@\relax
8273 \def\nilm@{\nil@}%
8274 \long\def\nillm@{\nil@}%
8275
8276 % This macro is expanded during the Texinfo macro expansion, not during its
8277 % definition.  It gets all the arguments' values and assigns them to macros
8278 % macarg.ARGNAME
8279 %
8280 % #1 is the macro name
8281 % #2 is the list of argument names
8282 % #3 is the list of argument values
8283 \def\getargvals@#1#2#3{%
8284   \def\macargdeflist@{}%
8285   \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
8286   \def\paramlist{#2,\nil@}%
8287   \def\macroname{#1}%
8288   \begingroup
8289   \macroargctxt
8290   \def\argvaluelist{#3,\nil@}%
8291   \def\@tempa{#3}%
8292   \ifx\@tempa\empty
8293     \setemptyargvalues@
8294   \else
8295     \getargvals@@
8296   \fi
8297 }
8298 \def\getargvals@@{%
8299   \ifx\paramlist\nilm@
8300       % Some sanity check needed here that \argvaluelist is also empty.
8301       \ifx\argvaluelist\nillm@
8302       \else
8303         \errhelp = \EMsimple
8304         \errmessage{Too many arguments in macro `\macroname'!}%
8305       \fi
8306       \let\next\macargexpandinbody@
8307   \else
8308     \ifx\argvaluelist\nillm@
8309        % No more arguments values passed to macro.  Set remaining named-arg
8310        % macros to empty.
8311        \let\next\setemptyargvalues@
8312     \else
8313       % pop current arg name into \@tempb
8314       \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
8315       \expandafter\@tempa\expandafter{\paramlist}%
8316        % pop current argument value into \@tempc
8317       \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
8318       \expandafter\@tempa\expandafter{\argvaluelist}%
8319        % Here \@tempb is the current arg name and \@tempc is the current arg value.
8320        % First place the new argument macro definition into \@tempd
8321        \expandafter\macname\expandafter{\@tempc}%
8322        \expandafter\let\csname macarg.\@tempb\endcsname\relax
8323        \expandafter\def\expandafter\@tempe\expandafter{%
8324          \csname macarg.\@tempb\endcsname}%
8325        \edef\@tempd{\long\def\@tempe{\the\macname}}%
8326        \push@\@tempd\macargdeflist@
8327        \let\next\getargvals@@
8328     \fi
8329   \fi
8330   \next
8331 }
8332
8333 \def\push@#1#2{%
8334   \expandafter\expandafter\expandafter\def
8335   \expandafter\expandafter\expandafter#2%
8336   \expandafter\expandafter\expandafter{%
8337   \expandafter#1#2}%
8338 }
8339
8340 % Replace arguments by their values in the macro body, and place the result
8341 % in macro \@tempa.
8342 %
8343 \def\macvalstoargs@{%
8344   %  To do this we use the property that token registers that are \the'ed
8345   % within an \edef  expand only once. So we are going to place all argument
8346   % values into respective token registers.
8347   %
8348   % First we save the token context, and initialize argument numbering.
8349   \begingroup
8350     \paramno0\relax
8351     % Then, for each argument number #N, we place the corresponding argument
8352     % value into a new token list register \toks#N
8353     \expandafter\putargsintokens@\saveparamlist@,;,%
8354     % Then, we expand the body so that argument are replaced by their
8355     % values. The trick for values not to be expanded themselves is that they
8356     % are within tokens and that tokens expand only once in an \edef .
8357     \edef\@tempc{\csname mac.\macroname .body\endcsname}%
8358     % Now we restore the token stack pointer to free the token list registers
8359     % which we have used, but we make sure that expanded body is saved after
8360     % group.
8361     \expandafter
8362   \endgroup
8363   \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
8364   }
8365
8366 % Define the named-macro outside of this group and then close this group.
8367 %
8368 \def\macargexpandinbody@{%
8369   \expandafter
8370   \endgroup
8371   \macargdeflist@
8372   % First the replace in body the macro arguments by their values, the result
8373   % is in \@tempa .
8374   \macvalstoargs@
8375   % Then we point at the \norecurse or \gobble (for recursive) macro value
8376   % with \@tempb .
8377   \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
8378   % Depending on whether it is recursive or not, we need some tailing
8379   % \egroup .
8380   \ifx\@tempb\gobble
8381      \let\@tempc\relax
8382   \else
8383      \let\@tempc\egroup
8384   \fi
8385   % And now we do the real job:
8386   \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
8387   \@tempd
8388 }
8389
8390 \def\putargsintokens@#1,{%
8391   \if#1;\let\next\relax
8392   \else
8393     \let\next\putargsintokens@
8394     % First we allocate the new token list register, and give it a temporary
8395     % alias \@tempb .
8396     \toksdef\@tempb\the\paramno
8397     % Then we place the argument value into that token list register.
8398     \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
8399     \expandafter\@tempb\expandafter{\@tempa}%
8400     \advance\paramno by 1\relax
8401   \fi
8402   \next
8403 }
8404
8405 % Trailing missing arguments are set to empty.
8406 %
8407 \def\setemptyargvalues@{%
8408   \ifx\paramlist\nilm@
8409     \let\next\macargexpandinbody@
8410   \else
8411     \expandafter\setemptyargvaluesparser@\paramlist\endargs@
8412     \let\next\setemptyargvalues@
8413   \fi
8414   \next
8415 }
8416
8417 \def\setemptyargvaluesparser@#1,#2\endargs@{%
8418   \expandafter\def\expandafter\@tempa\expandafter{%
8419     \expandafter\def\csname macarg.#1\endcsname{}}%
8420   \push@\@tempa\macargdeflist@
8421   \def\paramlist{#2}%
8422 }
8423
8424 % #1 is the element target macro
8425 % #2 is the list macro
8426 % #3,#4\endargs@ is the list value
8427 \def\pop@#1#2#3,#4\endargs@{%
8428    \def#1{#3}%
8429    \def#2{#4}%
8430 }
8431 \long\def\longpop@#1#2#3,#4\endargs@{%
8432    \long\def#1{#3}%
8433    \long\def#2{#4}%
8434 }
8435
8436
8437 %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
8438
8439
8440 % This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
8441 %    \macrobody has the body of the macro in it, with placeholders for
8442 % its parameters, looking like "\xeatspaces{\hash 1}".
8443 %    \paramno is the number of parameters
8444 %    \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
8445 % There are four cases: macros of zero, one, up to nine, and many arguments.
8446 % \xdef is used so that macro definitions will survive the file
8447 % they're defined in: @include reads the file inside a group.
8448 %
8449 \def\defmacro{%
8450   \let\hash=##% convert placeholders to macro parameter chars
8451   \ifnum\paramno=1
8452     \def\xeatspaces##1{##1}%
8453     % This removes the pair of braces around the argument.  We don't
8454     % use \eatspaces, because this can cause ends of lines to be lost
8455     % when the argument to \eatspaces is read, leading to line-based
8456     % commands like "@itemize" not being read correctly.
8457   \else
8458     \let\xeatspaces\relax % suppress expansion
8459   \fi
8460   \ifcase\paramno
8461   % 0
8462     \expandafter\xdef\csname\the\macname\endcsname{%
8463       \bgroup
8464         \noexpand\spaceisspace
8465         \noexpand\endlineisspace
8466         \noexpand\expandafter % skip any whitespace after the macro name.
8467         \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8468     \expandafter\xdef\csname\the\macname @@@\endcsname{%
8469       \egroup
8470       \noexpand\scanmacro{\macrobody}}%
8471   \or % 1
8472     \expandafter\xdef\csname\the\macname\endcsname{%
8473        \bgroup
8474        \noexpand\braceorline
8475        \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8476     \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8477       \egroup
8478       \noexpand\scanmacro{\macrobody}%
8479       }%
8480   \else % at most 9
8481     \ifnum\paramno<10\relax
8482       % @MACNAME sets the context for reading the macro argument
8483       % @MACNAME@@ gets the argument, processes backslashes and appends a
8484       % comma.
8485       % @MACNAME@@@ removes braces surrounding the argument list.
8486       % @MACNAME@@@@ scans the macro body with arguments substituted.
8487       \expandafter\xdef\csname\the\macname\endcsname{%
8488         \bgroup
8489         \noexpand\expandafter  % This \expandafter skip any spaces after the
8490         \noexpand\macroargctxt % macro before we change the catcode of space.
8491         \noexpand\expandafter
8492         \expandafter\noexpand\csname\the\macname @@\endcsname}%
8493       \expandafter\xdef\csname\the\macname @@\endcsname##1{%
8494           \noexpand\passargtomacro
8495           \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
8496       \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8497           \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
8498       \expandafter\expandafter
8499       \expandafter\xdef
8500       \expandafter\expandafter
8501         \csname\the\macname @@@@\endcsname\paramlist{%
8502           \egroup\noexpand\scanmacro{\macrobody}}%
8503     \else % 10 or more:
8504       \expandafter\xdef\csname\the\macname\endcsname{%
8505         \noexpand\getargvals@{\the\macname}{\argl}%
8506       }%
8507       \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
8508       \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
8509     \fi
8510   \fi}
8511
8512 \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
8513
8514 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
8515
8516
8517 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8518 %
8519 {\catcode`\@=0 \catcode`\\=13  % We need to manipulate \ so use @ as escape
8520 @catcode`@_=11  % private names
8521 @catcode`@!=11  % used as argument separator
8522
8523 % \passargtomacro#1#2 -
8524 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
8525 % compressed to one.
8526 %
8527 % This implementation works by expansion, and not execution (so we cannot use
8528 % \def or similar).  This reduces the risk of this failing in contexts where
8529 % complete expansion is done with no execution (for example, in writing out to
8530 % an auxiliary file for an index entry).
8531 %
8532 % State is kept in the input stream: the argument passed to
8533 % @look_ahead, @gobble_and_check_finish and @add_segment is
8534 %
8535 % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN  (... rest of input)
8536 %
8537 % where:
8538 % THE_MACRO - name of the macro we want to call
8539 % ARG_RESULT - argument list we build to pass to that macro
8540 % PENDING_BS - either a backslash or nothing
8541 % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
8542
8543 @gdef@passargtomacro#1#2{%
8544   @add_segment #1!{}@relax#2\@_finish\%
8545 }
8546 @gdef@_finish{@_finishx} @global@let@_finishx@relax
8547
8548 % #1 - THE_MACRO ARG_RESULT
8549 % #2 - PENDING_BS
8550 % #3 - NEXT_TOKEN
8551 % #4 used to look ahead
8552 %
8553 % If the next token is not a backslash, process the rest of the argument;
8554 % otherwise, remove the next token.
8555 @gdef@look_ahead#1!#2#3#4{%
8556   @ifx#4\%
8557    @expandafter@gobble_and_check_finish
8558   @else
8559    @expandafter@add_segment
8560   @fi#1!{#2}#4#4%
8561 }
8562
8563 % #1 - THE_MACRO ARG_RESULT
8564 % #2 - PENDING_BS
8565 % #3 - NEXT_TOKEN
8566 % #4 should be a backslash, which is gobbled.
8567 % #5 looks ahead
8568 %
8569 % Double backslash found.  Add a single backslash, and look ahead.
8570 @gdef@gobble_and_check_finish#1!#2#3#4#5{%
8571   @add_segment#1\!{}#5#5%
8572 }
8573
8574 @gdef@is_fi{@fi}
8575
8576 % #1 - THE_MACRO ARG_RESULT
8577 % #2 - PENDING_BS
8578 % #3 - NEXT_TOKEN
8579 % #4 is input stream until next backslash
8580 %
8581 % Input stream is either at the start of the argument, or just after a
8582 % backslash sequence, either a lone backslash, or a doubled backslash.
8583 % NEXT_TOKEN contains the first token in the input stream: if it is \finish,
8584 % finish; otherwise, append to ARG_RESULT the segment of the argument up until
8585 % the next backslash.  PENDING_BACKSLASH contains a backslash to represent
8586 % a backslash just before the start of the input stream that has not been
8587 % added to ARG_RESULT.
8588 @gdef@add_segment#1!#2#3#4\{%
8589 @ifx#3@_finish
8590   @call_the_macro#1!%
8591 @else
8592   % append the pending backslash to the result, followed by the next segment
8593   @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
8594   % this @fi is discarded by @look_ahead.
8595   % we can't get rid of it with \expandafter because we don't know how
8596   % long #4 is.
8597 }
8598
8599 % #1 - THE_MACRO
8600 % #2 - ARG_RESULT
8601 % #3 discards the res of the conditional in @add_segment, and @is_fi ends the
8602 % conditional.
8603 @gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
8604
8605 }
8606 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8607
8608 % \braceorline MAC is used for a one-argument macro MAC.  It checks
8609 % whether the next non-whitespace character is a {.  It sets the context
8610 % for reading the argument (slightly different in the two cases).  Then,
8611 % to read the argument, in the whole-line case, it then calls the regular
8612 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8613 %
8614 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
8615 \def\braceorlinexxx{%
8616   \ifx\nchar\bgroup
8617     \macroargctxt
8618     \expandafter\passargtomacro
8619   \else
8620     \macrolineargctxt\expandafter\parsearg
8621   \fi \macnamexxx}
8622
8623
8624 % @alias.
8625 % We need some trickery to remove the optional spaces around the equal
8626 % sign.  Make them active and then expand them all to nothing.
8627 %
8628 \def\alias{\parseargusing\obeyspaces\aliasxxx}
8629 \def\aliasxxx #1{\aliasyyy#1\relax}
8630 \def\aliasyyy #1=#2\relax{%
8631   {%
8632     \expandafter\let\obeyedspace=\empty
8633     \addtomacrolist{#1}%
8634     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
8635   }%
8636   \next
8637 }
8638
8639
8640 \message{cross references,}
8641
8642 \newwrite\auxfile
8643 \newif\ifhavexrefs    % True if xref values are known.
8644 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
8645
8646 % @inforef is relatively simple.
8647 \def\inforef #1{\inforefzzz #1,,,,**}
8648 \def\inforefzzz #1,#2,#3,#4**{%
8649   \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8650   node \samp{\ignorespaces#1{}}}
8651
8652 % @node's only job in TeX is to define \lastnode, which is used in
8653 % cross-references.  The @node line might or might not have commas, and
8654 % might or might not have spaces before the first comma, like:
8655 % @node foo , bar , ...
8656 % We don't want such trailing spaces in the node name.
8657 %
8658 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
8659 %
8660 % also remove a trailing comma, in case of something like this:
8661 % @node Help-Cross,  ,  , Cross-refs
8662 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
8663 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}\omittopnode}
8664
8665 % Used so that the @top node doesn't have to be wrapped in an @ifnottex
8666 % conditional.
8667 % \doignore goes to more effort to skip nested conditionals but we don't need
8668 % that here.
8669 \def\omittopnode{%
8670    \ifx\lastnode\wordTop
8671    \expandafter\ignorenode\fi
8672 }
8673 \def\wordTop{Top}
8674
8675 % Until the next @node, @part or @bye command, divert output to a box that
8676 % is not output.
8677 \def\ignorenode{\setbox\dummybox\vbox\bgroup
8678 \def\part{\egroup\part}%
8679 \def\node{\egroup\node}%
8680 \ignorenodebye
8681 }
8682
8683 {\let\bye\relax
8684 \gdef\ignorenodebye{\let\bye\ignorenodebyedef}
8685 \gdef\ignorenodebyedef{\egroup(`Top' node ignored)\bye}}
8686 % The redefinition of \bye here is because it is declared \outer
8687
8688 \let\lastnode=\empty
8689
8690 % Write a cross-reference definition for the current node.  #1 is the
8691 % type (Ynumbered, Yappendix, Ynothing).
8692 %
8693 \def\donoderef#1{%
8694   \ifx\lastnode\empty\else
8695     \setref{\lastnode}{#1}%
8696     \global\let\lastnode=\empty
8697   \fi
8698 }
8699
8700 % @anchor{NAME} -- define xref target at arbitrary point.
8701 %
8702 \newcount\savesfregister
8703 %
8704 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
8705 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
8706 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
8707
8708 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8709 % anchor), which consists of three parts:
8710 % 1) NAME-title - the current sectioning name taken from \currentsection,
8711 %                 or the anchor name.
8712 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
8713 %                 empty for anchors.
8714 % 3) NAME-pg    - the page number.
8715 %
8716 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
8717 % floats, there is an additional part, which is not written here:
8718 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
8719 %
8720 \def\setref#1#2{%
8721   \pdfmkdest{#1}%
8722   \iflinks
8723     {%
8724       \requireauxfile
8725       \atdummies  % preserve commands, but don't expand them
8726       % match definition in \xrdef, \refx, \xrefX.
8727       \def\value##1{##1}%
8728       \edef\writexrdef##1##2{%
8729         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
8730           ##1}{##2}}% these are parameters of \writexrdef
8731       }%
8732       \toks0 = \expandafter{\currentsection}%
8733       \immediate \writexrdef{title}{\the\toks0 }%
8734       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
8735       \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
8736     }%
8737   \fi
8738 }
8739
8740 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8741 % automatically in xrefs, if the third arg is not explicitly specified.
8742 % This was provided as a "secret" @set xref-automatic-section-title
8743 % variable, now it's official.
8744 %
8745 \parseargdef\xrefautomaticsectiontitle{%
8746   \def\temp{#1}%
8747   \ifx\temp\onword
8748     \expandafter\let\csname SETxref-automatic-section-title\endcsname
8749       = \empty
8750   \else\ifx\temp\offword
8751     \expandafter\let\csname SETxref-automatic-section-title\endcsname
8752       = \relax
8753   \else
8754     \errhelp = \EMsimple
8755     \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
8756                 must be on|off}%
8757   \fi\fi
8758 }
8759
8760 %
8761 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
8762 % the node name, #2 the name of the Info cross-reference, #3 the printed
8763 % node name, #4 the name of the Info file, #5 the name of the printed
8764 % manual.  All but the node name can be omitted.
8765 %
8766 \def\pxref{\putwordsee{} \xrefXX}
8767 \def\xref{\putwordSee{} \xrefXX}
8768 \def\ref{\xrefXX}
8769
8770 \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
8771 \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
8772 %
8773 \newbox\toprefbox
8774 \newbox\printedrefnamebox
8775 \newbox\infofilenamebox
8776 \newbox\printedmanualbox
8777 %
8778 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8779   \unsepspaces
8780   %
8781   % Get args without leading/trailing spaces.
8782   \def\printedrefname{\ignorespaces #3}%
8783   \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8784   %
8785   \def\infofilename{\ignorespaces #4}%
8786   \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8787   %
8788   \def\printedmanual{\ignorespaces #5}%
8789   \setbox\printedmanualbox  = \hbox{\printedmanual\unskip}%
8790   %
8791   % If the printed reference name (arg #3) was not explicitly given in
8792   % the @xref, figure out what we want to use.
8793   \ifdim \wd\printedrefnamebox = 0pt
8794     % No printed node name was explicitly given.
8795     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8796       % Not auto section-title: use node name inside the square brackets.
8797       \def\printedrefname{\ignorespaces #1}%
8798     \else
8799       % Auto section-title: use chapter/section title inside
8800       % the square brackets if we have it.
8801       \ifdim \wd\printedmanualbox > 0pt
8802         % It is in another manual, so we don't have it; use node name.
8803         \def\printedrefname{\ignorespaces #1}%
8804       \else
8805         \ifhavexrefs
8806           % We (should) know the real title if we have the xref values.
8807           \def\printedrefname{\refx{#1-title}}%
8808         \else
8809           % Otherwise just copy the Info node name.
8810           \def\printedrefname{\ignorespaces #1}%
8811         \fi%
8812       \fi
8813     \fi
8814   \fi
8815   %
8816   % Make link in pdf output.
8817   \ifpdf
8818     % For pdfTeX and LuaTeX
8819     {\indexnofonts
8820      \makevalueexpandable
8821      \turnoffactive
8822      % This expands tokens, so do it after making catcode changes, so _
8823      % etc. don't get their TeX definitions.  This ignores all spaces in
8824      % #4, including (wrongly) those in the middle of the filename.
8825      \getfilename{#4}%
8826      %
8827      % This (wrongly) does not take account of leading or trailing
8828      % spaces in #1, which should be ignored.
8829      \setpdfdestname{#1}%
8830      %
8831      \ifx\pdfdestname\empty
8832        \def\pdfdestname{Top}% no empty targets
8833      \fi
8834      %
8835      \leavevmode
8836      \startlink attr{/Border [0 0 0]}%
8837      \ifnum\filenamelength>0
8838        goto file{\the\filename.pdf} name{\pdfdestname}%
8839      \else
8840        goto name{\pdfmkpgn{\pdfdestname}}%
8841      \fi
8842     }%
8843     \setcolor{\linkcolor}%
8844   \else
8845     \ifx\XeTeXrevision\thisisundefined
8846     \else
8847       % For XeTeX
8848       {\indexnofonts
8849        \makevalueexpandable
8850        \turnoffactive
8851        % This expands tokens, so do it after making catcode changes, so _
8852        % etc. don't get their TeX definitions.  This ignores all spaces in
8853        % #4, including (wrongly) those in the middle of the filename.
8854        \getfilename{#4}%
8855        %
8856        % This (wrongly) does not take account of leading or trailing
8857        % spaces in #1, which should be ignored.
8858        \setpdfdestname{#1}%
8859        %
8860        \ifx\pdfdestname\empty
8861          \def\pdfdestname{Top}% no empty targets
8862        \fi
8863        %
8864        \leavevmode
8865        \ifnum\filenamelength>0
8866          % With default settings,
8867          % XeTeX (xdvipdfmx) replaces link destination names with integers.
8868          % In this case, the replaced destination names of
8869          % remote PDFs are no longer known.  In order to avoid a replacement,
8870          % you can use xdvipdfmx's command line option `-C 0x0010'.
8871          % If you use XeTeX 0.99996+ (TeX Live 2016+),
8872          % this command line option is no longer necessary
8873          % because we can use the `dvipdfmx:config' special.
8874          \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8875            << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}%
8876        \else
8877          \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8878            << /S /GoTo /D (\pdfdestname) >> >>}%
8879        \fi
8880       }%
8881       \setcolor{\linkcolor}%
8882     \fi
8883   \fi
8884   {%
8885     % Have to otherify everything special to allow the \csname to
8886     % include an _ in the xref name, etc.
8887     \indexnofonts
8888     \turnoffactive
8889     \def\value##1{##1}%
8890     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8891       \csname XR#1-title\endcsname
8892   }%
8893   %
8894   % Float references are printed completely differently: "Figure 1.2"
8895   % instead of "[somenode], p.3".  \iffloat distinguishes them by
8896   % \Xthisreftitle being set to a magic string.
8897   \iffloat\Xthisreftitle
8898     % If the user specified the print name (third arg) to the ref,
8899     % print it instead of our usual "Figure 1.2".
8900     \ifdim\wd\printedrefnamebox = 0pt
8901       \refx{#1-snt}%
8902     \else
8903       \printedrefname
8904     \fi
8905     %
8906     % If the user also gave the printed manual name (fifth arg), append
8907     % "in MANUALNAME".
8908     \ifdim \wd\printedmanualbox > 0pt
8909       \space \putwordin{} \cite{\printedmanual}%
8910     \fi
8911   \else
8912     % node/anchor (non-float) references.
8913     %
8914     % If we use \unhbox to print the node names, TeX does not insert
8915     % empty discretionaries after hyphens, which means that it will not
8916     % find a line break at a hyphen in a node names.  Since some manuals
8917     % are best written with fairly long node names, containing hyphens,
8918     % this is a loss.  Therefore, we give the text of the node name
8919     % again, so it is as if TeX is seeing it for the first time.
8920     %
8921     \ifdim \wd\printedmanualbox > 0pt
8922       % Cross-manual reference with a printed manual name.
8923       %
8924       \crossmanualxref{\cite{\printedmanual\unskip}}%
8925     %
8926     \else\ifdim \wd\infofilenamebox > 0pt
8927       % Cross-manual reference with only an info filename (arg 4), no
8928       % printed manual name (arg 5).  This is essentially the same as
8929       % the case above; we output the filename, since we have nothing else.
8930       %
8931       \crossmanualxref{\code{\infofilename\unskip}}%
8932     %
8933     \else
8934       % Reference within this manual.
8935       %
8936       % Only output a following space if the -snt ref is nonempty, as the ref
8937       % will be empty for @unnumbered and @anchor.
8938       \setbox2 = \hbox{\ignorespaces \refx{#1-snt}}%
8939       \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8940       %
8941       % output the `[mynode]' via the macro below so it can be overridden.
8942       \xrefprintnodename\printedrefname
8943       %
8944       \expandafter\ifx\csname SETtxiomitxrefpg\endcsname\relax
8945         % But we always want a comma and a space:
8946         ,\space
8947         %
8948         % output the `page 3'.
8949         \turnoffactive \putwordpage\tie\refx{#1-pg}%
8950         % Add a , if xref followed by a space
8951         \if\space\noexpand\tokenafterxref ,%
8952         \else\ifx\      \tokenafterxref ,% @TAB
8953         \else\ifx\*\tokenafterxref ,%   @*
8954         \else\ifx\ \tokenafterxref ,%   @SPACE
8955         \else\ifx\
8956                   \tokenafterxref ,%    @NL
8957         \else\ifx\tie\tokenafterxref ,% @tie
8958         \fi\fi\fi\fi\fi\fi
8959       \fi
8960     \fi\fi
8961   \fi
8962   \endlink
8963 \endgroup}
8964
8965 % Output a cross-manual xref to #1.  Used just above (twice).
8966 %
8967 % Only include the text "Section ``foo'' in" if the foo is neither
8968 % missing or Top.  Thus, @xref{,,,foo,The Foo Manual} outputs simply
8969 % "see The Foo Manual", the idea being to refer to the whole manual.
8970 %
8971 % But, this being TeX, we can't easily compare our node name against the
8972 % string "Top" while ignoring the possible spaces before and after in
8973 % the input.  By adding the arbitrary 7sp below, we make it much less
8974 % likely that a real node name would have the same width as "Top" (e.g.,
8975 % in a monospaced font).  Hopefully it will never happen in practice.
8976 %
8977 % For the same basic reason, we retypeset the "Top" at every
8978 % reference, since the current font is indeterminate.
8979 %
8980 \def\crossmanualxref#1{%
8981   \setbox\toprefbox = \hbox{Top\kern7sp}%
8982   \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8983   \ifdim \wd2 > 7sp  % nonempty?
8984     \ifdim \wd2 = \wd\toprefbox \else  % same as Top?
8985       \putwordSection{} ``\printedrefname'' \putwordin{}\space
8986     \fi
8987   \fi
8988   #1%
8989 }
8990
8991 % This macro is called from \xrefX for the `[nodename]' part of xref
8992 % output.  It's a separate macro only so it can be changed more easily,
8993 % since square brackets don't work well in some documents.  Particularly
8994 % one that Bob is working on :).
8995 %
8996 \def\xrefprintnodename#1{[#1]}
8997
8998 % Things referred to by \setref.
8999 %
9000 \def\Ynothing{}
9001 \def\Yomitfromtoc{}
9002 \def\Ynumbered{%
9003   \ifnum\secno=0
9004     \putwordChapter@tie \the\chapno
9005   \else \ifnum\subsecno=0
9006     \putwordSection@tie \the\chapno.\the\secno
9007   \else \ifnum\subsubsecno=0
9008     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
9009   \else
9010     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
9011   \fi\fi\fi
9012 }
9013 \def\Yappendix{%
9014   \ifnum\secno=0
9015      \putwordAppendix@tie @char\the\appendixno{}%
9016   \else \ifnum\subsecno=0
9017      \putwordSection@tie @char\the\appendixno.\the\secno
9018   \else \ifnum\subsubsecno=0
9019     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
9020   \else
9021     \putwordSection@tie
9022       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
9023   \fi\fi\fi
9024 }
9025
9026 % \refx{NAME} - reference a cross-reference string named NAME.
9027 \def\refx#1{%
9028   \requireauxfile
9029   {%
9030     \indexnofonts
9031     \turnoffactive
9032     \def\value##1{##1}%
9033     \expandafter\global\expandafter\let\expandafter\thisrefX
9034       \csname XR#1\endcsname
9035   }%
9036   \ifx\thisrefX\relax
9037     % If not defined, say something at least.
9038     \angleleft un\-de\-fined\angleright
9039     \iflinks
9040       \ifhavexrefs
9041         {\toks0 = {#1}% avoid expansion of possibly-complex value
9042          \message{\linenumber Undefined cross reference `\the\toks0'.}}%
9043       \else
9044         \ifwarnedxrefs\else
9045           \global\warnedxrefstrue
9046           \message{Cross reference values unknown; you must run TeX again.}%
9047         \fi
9048       \fi
9049     \fi
9050   \else
9051     % It's defined, so just use it.
9052     \thisrefX
9053   \fi
9054 }
9055
9056 % This is the macro invoked by entries in the aux file.  Define a control
9057 % sequence for a cross-reference target (we prepend XR to the control sequence
9058 % name to avoid collisions).  The value is the page number.  If this is a float
9059 % type, we have more work to do.
9060 %
9061 \def\xrdef#1#2{%
9062   {% Expand the node or anchor name to remove control sequences.
9063    % \turnoffactive stops 8-bit characters being changed to commands
9064    % like @'e.  \refx does the same to retrieve the value in the definition.
9065     \indexnofonts
9066     \turnoffactive
9067     \def\value##1{##1}%
9068     \xdef\safexrefname{#1}%
9069   }%
9070   %
9071   \bgroup
9072     \expandafter\gdef\csname XR\safexrefname\endcsname{#2}%
9073   \egroup
9074   % We put the \gdef inside a group to avoid the definitions building up on
9075   % TeX's save stack, which can cause it to run out of space for aux files with
9076   % thousands of lines.  \gdef doesn't use the save stack, but \csname does
9077   % when it defines an unknown control sequence as \relax.
9078   %
9079   % Was that xref control sequence that we just defined for a float?
9080   \expandafter\iffloat\csname XR\safexrefname\endcsname
9081     % it was a float, and we have the (safe) float type in \iffloattype.
9082     \expandafter\let\expandafter\floatlist
9083       \csname floatlist\iffloattype\endcsname
9084     %
9085     % Is this the first time we've seen this float type?
9086     \expandafter\ifx\floatlist\relax
9087       \toks0 = {\do}% yes, so just \do
9088     \else
9089       % had it before, so preserve previous elements in list.
9090       \toks0 = \expandafter{\floatlist\do}%
9091     \fi
9092     %
9093     % Remember this xref in the control sequence \floatlistFLOATTYPE,
9094     % for later use in \listoffloats.
9095     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
9096       {\safexrefname}}%
9097   \fi
9098 }
9099
9100 % If working on a large document in chapters, it is convenient to
9101 % be able to disable indexing, cross-referencing, and contents, for test runs.
9102 % This is done with @novalidate at the beginning of the file.
9103 %
9104 \newif\iflinks \linkstrue % by default we want the aux files.
9105 \let\novalidate = \linksfalse
9106
9107 % Used when writing to the aux file, or when using data from it.
9108 \def\requireauxfile{%
9109   \iflinks
9110     \tryauxfile
9111     % Open the new aux file.  TeX will close it automatically at exit.
9112     \immediate\openout\auxfile=\jobname.aux
9113   \fi
9114   \global\let\requireauxfile=\relax   % Only do this once.
9115 }
9116
9117 % Read the last existing aux file, if any.  No error if none exists.
9118 %
9119 \def\tryauxfile{%
9120   \openin 1 \jobname.aux
9121   \ifeof 1 \else
9122     \readdatafile{aux}%
9123     \global\havexrefstrue
9124   \fi
9125   \closein 1
9126 }
9127
9128 \def\setupdatafile{%
9129   \catcode`\^^@=\other
9130   \catcode`\^^A=\other
9131   \catcode`\^^B=\other
9132   \catcode`\^^C=\other
9133   \catcode`\^^D=\other
9134   \catcode`\^^E=\other
9135   \catcode`\^^F=\other
9136   \catcode`\^^G=\other
9137   \catcode`\^^H=\other
9138   \catcode`\^^K=\other
9139   \catcode`\^^L=\other
9140   \catcode`\^^N=\other
9141   \catcode`\^^P=\other
9142   \catcode`\^^Q=\other
9143   \catcode`\^^R=\other
9144   \catcode`\^^S=\other
9145   \catcode`\^^T=\other
9146   \catcode`\^^U=\other
9147   \catcode`\^^V=\other
9148   \catcode`\^^W=\other
9149   \catcode`\^^X=\other
9150   \catcode`\^^Z=\other
9151   \catcode`\^^[=\other
9152   \catcode`\^^\=\other
9153   \catcode`\^^]=\other
9154   \catcode`\^^^=\other
9155   \catcode`\^^_=\other
9156   \catcode`\^=\other
9157   %
9158   % Special characters.  Should be turned off anyway, but...
9159   \catcode`\~=\other
9160   \catcode`\[=\other
9161   \catcode`\]=\other
9162   \catcode`\"=\other
9163   \catcode`\_=\active
9164   \catcode`\|=\active
9165   \catcode`\<=\active
9166   \catcode`\>=\active
9167   \catcode`\$=\other
9168   \catcode`\#=\other
9169   \catcode`\&=\other
9170   \catcode`\%=\other
9171   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
9172   %
9173   \catcode`\\=\active
9174   %
9175   % @ is our escape character in .aux files, and we need braces.
9176   \catcode`\{=1
9177   \catcode`\}=2
9178   \catcode`\@=0
9179 }
9180
9181 \def\readdatafile#1{%
9182 \begingroup
9183   \setupdatafile
9184   \input\jobname.#1
9185 \endgroup}
9186
9187
9188 \message{insertions,}
9189 % including footnotes.
9190
9191 \newcount \footnoteno
9192
9193 % The trailing space in the following definition for supereject is
9194 % vital for proper filling; pages come out unaligned when you do a
9195 % pagealignmacro call if that space before the closing brace is
9196 % removed. (Generally, numeric constants should always be followed by a
9197 % space to prevent strange expansion errors.)
9198 \def\supereject{\par\penalty -20000\footnoteno =0 }
9199
9200 % @footnotestyle is meaningful for Info output only.
9201 \let\footnotestyle=\comment
9202
9203 {\catcode `\@=11
9204 %
9205 % Auto-number footnotes.  Otherwise like plain.
9206 \gdef\footnote{%
9207   \global\advance\footnoteno by \@ne
9208   \edef\thisfootno{$^{\the\footnoteno}$}%
9209   %
9210   % In case the footnote comes at the end of a sentence, preserve the
9211   % extra spacing after we do the footnote number.
9212   \let\@sf\empty
9213   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
9214   %
9215   % Remove inadvertent blank space before typesetting the footnote number.
9216   \unskip
9217   \thisfootno\@sf
9218   \dofootnote
9219 }%
9220
9221 % Don't bother with the trickery in plain.tex to not require the
9222 % footnote text as a parameter.  Our footnotes don't need to be so general.
9223 %
9224 % Oh yes, they do; otherwise, @ifset (and anything else that uses
9225 % \parseargline) fails inside footnotes because the tokens are fixed when
9226 % the footnote is read.  --karl, 16nov96.
9227 %
9228 \gdef\dofootnote{%
9229   \insert\footins\bgroup
9230   %
9231   % Nested footnotes are not supported in TeX, that would take a lot
9232   % more work.  (\startsavinginserts does not suffice.)
9233   \let\footnote=\errfootnotenest
9234   %
9235   % We want to typeset this text as a normal paragraph, even if the
9236   % footnote reference occurs in (for example) a display environment.
9237   % So reset some parameters.
9238   \hsize=\txipagewidth
9239   \interlinepenalty\interfootnotelinepenalty
9240   \splittopskip\ht\strutbox % top baseline for broken footnotes
9241   \splitmaxdepth\dp\strutbox
9242   \floatingpenalty\@MM
9243   \leftskip\z@skip
9244   \rightskip\z@skip
9245   \spaceskip\z@skip
9246   \xspaceskip\z@skip
9247   \parindent\defaultparindent
9248   %
9249   \smallfonts \rm
9250   %
9251   % Because we use hanging indentation in footnotes, a @noindent appears
9252   % to exdent this text, so make it be a no-op.  makeinfo does not use
9253   % hanging indentation so @noindent can still be needed within footnote
9254   % text after an @example or the like (not that this is good style).
9255   \let\noindent = \relax
9256   %
9257   % Hang the footnote text off the number.  Use \everypar in case the
9258   % footnote extends for more than one paragraph.
9259   \everypar = {\hang}%
9260   \textindent{\thisfootno}%
9261   %
9262   % Don't crash into the line above the footnote text.  Since this
9263   % expands into a box, it must come within the paragraph, lest it
9264   % provide a place where TeX can split the footnote.
9265   \footstrut
9266   %
9267   % Invoke rest of plain TeX footnote routine.
9268   \futurelet\next\fo@t
9269 }
9270 }%end \catcode `\@=11
9271
9272 \def\errfootnotenest{%
9273   \errhelp=\EMsimple
9274   \errmessage{Nested footnotes not supported in texinfo.tex,
9275     even though they work in makeinfo; sorry}
9276 }
9277
9278 \def\errfootnoteheading{%
9279   \errhelp=\EMsimple
9280   \errmessage{Footnotes in chapters, sections, etc., are not supported}
9281 }
9282
9283 % In case a @footnote appears in a vbox, save the footnote text and create
9284 % the real \insert just after the vbox finished.  Otherwise, the insertion
9285 % would be lost.
9286 % Similarly, if a @footnote appears inside an alignment, save the footnote
9287 % text to a box and make the \insert when a row of the table is finished.
9288 % And the same can be done for other insert classes.  --kasal, 16nov03.
9289 %
9290 % Replace the \insert primitive by a cheating macro.
9291 % Deeper inside, just make sure that the saved insertions are not spilled
9292 % out prematurely.
9293 %
9294 \def\startsavinginserts{%
9295   \ifx \insert\ptexinsert
9296     \let\insert\saveinsert
9297   \else
9298     \let\checkinserts\relax
9299   \fi
9300 }
9301
9302 % This \insert replacement works for both \insert\footins{foo} and
9303 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
9304 %
9305 \def\saveinsert#1{%
9306   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
9307   \afterassignment\next
9308   % swallow the left brace
9309   \let\temp =
9310 }
9311 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
9312 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
9313
9314 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
9315
9316 \def\placesaveins#1{%
9317   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
9318     {\box#1}%
9319 }
9320
9321 % eat @SAVE -- beware, all of them have catcode \other:
9322 {
9323   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
9324   \gdef\gobblesave @SAVE{}
9325 }
9326
9327 % initialization:
9328 \def\newsaveins #1{%
9329   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
9330   \next
9331 }
9332 \def\newsaveinsX #1{%
9333   \csname newbox\endcsname #1%
9334   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
9335     \checksaveins #1}%
9336 }
9337
9338 % initialize:
9339 \let\checkinserts\empty
9340 \newsaveins\footins
9341 \newsaveins\margin
9342
9343
9344 % @image.  We use the macros from epsf.tex to support this.
9345 % If epsf.tex is not installed and @image is used, we complain.
9346 %
9347 % Check for and read epsf.tex up front.  If we read it only at @image
9348 % time, we might be inside a group, and then its definitions would get
9349 % undone and the next image would fail.
9350 \openin 1 = epsf.tex
9351 \ifeof 1 \else
9352   % Do not bother showing banner with epsf.tex v2.7k (available in
9353   % doc/epsf.tex and on ctan).
9354   \def\epsfannounce{\toks0 = }%
9355   \input epsf.tex
9356 \fi
9357 \closein 1
9358 %
9359 % We will only complain once about lack of epsf.tex.
9360 \newif\ifwarnednoepsf
9361 \newhelp\noepsfhelp{epsf.tex must be installed for images to
9362   work.  It is also included in the Texinfo distribution, or you can get
9363   it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.}
9364 %
9365 \def\image#1{%
9366   \ifx\epsfbox\thisisundefined
9367     \ifwarnednoepsf \else
9368       \errhelp = \noepsfhelp
9369       \errmessage{epsf.tex not found, images will be ignored}%
9370       \global\warnednoepsftrue
9371     \fi
9372   \else
9373     \imagexxx #1,,,,,\finish
9374   \fi
9375 }
9376 %
9377 % Arguments to @image:
9378 % #1 is (mandatory) image filename; we tack on .eps extension.
9379 % #2 is (optional) width, #3 is (optional) height.
9380 % #4 is (ignored optional) html alt text.
9381 % #5 is (ignored optional) extension.
9382 % #6 is just the usual extra ignored arg for parsing stuff.
9383 \newif\ifimagevmode
9384 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
9385   \catcode`\^^M = 5     % in case we're inside an example
9386   \normalturnoffactive  % allow _ et al. in names
9387   \makevalueexpandable
9388   \ifvmode
9389     \imagevmodetrue
9390   \else \ifx\centersub\centerV
9391     % for @center @image, we need a vbox so we can have our vertical space
9392     \imagevmodetrue
9393     \vbox\bgroup % vbox has better behavior than vtop here
9394   \fi\fi
9395   %
9396   \ifimagevmode
9397     \medskip
9398     % Usually we'll have text after the image which will insert
9399     % \parskip glue, so insert it here too to equalize the space
9400     % above and below.
9401     \vskip\parskip
9402     %
9403     % Place image in a \vtop for a top page margin that is (close to) correct,
9404     % as \topskip glue is relative to the first baseline.
9405     \vtop\bgroup\hrule height 0pt\vskip-\parskip
9406   \fi
9407   %
9408   % Enter horizontal mode so that indentation from an enclosing
9409   %  environment such as @quotation is respected.
9410   % However, if we're at the top level, we don't want the
9411   %  normal paragraph indentation.
9412   % On the other hand, if we are in the case of @center @image, we don't
9413   %  want to start a paragraph, which will create a hsize-width box and
9414   %  eradicate the centering.
9415   \ifx\centersub\centerV \else \imageindent \fi
9416   %
9417   % Output the image.
9418   \ifpdf
9419     % For pdfTeX and LuaTeX <= 0.80
9420     \dopdfimage{#1}{#2}{#3}%
9421   \else
9422     \ifx\XeTeXrevision\thisisundefined
9423       % For epsf.tex
9424       % \epsfbox itself resets \epsf?size at each figure.
9425       \setbox0 = \hbox{\ignorespaces #2}%
9426         \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
9427       \setbox0 = \hbox{\ignorespaces #3}%
9428         \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
9429       \epsfbox{#1.eps}%
9430     \else
9431       % For XeTeX
9432       \doxeteximage{#1}{#2}{#3}%
9433     \fi
9434   \fi
9435   %
9436   \ifimagevmode
9437     \egroup
9438     \medskip  % space after a standalone image
9439   \fi
9440   \ifx\centersub\centerV \egroup \fi
9441 \endgroup}
9442
9443
9444 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
9445 % etc.  We don't actually implement floating yet, we always include the
9446 % float "here".  But it seemed the best name for the future.
9447 %
9448 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
9449
9450 % There may be a space before second and/or third parameter; delete it.
9451 \def\eatcommaspace#1, {#1,}
9452
9453 % #1 is the optional FLOATTYPE, the text label for this float, typically
9454 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
9455 % this float will not be numbered and cannot be referred to.
9456 %
9457 % #2 is the optional xref label.  Also must be present for the float to
9458 % be referable.
9459 %
9460 % #3 is the optional positioning argument; for now, it is ignored.  It
9461 % will somehow specify the positions allowed to float to (here, top, bottom).
9462 %
9463 % We keep a separate counter for each FLOATTYPE, which we reset at each
9464 % chapter-level command.
9465 \let\resetallfloatnos=\empty
9466 %
9467 \def\dofloat#1,#2,#3,#4\finish{%
9468   \let\thiscaption=\empty
9469   \let\thisshortcaption=\empty
9470   %
9471   % don't lose footnotes inside @float.
9472   %
9473   % BEWARE: when the floats start float, we have to issue warning whenever an
9474   % insert appears inside a float which could possibly float. --kasal, 26may04
9475   %
9476   \startsavinginserts
9477   %
9478   % We can't be used inside a paragraph.
9479   \par
9480   %
9481   \vtop\bgroup
9482     \def\floattype{#1}%
9483     \def\floatlabel{#2}%
9484     \def\floatloc{#3}% we do nothing with this yet.
9485     %
9486     \ifx\floattype\empty
9487       \let\safefloattype=\empty
9488     \else
9489       {%
9490         % the floattype might have accents or other special characters,
9491         % but we need to use it in a control sequence name.
9492         \indexnofonts
9493         \turnoffactive
9494         \xdef\safefloattype{\floattype}%
9495       }%
9496     \fi
9497     %
9498     % If label is given but no type, we handle that as the empty type.
9499     \ifx\floatlabel\empty \else
9500       % We want each FLOATTYPE to be numbered separately (Figure 1,
9501       % Table 1, Figure 2, ...).  (And if no label, no number.)
9502       %
9503       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
9504       \global\advance\floatno by 1
9505       %
9506       {%
9507         % This magic value for \currentsection is output by \setref as the
9508         % XREFLABEL-title value.  \xrefX uses it to distinguish float
9509         % labels (which have a completely different output format) from
9510         % node and anchor labels.  And \xrdef uses it to construct the
9511         % lists of floats.
9512         %
9513         \edef\currentsection{\floatmagic=\safefloattype}%
9514         \setref{\floatlabel}{Yfloat}%
9515       }%
9516     \fi
9517     %
9518     % start with \parskip glue, I guess.
9519     \vskip\parskip
9520     %
9521     % Don't suppress indentation if a float happens to start a section.
9522     \restorefirstparagraphindent
9523 }
9524
9525 % we have these possibilities:
9526 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
9527 % @float Foo,lbl & no caption:    Foo 1.1
9528 % @float Foo & @caption{Cap}:     Foo: Cap
9529 % @float Foo & no caption:        Foo
9530 % @float ,lbl & Caption{Cap}:     1.1: Cap
9531 % @float ,lbl & no caption:       1.1
9532 % @float & @caption{Cap}:         Cap
9533 % @float & no caption:
9534 %
9535 \def\Efloat{%
9536     \let\floatident = \empty
9537     %
9538     % In all cases, if we have a float type, it comes first.
9539     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
9540     %
9541     % If we have an xref label, the number comes next.
9542     \ifx\floatlabel\empty \else
9543       \ifx\floattype\empty \else % if also had float type, need tie first.
9544         \appendtomacro\floatident{\tie}%
9545       \fi
9546       % the number.
9547       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
9548     \fi
9549     %
9550     % Start the printed caption with what we've constructed in
9551     % \floatident, but keep it separate; we need \floatident again.
9552     \let\captionline = \floatident
9553     %
9554     \ifx\thiscaption\empty \else
9555       \ifx\floatident\empty \else
9556         \appendtomacro\captionline{: }% had ident, so need a colon between
9557       \fi
9558       %
9559       % caption text.
9560       \appendtomacro\captionline{\scanexp\thiscaption}%
9561     \fi
9562     %
9563     % If we have anything to print, print it, with space before.
9564     % Eventually this needs to become an \insert.
9565     \ifx\captionline\empty \else
9566       \vskip.5\parskip
9567       \captionline
9568       %
9569       % Space below caption.
9570       \vskip\parskip
9571     \fi
9572     %
9573     % If have an xref label, write the list of floats info.  Do this
9574     % after the caption, to avoid chance of it being a breakpoint.
9575     \ifx\floatlabel\empty \else
9576       % Write the text that goes in the lof to the aux file as
9577       % \floatlabel-lof.  Besides \floatident, we include the short
9578       % caption if specified, else the full caption if specified, else nothing.
9579       {%
9580         \requireauxfile
9581         \atdummies
9582         %
9583         \ifx\thisshortcaption\empty
9584           \def\gtemp{\thiscaption}%
9585         \else
9586           \def\gtemp{\thisshortcaption}%
9587         \fi
9588         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
9589           \ifx\gtemp\empty \else : \gtemp \fi}}%
9590       }%
9591     \fi
9592   \egroup  % end of \vtop
9593   %
9594   \checkinserts
9595 }
9596
9597 % Append the tokens #2 to the definition of macro #1, not expanding either.
9598 %
9599 \def\appendtomacro#1#2{%
9600   \expandafter\def\expandafter#1\expandafter{#1#2}%
9601 }
9602
9603 % @caption, @shortcaption
9604 %
9605 \def\caption{\docaption\thiscaption}
9606 \def\shortcaption{\docaption\thisshortcaption}
9607 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
9608 \def\defcaption#1#2{\egroup \def#1{#2}}
9609
9610 % The parameter is the control sequence identifying the counter we are
9611 % going to use.  Create it if it doesn't exist and assign it to \floatno.
9612 \def\getfloatno#1{%
9613   \ifx#1\relax
9614       % Haven't seen this figure type before.
9615       \csname newcount\endcsname #1%
9616       %
9617       % Remember to reset this floatno at the next chap.
9618       \expandafter\gdef\expandafter\resetallfloatnos
9619         \expandafter{\resetallfloatnos #1=0 }%
9620   \fi
9621   \let\floatno#1%
9622 }
9623
9624 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
9625 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
9626 % first read the @float command.
9627 %
9628 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
9629
9630 % Magic string used for the XREFLABEL-title value, so \xrefX can
9631 % distinguish floats from other xref types.
9632 \def\floatmagic{!!float!!}
9633
9634 % #1 is the control sequence we are passed; we expand into a conditional
9635 % which is true if #1 represents a float ref.  That is, the magic
9636 % \currentsection value which we \setref above.
9637 %
9638 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
9639 %
9640 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
9641 % (safe) float type for this float.  We set \iffloattype to #2.
9642 %
9643 \def\doiffloat#1=#2=#3\finish{%
9644   \def\temp{#1}%
9645   \def\iffloattype{#2}%
9646   \ifx\temp\floatmagic
9647 }
9648
9649 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9650 %
9651 \parseargdef\listoffloats{%
9652   \def\floattype{#1}% floattype
9653   {%
9654     % the floattype might have accents or other special characters,
9655     % but we need to use it in a control sequence name.
9656     \indexnofonts
9657     \turnoffactive
9658     \xdef\safefloattype{\floattype}%
9659   }%
9660   %
9661   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9662   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
9663     \ifhavexrefs
9664       % if the user said @listoffloats foo but never @float foo.
9665       \message{\linenumber No `\safefloattype' floats to list.}%
9666     \fi
9667   \else
9668     \begingroup
9669       \leftskip=\tocindent  % indent these entries like a toc
9670       \let\do=\listoffloatsdo
9671       \csname floatlist\safefloattype\endcsname
9672     \endgroup
9673   \fi
9674 }
9675
9676 % This is called on each entry in a list of floats.  We're passed the
9677 % xref label, in the form LABEL-title, which is how we save it in the
9678 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
9679 % has the text we're supposed to typeset here.
9680 %
9681 % Figures without xref labels will not be included in the list (since
9682 % they won't appear in the aux file).
9683 %
9684 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
9685 \def\listoffloatsdoentry#1-title\finish{{%
9686   % Can't fully expand XR#1-lof because it can contain anything.  Just
9687   % pass the control sequence.  On the other hand, XR#1-pg is just the
9688   % page number, and we want to fully expand that so we can get a link
9689   % in pdf output.
9690   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
9691   %
9692   % use the same \entry macro we use to generate the TOC and index.
9693   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
9694   \writeentry
9695 }}
9696
9697
9698 \message{localization,}
9699
9700 % For single-language documents, @documentlanguage is usually given very
9701 % early, just after @documentencoding.  Single argument is the language
9702 % (de) or locale (de_DE) abbreviation.
9703 %
9704 {
9705   \catcode`\_ = \active
9706   \globaldefs=1
9707 \parseargdef\documentlanguage{%
9708   \tex % read txi-??.tex file in plain TeX.
9709     % Read the file by the name they passed if it exists.
9710     \let_ = \normalunderscore  % normal _ character for filename test
9711     \openin 1 txi-#1.tex
9712     \ifeof 1
9713       \documentlanguagetrywithoutunderscore #1_\finish
9714     \else
9715       \globaldefs = 1  % everything in the txi-LL files needs to persist
9716       \input txi-#1.tex
9717     \fi
9718     \closein 1
9719   \endgroup % end raw TeX
9720 }
9721 %
9722 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9723 % try txi-de.tex.
9724 %
9725 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
9726   \openin 1 txi-#1.tex
9727   \ifeof 1
9728     \errhelp = \nolanghelp
9729     \errmessage{Cannot read language file txi-#1.tex}%
9730   \else
9731     \globaldefs = 1  % everything in the txi-LL files needs to persist
9732     \input txi-#1.tex
9733   \fi
9734   \closein 1
9735 }
9736 }% end of special _ catcode
9737 %
9738 \newhelp\nolanghelp{The given language definition file cannot be found or
9739 is empty.  Maybe you need to install it?  Putting it in the current
9740 directory should work if nowhere else does.}
9741
9742 % This macro is called from txi-??.tex files; the first argument is the
9743 % \language name to set (without the "\lang@" prefix), the second and
9744 % third args are \{left,right}hyphenmin.
9745 %
9746 % The language names to pass are determined when the format is built.
9747 % See the etex.log file created at that time, e.g.,
9748 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9749 %
9750 % With TeX Live 2008, etex now includes hyphenation patterns for all
9751 % available languages.  This means we can support hyphenation in
9752 % Texinfo, at least to some extent.  (This still doesn't solve the
9753 % accented characters problem.)
9754 %
9755 \catcode`@=11
9756 \def\txisetlanguage#1#2#3{%
9757   % do not set the language if the name is undefined in the current TeX.
9758   \expandafter\ifx\csname lang@#1\endcsname \relax
9759     \message{no patterns for #1}%
9760   \else
9761     \global\language = \csname lang@#1\endcsname
9762   \fi
9763   % but there is no harm in adjusting the hyphenmin values regardless.
9764   \global\lefthyphenmin = #2\relax
9765   \global\righthyphenmin = #3\relax
9766 }
9767
9768 % XeTeX and LuaTeX can handle Unicode natively.
9769 % Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
9770 % Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
9771 %
9772 \newif\iftxinativeunicodecapable
9773 \newif\iftxiusebytewiseio
9774
9775 \ifx\XeTeXrevision\thisisundefined
9776   \ifx\luatexversion\thisisundefined
9777     \txinativeunicodecapablefalse
9778     \txiusebytewiseiotrue
9779   \else
9780     \txinativeunicodecapabletrue
9781     \txiusebytewiseiofalse
9782   \fi
9783 \else
9784   \txinativeunicodecapabletrue
9785   \txiusebytewiseiofalse
9786 \fi
9787
9788 % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
9789 % for non-UTF-8 (byte-wise) encodings.
9790 %
9791 \def\setbytewiseio{%
9792   \ifx\XeTeXrevision\thisisundefined
9793   \else
9794     \XeTeXdefaultencoding "bytes"  % For subsequent files to be read
9795     \XeTeXinputencoding "bytes"  % For document root file
9796     % Unfortunately, there seems to be no corresponding XeTeX command for
9797     % output encoding.  This is a problem for auxiliary index and TOC files.
9798     % The only solution would be perhaps to write out @U{...} sequences in
9799     % place of non-ASCII characters.
9800   \fi
9801
9802   \ifx\luatexversion\thisisundefined
9803   \else
9804     \directlua{
9805     local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
9806     local function convert_char (char)
9807       return utf8_char(byte(char))
9808     end
9809
9810     local function convert_line (line)
9811       return gsub(line, ".", convert_char)
9812     end
9813
9814     callback.register("process_input_buffer", convert_line)
9815
9816     local function convert_line_out (line)
9817       local line_out = ""
9818       for c in string.utfvalues(line) do
9819          line_out = line_out .. string.char(c)
9820       end
9821       return line_out
9822     end
9823
9824     callback.register("process_output_buffer", convert_line_out)
9825     }
9826   \fi
9827
9828   \txiusebytewiseiotrue
9829 }
9830
9831
9832 % Helpers for encodings.
9833 % Set the catcode of characters 128 through 255 to the specified number.
9834 %
9835 \def\setnonasciicharscatcode#1{%
9836    \count255=128
9837    \loop\ifnum\count255<256
9838       \global\catcode\count255=#1\relax
9839       \advance\count255 by 1
9840    \repeat
9841 }
9842
9843 \def\setnonasciicharscatcodenonglobal#1{%
9844    \count255=128
9845    \loop\ifnum\count255<256
9846       \catcode\count255=#1\relax
9847       \advance\count255 by 1
9848    \repeat
9849 }
9850
9851 % @documentencoding sets the definition of non-ASCII characters
9852 % according to the specified encoding.
9853 %
9854 \def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
9855 \def\documentencodingzzz#1{%
9856   %
9857   % Encoding being declared for the document.
9858   \def\declaredencoding{\csname #1.enc\endcsname}%
9859   %
9860   % Supported encodings: names converted to tokens in order to be able
9861   % to compare them with \ifx.
9862   \def\ascii{\csname US-ASCII.enc\endcsname}%
9863   \def\latnine{\csname ISO-8859-15.enc\endcsname}%
9864   \def\latone{\csname ISO-8859-1.enc\endcsname}%
9865   \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
9866   \def\utfeight{\csname UTF-8.enc\endcsname}%
9867   %
9868   \ifx \declaredencoding \ascii
9869      \asciichardefs
9870   %
9871   \else \ifx \declaredencoding \lattwo
9872      \iftxinativeunicodecapable
9873        \setbytewiseio
9874      \fi
9875      \setnonasciicharscatcode\active
9876      \lattwochardefs
9877   %
9878   \else \ifx \declaredencoding \latone
9879      \iftxinativeunicodecapable
9880        \setbytewiseio
9881      \fi
9882      \setnonasciicharscatcode\active
9883      \latonechardefs
9884   %
9885   \else \ifx \declaredencoding \latnine
9886      \iftxinativeunicodecapable
9887        \setbytewiseio
9888      \fi
9889      \setnonasciicharscatcode\active
9890      \latninechardefs
9891   %
9892   \else \ifx \declaredencoding \utfeight
9893      \iftxinativeunicodecapable
9894        % For native Unicode handling (XeTeX and LuaTeX)
9895        \nativeunicodechardefs
9896      \else
9897        % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX)
9898        \setnonasciicharscatcode\active
9899        % since we already invoked \utfeightchardefs at the top level
9900        % (below), do not re-invoke it, otherwise our check for duplicated
9901        % definitions gets triggered.  Making non-ascii chars active is
9902        % sufficient.
9903      \fi
9904   %
9905   \else
9906     \message{Ignoring unknown document encoding: #1.}%
9907   %
9908   \fi % utfeight
9909   \fi % latnine
9910   \fi % latone
9911   \fi % lattwo
9912   \fi % ascii
9913   %
9914   \ifx\XeTeXrevision\thisisundefined
9915   \else
9916     \ifx \declaredencoding \utfeight
9917     \else
9918       \ifx \declaredencoding \ascii
9919       \else
9920         \message{Warning: XeTeX with non-UTF-8 encodings cannot handle %
9921         non-ASCII characters in auxiliary files.}%
9922       \fi
9923     \fi
9924   \fi
9925 }
9926
9927 % emacs-page
9928 % A message to be logged when using a character that isn't available
9929 % the default font encoding (OT1).
9930 %
9931 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9932
9933 % Take account of \c (plain) vs. \, (Texinfo) difference.
9934 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9935
9936 % First, make active non-ASCII characters in order for them to be
9937 % correctly categorized when TeX reads the replacement text of
9938 % macros containing the character definitions.
9939 \setnonasciicharscatcode\active
9940 %
9941
9942 \def\gdefchar#1#2{%
9943 \gdef#1{%
9944    \ifpassthroughchars
9945      \string#1%
9946    \else
9947      #2%
9948    \fi
9949 }}
9950
9951 % Latin1 (ISO-8859-1) character definitions.
9952 \def\latonechardefs{%
9953   \gdefchar^^a0{\tie}
9954   \gdefchar^^a1{\exclamdown}
9955   \gdefchar^^a2{{\tcfont \char162}} % cent
9956   \gdefchar^^a3{\pounds{}}
9957   \gdefchar^^a4{{\tcfont \char164}} % currency
9958   \gdefchar^^a5{{\tcfont \char165}} % yen
9959   \gdefchar^^a6{{\tcfont \char166}} % broken bar
9960   \gdefchar^^a7{\S}
9961   \gdefchar^^a8{\"{}}
9962   \gdefchar^^a9{\copyright{}}
9963   \gdefchar^^aa{\ordf}
9964   \gdefchar^^ab{\guillemetleft{}}
9965   \gdefchar^^ac{\ensuremath\lnot}
9966   \gdefchar^^ad{\-}
9967   \gdefchar^^ae{\registeredsymbol{}}
9968   \gdefchar^^af{\={}}
9969   %
9970   \gdefchar^^b0{\textdegree}
9971   \gdefchar^^b1{$\pm$}
9972   \gdefchar^^b2{$^2$}
9973   \gdefchar^^b3{$^3$}
9974   \gdefchar^^b4{\'{}}
9975   \gdefchar^^b5{$\mu$}
9976   \gdefchar^^b6{\P}
9977   \gdefchar^^b7{\ensuremath\cdot}
9978   \gdefchar^^b8{\cedilla\ }
9979   \gdefchar^^b9{$^1$}
9980   \gdefchar^^ba{\ordm}
9981   \gdefchar^^bb{\guillemetright{}}
9982   \gdefchar^^bc{$1\over4$}
9983   \gdefchar^^bd{$1\over2$}
9984   \gdefchar^^be{$3\over4$}
9985   \gdefchar^^bf{\questiondown}
9986   %
9987   \gdefchar^^c0{\`A}
9988   \gdefchar^^c1{\'A}
9989   \gdefchar^^c2{\^A}
9990   \gdefchar^^c3{\~A}
9991   \gdefchar^^c4{\"A}
9992   \gdefchar^^c5{\ringaccent A}
9993   \gdefchar^^c6{\AE}
9994   \gdefchar^^c7{\cedilla C}
9995   \gdefchar^^c8{\`E}
9996   \gdefchar^^c9{\'E}
9997   \gdefchar^^ca{\^E}
9998   \gdefchar^^cb{\"E}
9999   \gdefchar^^cc{\`I}
10000   \gdefchar^^cd{\'I}
10001   \gdefchar^^ce{\^I}
10002   \gdefchar^^cf{\"I}
10003   %
10004   \gdefchar^^d0{\DH}
10005   \gdefchar^^d1{\~N}
10006   \gdefchar^^d2{\`O}
10007   \gdefchar^^d3{\'O}
10008   \gdefchar^^d4{\^O}
10009   \gdefchar^^d5{\~O}
10010   \gdefchar^^d6{\"O}
10011   \gdefchar^^d7{$\times$}
10012   \gdefchar^^d8{\O}
10013   \gdefchar^^d9{\`U}
10014   \gdefchar^^da{\'U}
10015   \gdefchar^^db{\^U}
10016   \gdefchar^^dc{\"U}
10017   \gdefchar^^dd{\'Y}
10018   \gdefchar^^de{\TH}
10019   \gdefchar^^df{\ss}
10020   %
10021   \gdefchar^^e0{\`a}
10022   \gdefchar^^e1{\'a}
10023   \gdefchar^^e2{\^a}
10024   \gdefchar^^e3{\~a}
10025   \gdefchar^^e4{\"a}
10026   \gdefchar^^e5{\ringaccent a}
10027   \gdefchar^^e6{\ae}
10028   \gdefchar^^e7{\cedilla c}
10029   \gdefchar^^e8{\`e}
10030   \gdefchar^^e9{\'e}
10031   \gdefchar^^ea{\^e}
10032   \gdefchar^^eb{\"e}
10033   \gdefchar^^ec{\`{\dotless i}}
10034   \gdefchar^^ed{\'{\dotless i}}
10035   \gdefchar^^ee{\^{\dotless i}}
10036   \gdefchar^^ef{\"{\dotless i}}
10037   %
10038   \gdefchar^^f0{\dh}
10039   \gdefchar^^f1{\~n}
10040   \gdefchar^^f2{\`o}
10041   \gdefchar^^f3{\'o}
10042   \gdefchar^^f4{\^o}
10043   \gdefchar^^f5{\~o}
10044   \gdefchar^^f6{\"o}
10045   \gdefchar^^f7{$\div$}
10046   \gdefchar^^f8{\o}
10047   \gdefchar^^f9{\`u}
10048   \gdefchar^^fa{\'u}
10049   \gdefchar^^fb{\^u}
10050   \gdefchar^^fc{\"u}
10051   \gdefchar^^fd{\'y}
10052   \gdefchar^^fe{\th}
10053   \gdefchar^^ff{\"y}
10054 }
10055
10056 % Latin9 (ISO-8859-15) encoding character definitions.
10057 \def\latninechardefs{%
10058   % Encoding is almost identical to Latin1.
10059   \latonechardefs
10060   %
10061   \gdefchar^^a4{\euro{}}
10062   \gdefchar^^a6{\v S}
10063   \gdefchar^^a8{\v s}
10064   \gdefchar^^b4{\v Z}
10065   \gdefchar^^b8{\v z}
10066   \gdefchar^^bc{\OE}
10067   \gdefchar^^bd{\oe}
10068   \gdefchar^^be{\"Y}
10069 }
10070
10071 % Latin2 (ISO-8859-2) character definitions.
10072 \def\lattwochardefs{%
10073   \gdefchar^^a0{\tie}
10074   \gdefchar^^a1{\ogonek{A}}
10075   \gdefchar^^a2{\u{}}
10076   \gdefchar^^a3{\L}
10077   \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
10078   \gdefchar^^a5{\v L}
10079   \gdefchar^^a6{\'S}
10080   \gdefchar^^a7{\S}
10081   \gdefchar^^a8{\"{}}
10082   \gdefchar^^a9{\v S}
10083   \gdefchar^^aa{\cedilla S}
10084   \gdefchar^^ab{\v T}
10085   \gdefchar^^ac{\'Z}
10086   \gdefchar^^ad{\-}
10087   \gdefchar^^ae{\v Z}
10088   \gdefchar^^af{\dotaccent Z}
10089   %
10090   \gdefchar^^b0{\textdegree{}}
10091   \gdefchar^^b1{\ogonek{a}}
10092   \gdefchar^^b2{\ogonek{ }}
10093   \gdefchar^^b3{\l}
10094   \gdefchar^^b4{\'{}}
10095   \gdefchar^^b5{\v l}
10096   \gdefchar^^b6{\'s}
10097   \gdefchar^^b7{\v{}}
10098   \gdefchar^^b8{\cedilla\ }
10099   \gdefchar^^b9{\v s}
10100   \gdefchar^^ba{\cedilla s}
10101   \gdefchar^^bb{\v t}
10102   \gdefchar^^bc{\'z}
10103   \gdefchar^^bd{\H{}}
10104   \gdefchar^^be{\v z}
10105   \gdefchar^^bf{\dotaccent z}
10106   %
10107   \gdefchar^^c0{\'R}
10108   \gdefchar^^c1{\'A}
10109   \gdefchar^^c2{\^A}
10110   \gdefchar^^c3{\u A}
10111   \gdefchar^^c4{\"A}
10112   \gdefchar^^c5{\'L}
10113   \gdefchar^^c6{\'C}
10114   \gdefchar^^c7{\cedilla C}
10115   \gdefchar^^c8{\v C}
10116   \gdefchar^^c9{\'E}
10117   \gdefchar^^ca{\ogonek{E}}
10118   \gdefchar^^cb{\"E}
10119   \gdefchar^^cc{\v E}
10120   \gdefchar^^cd{\'I}
10121   \gdefchar^^ce{\^I}
10122   \gdefchar^^cf{\v D}
10123   %
10124   \gdefchar^^d0{\DH}
10125   \gdefchar^^d1{\'N}
10126   \gdefchar^^d2{\v N}
10127   \gdefchar^^d3{\'O}
10128   \gdefchar^^d4{\^O}
10129   \gdefchar^^d5{\H O}
10130   \gdefchar^^d6{\"O}
10131   \gdefchar^^d7{$\times$}
10132   \gdefchar^^d8{\v R}
10133   \gdefchar^^d9{\ringaccent U}
10134   \gdefchar^^da{\'U}
10135   \gdefchar^^db{\H U}
10136   \gdefchar^^dc{\"U}
10137   \gdefchar^^dd{\'Y}
10138   \gdefchar^^de{\cedilla T}
10139   \gdefchar^^df{\ss}
10140   %
10141   \gdefchar^^e0{\'r}
10142   \gdefchar^^e1{\'a}
10143   \gdefchar^^e2{\^a}
10144   \gdefchar^^e3{\u a}
10145   \gdefchar^^e4{\"a}
10146   \gdefchar^^e5{\'l}
10147   \gdefchar^^e6{\'c}
10148   \gdefchar^^e7{\cedilla c}
10149   \gdefchar^^e8{\v c}
10150   \gdefchar^^e9{\'e}
10151   \gdefchar^^ea{\ogonek{e}}
10152   \gdefchar^^eb{\"e}
10153   \gdefchar^^ec{\v e}
10154   \gdefchar^^ed{\'{\dotless{i}}}
10155   \gdefchar^^ee{\^{\dotless{i}}}
10156   \gdefchar^^ef{\v d}
10157   %
10158   \gdefchar^^f0{\dh}
10159   \gdefchar^^f1{\'n}
10160   \gdefchar^^f2{\v n}
10161   \gdefchar^^f3{\'o}
10162   \gdefchar^^f4{\^o}
10163   \gdefchar^^f5{\H o}
10164   \gdefchar^^f6{\"o}
10165   \gdefchar^^f7{$\div$}
10166   \gdefchar^^f8{\v r}
10167   \gdefchar^^f9{\ringaccent u}
10168   \gdefchar^^fa{\'u}
10169   \gdefchar^^fb{\H u}
10170   \gdefchar^^fc{\"u}
10171   \gdefchar^^fd{\'y}
10172   \gdefchar^^fe{\cedilla t}
10173   \gdefchar^^ff{\dotaccent{}}
10174 }
10175
10176 % UTF-8 character definitions.
10177 %
10178 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
10179 % changes for Texinfo conventions.  It is included here under the GPL by
10180 % permission from Frank Mittelbach and the LaTeX team.
10181 %
10182 \newcount\countUTFx
10183 \newcount\countUTFy
10184 \newcount\countUTFz
10185
10186 \gdef\UTFviiiTwoOctets#1#2{\expandafter
10187    \UTFviiiDefined\csname u8:#1\string #2\endcsname}
10188 %
10189 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
10190    \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
10191 %
10192 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
10193    \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
10194
10195 \gdef\UTFviiiDefined#1{%
10196   \ifx #1\relax
10197     \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
10198   \else
10199     \expandafter #1%
10200   \fi
10201 }
10202
10203 % Give non-ASCII bytes the active definitions for processing UTF-8 sequences
10204 \begingroup
10205   \catcode`\~13
10206   \catcode`\$12
10207   \catcode`\"12
10208
10209   % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
10210   % substituting ~ and $ with a character token of that value.
10211   \def\UTFviiiLoop{%
10212     \global\catcode\countUTFx\active
10213     \uccode`\~\countUTFx
10214     \uccode`\$\countUTFx
10215     \uppercase\expandafter{\UTFviiiTmp}%
10216     \advance\countUTFx by 1
10217     \ifnum\countUTFx < \countUTFy
10218       \expandafter\UTFviiiLoop
10219     \fi}
10220
10221   % For bytes other than the first in a UTF-8 sequence.  Not expected to
10222   % be expanded except when writing to auxiliary files.
10223   \countUTFx = "80
10224   \countUTFy = "C2
10225   \def\UTFviiiTmp{%
10226     \gdef~{%
10227         \ifpassthroughchars $\fi}}%
10228   \UTFviiiLoop
10229
10230   \countUTFx = "C2
10231   \countUTFy = "E0
10232   \def\UTFviiiTmp{%
10233     \gdef~{%
10234         \ifpassthroughchars $%
10235         \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
10236   \UTFviiiLoop
10237
10238   \countUTFx = "E0
10239   \countUTFy = "F0
10240   \def\UTFviiiTmp{%
10241     \gdef~{%
10242         \ifpassthroughchars $%
10243         \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
10244   \UTFviiiLoop
10245
10246   \countUTFx = "F0
10247   \countUTFy = "F4
10248   \def\UTFviiiTmp{%
10249     \gdef~{%
10250         \ifpassthroughchars $%
10251         \else\expandafter\UTFviiiFourOctets\expandafter$\fi
10252         }}%
10253   \UTFviiiLoop
10254 \endgroup
10255
10256 \def\globallet{\global\let} % save some \expandafter's below
10257
10258 % @U{xxxx} to produce U+xxxx, if we support it.
10259 \def\U#1{%
10260   \expandafter\ifx\csname uni:#1\endcsname \relax
10261     \iftxinativeunicodecapable
10262       % All Unicode characters can be used if native Unicode handling is
10263       % active.  However, if the font does not have the glyph,
10264       % letters are missing.
10265       \begingroup
10266         \uccode`\.="#1\relax
10267         \uppercase{.}
10268       \endgroup
10269     \else
10270       \errhelp = \EMsimple
10271       \errmessage{Unicode character U+#1 not supported, sorry}%
10272     \fi
10273   \else
10274     \csname uni:#1\endcsname
10275   \fi
10276 }
10277
10278 % These macros are used here to construct the name of a control
10279 % sequence to be defined.
10280 \def\UTFviiiTwoOctetsName#1#2{%
10281   \csname u8:#1\string #2\endcsname}%
10282 \def\UTFviiiThreeOctetsName#1#2#3{%
10283   \csname u8:#1\string #2\string #3\endcsname}%
10284 \def\UTFviiiFourOctetsName#1#2#3#4{%
10285   \csname u8:#1\string #2\string #3\string #4\endcsname}%
10286
10287 % For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
10288 % provide a definition macro to replace a Unicode character;
10289 % this gets used by the @U command
10290 %
10291 \begingroup
10292   \catcode`\"=12
10293   \catcode`\<=12
10294   \catcode`\.=12
10295   \catcode`\,=12
10296   \catcode`\;=12
10297   \catcode`\!=12
10298   \catcode`\~=13
10299   \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
10300     \countUTFz = "#1\relax
10301     \begingroup
10302       \parseXMLCharref
10303
10304       % Give \u8:... its definition.  The sequence of seven \expandafter's
10305       % expands after the \gdef three times, e.g.
10306       %
10307       % 1.  \UTFviiTwoOctetsName B1 B2
10308       % 2.  \csname u8:B1 \string B2 \endcsname
10309       % 3.  \u8: B1 B2  (a single control sequence token)
10310       %
10311       \expandafter\expandafter
10312       \expandafter\expandafter
10313       \expandafter\expandafter
10314       \expandafter\gdef       \UTFviiiTmp{#2}%
10315       %
10316       \expandafter\ifx\csname uni:#1\endcsname \relax \else
10317        \message{Internal error, already defined: #1}%
10318       \fi
10319       %
10320       % define an additional control sequence for this code point.
10321       \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
10322     \endgroup}
10323   %
10324   % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
10325   % to the corresponding UTF-8 sequence.
10326   \gdef\parseXMLCharref{%
10327     \ifnum\countUTFz < "A0\relax
10328       \errhelp = \EMsimple
10329       \errmessage{Cannot define Unicode char value < 00A0}%
10330     \else\ifnum\countUTFz < "800\relax
10331       \parseUTFviiiA,%
10332       \parseUTFviiiB C\UTFviiiTwoOctetsName.,%
10333     \else\ifnum\countUTFz < "10000\relax
10334       \parseUTFviiiA;%
10335       \parseUTFviiiA,%
10336       \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}%
10337     \else
10338       \parseUTFviiiA;%
10339       \parseUTFviiiA,%
10340       \parseUTFviiiA!%
10341       \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}%
10342     \fi\fi\fi
10343   }
10344
10345   % Extract a byte from the end of the UTF-8 representation of \countUTFx.
10346   % It must be a non-initial byte in the sequence.
10347   % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
10348   % of the bytes.
10349   \gdef\parseUTFviiiA#1{%
10350     \countUTFx = \countUTFz
10351     \divide\countUTFz by 64
10352     \countUTFy = \countUTFz  % Save to be the future value of \countUTFz.
10353     \multiply\countUTFz by 64
10354
10355     % \countUTFz is now \countUTFx with the last 5 bits cleared.  Subtract
10356     % in order to get the last five bits.
10357     \advance\countUTFx by -\countUTFz
10358
10359     % Convert this to the byte in the UTF-8 sequence.
10360     \advance\countUTFx by 128
10361     \uccode `#1\countUTFx
10362     \countUTFz = \countUTFy}
10363
10364   % Used to put a UTF-8 byte sequence into \UTFviiiTmp
10365   % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
10366   %    sequence.
10367   % #2 is one of the \UTFviii*OctetsName macros.
10368   % #3 is always a full stop (.)
10369   % #4 is a template for the other bytes in the sequence.  The values for these
10370   %    bytes is substituted in here with \uppercase using the \uccode's.
10371   \gdef\parseUTFviiiB#1#2#3#4{%
10372     \advance\countUTFz by "#10\relax
10373     \uccode `#3\countUTFz
10374     \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
10375 \endgroup
10376
10377 % For native Unicode handling (XeTeX and LuaTeX),
10378 % provide a definition macro that sets a catcode to `other' non-globally
10379 %
10380 \def\DeclareUnicodeCharacterNativeOther#1#2{%
10381   \catcode"#1=\other
10382 }
10383
10384 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
10385 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
10386 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
10387 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
10388 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
10389 %
10390 % Many of our renditions are less than wonderful, and all the missing
10391 % characters are available somewhere.  Loading the necessary fonts
10392 % awaits user request.  We can't truly support Unicode without
10393 % reimplementing everything that's been done in LaTeX for many years,
10394 % plus probably using luatex or xetex, and who knows what else.
10395 % We won't be doing that here in this simple file.  But we can try to at
10396 % least make most of the characters not bomb out.
10397 %
10398 \def\unicodechardefs{%
10399   \DeclareUnicodeCharacter{00A0}{\tie}%
10400   \DeclareUnicodeCharacter{00A1}{\exclamdown}%
10401   \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
10402   \DeclareUnicodeCharacter{00A3}{\pounds{}}%
10403   \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
10404   \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
10405   \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
10406   \DeclareUnicodeCharacter{00A7}{\S}%
10407   \DeclareUnicodeCharacter{00A8}{\"{ }}%
10408   \DeclareUnicodeCharacter{00A9}{\copyright{}}%
10409   \DeclareUnicodeCharacter{00AA}{\ordf}%
10410   \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}%
10411   \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
10412   \DeclareUnicodeCharacter{00AD}{\-}%
10413   \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}%
10414   \DeclareUnicodeCharacter{00AF}{\={ }}%
10415   %
10416   \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}%
10417   \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
10418   \DeclareUnicodeCharacter{00B2}{$^2$}%
10419   \DeclareUnicodeCharacter{00B3}{$^3$}%
10420   \DeclareUnicodeCharacter{00B4}{\'{ }}%
10421   \DeclareUnicodeCharacter{00B5}{$\mu$}%
10422   \DeclareUnicodeCharacter{00B6}{\P}%
10423   \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
10424   \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
10425   \DeclareUnicodeCharacter{00B9}{$^1$}%
10426   \DeclareUnicodeCharacter{00BA}{\ordm}%
10427   \DeclareUnicodeCharacter{00BB}{\guillemetright{}}%
10428   \DeclareUnicodeCharacter{00BC}{$1\over4$}%
10429   \DeclareUnicodeCharacter{00BD}{$1\over2$}%
10430   \DeclareUnicodeCharacter{00BE}{$3\over4$}%
10431   \DeclareUnicodeCharacter{00BF}{\questiondown}%
10432   %
10433   \DeclareUnicodeCharacter{00C0}{\`A}%
10434   \DeclareUnicodeCharacter{00C1}{\'A}%
10435   \DeclareUnicodeCharacter{00C2}{\^A}%
10436   \DeclareUnicodeCharacter{00C3}{\~A}%
10437   \DeclareUnicodeCharacter{00C4}{\"A}%
10438   \DeclareUnicodeCharacter{00C5}{\AA}%
10439   \DeclareUnicodeCharacter{00C6}{\AE}%
10440   \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
10441   \DeclareUnicodeCharacter{00C8}{\`E}%
10442   \DeclareUnicodeCharacter{00C9}{\'E}%
10443   \DeclareUnicodeCharacter{00CA}{\^E}%
10444   \DeclareUnicodeCharacter{00CB}{\"E}%
10445   \DeclareUnicodeCharacter{00CC}{\`I}%
10446   \DeclareUnicodeCharacter{00CD}{\'I}%
10447   \DeclareUnicodeCharacter{00CE}{\^I}%
10448   \DeclareUnicodeCharacter{00CF}{\"I}%
10449   %
10450   \DeclareUnicodeCharacter{00D0}{\DH}%
10451   \DeclareUnicodeCharacter{00D1}{\~N}%
10452   \DeclareUnicodeCharacter{00D2}{\`O}%
10453   \DeclareUnicodeCharacter{00D3}{\'O}%
10454   \DeclareUnicodeCharacter{00D4}{\^O}%
10455   \DeclareUnicodeCharacter{00D5}{\~O}%
10456   \DeclareUnicodeCharacter{00D6}{\"O}%
10457   \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
10458   \DeclareUnicodeCharacter{00D8}{\O}%
10459   \DeclareUnicodeCharacter{00D9}{\`U}%
10460   \DeclareUnicodeCharacter{00DA}{\'U}%
10461   \DeclareUnicodeCharacter{00DB}{\^U}%
10462   \DeclareUnicodeCharacter{00DC}{\"U}%
10463   \DeclareUnicodeCharacter{00DD}{\'Y}%
10464   \DeclareUnicodeCharacter{00DE}{\TH}%
10465   \DeclareUnicodeCharacter{00DF}{\ss}%
10466   %
10467   \DeclareUnicodeCharacter{00E0}{\`a}%
10468   \DeclareUnicodeCharacter{00E1}{\'a}%
10469   \DeclareUnicodeCharacter{00E2}{\^a}%
10470   \DeclareUnicodeCharacter{00E3}{\~a}%
10471   \DeclareUnicodeCharacter{00E4}{\"a}%
10472   \DeclareUnicodeCharacter{00E5}{\aa}%
10473   \DeclareUnicodeCharacter{00E6}{\ae}%
10474   \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
10475   \DeclareUnicodeCharacter{00E8}{\`e}%
10476   \DeclareUnicodeCharacter{00E9}{\'e}%
10477   \DeclareUnicodeCharacter{00EA}{\^e}%
10478   \DeclareUnicodeCharacter{00EB}{\"e}%
10479   \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
10480   \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
10481   \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
10482   \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
10483   %
10484   \DeclareUnicodeCharacter{00F0}{\dh}%
10485   \DeclareUnicodeCharacter{00F1}{\~n}%
10486   \DeclareUnicodeCharacter{00F2}{\`o}%
10487   \DeclareUnicodeCharacter{00F3}{\'o}%
10488   \DeclareUnicodeCharacter{00F4}{\^o}%
10489   \DeclareUnicodeCharacter{00F5}{\~o}%
10490   \DeclareUnicodeCharacter{00F6}{\"o}%
10491   \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
10492   \DeclareUnicodeCharacter{00F8}{\o}%
10493   \DeclareUnicodeCharacter{00F9}{\`u}%
10494   \DeclareUnicodeCharacter{00FA}{\'u}%
10495   \DeclareUnicodeCharacter{00FB}{\^u}%
10496   \DeclareUnicodeCharacter{00FC}{\"u}%
10497   \DeclareUnicodeCharacter{00FD}{\'y}%
10498   \DeclareUnicodeCharacter{00FE}{\th}%
10499   \DeclareUnicodeCharacter{00FF}{\"y}%
10500   %
10501   \DeclareUnicodeCharacter{0100}{\=A}%
10502   \DeclareUnicodeCharacter{0101}{\=a}%
10503   \DeclareUnicodeCharacter{0102}{\u{A}}%
10504   \DeclareUnicodeCharacter{0103}{\u{a}}%
10505   \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
10506   \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
10507   \DeclareUnicodeCharacter{0106}{\'C}%
10508   \DeclareUnicodeCharacter{0107}{\'c}%
10509   \DeclareUnicodeCharacter{0108}{\^C}%
10510   \DeclareUnicodeCharacter{0109}{\^c}%
10511   \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
10512   \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
10513   \DeclareUnicodeCharacter{010C}{\v{C}}%
10514   \DeclareUnicodeCharacter{010D}{\v{c}}%
10515   \DeclareUnicodeCharacter{010E}{\v{D}}%
10516   \DeclareUnicodeCharacter{010F}{d'}%
10517   %
10518   \DeclareUnicodeCharacter{0110}{\DH}%
10519   \DeclareUnicodeCharacter{0111}{\dh}%
10520   \DeclareUnicodeCharacter{0112}{\=E}%
10521   \DeclareUnicodeCharacter{0113}{\=e}%
10522   \DeclareUnicodeCharacter{0114}{\u{E}}%
10523   \DeclareUnicodeCharacter{0115}{\u{e}}%
10524   \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
10525   \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
10526   \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
10527   \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
10528   \DeclareUnicodeCharacter{011A}{\v{E}}%
10529   \DeclareUnicodeCharacter{011B}{\v{e}}%
10530   \DeclareUnicodeCharacter{011C}{\^G}%
10531   \DeclareUnicodeCharacter{011D}{\^g}%
10532   \DeclareUnicodeCharacter{011E}{\u{G}}%
10533   \DeclareUnicodeCharacter{011F}{\u{g}}%
10534   %
10535   \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
10536   \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
10537   \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
10538   \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
10539   \DeclareUnicodeCharacter{0124}{\^H}%
10540   \DeclareUnicodeCharacter{0125}{\^h}%
10541   \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
10542   \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
10543   \DeclareUnicodeCharacter{0128}{\~I}%
10544   \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
10545   \DeclareUnicodeCharacter{012A}{\=I}%
10546   \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
10547   \DeclareUnicodeCharacter{012C}{\u{I}}%
10548   \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
10549   \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
10550   \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
10551   %
10552   \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
10553   \DeclareUnicodeCharacter{0131}{\dotless{i}}%
10554   \DeclareUnicodeCharacter{0132}{IJ}%
10555   \DeclareUnicodeCharacter{0133}{ij}%
10556   \DeclareUnicodeCharacter{0134}{\^J}%
10557   \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
10558   \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
10559   \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
10560   \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
10561   \DeclareUnicodeCharacter{0139}{\'L}%
10562   \DeclareUnicodeCharacter{013A}{\'l}%
10563   \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
10564   \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
10565   \DeclareUnicodeCharacter{013D}{L'}% should kern
10566   \DeclareUnicodeCharacter{013E}{l'}% should kern
10567   \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
10568   %
10569   \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
10570   \DeclareUnicodeCharacter{0141}{\L}%
10571   \DeclareUnicodeCharacter{0142}{\l}%
10572   \DeclareUnicodeCharacter{0143}{\'N}%
10573   \DeclareUnicodeCharacter{0144}{\'n}%
10574   \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
10575   \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
10576   \DeclareUnicodeCharacter{0147}{\v{N}}%
10577   \DeclareUnicodeCharacter{0148}{\v{n}}%
10578   \DeclareUnicodeCharacter{0149}{'n}%
10579   \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
10580   \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
10581   \DeclareUnicodeCharacter{014C}{\=O}%
10582   \DeclareUnicodeCharacter{014D}{\=o}%
10583   \DeclareUnicodeCharacter{014E}{\u{O}}%
10584   \DeclareUnicodeCharacter{014F}{\u{o}}%
10585   %
10586   \DeclareUnicodeCharacter{0150}{\H{O}}%
10587   \DeclareUnicodeCharacter{0151}{\H{o}}%
10588   \DeclareUnicodeCharacter{0152}{\OE}%
10589   \DeclareUnicodeCharacter{0153}{\oe}%
10590   \DeclareUnicodeCharacter{0154}{\'R}%
10591   \DeclareUnicodeCharacter{0155}{\'r}%
10592   \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
10593   \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
10594   \DeclareUnicodeCharacter{0158}{\v{R}}%
10595   \DeclareUnicodeCharacter{0159}{\v{r}}%
10596   \DeclareUnicodeCharacter{015A}{\'S}%
10597   \DeclareUnicodeCharacter{015B}{\'s}%
10598   \DeclareUnicodeCharacter{015C}{\^S}%
10599   \DeclareUnicodeCharacter{015D}{\^s}%
10600   \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
10601   \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
10602   %
10603   \DeclareUnicodeCharacter{0160}{\v{S}}%
10604   \DeclareUnicodeCharacter{0161}{\v{s}}%
10605   \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
10606   \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
10607   \DeclareUnicodeCharacter{0164}{\v{T}}%
10608   \DeclareUnicodeCharacter{0165}{\v{t}}%
10609   \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
10610   \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
10611   \DeclareUnicodeCharacter{0168}{\~U}%
10612   \DeclareUnicodeCharacter{0169}{\~u}%
10613   \DeclareUnicodeCharacter{016A}{\=U}%
10614   \DeclareUnicodeCharacter{016B}{\=u}%
10615   \DeclareUnicodeCharacter{016C}{\u{U}}%
10616   \DeclareUnicodeCharacter{016D}{\u{u}}%
10617   \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
10618   \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
10619   %
10620   \DeclareUnicodeCharacter{0170}{\H{U}}%
10621   \DeclareUnicodeCharacter{0171}{\H{u}}%
10622   \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
10623   \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
10624   \DeclareUnicodeCharacter{0174}{\^W}%
10625   \DeclareUnicodeCharacter{0175}{\^w}%
10626   \DeclareUnicodeCharacter{0176}{\^Y}%
10627   \DeclareUnicodeCharacter{0177}{\^y}%
10628   \DeclareUnicodeCharacter{0178}{\"Y}%
10629   \DeclareUnicodeCharacter{0179}{\'Z}%
10630   \DeclareUnicodeCharacter{017A}{\'z}%
10631   \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
10632   \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
10633   \DeclareUnicodeCharacter{017D}{\v{Z}}%
10634   \DeclareUnicodeCharacter{017E}{\v{z}}%
10635   \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
10636   %
10637   \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
10638   \DeclareUnicodeCharacter{01C5}{D\v{z}}%
10639   \DeclareUnicodeCharacter{01C6}{d\v{z}}%
10640   \DeclareUnicodeCharacter{01C7}{LJ}%
10641   \DeclareUnicodeCharacter{01C8}{Lj}%
10642   \DeclareUnicodeCharacter{01C9}{lj}%
10643   \DeclareUnicodeCharacter{01CA}{NJ}%
10644   \DeclareUnicodeCharacter{01CB}{Nj}%
10645   \DeclareUnicodeCharacter{01CC}{nj}%
10646   \DeclareUnicodeCharacter{01CD}{\v{A}}%
10647   \DeclareUnicodeCharacter{01CE}{\v{a}}%
10648   \DeclareUnicodeCharacter{01CF}{\v{I}}%
10649   %
10650   \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
10651   \DeclareUnicodeCharacter{01D1}{\v{O}}%
10652   \DeclareUnicodeCharacter{01D2}{\v{o}}%
10653   \DeclareUnicodeCharacter{01D3}{\v{U}}%
10654   \DeclareUnicodeCharacter{01D4}{\v{u}}%
10655   %
10656   \DeclareUnicodeCharacter{01E2}{\={\AE}}%
10657   \DeclareUnicodeCharacter{01E3}{\={\ae}}%
10658   \DeclareUnicodeCharacter{01E6}{\v{G}}%
10659   \DeclareUnicodeCharacter{01E7}{\v{g}}%
10660   \DeclareUnicodeCharacter{01E8}{\v{K}}%
10661   \DeclareUnicodeCharacter{01E9}{\v{k}}%
10662   %
10663   \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
10664   \DeclareUnicodeCharacter{01F1}{DZ}%
10665   \DeclareUnicodeCharacter{01F2}{Dz}%
10666   \DeclareUnicodeCharacter{01F3}{dz}%
10667   \DeclareUnicodeCharacter{01F4}{\'G}%
10668   \DeclareUnicodeCharacter{01F5}{\'g}%
10669   \DeclareUnicodeCharacter{01F8}{\`N}%
10670   \DeclareUnicodeCharacter{01F9}{\`n}%
10671   \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
10672   \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
10673   \DeclareUnicodeCharacter{01FE}{\'{\O}}%
10674   \DeclareUnicodeCharacter{01FF}{\'{\o}}%
10675   %
10676   \DeclareUnicodeCharacter{021E}{\v{H}}%
10677   \DeclareUnicodeCharacter{021F}{\v{h}}%
10678   %
10679   \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
10680   \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
10681   \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
10682   \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
10683   \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
10684   \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
10685   %
10686   \DeclareUnicodeCharacter{0232}{\=Y}%
10687   \DeclareUnicodeCharacter{0233}{\=y}%
10688   \DeclareUnicodeCharacter{0237}{\dotless{j}}%
10689   %
10690   \DeclareUnicodeCharacter{02BC}{'}%
10691   %
10692   \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
10693   %
10694   % Greek letters upper case
10695   \DeclareUnicodeCharacter{0391}{{\it A}}%
10696   \DeclareUnicodeCharacter{0392}{{\it B}}%
10697   \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
10698   \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
10699   \DeclareUnicodeCharacter{0395}{{\it E}}%
10700   \DeclareUnicodeCharacter{0396}{{\it Z}}%
10701   \DeclareUnicodeCharacter{0397}{{\it H}}%
10702   \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
10703   \DeclareUnicodeCharacter{0399}{{\it I}}%
10704   \DeclareUnicodeCharacter{039A}{{\it K}}%
10705   \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
10706   \DeclareUnicodeCharacter{039C}{{\it M}}%
10707   \DeclareUnicodeCharacter{039D}{{\it N}}%
10708   \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
10709   \DeclareUnicodeCharacter{039F}{{\it O}}%
10710   \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
10711   \DeclareUnicodeCharacter{03A1}{{\it P}}%
10712   %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
10713   \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
10714   \DeclareUnicodeCharacter{03A4}{{\it T}}%
10715   \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
10716   \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
10717   \DeclareUnicodeCharacter{03A7}{{\it X}}%
10718   \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
10719   \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
10720   %
10721   % Vowels with accents
10722   \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
10723   \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
10724   \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
10725   \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
10726   \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
10727   \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
10728   %
10729   % Standalone accent
10730   \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
10731   %
10732   % Greek letters lower case
10733   \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
10734   \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
10735   \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
10736   \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
10737   \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
10738   \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
10739   \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
10740   \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
10741   \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
10742   \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
10743   \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
10744   \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
10745   \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
10746   \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
10747   \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
10748   \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
10749   \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
10750   \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
10751   \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
10752   \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
10753   \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
10754   \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
10755   \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
10756   \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
10757   \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
10758   %
10759   % More Greek vowels with accents
10760   \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
10761   \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
10762   \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
10763   \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
10764   \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
10765   %
10766   % Variant Greek letters
10767   \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
10768   \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
10769   \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
10770   %
10771   \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
10772   \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
10773   \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
10774   \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
10775   \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
10776   \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
10777   \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
10778   \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
10779   \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
10780   \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
10781   \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
10782   \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
10783   %
10784   \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
10785   \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
10786   %
10787   \DeclareUnicodeCharacter{1E20}{\=G}%
10788   \DeclareUnicodeCharacter{1E21}{\=g}%
10789   \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
10790   \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
10791   \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
10792   \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
10793   \DeclareUnicodeCharacter{1E26}{\"H}%
10794   \DeclareUnicodeCharacter{1E27}{\"h}%
10795   %
10796   \DeclareUnicodeCharacter{1E30}{\'K}%
10797   \DeclareUnicodeCharacter{1E31}{\'k}%
10798   \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
10799   \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
10800   \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
10801   \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
10802   \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
10803   \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
10804   \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
10805   \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
10806   \DeclareUnicodeCharacter{1E3E}{\'M}%
10807   \DeclareUnicodeCharacter{1E3F}{\'m}%
10808   %
10809   \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
10810   \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
10811   \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
10812   \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
10813   \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
10814   \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
10815   \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
10816   \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
10817   \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
10818   \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
10819   %
10820   \DeclareUnicodeCharacter{1E54}{\'P}%
10821   \DeclareUnicodeCharacter{1E55}{\'p}%
10822   \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
10823   \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
10824   \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
10825   \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
10826   \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
10827   \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
10828   \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
10829   \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
10830   %
10831   \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
10832   \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
10833   \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
10834   \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
10835   \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
10836   \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
10837   \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
10838   \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
10839   \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
10840   \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
10841   %
10842   \DeclareUnicodeCharacter{1E7C}{\~V}%
10843   \DeclareUnicodeCharacter{1E7D}{\~v}%
10844   \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
10845   \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
10846   %
10847   \DeclareUnicodeCharacter{1E80}{\`W}%
10848   \DeclareUnicodeCharacter{1E81}{\`w}%
10849   \DeclareUnicodeCharacter{1E82}{\'W}%
10850   \DeclareUnicodeCharacter{1E83}{\'w}%
10851   \DeclareUnicodeCharacter{1E84}{\"W}%
10852   \DeclareUnicodeCharacter{1E85}{\"w}%
10853   \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
10854   \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
10855   \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
10856   \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
10857   \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
10858   \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
10859   \DeclareUnicodeCharacter{1E8C}{\"X}%
10860   \DeclareUnicodeCharacter{1E8D}{\"x}%
10861   \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
10862   \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
10863   %
10864   \DeclareUnicodeCharacter{1E90}{\^Z}%
10865   \DeclareUnicodeCharacter{1E91}{\^z}%
10866   \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
10867   \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
10868   \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
10869   \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
10870   \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
10871   \DeclareUnicodeCharacter{1E97}{\"t}%
10872   \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
10873   \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
10874   %
10875   \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
10876   \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
10877   %
10878   \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
10879   \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
10880   \DeclareUnicodeCharacter{1EBC}{\~E}%
10881   \DeclareUnicodeCharacter{1EBD}{\~e}%
10882   %
10883   \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
10884   \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
10885   \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
10886   \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
10887   %
10888   \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
10889   \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
10890   %
10891   \DeclareUnicodeCharacter{1EF2}{\`Y}%
10892   \DeclareUnicodeCharacter{1EF3}{\`y}%
10893   \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
10894   %
10895   \DeclareUnicodeCharacter{1EF8}{\~Y}%
10896   \DeclareUnicodeCharacter{1EF9}{\~y}%
10897   %
10898   % Exotic spaces
10899   \DeclareUnicodeCharacter{2007}{\hphantom{0}}%
10900   %
10901   % Punctuation
10902   \DeclareUnicodeCharacter{2013}{--}%
10903   \DeclareUnicodeCharacter{2014}{---}%
10904   \DeclareUnicodeCharacter{2018}{\quoteleft{}}%
10905   \DeclareUnicodeCharacter{2019}{\quoteright{}}%
10906   \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}%
10907   \DeclareUnicodeCharacter{201C}{\quotedblleft{}}%
10908   \DeclareUnicodeCharacter{201D}{\quotedblright{}}%
10909   \DeclareUnicodeCharacter{201E}{\quotedblbase{}}%
10910   \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
10911   \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
10912   \DeclareUnicodeCharacter{2022}{\bullet{}}%
10913   \DeclareUnicodeCharacter{202F}{\thinspace}%
10914   \DeclareUnicodeCharacter{2026}{\dots{}}%
10915   \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}%
10916   \DeclareUnicodeCharacter{203A}{\guilsinglright{}}%
10917   %
10918   \DeclareUnicodeCharacter{20AC}{\euro{}}%
10919   %
10920   \DeclareUnicodeCharacter{2192}{\expansion{}}%
10921   \DeclareUnicodeCharacter{21D2}{\result{}}%
10922   %
10923   % Mathematical symbols
10924   \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
10925   \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
10926   \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
10927   \DeclareUnicodeCharacter{2212}{\minus{}}%
10928   \DeclareUnicodeCharacter{2217}{\ast}%
10929   \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
10930   \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
10931   \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
10932   \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
10933   \DeclareUnicodeCharacter{2261}{\equiv{}}%
10934   \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
10935   \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
10936   \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
10937   \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
10938   %
10939   \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
10940   \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
10941   \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
10942   \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
10943   \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
10944   \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
10945   \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
10946   \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
10947   \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
10948   \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
10949   \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
10950   \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
10951   \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
10952   \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
10953   \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
10954   \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
10955   \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
10956   \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
10957   \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
10958   \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
10959   \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
10960   \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
10961   \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
10962   \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
10963   \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
10964   \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
10965   \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
10966   \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
10967   \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
10968   \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
10969   \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
10970   \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
10971   \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
10972   \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
10973   \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
10974   \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
10975   \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
10976   \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
10977   \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
10978   \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
10979   \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
10980   \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
10981   \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
10982   \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
10983   \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
10984   \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
10985   \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
10986   \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
10987   \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
10988   \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
10989   \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
10990   \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
10991   \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
10992   \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
10993   \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
10994   \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
10995   \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
10996   \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
10997   \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
10998   \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
10999   \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
11000   \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
11001   \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
11002   \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
11003   \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
11004   \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
11005   \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
11006   \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
11007   \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
11008   \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
11009   \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
11010   \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
11011   \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
11012   \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
11013   \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
11014   \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
11015   \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
11016   \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
11017   \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
11018   \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
11019   \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
11020   \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
11021   \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
11022   \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
11023   \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
11024   \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
11025   \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
11026   \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
11027   \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
11028   \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
11029   \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
11030   %
11031   \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
11032   \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
11033   \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
11034   \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
11035   \DeclareUnicodeCharacter{25C7}{\ensuremath\diamond}%
11036   \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
11037   \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
11038   \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
11039   \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
11040   \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
11041   \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
11042   \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
11043   \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
11044   \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
11045   \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
11046   \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
11047   \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
11048   \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
11049   \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
11050   \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
11051   \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
11052   \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
11053   \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
11054   \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
11055   \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
11056   \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
11057   \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
11058   \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
11059   \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
11060   %
11061   \global\mathchardef\checkmark="1370% actually the square root sign
11062   \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
11063 }% end of \unicodechardefs
11064
11065 % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
11066 % It makes the setting that replace UTF-8 byte sequence.
11067 \def\utfeightchardefs{%
11068   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
11069   \unicodechardefs
11070 }
11071
11072 % Whether the active definitions of non-ASCII characters expand to
11073 % non-active tokens with the same character code.  This is used to
11074 % write characters literally, instead of using active definitions for
11075 % printing the correct glyphs.
11076 \newif\ifpassthroughchars
11077 \passthroughcharsfalse
11078
11079 % For native Unicode handling (XeTeX and LuaTeX),
11080 % provide a definition macro to replace/pass-through a Unicode character
11081 %
11082 \def\DeclareUnicodeCharacterNative#1#2{%
11083   \catcode"#1=\active
11084   \def\dodeclareunicodecharacternative##1##2##3{%
11085     \begingroup
11086       \uccode`\~="##2\relax
11087       \uppercase{\gdef~}{%
11088         \ifpassthroughchars
11089           ##1%
11090         \else
11091           ##3%
11092         \fi
11093       }
11094     \endgroup
11095   }
11096   \begingroup
11097     \uccode`\.="#1\relax
11098     \uppercase{\def\UTFNativeTmp{.}}%
11099     \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
11100   \endgroup
11101 }
11102
11103 % Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
11104 % It activates the setting that replaces Unicode characters.
11105 \def\nativeunicodechardefs{%
11106   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
11107   \unicodechardefs
11108 }
11109
11110 % For native Unicode handling (XeTeX and LuaTeX),
11111 % make the character token expand
11112 % to the sequences given in \unicodechardefs for printing.
11113 \def\DeclareUnicodeCharacterNativeAtU#1#2{%
11114   \def\UTFAtUTmp{#2}
11115   \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
11116 }
11117
11118 % @U command definitions for native Unicode handling (XeTeX and LuaTeX).
11119 \def\nativeunicodechardefsatu{%
11120   \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
11121   \unicodechardefs
11122 }
11123
11124 % US-ASCII character definitions.
11125 \def\asciichardefs{% nothing need be done
11126    \relax
11127 }
11128
11129 % Define all Unicode characters we know about.  This makes UTF-8 the default
11130 % input encoding and allows @U to work.
11131 \iftxinativeunicodecapable
11132   \nativeunicodechardefsatu
11133 \else
11134   \utfeightchardefs
11135 \fi
11136
11137 \message{formatting,}
11138
11139 \newdimen\defaultparindent \defaultparindent = 15pt
11140
11141 \chapheadingskip = 15pt plus 4pt minus 2pt
11142 \secheadingskip = 12pt plus 3pt minus 2pt
11143 \subsecheadingskip = 9pt plus 2pt minus 2pt
11144
11145 % Prevent underfull vbox error messages.
11146 \vbadness = 10000
11147
11148 % Don't be very finicky about underfull hboxes, either.
11149 \hbadness = 6666
11150
11151 % Following George Bush, get rid of widows and orphans.
11152 \widowpenalty=10000
11153 \clubpenalty=10000
11154
11155 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
11156 % using an old version of TeX, don't do anything.  We want the amount of
11157 % stretch added to depend on the line length, hence the dependence on
11158 % \hsize.  We call this whenever the paper size is set.
11159 %
11160 \def\setemergencystretch{%
11161   \ifx\emergencystretch\thisisundefined
11162     % Allow us to assign to \emergencystretch anyway.
11163     \def\emergencystretch{\dimen0}%
11164   \else
11165     \emergencystretch = .15\hsize
11166   \fi
11167 }
11168
11169 % Parameters in order: 1) textheight; 2) textwidth;
11170 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
11171 % 7) physical page height; 8) physical page width.
11172 %
11173 % We also call \setleading{\textleading}, so the caller should define
11174 % \textleading.  The caller should also set \parskip.
11175 %
11176 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
11177   \voffset = #3\relax
11178   \topskip = #6\relax
11179   \splittopskip = \topskip
11180   %
11181   \vsize = #1\relax
11182   \advance\vsize by \topskip
11183   \outervsize = \vsize
11184   \advance\outervsize by 2\topandbottommargin
11185   \txipageheight = \vsize
11186   %
11187   \hsize = #2\relax
11188   \outerhsize = \hsize
11189   \advance\outerhsize by 0.5in
11190   \txipagewidth = \hsize
11191   %
11192   \normaloffset = #4\relax
11193   \bindingoffset = #5\relax
11194   %
11195   \ifpdf
11196     \pdfpageheight #7\relax
11197     \pdfpagewidth #8\relax
11198     % if we don't reset these, they will remain at "1 true in" of
11199     % whatever layout pdftex was dumped with.
11200     \pdfhorigin = 1 true in
11201     \pdfvorigin = 1 true in
11202   \else
11203     \ifx\XeTeXrevision\thisisundefined
11204       \special{papersize=#8,#7}%
11205     \else
11206       \pdfpageheight #7\relax
11207       \pdfpagewidth #8\relax
11208       % XeTeX does not have \pdfhorigin and \pdfvorigin.
11209     \fi
11210   \fi
11211   %
11212   \setleading{\textleading}
11213   %
11214   \parindent = \defaultparindent
11215   \setemergencystretch
11216 }
11217
11218 % @letterpaper (the default).
11219 \def\letterpaper{{\globaldefs = 1
11220   \parskip = 3pt plus 2pt minus 1pt
11221   \textleading = 13.2pt
11222   %
11223   % If page is nothing but text, make it come out even.
11224   \internalpagesizes{607.2pt}{6in}% that's 46 lines
11225                     {\voffset}{.25in}%
11226                     {\bindingoffset}{36pt}%
11227                     {11in}{8.5in}%
11228 }}
11229
11230 % Use @smallbook to reset parameters for 7x9.25 trim size.
11231 \def\smallbook{{\globaldefs = 1
11232   \parskip = 2pt plus 1pt
11233   \textleading = 12pt
11234   %
11235   \internalpagesizes{7.5in}{5in}%
11236                     {-.2in}{0in}%
11237                     {\bindingoffset}{16pt}%
11238                     {9.25in}{7in}%
11239   %
11240   \lispnarrowing = 0.3in
11241   \tolerance = 700
11242   \contentsrightmargin = 0pt
11243   \defbodyindent = .5cm
11244 }}
11245
11246 % Use @afourpaper to print on European A4 paper.
11247 \def\afourpaper{{\globaldefs = 1
11248   \parskip = 3pt plus 2pt minus 1pt
11249   \textleading = 13.2pt
11250   %
11251   % Double-side printing via postscript on Laserjet 4050
11252   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
11253   % To change the settings for a different printer or situation, adjust
11254   % \normaloffset until the front-side and back-side texts align.  Then
11255   % do the same for \bindingoffset.  You can set these for testing in
11256   % your texinfo source file like this:
11257   % @tex
11258   % \global\normaloffset = -6mm
11259   % \global\bindingoffset = 10mm
11260   % @end tex
11261   \internalpagesizes{673.2pt}{160mm}% that's 51 lines
11262                     {\voffset}{\hoffset}%
11263                     {\bindingoffset}{44pt}%
11264                     {297mm}{210mm}%
11265   %
11266   \tolerance = 700
11267   \contentsrightmargin = 0pt
11268   \defbodyindent = 5mm
11269 }}
11270
11271 % Use @afivepaper to print on European A5 paper.
11272 % From romildo@urano.iceb.ufop.br, 2 July 2000.
11273 % He also recommends making @example and @lisp be small.
11274 \def\afivepaper{{\globaldefs = 1
11275   \parskip = 2pt plus 1pt minus 0.1pt
11276   \textleading = 12.5pt
11277   %
11278   \internalpagesizes{160mm}{120mm}%
11279                     {\voffset}{\hoffset}%
11280                     {\bindingoffset}{8pt}%
11281                     {210mm}{148mm}%
11282   %
11283   \lispnarrowing = 0.2in
11284   \tolerance = 800
11285   \contentsrightmargin = 0pt
11286   \defbodyindent = 2mm
11287   \tableindent = 12mm
11288 }}
11289
11290 % A specific text layout, 24x15cm overall, intended for A4 paper.
11291 \def\afourlatex{{\globaldefs = 1
11292   \afourpaper
11293   \internalpagesizes{237mm}{150mm}%
11294                     {\voffset}{4.6mm}%
11295                     {\bindingoffset}{7mm}%
11296                     {297mm}{210mm}%
11297   %
11298   % Must explicitly reset to 0 because we call \afourpaper.
11299   \globaldefs = 0
11300 }}
11301
11302 % Use @afourwide to print on A4 paper in landscape format.
11303 \def\afourwide{{\globaldefs = 1
11304   \afourpaper
11305   \internalpagesizes{241mm}{165mm}%
11306                     {\voffset}{-2.95mm}%
11307                     {\bindingoffset}{7mm}%
11308                     {297mm}{210mm}%
11309   \globaldefs = 0
11310 }}
11311
11312 \def\bsixpaper{{\globaldefs = 1
11313   \afourpaper
11314   \internalpagesizes{140mm}{100mm}%
11315                     {-6.35mm}{-12.7mm}%
11316                     {\bindingoffset}{14pt}%
11317                     {176mm}{125mm}%
11318   \let\SETdispenvsize=\smallword
11319   \lispnarrowing = 0.2in
11320   \globaldefs = 0
11321 }}
11322
11323
11324 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
11325 % Perhaps we should allow setting the margins, \topskip, \parskip,
11326 % and/or leading, also. Or perhaps we should compute them somehow.
11327 %
11328 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
11329 \def\pagesizesyyy#1,#2,#3\finish{{%
11330   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
11331   \globaldefs = 1
11332   %
11333   \parskip = 3pt plus 2pt minus 1pt
11334   \setleading{\textleading}%
11335   %
11336   \dimen0 = #1\relax
11337   \advance\dimen0 by 2.5in % default 1in margin above heading line
11338                            % and 1.5in to include heading, footing and
11339                            % bottom margin
11340   %
11341   \dimen2 = \hsize
11342   \advance\dimen2 by 2in % default to 1 inch margin on each side
11343   %
11344   \internalpagesizes{#1}{\hsize}%
11345                     {\voffset}{\normaloffset}%
11346                     {\bindingoffset}{44pt}%
11347                     {\dimen0}{\dimen2}%
11348 }}
11349
11350 % Set default to letter.
11351 %
11352 \letterpaper
11353
11354 % Default value of \hfuzz, for suppressing warnings about overfull hboxes.
11355 \hfuzz = 1pt
11356
11357
11358 \message{and turning on texinfo input format.}
11359
11360 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
11361
11362 % DEL is a comment character, in case @c does not suffice.
11363 \catcode`\^^? = 14
11364
11365 % Define macros to output various characters with catcode for normal text.
11366 \catcode`\"=\other \def\normaldoublequote{"}
11367 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
11368 \catcode`\+=\other \def\normalplus{+}
11369 \catcode`\<=\other \def\normalless{<}
11370 \catcode`\>=\other \def\normalgreater{>}
11371 \catcode`\^=\other \def\normalcaret{^}
11372 \catcode`\_=\other \def\normalunderscore{_}
11373 \catcode`\|=\other \def\normalverticalbar{|}
11374 \catcode`\~=\other \def\normaltilde{~}
11375
11376 % This macro is used to make a character print one way in \tt
11377 % (where it can probably be output as-is), and another way in other fonts,
11378 % where something hairier probably needs to be done.
11379 %
11380 % #1 is what to print if we are indeed using \tt; #2 is what to print
11381 % otherwise.  Since all the Computer Modern typewriter fonts have zero
11382 % interword stretch (and shrink), and it is reasonable to expect all
11383 % typewriter fonts to have this, we can check that font parameter.
11384 %
11385 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
11386
11387 % Same as above, but check for italic font.  Actually this also catches
11388 % non-italic slanted fonts since it is impossible to distinguish them from
11389 % italic fonts.  But since this is only used by $ and it uses \sl anyway
11390 % this is not a problem.
11391 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
11392
11393 % Set catcodes for Texinfo file
11394
11395 % Active characters for printing the wanted glyph.
11396 % Most of these we simply print from the \tt font, but for some, we can
11397 % use math or other variants that look better in normal text.
11398 %
11399 \catcode`\"=\active
11400 \def\activedoublequote{{\tt\char34}}
11401 \let"=\activedoublequote
11402 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
11403 \chardef\hatchar=`\^
11404 \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
11405
11406 \catcode`\_=\active
11407 \def_{\ifusingtt\normalunderscore\_}
11408 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
11409 \let\realunder=_
11410
11411 \catcode`\|=\active \def|{{\tt\char124}}
11412
11413 \chardef \less=`\<
11414 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
11415 \chardef \gtr=`\>
11416 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
11417 \catcode`\+=\active \def+{{\tt \char 43}}
11418 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
11419 \catcode`\-=\active \let-=\normaldash
11420
11421
11422 % used for headline/footline in the output routine, in case the page
11423 % breaks in the middle of an @tex block.
11424 \def\texinfochars{%
11425   \let< = \activeless
11426   \let> = \activegtr
11427   \let~ = \activetilde
11428   \let^ = \activehat
11429   \setregularquotes
11430   \let\b = \strong
11431   \let\i = \smartitalic
11432   % in principle, all other definitions in \tex have to be undone too.
11433 }
11434
11435 % Used sometimes to turn off (effectively) the active characters even after
11436 % parsing them.
11437 \def\turnoffactive{%
11438   \normalturnoffactive
11439   \otherbackslash
11440 }
11441
11442 \catcode`\@=0
11443
11444 % \backslashcurfont outputs one backslash character in current font,
11445 % as in \char`\\.
11446 \global\chardef\backslashcurfont=`\\
11447
11448 % \realbackslash is an actual character `\' with catcode other.
11449 {\catcode`\\=\other @gdef@realbackslash{\}}
11450
11451 % In Texinfo, backslash is an active character; it prints the backslash
11452 % in fixed width font.
11453 \catcode`\\=\active  % @ for escape char from now on.
11454
11455 % Print a typewriter backslash.  For math mode, we can't simply use
11456 % \backslashcurfont: the story here is that in math mode, the \char
11457 % of \backslashcurfont ends up printing the roman \ from the math symbol
11458 % font (because \char in math mode uses the \mathcode, and plain.tex
11459 % sets \mathcode`\\="026E).  Hence we use an explicit \mathchar,
11460 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
11461 % ignored family value; char position "5C).  We can't use " for the
11462 % usual hex value because it has already been made active.
11463
11464 @def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
11465 @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
11466
11467 % \otherbackslash defines an active \ to be a literal `\' character with
11468 % catcode other.
11469 @gdef@otherbackslash{@let\=@realbackslash}
11470
11471 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
11472 % the literal character `\'.
11473 %
11474 {@catcode`- = @active
11475  @gdef@normalturnoffactive{%
11476    @passthroughcharstrue
11477    @let-=@normaldash
11478    @let"=@normaldoublequote
11479    @let$=@normaldollar %$ font-lock fix
11480    @let+=@normalplus
11481    @let<=@normalless
11482    @let>=@normalgreater
11483    @let^=@normalcaret
11484    @let_=@normalunderscore
11485    @let|=@normalverticalbar
11486    @let~=@normaltilde
11487    @let\=@ttbackslash
11488    @setregularquotes
11489    @unsepspaces
11490  }
11491 }
11492
11493 % If a .fmt file is being used, characters that might appear in a file
11494 % name cannot be active until we have parsed the command line.
11495 % So turn them off again, and have @fixbackslash turn them back on.
11496 @catcode`+=@other @catcode`@_=@other
11497
11498 % \enablebackslashhack - allow file to begin `\input texinfo'
11499 %
11500 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
11501 % That is what \eatinput is for; after that, the `\' should revert to printing
11502 % a backslash.
11503 % If the file did not have a `\input texinfo', then it is turned off after
11504 % the first line; otherwise the first `\' in the file would cause an error.
11505 % This is used on the very last line of this file, texinfo.tex.
11506 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
11507 {
11508 @catcode`@^=7
11509 @catcode`@^^M=13@gdef@enablebackslashhack{%
11510   @global@let\ = @eatinput%
11511   @catcode`@^^M=13%
11512   @def@c{@fixbackslash@c}%
11513   % Definition for the newline at the end of this file.
11514   @def ^^M{@let^^M@secondlinenl}%
11515   % Definition for a newline in the main Texinfo file.
11516   @gdef @secondlinenl{@fixbackslash}%
11517   % In case the first line has a whole-line command on it
11518   @let@originalparsearg@parsearg
11519   @def@parsearg{@fixbackslash@originalparsearg}
11520 }}
11521
11522 {@catcode`@^=7 @catcode`@^^M=13%
11523 @gdef@eatinput input texinfo#1^^M{@fixbackslash}}
11524
11525 % Emergency active definition of newline, in case an active newline token
11526 % appears by mistake.
11527 {@catcode`@^=7 @catcode13=13%
11528 @gdef@enableemergencynewline{%
11529   @gdef^^M{%
11530     @par%
11531     %<warning: active newline>@par%
11532 }}}
11533
11534
11535 @gdef@fixbackslash{%
11536   @ifx\@eatinput @let\ = @ttbackslash @fi
11537   @catcode13=5 % regular end of line
11538   @enableemergencynewline
11539   @let@c=@comment
11540   @let@parsearg@originalparsearg
11541   % Also turn back on active characters that might appear in the input
11542   % file name, in case not using a pre-dumped format.
11543   @catcode`+=@active
11544   @catcode`@_=@active
11545   %
11546   % If texinfo.cnf is present on the system, read it.
11547   % Useful for site-wide @afourpaper, etc.  This macro, @fixbackslash, gets
11548   % called at the beginning of every Texinfo file.  Not opening texinfo.cnf
11549   % directly in this file, texinfo.tex, makes it possible to make a format
11550   % file for Texinfo.
11551   %
11552   @openin 1 texinfo.cnf
11553   @ifeof 1 @else @input texinfo.cnf @fi
11554   @closein 1
11555 }
11556
11557
11558 % Say @foo, not \foo, in error messages.
11559 @escapechar = `@@
11560
11561 % These (along with & and #) are made active for url-breaking, so need
11562 % active definitions as the normal characters.
11563 @def@normaldot{.}
11564 @def@normalquest{?}
11565 @def@normalslash{/}
11566
11567 % These look ok in all fonts, so just make them not special.
11568 % @hashchar{} gets its own user-level command, because of #line.
11569 @catcode`@& = @other @def@normalamp{&}
11570 @catcode`@# = @other @def@normalhash{#}
11571 @catcode`@% = @other @def@normalpercent{%}
11572
11573 @let @hashchar = @normalhash
11574
11575 @c Finally, make ` and ' active, so that txicodequoteundirected and
11576 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
11577 @c don't make ` and ' active, @code will not get them as active chars.
11578 @c Do this last of all since we use ` in the previous @catcode assignments.
11579 @catcode`@'=@active
11580 @catcode`@`=@active
11581 @setregularquotes
11582
11583 @c Local variables:
11584 @c eval: (add-hook 'before-save-hook 'time-stamp nil t)
11585 @c time-stamp-pattern: "texinfoversion{%Y-%02m-%02d.%02H}"
11586 @c page-delimiter: "^\\\\message\\|emacs-page"
11587 @c End:
11588
11589 @c vim:sw=2:
11590
11591 @enablebackslashhack
11592