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