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