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