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-05-14.10}
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{27pt}}
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\, = \ptexc
2745 \let\dotaccent = \ptexdot
2746 \def\ringaccent#1{{\accent23 #1}}
2747 \let\tieaccent = \ptext
2748 \let\ubaraccent = \ptexb
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\entrybreak
4261   \definedummyword\equiv
4262   \definedummyword\error
4263   \definedummyword\euro
4264   \definedummyword\guillemetleft
4265   \definedummyword\guillemetright
4266   \definedummyword\guilsinglleft
4267   \definedummyword\guilsinglright
4268   \definedummyword\expansion
4269   \definedummyword\minus
4270   \definedummyword\ogonek
4271   \definedummyword\pounds
4272   \definedummyword\point
4273   \definedummyword\print
4274   \definedummyword\quotedblbase
4275   \definedummyword\quotedblleft
4276   \definedummyword\quotedblright
4277   \definedummyword\quoteleft
4278   \definedummyword\quoteright
4279   \definedummyword\quotesinglbase
4280   \definedummyword\result
4281   \definedummyword\textdegree
4282   %
4283   % We want to disable all macros so that they are not expanded by \write.
4284   \macrolist
4285   %
4286   \normalturnoffactive
4287   %
4288   % Handle some cases of @value -- where it does not contain any
4289   % (non-fully-expandable) commands.
4290   \makevalueexpandable
4291 }
4292
4293 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4294 %
4295 \def\commondummiesnofonts{%
4296   % Control letters and accents.
4297   \definedummyletter\!%
4298   \definedummyaccent\"%
4299   \definedummyaccent\'%
4300   \definedummyletter\*%
4301   \definedummyaccent\,%
4302   \definedummyletter\.%
4303   \definedummyletter\/%
4304   \definedummyletter\:%
4305   \definedummyaccent\=%
4306   \definedummyletter\?%
4307   \definedummyaccent\^%
4308   \definedummyaccent\`%
4309   \definedummyaccent\~%
4310   \definedummyword\u
4311   \definedummyword\v
4312   \definedummyword\H
4313   \definedummyword\dotaccent
4314   \definedummyword\ogonek
4315   \definedummyword\ringaccent
4316   \definedummyword\tieaccent
4317   \definedummyword\ubaraccent
4318   \definedummyword\udotaccent
4319   \definedummyword\dotless
4320   %
4321   % Texinfo font commands.
4322   \definedummyword\b
4323   \definedummyword\i
4324   \definedummyword\r
4325   \definedummyword\sc
4326   \definedummyword\t
4327   %
4328   % Commands that take arguments.
4329   \definedummyword\acronym
4330   \definedummyword\cite
4331   \definedummyword\code
4332   \definedummyword\command
4333   \definedummyword\dfn
4334   \definedummyword\email
4335   \definedummyword\emph
4336   \definedummyword\env
4337   \definedummyword\file
4338   \definedummyword\kbd
4339   \definedummyword\key
4340   \definedummyword\math
4341   \definedummyword\option
4342   \definedummyword\pxref
4343   \definedummyword\ref
4344   \definedummyword\samp
4345   \definedummyword\strong
4346   \definedummyword\tie
4347   \definedummyword\uref
4348   \definedummyword\url
4349   \definedummyword\var
4350   \definedummyword\verb
4351   \definedummyword\w
4352   \definedummyword\xref
4353 }
4354
4355 % \indexnofonts is used when outputting the strings to sort the index
4356 % by, and when constructing control sequence names.  It eliminates all
4357 % control sequences and just writes whatever the best ASCII sort string
4358 % would be for a given command (usually its argument).
4359 %
4360 \def\indexnofonts{%
4361   % Accent commands should become @asis.
4362   \def\definedummyaccent##1{\let##1\asis}%
4363   % We can just ignore other control letters.
4364   \def\definedummyletter##1{\let##1\empty}%
4365   % Hopefully, all control words can become @asis.
4366   \let\definedummyword\definedummyaccent
4367   %
4368   \commondummiesnofonts
4369   %
4370   % Don't no-op \tt, since it isn't a user-level command
4371   % and is used in the definitions of the active chars like <, >, |, etc.
4372   % Likewise with the other plain tex font commands.
4373   %\let\tt=\asis
4374   %
4375   \def\ { }%
4376   \def\@{@}%
4377   % how to handle braces?
4378   \def\_{\normalunderscore}%
4379   %
4380   % Non-English letters.
4381   \def\AA{AA}%
4382   \def\AE{AE}%
4383   \def\DH{DZZ}%
4384   \def\L{L}%
4385   \def\OE{OE}%
4386   \def\O{O}%
4387   \def\TH{ZZZ}%
4388   \def\aa{aa}%
4389   \def\ae{ae}%
4390   \def\dh{dzz}%
4391   \def\exclamdown{!}%
4392   \def\l{l}%
4393   \def\oe{oe}%
4394   \def\ordf{a}%
4395   \def\ordm{o}%
4396   \def\o{o}%
4397   \def\questiondown{?}%
4398   \def\ss{ss}%
4399   \def\th{zzz}%
4400   %
4401   \def\LaTeX{LaTeX}%
4402   \def\TeX{TeX}%
4403   %
4404   % Assorted special characters.
4405   % (The following {} will end up in the sort string, but that's ok.)
4406   \def\bullet{bullet}%
4407   \def\comma{,}%
4408   \def\copyright{copyright}%
4409   \def\dots{...}%
4410   \def\enddots{...}%
4411   \def\equiv{==}%
4412   \def\error{error}%
4413   \def\euro{euro}%
4414   \def\expansion{==>}%
4415   \def\guillemetleft{<<}%
4416   \def\guillemetright{>>}%
4417   \def\guilsinglleft{<}%
4418   \def\guilsinglright{>}%
4419   \def\minus{-}%
4420   \def\point{.}%
4421   \def\pounds{pounds}%
4422   \def\print{-|}%
4423   \def\quotedblbase{"}%
4424   \def\quotedblleft{"}%
4425   \def\quotedblright{"}%
4426   \def\quoteleft{`}%
4427   \def\quoteright{'}%
4428   \def\quotesinglbase{,}%
4429   \def\registeredsymbol{R}%
4430   \def\result{=>}%
4431   \def\textdegree{o}%
4432   %
4433   % We need to get rid of all macros, leaving only the arguments (if present).
4434   % Of course this is not nearly correct, but it is the best we can do for now.
4435   % makeinfo does not expand macros in the argument to @deffn, which ends up
4436   % writing an index entry, and texindex isn't prepared for an index sort entry
4437   % that starts with \.
4438   %
4439   % Since macro invocations are followed by braces, we can just redefine them
4440   % to take a single TeX argument.  The case of a macro invocation that
4441   % goes to end-of-line is not handled.
4442   %
4443   \macrolist
4444 }
4445
4446 \let\indexbackslash=0  %overridden during \printindex.
4447 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4448
4449 % Most index entries go through here, but \dosubind is the general case.
4450 % #1 is the index name, #2 is the entry text.
4451 \def\doind#1#2{\dosubind{#1}{#2}{}}
4452
4453 % Workhorse for all \fooindexes.
4454 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4455 % empty if called from \doind, as we usually are (the main exception
4456 % is with most defuns, which call us directly).
4457 %
4458 \def\dosubind#1#2#3{%
4459   \iflinks
4460   {%
4461     % Store the main index entry text (including the third arg).
4462     \toks0 = {#2}%
4463     % If third arg is present, precede it with a space.
4464     \def\thirdarg{#3}%
4465     \ifx\thirdarg\empty \else
4466       \toks0 = \expandafter{\the\toks0 \space #3}%
4467     \fi
4468     %
4469     \edef\writeto{\csname#1indfile\endcsname}%
4470     %
4471     \safewhatsit\dosubindwrite
4472   }%
4473   \fi
4474 }
4475
4476 % Write the entry in \toks0 to the index file:
4477 %
4478 \def\dosubindwrite{%
4479   % Put the index entry in the margin if desired.
4480   \ifx\SETmarginindex\relax\else
4481     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4482   \fi
4483   %
4484   % Remember, we are within a group.
4485   \indexdummies % Must do this here, since \bf, etc expand at this stage
4486   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4487       % so it will be output as is; and it will print as backslash.
4488   %
4489   % Process the index entry with all font commands turned off, to
4490   % get the string to sort by.
4491   {\indexnofonts
4492    \edef\temp{\the\toks0}% need full expansion
4493    \xdef\indexsorttmp{\temp}%
4494   }%
4495   %
4496   % Set up the complete index entry, with both the sort key and
4497   % the original text, including any font commands.  We write
4498   % three arguments to \entry to the .?? file (four in the
4499   % subentry case), texindex reduces to two when writing the .??s
4500   % sorted result.
4501   \edef\temp{%
4502     \write\writeto{%
4503       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4504   }%
4505   \temp
4506 }
4507
4508 % Take care of unwanted page breaks/skips around a whatsit:
4509 %
4510 % If a skip is the last thing on the list now, preserve it
4511 % by backing up by \lastskip, doing the \write, then inserting
4512 % the skip again.  Otherwise, the whatsit generated by the
4513 % \write or \pdfdest will make \lastskip zero.  The result is that
4514 % sequences like this:
4515 % @end defun
4516 % @tindex whatever
4517 % @defun ...
4518 % will have extra space inserted, because the \medbreak in the
4519 % start of the @defun won't see the skip inserted by the @end of
4520 % the previous defun.
4521 %
4522 % But don't do any of this if we're not in vertical mode.  We
4523 % don't want to do a \vskip and prematurely end a paragraph.
4524 %
4525 % Avoid page breaks due to these extra skips, too.
4526 %
4527 % But wait, there is a catch there:
4528 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
4529 % sufficient for this purpose, as it ignores stretch and shrink parts
4530 % of the skip.  The only way seems to be to check the textual
4531 % representation of the skip.
4532 %
4533 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4534 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4535 %
4536 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4537 %
4538 \newskip\whatsitskip
4539 \newcount\whatsitpenalty
4540 %
4541 % ..., ready, GO:
4542 %
4543 \def\safewhatsit#1{%
4544 \ifhmode
4545   #1%
4546 \else
4547   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4548   \whatsitskip = \lastskip
4549   \edef\lastskipmacro{\the\lastskip}%
4550   \whatsitpenalty = \lastpenalty
4551   %
4552   % If \lastskip is nonzero, that means the last item was a
4553   % skip.  And since a skip is discardable, that means this
4554   % -\whatsitskip glue we're inserting is preceded by a
4555   % non-discardable item, therefore it is not a potential
4556   % breakpoint, therefore no \nobreak needed.
4557   \ifx\lastskipmacro\zeroskipmacro
4558   \else
4559     \vskip-\whatsitskip
4560   \fi
4561   %
4562   #1%
4563   %
4564   \ifx\lastskipmacro\zeroskipmacro
4565     % If \lastskip was zero, perhaps the last item was a penalty, and
4566     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
4567     % to re-insert the same penalty (values >10000 are used for various
4568     % signals); since we just inserted a non-discardable item, any
4569     % following glue (such as a \parskip) would be a breakpoint.  For example:
4570     %
4571     %   @deffn deffn-whatever
4572     %   @vindex index-whatever
4573     %   Description.
4574     % would allow a break between the index-whatever whatsit
4575     % and the "Description." paragraph.
4576     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4577   \else
4578     % On the other hand, if we had a nonzero \lastskip,
4579     % this make-up glue would be preceded by a non-discardable item
4580     % (the whatsit from the \write), so we must insert a \nobreak.
4581     \nobreak\vskip\whatsitskip
4582   \fi
4583 \fi
4584 }
4585
4586 % The index entry written in the file actually looks like
4587 %  \entry {sortstring}{page}{topic}
4588 % or
4589 %  \entry {sortstring}{page}{topic}{subtopic}
4590 % The texindex program reads in these files and writes files
4591 % containing these kinds of lines:
4592 %  \initial {c}
4593 %     before the first topic whose initial is c
4594 %  \entry {topic}{pagelist}
4595 %     for a topic that is used without subtopics
4596 %  \primary {topic}
4597 %     for the beginning of a topic that is used with subtopics
4598 %  \secondary {subtopic}{pagelist}
4599 %     for each subtopic.
4600
4601 % Define the user-accessible indexing commands
4602 % @findex, @vindex, @kindex, @cindex.
4603
4604 \def\findex {\fnindex}
4605 \def\kindex {\kyindex}
4606 \def\cindex {\cpindex}
4607 \def\vindex {\vrindex}
4608 \def\tindex {\tpindex}
4609 \def\pindex {\pgindex}
4610
4611 \def\cindexsub {\begingroup\obeylines\cindexsub}
4612 {\obeylines %
4613 \gdef\cindexsub "#1" #2^^M{\endgroup %
4614 \dosubind{cp}{#2}{#1}}}
4615
4616 % Define the macros used in formatting output of the sorted index material.
4617
4618 % @printindex causes a particular index (the ??s file) to get printed.
4619 % It does not print any chapter heading (usually an @unnumbered).
4620 %
4621 \parseargdef\printindex{\begingroup
4622   \dobreak \chapheadingskip{10000}%
4623   %
4624   \smallfonts \rm
4625   \tolerance = 9500
4626   \plainfrenchspacing
4627   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4628   %
4629   % See if the index file exists and is nonempty.
4630   % Change catcode of @ here so that if the index file contains
4631   % \initial {@}
4632   % as its first line, TeX doesn't complain about mismatched braces
4633   % (because it thinks @} is a control sequence).
4634   \catcode`\@ = 11
4635   \openin 1 \jobname.#1s
4636   \ifeof 1
4637     % \enddoublecolumns gets confused if there is no text in the index,
4638     % and it loses the chapter title and the aux file entries for the
4639     % index.  The easiest way to prevent this problem is to make sure
4640     % there is some text.
4641     \putwordIndexNonexistent
4642   \else
4643     %
4644     % If the index file exists but is empty, then \openin leaves \ifeof
4645     % false.  We have to make TeX try to read something from the file, so
4646     % it can discover if there is anything in it.
4647     \read 1 to \temp
4648     \ifeof 1
4649       \putwordIndexIsEmpty
4650     \else
4651       % Index files are almost Texinfo source, but we use \ as the escape
4652       % character.  It would be better to use @, but that's too big a change
4653       % to make right now.
4654       \def\indexbackslash{\backslashcurfont}%
4655       \catcode`\\ = 0
4656       \escapechar = `\\
4657       \begindoublecolumns
4658       \input \jobname.#1s
4659       \enddoublecolumns
4660     \fi
4661   \fi
4662   \closein 1
4663 \endgroup}
4664
4665 % These macros are used by the sorted index file itself.
4666 % Change them to control the appearance of the index.
4667
4668 \def\initial#1{{%
4669   % Some minor font changes for the special characters.
4670   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4671   %
4672   % Remove any glue we may have, we'll be inserting our own.
4673   \removelastskip
4674   %
4675   % We like breaks before the index initials, so insert a bonus.
4676   \nobreak
4677   \vskip 0pt plus 3\baselineskip
4678   \penalty 0
4679   \vskip 0pt plus -3\baselineskip
4680   %
4681   % Typeset the initial.  Making this add up to a whole number of
4682   % baselineskips increases the chance of the dots lining up from column
4683   % to column.  It still won't often be perfect, because of the stretch
4684   % we need before each entry, but it's better.
4685   %
4686   % No shrink because it confuses \balancecolumns.
4687   \vskip 1.67\baselineskip plus .5\baselineskip
4688   \leftline{\secbf #1}%
4689   % Do our best not to break after the initial.
4690   \nobreak
4691   \vskip .33\baselineskip plus .1\baselineskip
4692 }}
4693
4694 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4695 % then page number (#2) flushed to the right margin.  It is used for index
4696 % and table of contents entries.  The paragraph is indented by \leftskip.
4697 %
4698 % A straightforward implementation would start like this:
4699 %       \def\entry#1#2{...
4700 % But this freezes the catcodes in the argument, and can cause problems to
4701 % @code, which sets - active.  This problem was fixed by a kludge---
4702 % ``-'' was active throughout whole index, but this isn't really right.
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     \def\entrybreak{\hfil\break}%
4744     %
4745     % Swallow the left brace of the text (first parameter):
4746     \afterassignment\doentry
4747     \let\temp =
4748 }
4749 \def\entrybreak{\unskip\space\ignorespaces}%
4750 \def\doentry{%
4751     \bgroup % Instead of the swallowed brace.
4752       \noindent
4753       \aftergroup\finishentry
4754       % And now comes the text of the entry.
4755 }
4756 \def\finishentry#1{%
4757     % #1 is the page number.
4758     %
4759     % The following is kludged to not output a line of dots in the index if
4760     % there are no page numbers.  The next person who breaks this will be
4761     % cursed by a Unix daemon.
4762     \setbox\boxA = \hbox{#1}%
4763     \ifdim\wd\boxA = 0pt
4764       \ %
4765     \else
4766       %
4767       % If we must, put the page number on a line of its own, and fill out
4768       % this line with blank space.  (The \hfil is overwhelmed with the
4769       % fill leaders glue in \indexdotfill if the page number does fit.)
4770       \hfil\penalty50
4771       \null\nobreak\indexdotfill % Have leaders before the page number.
4772       %
4773       % The `\ ' here is removed by the implicit \unskip that TeX does as
4774       % part of (the primitive) \par.  Without it, a spurious underfull
4775       % \hbox ensues.
4776       \ifpdf
4777         \pdfgettoks#1.%
4778         \ \the\toksA
4779       \else
4780         \ #1%
4781       \fi
4782     \fi
4783     \par
4784   \endgroup
4785 }
4786
4787 % Like plain.tex's \dotfill, except uses up at least 1 em.
4788 \def\indexdotfill{\cleaders
4789   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4790
4791 \def\primary #1{\line{#1\hfil}}
4792
4793 \newskip\secondaryindent \secondaryindent=0.5cm
4794 \def\secondary#1#2{{%
4795   \parfillskip=0in
4796   \parskip=0in
4797   \hangindent=1in
4798   \hangafter=1
4799   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4800   \ifpdf
4801     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4802   \else
4803     #2
4804   \fi
4805   \par
4806 }}
4807
4808 % Define two-column mode, which we use to typeset indexes.
4809 % Adapted from the TeXbook, page 416, which is to say,
4810 % the manmac.tex format used to print the TeXbook itself.
4811 \catcode`\@=11
4812
4813 \newbox\partialpage
4814 \newdimen\doublecolumnhsize
4815
4816 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4817   % Grab any single-column material above us.
4818   \output = {%
4819     %
4820     % Here is a possibility not foreseen in manmac: if we accumulate a
4821     % whole lot of material, we might end up calling this \output
4822     % routine twice in a row (see the doublecol-lose test, which is
4823     % essentially a couple of indexes with @setchapternewpage off).  In
4824     % that case we just ship out what is in \partialpage with the normal
4825     % output routine.  Generally, \partialpage will be empty when this
4826     % runs and this will be a no-op.  See the indexspread.tex test case.
4827     \ifvoid\partialpage \else
4828       \onepageout{\pagecontents\partialpage}%
4829     \fi
4830     %
4831     \global\setbox\partialpage = \vbox{%
4832       % Unvbox the main output page.
4833       \unvbox\PAGE
4834       \kern-\topskip \kern\baselineskip
4835     }%
4836   }%
4837   \eject % run that output routine to set \partialpage
4838   %
4839   % Use the double-column output routine for subsequent pages.
4840   \output = {\doublecolumnout}%
4841   %
4842   % Change the page size parameters.  We could do this once outside this
4843   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4844   % format, but then we repeat the same computation.  Repeating a couple
4845   % of assignments once per index is clearly meaningless for the
4846   % execution time, so we may as well do it in one place.
4847   %
4848   % First we halve the line length, less a little for the gutter between
4849   % the columns.  We compute the gutter based on the line length, so it
4850   % changes automatically with the paper format.  The magic constant
4851   % below is chosen so that the gutter has the same value (well, +-<1pt)
4852   % as it did when we hard-coded it.
4853   %
4854   % We put the result in a separate register, \doublecolumhsize, so we
4855   % can restore it in \pagesofar, after \hsize itself has (potentially)
4856   % been clobbered.
4857   %
4858   \doublecolumnhsize = \hsize
4859     \advance\doublecolumnhsize by -.04154\hsize
4860     \divide\doublecolumnhsize by 2
4861   \hsize = \doublecolumnhsize
4862   %
4863   % Double the \vsize as well.  (We don't need a separate register here,
4864   % since nobody clobbers \vsize.)
4865   \vsize = 2\vsize
4866 }
4867
4868 % The double-column output routine for all double-column pages except
4869 % the last.
4870 %
4871 \def\doublecolumnout{%
4872   \splittopskip=\topskip \splitmaxdepth=\maxdepth
4873   % Get the available space for the double columns -- the normal
4874   % (undoubled) page height minus any material left over from the
4875   % previous page.
4876   \dimen@ = \vsize
4877   \divide\dimen@ by 2
4878   \advance\dimen@ by -\ht\partialpage
4879   %
4880   % box0 will be the left-hand column, box2 the right.
4881   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4882   \onepageout\pagesofar
4883   \unvbox255
4884   \penalty\outputpenalty
4885 }
4886 %
4887 % Re-output the contents of the output page -- any previous material,
4888 % followed by the two boxes we just split, in box0 and box2.
4889 \def\pagesofar{%
4890   \unvbox\partialpage
4891   %
4892   \hsize = \doublecolumnhsize
4893   \wd0=\hsize \wd2=\hsize
4894   \hbox to\pagewidth{\box0\hfil\box2}%
4895 }
4896 %
4897 % All done with double columns.
4898 \def\enddoublecolumns{%
4899   % The following penalty ensures that the page builder is exercised
4900   % _before_ we change the output routine.  This is necessary in the
4901   % following situation:
4902   %
4903   % The last section of the index consists only of a single entry.
4904   % Before this section, \pagetotal is less than \pagegoal, so no
4905   % break occurs before the last section starts.  However, the last
4906   % section, consisting of \initial and the single \entry, does not
4907   % fit on the page and has to be broken off.  Without the following
4908   % penalty the page builder will not be exercised until \eject
4909   % below, and by that time we'll already have changed the output
4910   % routine to the \balancecolumns version, so the next-to-last
4911   % double-column page will be processed with \balancecolumns, which
4912   % is wrong:  The two columns will go to the main vertical list, with
4913   % the broken-off section in the recent contributions.  As soon as
4914   % the output routine finishes, TeX starts reconsidering the page
4915   % break.  The two columns and the broken-off section both fit on the
4916   % page, because the two columns now take up only half of the page
4917   % goal.  When TeX sees \eject from below which follows the final
4918   % section, it invokes the new output routine that we've set after
4919   % \balancecolumns below; \onepageout will try to fit the two columns
4920   % and the final section into the vbox of \pageheight (see
4921   % \pagebody), causing an overfull box.
4922   %
4923   % Note that glue won't work here, because glue does not exercise the
4924   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4925   \penalty0
4926   %
4927   \output = {%
4928     % Split the last of the double-column material.  Leave it on the
4929     % current page, no automatic page break.
4930     \balancecolumns
4931     %
4932     % If we end up splitting too much material for the current page,
4933     % though, there will be another page break right after this \output
4934     % invocation ends.  Having called \balancecolumns once, we do not
4935     % want to call it again.  Therefore, reset \output to its normal
4936     % definition right away.  (We hope \balancecolumns will never be
4937     % called on to balance too much material, but if it is, this makes
4938     % the output somewhat more palatable.)
4939     \global\output = {\onepageout{\pagecontents\PAGE}}%
4940   }%
4941   \eject
4942   \endgroup % started in \begindoublecolumns
4943   %
4944   % \pagegoal was set to the doubled \vsize above, since we restarted
4945   % the current page.  We're now back to normal single-column
4946   % typesetting, so reset \pagegoal to the normal \vsize (after the
4947   % \endgroup where \vsize got restored).
4948   \pagegoal = \vsize
4949 }
4950 %
4951 % Called at the end of the double column material.
4952 \def\balancecolumns{%
4953   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4954   \dimen@ = \ht0
4955   \advance\dimen@ by \topskip
4956   \advance\dimen@ by-\baselineskip
4957   \divide\dimen@ by 2 % target to split to
4958   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4959   \splittopskip = \topskip
4960   % Loop until we get a decent breakpoint.
4961   {%
4962     \vbadness = 10000
4963     \loop
4964       \global\setbox3 = \copy0
4965       \global\setbox1 = \vsplit3 to \dimen@
4966     \ifdim\ht3>\dimen@
4967       \global\advance\dimen@ by 1pt
4968     \repeat
4969   }%
4970   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4971   \setbox0=\vbox to\dimen@{\unvbox1}%
4972   \setbox2=\vbox to\dimen@{\unvbox3}%
4973   %
4974   \pagesofar
4975 }
4976 \catcode`\@ = \other
4977
4978
4979 \message{sectioning,}
4980 % Chapters, sections, etc.
4981
4982 % Let's start with @part.
4983 \outer\parseargdef\part{\partzzz{#1}}
4984 \def\partzzz#1{%
4985   \chapoddpage
4986   \null
4987   \vskip.3\vsize  % move it down on the page a bit
4988   \begingroup
4989     \noindent \titlefonts\rmisbold #1\par % the text
4990     \let\lastnode=\empty      % no node to associate with
4991     \writetocentry{part}{#1}{}% but put it in the toc
4992     \headingsoff              % no headline or footline on the part page
4993     \chapoddpage
4994   \endgroup
4995 }
4996
4997 % \unnumberedno is an oxymoron.  But we count the unnumbered
4998 % sections so that we can refer to them unambiguously in the pdf
4999 % outlines by their "section number".  We avoid collisions with chapter
5000 % numbers by starting them at 10000.  (If a document ever has 10000
5001 % chapters, we're in trouble anyway, I'm sure.)
5002 \newcount\unnumberedno \unnumberedno = 10000
5003 \newcount\chapno
5004 \newcount\secno        \secno=0
5005 \newcount\subsecno     \subsecno=0
5006 \newcount\subsubsecno  \subsubsecno=0
5007
5008 % This counter is funny since it counts through charcodes of letters A, B, ...
5009 \newcount\appendixno  \appendixno = `\@
5010 %
5011 % \def\appendixletter{\char\the\appendixno}
5012 % We do the following ugly conditional instead of the above simple
5013 % construct for the sake of pdftex, which needs the actual
5014 % letter in the expansion, not just typeset.
5015 %
5016 \def\appendixletter{%
5017   \ifnum\appendixno=`A A%
5018   \else\ifnum\appendixno=`B B%
5019   \else\ifnum\appendixno=`C C%
5020   \else\ifnum\appendixno=`D D%
5021   \else\ifnum\appendixno=`E E%
5022   \else\ifnum\appendixno=`F F%
5023   \else\ifnum\appendixno=`G G%
5024   \else\ifnum\appendixno=`H H%
5025   \else\ifnum\appendixno=`I I%
5026   \else\ifnum\appendixno=`J J%
5027   \else\ifnum\appendixno=`K K%
5028   \else\ifnum\appendixno=`L L%
5029   \else\ifnum\appendixno=`M M%
5030   \else\ifnum\appendixno=`N N%
5031   \else\ifnum\appendixno=`O O%
5032   \else\ifnum\appendixno=`P P%
5033   \else\ifnum\appendixno=`Q Q%
5034   \else\ifnum\appendixno=`R R%
5035   \else\ifnum\appendixno=`S S%
5036   \else\ifnum\appendixno=`T T%
5037   \else\ifnum\appendixno=`U U%
5038   \else\ifnum\appendixno=`V V%
5039   \else\ifnum\appendixno=`W W%
5040   \else\ifnum\appendixno=`X X%
5041   \else\ifnum\appendixno=`Y Y%
5042   \else\ifnum\appendixno=`Z Z%
5043   % The \the is necessary, despite appearances, because \appendixletter is
5044   % expanded while writing the .toc file.  \char\appendixno is not
5045   % expandable, thus it is written literally, thus all appendixes come out
5046   % with the same letter (or @) in the toc without it.
5047   \else\char\the\appendixno
5048   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5049   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5050
5051 % Each @chapter defines these (using marks) as the number+name, number
5052 % and name of the chapter.  Page headings and footings can use
5053 % these.  @section does likewise.
5054 \def\thischapter{}
5055 \def\thischapternum{}
5056 \def\thischaptername{}
5057 \def\thissection{}
5058 \def\thissectionnum{}
5059 \def\thissectionname{}
5060
5061 \newcount\absseclevel % used to calculate proper heading level
5062 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5063
5064 % @raisesections: treat @section as chapter, @subsection as section, etc.
5065 \def\raisesections{\global\advance\secbase by -1}
5066 \let\up=\raisesections % original BFox name
5067
5068 % @lowersections: treat @chapter as section, @section as subsection, etc.
5069 \def\lowersections{\global\advance\secbase by 1}
5070 \let\down=\lowersections % original BFox name
5071
5072 % we only have subsub.
5073 \chardef\maxseclevel = 3
5074 %
5075 % A numbered section within an unnumbered changes to unnumbered too.
5076 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5077 \chardef\unnlevel = \maxseclevel
5078 %
5079 % Trace whether the current chapter is an appendix or not:
5080 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5081 \def\chapheadtype{N}
5082
5083 % Choose a heading macro
5084 % #1 is heading type
5085 % #2 is heading level
5086 % #3 is text for heading
5087 \def\genhead#1#2#3{%
5088   % Compute the abs. sec. level:
5089   \absseclevel=#2
5090   \advance\absseclevel by \secbase
5091   % Make sure \absseclevel doesn't fall outside the range:
5092   \ifnum \absseclevel < 0
5093     \absseclevel = 0
5094   \else
5095     \ifnum \absseclevel > 3
5096       \absseclevel = 3
5097     \fi
5098   \fi
5099   % The heading type:
5100   \def\headtype{#1}%
5101   \if \headtype U%
5102     \ifnum \absseclevel < \unnlevel
5103       \chardef\unnlevel = \absseclevel
5104     \fi
5105   \else
5106     % Check for appendix sections:
5107     \ifnum \absseclevel = 0
5108       \edef\chapheadtype{\headtype}%
5109     \else
5110       \if \headtype A\if \chapheadtype N%
5111         \errmessage{@appendix... within a non-appendix chapter}%
5112       \fi\fi
5113     \fi
5114     % Check for numbered within unnumbered:
5115     \ifnum \absseclevel > \unnlevel
5116       \def\headtype{U}%
5117     \else
5118       \chardef\unnlevel = 3
5119     \fi
5120   \fi
5121   % Now print the heading:
5122   \if \headtype U%
5123     \ifcase\absseclevel
5124         \unnumberedzzz{#3}%
5125     \or \unnumberedseczzz{#3}%
5126     \or \unnumberedsubseczzz{#3}%
5127     \or \unnumberedsubsubseczzz{#3}%
5128     \fi
5129   \else
5130     \if \headtype A%
5131       \ifcase\absseclevel
5132           \appendixzzz{#3}%
5133       \or \appendixsectionzzz{#3}%
5134       \or \appendixsubseczzz{#3}%
5135       \or \appendixsubsubseczzz{#3}%
5136       \fi
5137     \else
5138       \ifcase\absseclevel
5139           \chapterzzz{#3}%
5140       \or \seczzz{#3}%
5141       \or \numberedsubseczzz{#3}%
5142       \or \numberedsubsubseczzz{#3}%
5143       \fi
5144     \fi
5145   \fi
5146   \suppressfirstparagraphindent
5147 }
5148
5149 % an interface:
5150 \def\numhead{\genhead N}
5151 \def\apphead{\genhead A}
5152 \def\unnmhead{\genhead U}
5153
5154 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
5155 % all lower-level sectioning counters to zero.
5156 %
5157 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5158 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
5159 \let\chaplevelprefix = \empty
5160 %
5161 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5162 \def\chapterzzz#1{%
5163   % section resetting is \global in case the chapter is in a group, such
5164   % as an @include file.
5165   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5166     \global\advance\chapno by 1
5167   %
5168   % Used for \float.
5169   \gdef\chaplevelprefix{\the\chapno.}%
5170   \resetallfloatnos
5171   %
5172   % \putwordChapter can contain complex things in translations.
5173   \toks0=\expandafter{\putwordChapter}%
5174   \message{\the\toks0 \space \the\chapno}%
5175   %
5176   % Write the actual heading.
5177   \chapmacro{#1}{Ynumbered}{\the\chapno}%
5178   %
5179   % So @section and the like are numbered underneath this chapter.
5180   \global\let\section = \numberedsec
5181   \global\let\subsection = \numberedsubsec
5182   \global\let\subsubsection = \numberedsubsubsec
5183 }
5184
5185 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5186 %
5187 \def\appendixzzz#1{%
5188   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5189     \global\advance\appendixno by 1
5190   \gdef\chaplevelprefix{\appendixletter.}%
5191   \resetallfloatnos
5192   %
5193   % \putwordAppendix can contain complex things in translations.
5194   \toks0=\expandafter{\putwordAppendix}%
5195   \message{\the\toks0 \space \appendixletter}%
5196   %
5197   \chapmacro{#1}{Yappendix}{\appendixletter}%
5198   %
5199   \global\let\section = \appendixsec
5200   \global\let\subsection = \appendixsubsec
5201   \global\let\subsubsection = \appendixsubsubsec
5202 }
5203
5204 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5205 \def\unnumberedzzz#1{%
5206   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5207     \global\advance\unnumberedno by 1
5208   %
5209   % Since an unnumbered has no number, no prefix for figures.
5210   \global\let\chaplevelprefix = \empty
5211   \resetallfloatnos
5212   %
5213   % This used to be simply \message{#1}, but TeX fully expands the
5214   % argument to \message.  Therefore, if #1 contained @-commands, TeX
5215   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
5216   % expanded @cite (which turns out to cause errors because \cite is meant
5217   % to be executed, not expanded).
5218   %
5219   % Anyway, we don't want the fully-expanded definition of @cite to appear
5220   % as a result of the \message, we just want `@cite' itself.  We use
5221   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5222   % simply yielding the contents of <toks register>.  (We also do this for
5223   % the toc entries.)
5224   \toks0 = {#1}%
5225   \message{(\the\toks0)}%
5226   %
5227   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5228   %
5229   \global\let\section = \unnumberedsec
5230   \global\let\subsection = \unnumberedsubsec
5231   \global\let\subsubsection = \unnumberedsubsubsec
5232 }
5233
5234 % @centerchap is like @unnumbered, but the heading is centered.
5235 \outer\parseargdef\centerchap{%
5236   % Well, we could do the following in a group, but that would break
5237   % an assumption that \chapmacro is called at the outermost level.
5238   % Thus we are safer this way:         --kasal, 24feb04
5239   \let\centerparametersmaybe = \centerparameters
5240   \unnmhead0{#1}%
5241   \let\centerparametersmaybe = \relax
5242 }
5243
5244 % @top is like @unnumbered.
5245 \let\top\unnumbered
5246
5247 % Sections.
5248 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5249 \def\seczzz#1{%
5250   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5251   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5252 }
5253
5254 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5255 \def\appendixsectionzzz#1{%
5256   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5257   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5258 }
5259 \let\appendixsec\appendixsection
5260
5261 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5262 \def\unnumberedseczzz#1{%
5263   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5264   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5265 }
5266
5267 % Subsections.
5268 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5269 \def\numberedsubseczzz#1{%
5270   \global\subsubsecno=0  \global\advance\subsecno by 1
5271   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5272 }
5273
5274 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5275 \def\appendixsubseczzz#1{%
5276   \global\subsubsecno=0  \global\advance\subsecno by 1
5277   \sectionheading{#1}{subsec}{Yappendix}%
5278                  {\appendixletter.\the\secno.\the\subsecno}%
5279 }
5280
5281 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5282 \def\unnumberedsubseczzz#1{%
5283   \global\subsubsecno=0  \global\advance\subsecno by 1
5284   \sectionheading{#1}{subsec}{Ynothing}%
5285                  {\the\unnumberedno.\the\secno.\the\subsecno}%
5286 }
5287
5288 % Subsubsections.
5289 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5290 \def\numberedsubsubseczzz#1{%
5291   \global\advance\subsubsecno by 1
5292   \sectionheading{#1}{subsubsec}{Ynumbered}%
5293                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5294 }
5295
5296 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5297 \def\appendixsubsubseczzz#1{%
5298   \global\advance\subsubsecno by 1
5299   \sectionheading{#1}{subsubsec}{Yappendix}%
5300                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5301 }
5302
5303 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5304 \def\unnumberedsubsubseczzz#1{%
5305   \global\advance\subsubsecno by 1
5306   \sectionheading{#1}{subsubsec}{Ynothing}%
5307                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5308 }
5309
5310 % These macros control what the section commands do, according
5311 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5312 % Define them by default for a numbered chapter.
5313 \let\section = \numberedsec
5314 \let\subsection = \numberedsubsec
5315 \let\subsubsection = \numberedsubsubsec
5316
5317 % Define @majorheading, @heading and @subheading
5318
5319 % NOTE on use of \vbox for chapter headings, section headings, and such:
5320 %       1) We use \vbox rather than the earlier \line to permit
5321 %          overlong headings to fold.
5322 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
5323 %          heading is obnoxious; this forbids it.
5324 %       3) Likewise, headings look best if no \parindent is used, and
5325 %          if justification is not attempted.  Hence \raggedright.
5326
5327 \def\majorheading{%
5328   {\advance\chapheadingskip by 10pt \chapbreak }%
5329   \parsearg\chapheadingzzz
5330 }
5331
5332 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5333 \def\chapheadingzzz#1{%
5334   {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5335                     \parindent=0pt\ptexraggedright
5336                     \rmisbold #1\hfill}}%
5337   \bigskip \par\penalty 200\relax
5338   \suppressfirstparagraphindent
5339 }
5340
5341 % @heading, @subheading, @subsubheading.
5342 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5343   \suppressfirstparagraphindent}
5344 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5345   \suppressfirstparagraphindent}
5346 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5347   \suppressfirstparagraphindent}
5348
5349 % These macros generate a chapter, section, etc. heading only
5350 % (including whitespace, linebreaking, etc. around it),
5351 % given all the information in convenient, parsed form.
5352
5353 %%% Args are the skip and penalty (usually negative)
5354 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5355
5356 %%% Define plain chapter starts, and page on/off switching for it
5357 % Parameter controlling skip before chapter headings (if needed)
5358
5359 \newskip\chapheadingskip
5360
5361 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5362 \def\chappager{\par\vfill\supereject}
5363 % Because \domark is called before \chapoddpage, the filler page will
5364 % get the headings for the next chapter, which is wrong.  But we don't
5365 % care -- we just disable all headings on the filler page.
5366 \def\chapoddpage{%
5367   \chappager
5368   \ifodd\pageno \else
5369     \begingroup
5370       \headingsoff
5371       \null
5372       \chappager
5373     \endgroup
5374   \fi
5375 }
5376
5377 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5378
5379 \def\CHAPPAGoff{%
5380 \global\let\contentsalignmacro = \chappager
5381 \global\let\pchapsepmacro=\chapbreak
5382 \global\let\pagealignmacro=\chappager}
5383
5384 \def\CHAPPAGon{%
5385 \global\let\contentsalignmacro = \chappager
5386 \global\let\pchapsepmacro=\chappager
5387 \global\let\pagealignmacro=\chappager
5388 \global\def\HEADINGSon{\HEADINGSsingle}}
5389
5390 \def\CHAPPAGodd{%
5391 \global\let\contentsalignmacro = \chapoddpage
5392 \global\let\pchapsepmacro=\chapoddpage
5393 \global\let\pagealignmacro=\chapoddpage
5394 \global\def\HEADINGSon{\HEADINGSdouble}}
5395
5396 \CHAPPAGon
5397
5398 % Chapter opening.
5399 %
5400 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5401 % Yappendix, Yomitfromtoc), #3 the chapter number.
5402 %
5403 % To test against our argument.
5404 \def\Ynothingkeyword{Ynothing}
5405 \def\Yomitfromtockeyword{Yomitfromtoc}
5406 \def\Yappendixkeyword{Yappendix}
5407 %
5408 \def\chapmacro#1#2#3{%
5409   % Insert the first mark before the heading break (see notes for \domark).
5410   \let\prevchapterdefs=\lastchapterdefs
5411   \let\prevsectiondefs=\lastsectiondefs
5412   \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5413                         \gdef\thissection{}}%
5414   %
5415   \def\temptype{#2}%
5416   \ifx\temptype\Ynothingkeyword
5417     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5418                           \gdef\thischapter{\thischaptername}}%
5419   \else\ifx\temptype\Yomitfromtockeyword
5420     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5421                           \gdef\thischapter{}}%
5422   \else\ifx\temptype\Yappendixkeyword
5423     \toks0={#1}%
5424     \xdef\lastchapterdefs{%
5425       \gdef\noexpand\thischaptername{\the\toks0}%
5426       \gdef\noexpand\thischapternum{\appendixletter}%
5427       % \noexpand\putwordAppendix avoids expanding indigestible
5428       % commands in some of the translations.
5429       \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5430                                  \noexpand\thischapternum:
5431                                  \noexpand\thischaptername}%
5432     }%
5433   \else
5434     \toks0={#1}%
5435     \xdef\lastchapterdefs{%
5436       \gdef\noexpand\thischaptername{\the\toks0}%
5437       \gdef\noexpand\thischapternum{\the\chapno}%
5438       % \noexpand\putwordChapter avoids expanding indigestible
5439       % commands in some of the translations.
5440       \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5441                                  \noexpand\thischapternum:
5442                                  \noexpand\thischaptername}%
5443     }%
5444   \fi\fi\fi
5445   %
5446   % Output the mark.  Pass it through \safewhatsit, to take care of
5447   % the preceding space.
5448   \safewhatsit\domark
5449   %
5450   % Insert the chapter heading break.
5451   \pchapsepmacro
5452   %
5453   % Now the second mark, after the heading break.  No break points
5454   % between here and the heading.
5455   \let\prevchapterdefs=\lastchapterdefs
5456   \let\prevsectiondefs=\lastsectiondefs
5457   \domark
5458   %
5459   {%
5460     \chapfonts \rmisbold
5461     %
5462     % Have to define \lastsection before calling \donoderef, because the
5463     % xref code eventually uses it.  On the other hand, it has to be called
5464     % after \pchapsepmacro, or the headline will change too soon.
5465     \gdef\lastsection{#1}%
5466     %
5467     % Only insert the separating space if we have a chapter/appendix
5468     % number, and don't print the unnumbered ``number''.
5469     \ifx\temptype\Ynothingkeyword
5470       \setbox0 = \hbox{}%
5471       \def\toctype{unnchap}%
5472     \else\ifx\temptype\Yomitfromtockeyword
5473       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5474       \def\toctype{omit}%
5475     \else\ifx\temptype\Yappendixkeyword
5476       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5477       \def\toctype{app}%
5478     \else
5479       \setbox0 = \hbox{#3\enspace}%
5480       \def\toctype{numchap}%
5481     \fi\fi\fi
5482     %
5483     % Write the toc entry for this chapter.  Must come before the
5484     % \donoderef, because we include the current node name in the toc
5485     % entry, and \donoderef resets it to empty.
5486     \writetocentry{\toctype}{#1}{#3}%
5487     %
5488     % For pdftex, we have to write out the node definition (aka, make
5489     % the pdfdest) after any page break, but before the actual text has
5490     % been typeset.  If the destination for the pdf outline is after the
5491     % text, then jumping from the outline may wind up with the text not
5492     % being visible, for instance under high magnification.
5493     \donoderef{#2}%
5494     %
5495     % Typeset the actual heading.
5496     \nobreak % Avoid page breaks at the interline glue.
5497     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5498           \hangindent=\wd0 \centerparametersmaybe
5499           \unhbox0 #1\par}%
5500   }%
5501   \nobreak\bigskip % no page break after a chapter title
5502   \nobreak
5503 }
5504
5505 % @centerchap -- centered and unnumbered.
5506 \let\centerparametersmaybe = \relax
5507 \def\centerparameters{%
5508   \advance\rightskip by 3\rightskip
5509   \leftskip = \rightskip
5510   \parfillskip = 0pt
5511 }
5512
5513
5514 % I don't think this chapter style is supported any more, so I'm not
5515 % updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
5516 %
5517 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5518 %
5519 \def\unnchfopen #1{%
5520 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5521                        \parindent=0pt\ptexraggedright
5522                        \rmisbold #1\hfill}}\bigskip \par\nobreak
5523 }
5524 \def\chfopen #1#2{\chapoddpage {\chapfonts
5525 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5526 \par\penalty 5000 %
5527 }
5528 \def\centerchfopen #1{%
5529 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5530                        \parindent=0pt
5531                        \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5532 }
5533 \def\CHAPFopen{%
5534   \global\let\chapmacro=\chfopen
5535   \global\let\centerchapmacro=\centerchfopen}
5536
5537
5538 % Section titles.  These macros combine the section number parts and
5539 % call the generic \sectionheading to do the printing.
5540 %
5541 \newskip\secheadingskip
5542 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5543
5544 % Subsection titles.
5545 \newskip\subsecheadingskip
5546 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5547
5548 % Subsubsection titles.
5549 \def\subsubsecheadingskip{\subsecheadingskip}
5550 \def\subsubsecheadingbreak{\subsecheadingbreak}
5551
5552
5553 % Print any size, any type, section title.
5554 %
5555 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5556 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5557 % section number.
5558 %
5559 \def\seckeyword{sec}
5560 %
5561 \def\sectionheading#1#2#3#4{%
5562   {%
5563     % Switch to the right set of fonts.
5564     \csname #2fonts\endcsname \rmisbold
5565     %
5566     \def\sectionlevel{#2}%
5567     \def\temptype{#3}%
5568     %
5569     % Insert first mark before the heading break (see notes for \domark).
5570     \let\prevsectiondefs=\lastsectiondefs
5571     \ifx\temptype\Ynothingkeyword
5572       \ifx\sectionlevel\seckeyword
5573         \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5574                               \gdef\thissection{\thissectionname}}%
5575       \fi
5576     \else\ifx\temptype\Yomitfromtockeyword
5577       % Don't redefine \thissection.
5578     \else\ifx\temptype\Yappendixkeyword
5579       \ifx\sectionlevel\seckeyword
5580         \toks0={#1}%
5581         \xdef\lastsectiondefs{%
5582           \gdef\noexpand\thissectionname{\the\toks0}%
5583           \gdef\noexpand\thissectionnum{#4}%
5584           % \noexpand\putwordSection avoids expanding indigestible
5585           % commands in some of the translations.
5586           \gdef\noexpand\thissection{\noexpand\putwordSection{}
5587                                      \noexpand\thissectionnum:
5588                                      \noexpand\thissectionname}%
5589         }%
5590       \fi
5591     \else
5592       \ifx\sectionlevel\seckeyword
5593         \toks0={#1}%
5594         \xdef\lastsectiondefs{%
5595           \gdef\noexpand\thissectionname{\the\toks0}%
5596           \gdef\noexpand\thissectionnum{#4}%
5597           % \noexpand\putwordSection avoids expanding indigestible
5598           % commands in some of the translations.
5599           \gdef\noexpand\thissection{\noexpand\putwordSection{}
5600                                      \noexpand\thissectionnum:
5601                                      \noexpand\thissectionname}%
5602         }%
5603       \fi
5604     \fi\fi\fi
5605     %
5606     % Go into vertical mode.  Usually we'll already be there, but we
5607     % don't want the following whatsit to end up in a preceding paragraph
5608     % if the document didn't happen to have a blank line.
5609     \par
5610     %
5611     % Output the mark.  Pass it through \safewhatsit, to take care of
5612     % the preceding space.
5613     \safewhatsit\domark
5614     %
5615     % Insert space above the heading.
5616     \csname #2headingbreak\endcsname
5617     %
5618     % Now the second mark, after the heading break.  No break points
5619     % between here and the heading.
5620     \let\prevsectiondefs=\lastsectiondefs
5621     \domark
5622     %
5623     % Only insert the space after the number if we have a section number.
5624     \ifx\temptype\Ynothingkeyword
5625       \setbox0 = \hbox{}%
5626       \def\toctype{unn}%
5627       \gdef\lastsection{#1}%
5628     \else\ifx\temptype\Yomitfromtockeyword
5629       % for @headings -- no section number, don't include in toc,
5630       % and don't redefine \lastsection.
5631       \setbox0 = \hbox{}%
5632       \def\toctype{omit}%
5633       \let\sectionlevel=\empty
5634     \else\ifx\temptype\Yappendixkeyword
5635       \setbox0 = \hbox{#4\enspace}%
5636       \def\toctype{app}%
5637       \gdef\lastsection{#1}%
5638     \else
5639       \setbox0 = \hbox{#4\enspace}%
5640       \def\toctype{num}%
5641       \gdef\lastsection{#1}%
5642     \fi\fi\fi
5643     %
5644     % Write the toc entry (before \donoderef).  See comments in \chapmacro.
5645     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5646     %
5647     % Write the node reference (= pdf destination for pdftex).
5648     % Again, see comments in \chapmacro.
5649     \donoderef{#3}%
5650     %
5651     % Interline glue will be inserted when the vbox is completed.
5652     % That glue will be a valid breakpoint for the page, since it'll be
5653     % preceded by a whatsit (usually from the \donoderef, or from the
5654     % \writetocentry if there was no node).  We don't want to allow that
5655     % break, since then the whatsits could end up on page n while the
5656     % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
5657     \nobreak
5658     %
5659     % Output the actual section heading.
5660     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5661           \hangindent=\wd0  % zero if no section number
5662           \unhbox0 #1}%
5663   }%
5664   % Add extra space after the heading -- half of whatever came above it.
5665   % Don't allow stretch, though.
5666   \kern .5 \csname #2headingskip\endcsname
5667   %
5668   % Do not let the kern be a potential breakpoint, as it would be if it
5669   % was followed by glue.
5670   \nobreak
5671   %
5672   % We'll almost certainly start a paragraph next, so don't let that
5673   % glue accumulate.  (Not a breakpoint because it's preceded by a
5674   % discardable item.)
5675   \vskip-\parskip
5676   %
5677   % This is purely so the last item on the list is a known \penalty >
5678   % 10000.  This is so \startdefun can avoid allowing breakpoints after
5679   % section headings.  Otherwise, it would insert a valid breakpoint between:
5680   %
5681   %   @section sec-whatever
5682   %   @deffn def-whatever
5683   \penalty 10001
5684 }
5685
5686
5687 \message{toc,}
5688 % Table of contents.
5689 \newwrite\tocfile
5690
5691 % Write an entry to the toc file, opening it if necessary.
5692 % Called from @chapter, etc.
5693 %
5694 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5695 % We append the current node name (if any) and page number as additional
5696 % arguments for the \{chap,sec,...}entry macros which will eventually
5697 % read this.  The node name is used in the pdf outlines as the
5698 % destination to jump to.
5699 %
5700 % We open the .toc file for writing here instead of at @setfilename (or
5701 % any other fixed time) so that @contents can be anywhere in the document.
5702 % But if #1 is `omit', then we don't do anything.  This is used for the
5703 % table of contents chapter openings themselves.
5704 %
5705 \newif\iftocfileopened
5706 \def\omitkeyword{omit}%
5707 %
5708 \def\writetocentry#1#2#3{%
5709   \edef\writetoctype{#1}%
5710   \ifx\writetoctype\omitkeyword \else
5711     \iftocfileopened\else
5712       \immediate\openout\tocfile = \jobname.toc
5713       \global\tocfileopenedtrue
5714     \fi
5715     %
5716     \iflinks
5717       {\atdummies
5718        \edef\temp{%
5719          \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5720        \temp
5721       }%
5722     \fi
5723   \fi
5724   %
5725   % Tell \shipout to create a pdf destination on each page, if we're
5726   % writing pdf.  These are used in the table of contents.  We can't
5727   % just write one on every page because the title pages are numbered
5728   % 1 and 2 (the page numbers aren't printed), and so are the first
5729   % two pages of the document.  Thus, we'd have two destinations named
5730   % `1', and two named `2'.
5731   \ifpdf \global\pdfmakepagedesttrue \fi
5732 }
5733
5734
5735 % These characters do not print properly in the Computer Modern roman
5736 % fonts, so we must take special care.  This is more or less redundant
5737 % with the Texinfo input format setup at the end of this file.
5738 %
5739 \def\activecatcodes{%
5740   \catcode`\"=\active
5741   \catcode`\$=\active
5742   \catcode`\<=\active
5743   \catcode`\>=\active
5744   \catcode`\\=\active
5745   \catcode`\^=\active
5746   \catcode`\_=\active
5747   \catcode`\|=\active
5748   \catcode`\~=\active
5749 }
5750
5751
5752 % Read the toc file, which is essentially Texinfo input.
5753 \def\readtocfile{%
5754   \setupdatafile
5755   \activecatcodes
5756   \input \tocreadfilename
5757 }
5758
5759 \newskip\contentsrightmargin \contentsrightmargin=1in
5760 \newcount\savepageno
5761 \newcount\lastnegativepageno \lastnegativepageno = -1
5762
5763 % Prepare to read what we've written to \tocfile.
5764 %
5765 \def\startcontents#1{%
5766   % If @setchapternewpage on, and @headings double, the contents should
5767   % start on an odd page, unlike chapters.  Thus, we maintain
5768   % \contentsalignmacro in parallel with \pagealignmacro.
5769   % From: Torbjorn Granlund <tege@matematik.su.se>
5770   \contentsalignmacro
5771   \immediate\closeout\tocfile
5772   %
5773   % Don't need to put `Contents' or `Short Contents' in the headline.
5774   % It is abundantly clear what they are.
5775   \chapmacro{#1}{Yomitfromtoc}{}%
5776   %
5777   \savepageno = \pageno
5778   \begingroup                  % Set up to handle contents files properly.
5779     \raggedbottom              % Worry more about breakpoints than the bottom.
5780     \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5781     %
5782     % Roman numerals for page numbers.
5783     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5784 }
5785
5786 % redefined for the two-volume lispref.  We always output on
5787 % \jobname.toc even if this is redefined.
5788 %
5789 \def\tocreadfilename{\jobname.toc}
5790
5791 % Normal (long) toc.
5792 %
5793 \def\contents{%
5794   \startcontents{\putwordTOC}%
5795     \openin 1 \tocreadfilename\space
5796     \ifeof 1 \else
5797       \readtocfile
5798     \fi
5799     \vfill \eject
5800     \contentsalignmacro % in case @setchapternewpage odd is in effect
5801     \ifeof 1 \else
5802       \pdfmakeoutlines
5803     \fi
5804     \closein 1
5805   \endgroup
5806   \lastnegativepageno = \pageno
5807   \global\pageno = \savepageno
5808 }
5809
5810 % And just the chapters.
5811 \def\summarycontents{%
5812   \startcontents{\putwordShortTOC}%
5813     %
5814     \let\partentry = \shortpartentry
5815     \let\numchapentry = \shortchapentry
5816     \let\appentry = \shortchapentry
5817     \let\unnchapentry = \shortunnchapentry
5818     % We want a true roman here for the page numbers.
5819     \secfonts
5820     \let\rm=\shortcontrm \let\bf=\shortcontbf
5821     \let\sl=\shortcontsl \let\tt=\shortconttt
5822     \rm
5823     \hyphenpenalty = 10000
5824     \advance\baselineskip by 1pt % Open it up a little.
5825     \def\numsecentry##1##2##3##4{}
5826     \let\appsecentry = \numsecentry
5827     \let\unnsecentry = \numsecentry
5828     \let\numsubsecentry = \numsecentry
5829     \let\appsubsecentry = \numsecentry
5830     \let\unnsubsecentry = \numsecentry
5831     \let\numsubsubsecentry = \numsecentry
5832     \let\appsubsubsecentry = \numsecentry
5833     \let\unnsubsubsecentry = \numsecentry
5834     \openin 1 \tocreadfilename\space
5835     \ifeof 1 \else
5836       \readtocfile
5837     \fi
5838     \closein 1
5839     \vfill \eject
5840     \contentsalignmacro % in case @setchapternewpage odd is in effect
5841   \endgroup
5842   \lastnegativepageno = \pageno
5843   \global\pageno = \savepageno
5844 }
5845 \let\shortcontents = \summarycontents
5846
5847 % Typeset the label for a chapter or appendix for the short contents.
5848 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5849 %
5850 \def\shortchaplabel#1{%
5851   % This space should be enough, since a single number is .5em, and the
5852   % widest letter (M) is 1em, at least in the Computer Modern fonts.
5853   % But use \hss just in case.
5854   % (This space doesn't include the extra space that gets added after
5855   % the label; that gets put in by \shortchapentry above.)
5856   %
5857   % We'd like to right-justify chapter numbers, but that looks strange
5858   % with appendix letters.  And right-justifying numbers and
5859   % left-justifying letters looks strange when there is less than 10
5860   % chapters.  Have to read the whole toc once to know how many chapters
5861   % there are before deciding ...
5862   \hbox to 1em{#1\hss}%
5863 }
5864
5865 % These macros generate individual entries in the table of contents.
5866 % The first argument is the chapter or section name.
5867 % The last argument is the page number.
5868 % The arguments in between are the chapter number, section number, ...
5869
5870 % Parts, in the main contents.  Replace the part number, which doesn't
5871 % exist, with an empty box.  Let's hope all the numbers have the same width.
5872 % Also ignore the page number, which is conventionally not printed.
5873 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
5874 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
5875 %
5876 % Parts, in the short toc.
5877 \def\shortpartentry#1#2#3#4{%
5878   \penalty-300
5879   \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
5880   \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
5881 }
5882
5883 % Chapters, in the main contents.
5884 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5885 %
5886 % Chapters, in the short toc.
5887 % See comments in \dochapentry re vbox and related settings.
5888 \def\shortchapentry#1#2#3#4{%
5889   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5890 }
5891
5892 % Appendices, in the main contents.
5893 % Need the word Appendix, and a fixed-size box.
5894 %
5895 \def\appendixbox#1{%
5896   % We use M since it's probably the widest letter.
5897   \setbox0 = \hbox{\putwordAppendix{} M}%
5898   \hbox to \wd0{\putwordAppendix{} #1\hss}}
5899 %
5900 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5901
5902 % Unnumbered chapters.
5903 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5904 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5905
5906 % Sections.
5907 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5908 \let\appsecentry=\numsecentry
5909 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5910
5911 % Subsections.
5912 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5913 \let\appsubsecentry=\numsubsecentry
5914 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5915
5916 % And subsubsections.
5917 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5918 \let\appsubsubsecentry=\numsubsubsecentry
5919 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5920
5921 % This parameter controls the indentation of the various levels.
5922 % Same as \defaultparindent.
5923 \newdimen\tocindent \tocindent = 15pt
5924
5925 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5926 % page number.
5927 %
5928 % If the toc has to be broken over pages, we want it to be at chapters
5929 % if at all possible; hence the \penalty.
5930 \def\dochapentry#1#2{%
5931    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5932    \begingroup
5933      \chapentryfonts
5934      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5935    \endgroup
5936    \nobreak\vskip .25\baselineskip plus.1\baselineskip
5937 }
5938
5939 \def\dosecentry#1#2{\begingroup
5940   \secentryfonts \leftskip=\tocindent
5941   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5942 \endgroup}
5943
5944 \def\dosubsecentry#1#2{\begingroup
5945   \subsecentryfonts \leftskip=2\tocindent
5946   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5947 \endgroup}
5948
5949 \def\dosubsubsecentry#1#2{\begingroup
5950   \subsubsecentryfonts \leftskip=3\tocindent
5951   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5952 \endgroup}
5953
5954 % We use the same \entry macro as for the index entries.
5955 \let\tocentry = \entry
5956
5957 % Space between chapter (or whatever) number and the title.
5958 \def\labelspace{\hskip1em \relax}
5959
5960 \def\dopageno#1{{\rm #1}}
5961 \def\doshortpageno#1{{\rm #1}}
5962
5963 \def\chapentryfonts{\secfonts \rm}
5964 \def\secentryfonts{\textfonts}
5965 \def\subsecentryfonts{\textfonts}
5966 \def\subsubsecentryfonts{\textfonts}
5967
5968
5969 \message{environments,}
5970 % @foo ... @end foo.
5971
5972 % @tex ... @end tex    escapes into raw TeX temporarily.
5973 % One exception: @ is still an escape character, so that @end tex works.
5974 % But \@ or @@ will get a plain @ character.
5975
5976 \envdef\tex{%
5977   \setupmarkupstyle{tex}%
5978   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5979   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5980   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5981   \catcode `\%=14
5982   \catcode `\+=\other
5983   \catcode `\"=\other
5984   \catcode `\|=\other
5985   \catcode `\<=\other
5986   \catcode `\>=\other
5987   \catcode`\`=\other
5988   \catcode`\'=\other
5989   \escapechar=`\\
5990   %
5991   % ' is active in math mode (mathcode"8000).  So reset it, and all our
5992   % other math active characters (just in case), to plain's definitions.
5993   \mathactive
5994   %
5995   \let\b=\ptexb
5996   \let\bullet=\ptexbullet
5997   \let\c=\ptexc
5998   \let\,=\ptexcomma
5999   \let\.=\ptexdot
6000   \let\dots=\ptexdots
6001   \let\equiv=\ptexequiv
6002   \let\!=\ptexexclam
6003   \let\i=\ptexi
6004   \let\indent=\ptexindent
6005   \let\noindent=\ptexnoindent
6006   \let\{=\ptexlbrace
6007   \let\+=\tabalign
6008   \let\}=\ptexrbrace
6009   \let\/=\ptexslash
6010   \let\*=\ptexstar
6011   \let\t=\ptext
6012   \expandafter \let\csname top\endcsname=\ptextop  % outer
6013   \let\frenchspacing=\plainfrenchspacing
6014   %
6015   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6016   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6017   \def\@{@}%
6018 }
6019 % There is no need to define \Etex.
6020
6021 % Define @lisp ... @end lisp.
6022 % @lisp environment forms a group so it can rebind things,
6023 % including the definition of @end lisp (which normally is erroneous).
6024
6025 % Amount to narrow the margins by for @lisp.
6026 \newskip\lispnarrowing \lispnarrowing=0.4in
6027
6028 % This is the definition that ^^M gets inside @lisp, @example, and other
6029 % such environments.  \null is better than a space, since it doesn't
6030 % have any width.
6031 \def\lisppar{\null\endgraf}
6032
6033 % This space is always present above and below environments.
6034 \newskip\envskipamount \envskipamount = 0pt
6035
6036 % Make spacing and below environment symmetrical.  We use \parskip here
6037 % to help in doing that, since in @example-like environments \parskip
6038 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6039 % start of the next paragraph will insert \parskip.
6040 %
6041 \def\aboveenvbreak{{%
6042   % =10000 instead of <10000 because of a special case in \itemzzz and
6043   % \sectionheading, q.v.
6044   \ifnum \lastpenalty=10000 \else
6045     \advance\envskipamount by \parskip
6046     \endgraf
6047     \ifdim\lastskip<\envskipamount
6048       \removelastskip
6049       % it's not a good place to break if the last penalty was \nobreak
6050       % or better ...
6051       \ifnum\lastpenalty<10000 \penalty-50 \fi
6052       \vskip\envskipamount
6053     \fi
6054   \fi
6055 }}
6056
6057 \let\afterenvbreak = \aboveenvbreak
6058
6059 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
6060 % also clear it, so that its embedded environments do the narrowing again.
6061 \let\nonarrowing=\relax
6062
6063 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6064 % environment contents.
6065 \font\circle=lcircle10
6066 \newdimen\circthick
6067 \newdimen\cartouter\newdimen\cartinner
6068 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6069 \circthick=\fontdimen8\circle
6070 %
6071 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6072 \def\ctr{{\hskip 6pt\circle\char'010}}
6073 \def\cbl{{\circle\char'012\hskip -6pt}}
6074 \def\cbr{{\hskip 6pt\circle\char'011}}
6075 \def\carttop{\hbox to \cartouter{\hskip\lskip
6076         \ctl\leaders\hrule height\circthick\hfil\ctr
6077         \hskip\rskip}}
6078 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6079         \cbl\leaders\hrule height\circthick\hfil\cbr
6080         \hskip\rskip}}
6081 %
6082 \newskip\lskip\newskip\rskip
6083
6084 \envdef\cartouche{%
6085   \ifhmode\par\fi  % can't be in the midst of a paragraph.
6086   \startsavinginserts
6087   \lskip=\leftskip \rskip=\rightskip
6088   \leftskip=0pt\rightskip=0pt % we want these *outside*.
6089   \cartinner=\hsize \advance\cartinner by-\lskip
6090   \advance\cartinner by-\rskip
6091   \cartouter=\hsize
6092   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
6093                                 % side, and for 6pt waste from
6094                                 % each corner char, and rule thickness
6095   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6096   % Flag to tell @lisp, etc., not to narrow margin.
6097   \let\nonarrowing = t%
6098   \vbox\bgroup
6099       \baselineskip=0pt\parskip=0pt\lineskip=0pt
6100       \carttop
6101       \hbox\bgroup
6102           \hskip\lskip
6103           \vrule\kern3pt
6104           \vbox\bgroup
6105               \kern3pt
6106               \hsize=\cartinner
6107               \baselineskip=\normbskip
6108               \lineskip=\normlskip
6109               \parskip=\normpskip
6110               \vskip -\parskip
6111               \comment % For explanation, see the end of \def\group.
6112 }
6113 \def\Ecartouche{%
6114               \ifhmode\par\fi
6115               \kern3pt
6116           \egroup
6117           \kern3pt\vrule
6118           \hskip\rskip
6119       \egroup
6120       \cartbot
6121   \egroup
6122   \checkinserts
6123 }
6124
6125
6126 % This macro is called at the beginning of all the @example variants,
6127 % inside a group.
6128 \newdimen\nonfillparindent
6129 \def\nonfillstart{%
6130   \aboveenvbreak
6131   \hfuzz = 12pt % Don't be fussy
6132   \sepspaces % Make spaces be word-separators rather than space tokens.
6133   \let\par = \lisppar % don't ignore blank lines
6134   \obeylines % each line of input is a line of output
6135   \parskip = 0pt
6136   % Turn off paragraph indentation but redefine \indent to emulate
6137   % the normal \indent.
6138   \nonfillparindent=\parindent
6139   \parindent = 0pt
6140   \let\indent\nonfillindent
6141   %
6142   \emergencystretch = 0pt % don't try to avoid overfull boxes
6143   \ifx\nonarrowing\relax
6144     \advance \leftskip by \lispnarrowing
6145     \exdentamount=\lispnarrowing
6146   \else
6147     \let\nonarrowing = \relax
6148   \fi
6149   \let\exdent=\nofillexdent
6150 }
6151
6152 \begingroup
6153 \obeyspaces
6154 % We want to swallow spaces (but not other tokens) after the fake
6155 % @indent in our nonfill-environments, where spaces are normally
6156 % active and set to @tie, resulting in them not being ignored after
6157 % @indent.
6158 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6159 \gdef\nonfillindentcheck{%
6160 \ifx\temp %
6161 \expandafter\nonfillindentgobble%
6162 \else%
6163 \leavevmode\nonfillindentbox%
6164 \fi%
6165 }%
6166 \endgroup
6167 \def\nonfillindentgobble#1{\nonfillindent}
6168 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6169
6170 % If you want all examples etc. small: @set dispenvsize small.
6171 % If you want even small examples the full size: @set dispenvsize nosmall.
6172 % This affects the following displayed environments:
6173 %    @example, @display, @format, @lisp
6174 %
6175 \def\smallword{small}
6176 \def\nosmallword{nosmall}
6177 \let\SETdispenvsize\relax
6178 \def\setnormaldispenv{%
6179   \ifx\SETdispenvsize\smallword
6180     % end paragraph for sake of leading, in case document has no blank
6181     % line.  This is redundant with what happens in \aboveenvbreak, but
6182     % we need to do it before changing the fonts, and it's inconvenient
6183     % to change the fonts afterward.
6184     \ifnum \lastpenalty=10000 \else \endgraf \fi
6185     \smallexamplefonts \rm
6186   \fi
6187 }
6188 \def\setsmalldispenv{%
6189   \ifx\SETdispenvsize\nosmallword
6190   \else
6191     \ifnum \lastpenalty=10000 \else \endgraf \fi
6192     \smallexamplefonts \rm
6193   \fi
6194 }
6195
6196 % We often define two environments, @foo and @smallfoo.
6197 % Let's do it in one command.  #1 is the env name, #2 the definition.
6198 \def\makedispenvdef#1#2{%
6199   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6200   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6201   \expandafter\let\csname E#1\endcsname \afterenvbreak
6202   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6203 }
6204
6205 % Define two environment synonyms (#1 and #2) for an environment.
6206 \def\maketwodispenvdef#1#2#3{%
6207   \makedispenvdef{#1}{#3}%
6208   \makedispenvdef{#2}{#3}%
6209 }
6210 %
6211 % @lisp: indented, narrowed, typewriter font;
6212 % @example: same as @lisp.
6213 %
6214 % @smallexample and @smalllisp: use smaller fonts.
6215 % Originally contributed by Pavel@xerox.
6216 %
6217 \maketwodispenvdef{lisp}{example}{%
6218   \nonfillstart
6219   \tt\setupmarkupstyle{example}%
6220   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6221   \gobble % eat return
6222 }
6223 % @display/@smalldisplay: same as @lisp except keep current font.
6224 %
6225 \makedispenvdef{display}{%
6226   \nonfillstart
6227   \gobble
6228 }
6229
6230 % @format/@smallformat: same as @display except don't narrow margins.
6231 %
6232 \makedispenvdef{format}{%
6233   \let\nonarrowing = t%
6234   \nonfillstart
6235   \gobble
6236 }
6237
6238 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6239 \envdef\flushleft{%
6240   \let\nonarrowing = t%
6241   \nonfillstart
6242   \gobble
6243 }
6244 \let\Eflushleft = \afterenvbreak
6245
6246 % @flushright.
6247 %
6248 \envdef\flushright{%
6249   \let\nonarrowing = t%
6250   \nonfillstart
6251   \advance\leftskip by 0pt plus 1fill\relax
6252   \gobble
6253 }
6254 \let\Eflushright = \afterenvbreak
6255
6256
6257 % @raggedright does more-or-less normal line breaking but no right
6258 % justification.  From plain.tex.
6259 \envdef\raggedright{%
6260   \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6261 }
6262 \let\Eraggedright\par
6263
6264 \envdef\raggedleft{%
6265   \parindent=0pt \leftskip0pt plus2em
6266   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6267   \hbadness=10000 % Last line will usually be underfull, so turn off
6268                   % badness reporting.
6269 }
6270 \let\Eraggedleft\par
6271
6272 \envdef\raggedcenter{%
6273   \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6274   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6275   \hbadness=10000 % Last line will usually be underfull, so turn off
6276                   % badness reporting.
6277 }
6278 \let\Eraggedcenter\par
6279
6280
6281 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6282 % and narrows the margins.  We keep \parskip nonzero in general, since
6283 % we're doing normal filling.  So, when using \aboveenvbreak and
6284 % \afterenvbreak, temporarily make \parskip 0.
6285 %
6286 \makedispenvdef{quotation}{\quotationstart}
6287 %
6288 \def\quotationstart{%
6289   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6290   \parindent=0pt
6291   %
6292   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6293   \ifx\nonarrowing\relax
6294     \advance\leftskip by \lispnarrowing
6295     \advance\rightskip by \lispnarrowing
6296     \exdentamount = \lispnarrowing
6297   \else
6298     \let\nonarrowing = \relax
6299   \fi
6300   \parsearg\quotationlabel
6301 }
6302
6303 % We have retained a nonzero parskip for the environment, since we're
6304 % doing normal filling.
6305 %
6306 \def\Equotation{%
6307   \par
6308   \ifx\quotationauthor\undefined\else
6309     % indent a bit.
6310     \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6311   \fi
6312   {\parskip=0pt \afterenvbreak}%
6313 }
6314 \def\Esmallquotation{\Equotation}
6315
6316 % If we're given an argument, typeset it in bold with a colon after.
6317 \def\quotationlabel#1{%
6318   \def\temp{#1}%
6319   \ifx\temp\empty \else
6320     {\bf #1: }%
6321   \fi
6322 }
6323
6324
6325 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6326 % If we want to allow any <char> as delimiter,
6327 % we need the curly braces so that makeinfo sees the @verb command, eg:
6328 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
6329 %
6330 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
6331 %
6332 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6333 % active too.  Otherwise, they get lost as the first character on a
6334 % verbatim line.
6335 \def\dospecials{%
6336   \do\ \do\\\do\{\do\}\do\$\do\&%
6337   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6338   \do\<\do\>\do\|\do\@\do+\do\"%
6339   % Don't do the quotes -- if we do, @set txicodequoteundirected and
6340   % @set txicodequotebacktick will not have effect on @verb and
6341   % @verbatim, and ?` and !` ligatures won't get disabled.
6342   %\do\`\do\'%
6343 }
6344 %
6345 % [Knuth] p. 380
6346 \def\uncatcodespecials{%
6347   \def\do##1{\catcode`##1=\other}\dospecials}
6348 %
6349 % Setup for the @verb command.
6350 %
6351 % Eight spaces for a tab
6352 \begingroup
6353   \catcode`\^^I=\active
6354   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6355 \endgroup
6356 %
6357 \def\setupverb{%
6358   \tt  % easiest (and conventionally used) font for verbatim
6359   \def\par{\leavevmode\endgraf}%
6360   \setupmarkupstyle{verb}%
6361   \tabeightspaces
6362   % Respect line breaks,
6363   % print special symbols as themselves, and
6364   % make each space count
6365   % must do in this order:
6366   \obeylines \uncatcodespecials \sepspaces
6367 }
6368
6369 % Setup for the @verbatim environment
6370 %
6371 % Real tab expansion
6372 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6373 %
6374 \def\starttabbox{\setbox0=\hbox\bgroup}
6375 %
6376 \begingroup
6377   \catcode`\^^I=\active
6378   \gdef\tabexpand{%
6379     \catcode`\^^I=\active
6380     \def^^I{\leavevmode\egroup
6381       \dimen0=\wd0 % the width so far, or since the previous tab
6382       \divide\dimen0 by\tabw
6383       \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6384       \advance\dimen0 by\tabw  % advance to next multiple of \tabw
6385       \wd0=\dimen0 \box0 \starttabbox
6386     }%
6387   }
6388 \endgroup
6389
6390 % start the verbatim environment.
6391 \def\setupverbatim{%
6392   \let\nonarrowing = t%
6393   \nonfillstart
6394   % Easiest (and conventionally used) font for verbatim
6395   \tt
6396   \def\par{\leavevmode\egroup\box0\endgraf}%
6397   \tabexpand
6398   \setupmarkupstyle{verbatim}%
6399   % Respect line breaks,
6400   % print special symbols as themselves, and
6401   % make each space count
6402   % must do in this order:
6403   \obeylines \uncatcodespecials \sepspaces
6404   \everypar{\starttabbox}%
6405 }
6406
6407 % Do the @verb magic: verbatim text is quoted by unique
6408 % delimiter characters.  Before first delimiter expect a
6409 % right brace, after last delimiter expect closing brace:
6410 %
6411 %    \def\doverb'{'<char>#1<char>'}'{#1}
6412 %
6413 % [Knuth] p. 382; only eat outer {}
6414 \begingroup
6415   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6416   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6417 \endgroup
6418 %
6419 \def\verb{\begingroup\setupverb\doverb}
6420 %
6421 %
6422 % Do the @verbatim magic: define the macro \doverbatim so that
6423 % the (first) argument ends when '@end verbatim' is reached, ie:
6424 %
6425 %     \def\doverbatim#1@end verbatim{#1}
6426 %
6427 % For Texinfo it's a lot easier than for LaTeX,
6428 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6429 % we need not redefine '\', '{' and '}'.
6430 %
6431 % Inspired by LaTeX's verbatim command set [latex.ltx]
6432 %
6433 \begingroup
6434   \catcode`\ =\active
6435   \obeylines %
6436   % ignore everything up to the first ^^M, that's the newline at the end
6437   % of the @verbatim input line itself.  Otherwise we get an extra blank
6438   % line in the output.
6439   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6440   % We really want {...\end verbatim} in the body of the macro, but
6441   % without the active space; thus we have to use \xdef and \gobble.
6442 \endgroup
6443 %
6444 \envdef\verbatim{%
6445     \setupverbatim\doverbatim
6446 }
6447 \let\Everbatim = \afterenvbreak
6448
6449
6450 % @verbatiminclude FILE - insert text of file in verbatim environment.
6451 %
6452 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6453 %
6454 \def\doverbatiminclude#1{%
6455   {%
6456     \makevalueexpandable
6457     \setupverbatim
6458     \indexnofonts       % Allow `@@' and other weird things in file names.
6459     \input #1
6460     \afterenvbreak
6461   }%
6462 }
6463
6464 % @copying ... @end copying.
6465 % Save the text away for @insertcopying later.
6466 %
6467 % We save the uninterpreted tokens, rather than creating a box.
6468 % Saving the text in a box would be much easier, but then all the
6469 % typesetting commands (@smallbook, font changes, etc.) have to be done
6470 % beforehand -- and a) we want @copying to be done first in the source
6471 % file; b) letting users define the frontmatter in as flexible order as
6472 % possible is very desirable.
6473 %
6474 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6475 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6476 %
6477 \def\insertcopying{%
6478   \begingroup
6479     \parindent = 0pt  % paragraph indentation looks wrong on title page
6480     \scanexp\copyingtext
6481   \endgroup
6482 }
6483
6484
6485 \message{defuns,}
6486 % @defun etc.
6487
6488 \newskip\defbodyindent \defbodyindent=.4in
6489 \newskip\defargsindent \defargsindent=50pt
6490 \newskip\deflastargmargin \deflastargmargin=18pt
6491 \newcount\defunpenalty
6492
6493 % Start the processing of @deffn:
6494 \def\startdefun{%
6495   \ifnum\lastpenalty<10000
6496     \medbreak
6497     \defunpenalty=10003 % Will keep this @deffn together with the
6498                         % following @def command, see below.
6499   \else
6500     % If there are two @def commands in a row, we'll have a \nobreak,
6501     % which is there to keep the function description together with its
6502     % header.  But if there's nothing but headers, we need to allow a
6503     % break somewhere.  Check specifically for penalty 10002, inserted
6504     % by \printdefunline, instead of 10000, since the sectioning
6505     % commands also insert a nobreak penalty, and we don't want to allow
6506     % a break between a section heading and a defun.
6507     %
6508     % As a minor refinement, we avoid "club" headers by signalling
6509     % with penalty of 10003 after the very first @deffn in the
6510     % sequence (see above), and penalty of 10002 after any following
6511     % @def command.
6512     \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6513     %
6514     % Similarly, after a section heading, do not allow a break.
6515     % But do insert the glue.
6516     \medskip  % preceded by discardable penalty, so not a breakpoint
6517   \fi
6518   %
6519   \parindent=0in
6520   \advance\leftskip by \defbodyindent
6521   \exdentamount=\defbodyindent
6522 }
6523
6524 \def\dodefunx#1{%
6525   % First, check whether we are in the right environment:
6526   \checkenv#1%
6527   %
6528   % As above, allow line break if we have multiple x headers in a row.
6529   % It's not a great place, though.
6530   \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6531   %
6532   % And now, it's time to reuse the body of the original defun:
6533   \expandafter\gobbledefun#1%
6534 }
6535 \def\gobbledefun#1\startdefun{}
6536
6537 % \printdefunline \deffnheader{text}
6538 %
6539 \def\printdefunline#1#2{%
6540   \begingroup
6541     % call \deffnheader:
6542     #1#2 \endheader
6543     % common ending:
6544     \interlinepenalty = 10000
6545     \advance\rightskip by 0pt plus 1fil\relax
6546     \endgraf
6547     \nobreak\vskip -\parskip
6548     \penalty\defunpenalty  % signal to \startdefun and \dodefunx
6549     % Some of the @defun-type tags do not enable magic parentheses,
6550     % rendering the following check redundant.  But we don't optimize.
6551     \checkparencounts
6552   \endgroup
6553 }
6554
6555 \def\Edefun{\endgraf\medbreak}
6556
6557 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6558 % the only thing remaining is to define \deffnheader.
6559 %
6560 \def\makedefun#1{%
6561   \expandafter\let\csname E#1\endcsname = \Edefun
6562   \edef\temp{\noexpand\domakedefun
6563     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6564   \temp
6565 }
6566
6567 % \domakedefun \deffn \deffnx \deffnheader
6568 %
6569 % Define \deffn and \deffnx, without parameters.
6570 % \deffnheader has to be defined explicitly.
6571 %
6572 \def\domakedefun#1#2#3{%
6573   \envdef#1{%
6574     \startdefun
6575     \parseargusing\activeparens{\printdefunline#3}%
6576   }%
6577   \def#2{\dodefunx#1}%
6578   \def#3%
6579 }
6580
6581 %%% Untyped functions:
6582
6583 % @deffn category name args
6584 \makedefun{deffn}{\deffngeneral{}}
6585
6586 % @deffn category class name args
6587 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6588
6589 % \defopon {category on}class name args
6590 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6591
6592 % \deffngeneral {subind}category name args
6593 %
6594 \def\deffngeneral#1#2 #3 #4\endheader{%
6595   % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6596   \dosubind{fn}{\code{#3}}{#1}%
6597   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6598 }
6599
6600 %%% Typed functions:
6601
6602 % @deftypefn category type name args
6603 \makedefun{deftypefn}{\deftypefngeneral{}}
6604
6605 % @deftypeop category class type name args
6606 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6607
6608 % \deftypeopon {category on}class type name args
6609 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6610
6611 % \deftypefngeneral {subind}category type name args
6612 %
6613 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6614   \dosubind{fn}{\code{#4}}{#1}%
6615   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6616 }
6617
6618 %%% Typed variables:
6619
6620 % @deftypevr category type var args
6621 \makedefun{deftypevr}{\deftypecvgeneral{}}
6622
6623 % @deftypecv category class type var args
6624 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6625
6626 % \deftypecvof {category of}class type var args
6627 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6628
6629 % \deftypecvgeneral {subind}category type var args
6630 %
6631 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6632   \dosubind{vr}{\code{#4}}{#1}%
6633   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6634 }
6635
6636 %%% Untyped variables:
6637
6638 % @defvr category var args
6639 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6640
6641 % @defcv category class var args
6642 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6643
6644 % \defcvof {category of}class var args
6645 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6646
6647 %%% Type:
6648 % @deftp category name args
6649 \makedefun{deftp}#1 #2 #3\endheader{%
6650   \doind{tp}{\code{#2}}%
6651   \defname{#1}{}{#2}\defunargs{#3\unskip}%
6652 }
6653
6654 % Remaining @defun-like shortcuts:
6655 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6656 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6657 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6658 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6659 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6660 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6661 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6662 \makedefun{defmethod}{\defopon\putwordMethodon}
6663 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6664 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6665 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6666
6667 % \defname, which formats the name of the @def (not the args).
6668 % #1 is the category, such as "Function".
6669 % #2 is the return type, if any.
6670 % #3 is the function name.
6671 %
6672 % We are followed by (but not passed) the arguments, if any.
6673 %
6674 \def\defname#1#2#3{%
6675   % Get the values of \leftskip and \rightskip as they were outside the @def...
6676   \advance\leftskip by -\defbodyindent
6677   %
6678   % How we'll format the type name.  Putting it in brackets helps
6679   % distinguish it from the body text that may end up on the next line
6680   % just below it.
6681   \def\temp{#1}%
6682   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6683   %
6684   % Figure out line sizes for the paragraph shape.
6685   % The first line needs space for \box0; but if \rightskip is nonzero,
6686   % we need only space for the part of \box0 which exceeds it:
6687   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
6688   % The continuations:
6689   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
6690   % (plain.tex says that \dimen1 should be used only as global.)
6691   \parshape 2 0in \dimen0 \defargsindent \dimen2
6692   %
6693   % Put the type name to the right margin.
6694   \noindent
6695   \hbox to 0pt{%
6696     \hfil\box0 \kern-\hsize
6697     % \hsize has to be shortened this way:
6698     \kern\leftskip
6699     % Intentionally do not respect \rightskip, since we need the space.
6700   }%
6701   %
6702   % Allow all lines to be underfull without complaint:
6703   \tolerance=10000 \hbadness=10000
6704   \exdentamount=\defbodyindent
6705   {%
6706     % defun fonts. We use typewriter by default (used to be bold) because:
6707     % . we're printing identifiers, they should be in tt in principle.
6708     % . in languages with many accents, such as Czech or French, it's
6709     %   common to leave accents off identifiers.  The result looks ok in
6710     %   tt, but exceedingly strange in rm.
6711     % . we don't want -- and --- to be treated as ligatures.
6712     % . this still does not fix the ?` and !` ligatures, but so far no
6713     %   one has made identifiers using them :).
6714     \df \tt
6715     \def\temp{#2}% return value type
6716     \ifx\temp\empty\else \tclose{\temp} \fi
6717     #3% output function name
6718   }%
6719   {\rm\enskip}% hskip 0.5 em of \tenrm
6720   %
6721   \boldbrax
6722   % arguments will be output next, if any.
6723 }
6724
6725 % Print arguments in slanted roman (not ttsl), inconsistently with using
6726 % tt for the name.  This is because literal text is sometimes needed in
6727 % the argument list (groff manual), and ttsl and tt are not very
6728 % distinguishable.  Prevent hyphenation at `-' chars.
6729 %
6730 \def\defunargs#1{%
6731   % use sl by default (not ttsl),
6732   % tt for the names.
6733   \df \sl \hyphenchar\font=0
6734   %
6735   % On the other hand, if an argument has two dashes (for instance), we
6736   % want a way to get ttsl.  Let's try @var for that.
6737   \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6738   #1%
6739   \sl\hyphenchar\font=45
6740 }
6741
6742 % We want ()&[] to print specially on the defun line.
6743 %
6744 \def\activeparens{%
6745   \catcode`\(=\active \catcode`\)=\active
6746   \catcode`\[=\active \catcode`\]=\active
6747   \catcode`\&=\active
6748 }
6749
6750 % Make control sequences which act like normal parenthesis chars.
6751 \let\lparen = ( \let\rparen = )
6752
6753 % Be sure that we always have a definition for `(', etc.  For example,
6754 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6755 % so TeX would otherwise complain about undefined control sequence.
6756 {
6757   \activeparens
6758   \global\let(=\lparen \global\let)=\rparen
6759   \global\let[=\lbrack \global\let]=\rbrack
6760   \global\let& = \&
6761
6762   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6763   \gdef\magicamp{\let&=\amprm}
6764 }
6765
6766 \newcount\parencount
6767
6768 % If we encounter &foo, then turn on ()-hacking afterwards
6769 \newif\ifampseen
6770 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6771
6772 \def\parenfont{%
6773   \ifampseen
6774     % At the first level, print parens in roman,
6775     % otherwise use the default font.
6776     \ifnum \parencount=1 \rm \fi
6777   \else
6778     % The \sf parens (in \boldbrax) actually are a little bolder than
6779     % the contained text.  This is especially needed for [ and ] .
6780     \sf
6781   \fi
6782 }
6783 \def\infirstlevel#1{%
6784   \ifampseen
6785     \ifnum\parencount=1
6786       #1%
6787     \fi
6788   \fi
6789 }
6790 \def\bfafterword#1 {#1 \bf}
6791
6792 \def\opnr{%
6793   \global\advance\parencount by 1
6794   {\parenfont(}%
6795   \infirstlevel \bfafterword
6796 }
6797 \def\clnr{%
6798   {\parenfont)}%
6799   \infirstlevel \sl
6800   \global\advance\parencount by -1
6801 }
6802
6803 \newcount\brackcount
6804 \def\lbrb{%
6805   \global\advance\brackcount by 1
6806   {\bf[}%
6807 }
6808 \def\rbrb{%
6809   {\bf]}%
6810   \global\advance\brackcount by -1
6811 }
6812
6813 \def\checkparencounts{%
6814   \ifnum\parencount=0 \else \badparencount \fi
6815   \ifnum\brackcount=0 \else \badbrackcount \fi
6816 }
6817 % these should not use \errmessage; the glibc manual, at least, actually
6818 % has such constructs (when documenting function pointers).
6819 \def\badparencount{%
6820   \message{Warning: unbalanced parentheses in @def...}%
6821   \global\parencount=0
6822 }
6823 \def\badbrackcount{%
6824   \message{Warning: unbalanced square brackets in @def...}%
6825   \global\brackcount=0
6826 }
6827
6828
6829 \message{macros,}
6830 % @macro.
6831
6832 % To do this right we need a feature of e-TeX, \scantokens,
6833 % which we arrange to emulate with a temporary file in ordinary TeX.
6834 \ifx\eTeXversion\undefined
6835   \newwrite\macscribble
6836   \def\scantokens#1{%
6837     \toks0={#1}%
6838     \immediate\openout\macscribble=\jobname.tmp
6839     \immediate\write\macscribble{\the\toks0}%
6840     \immediate\closeout\macscribble
6841     \input \jobname.tmp
6842   }
6843 \fi
6844
6845 \def\scanmacro#1{%
6846   \begingroup
6847     \newlinechar`\^^M
6848     \let\xeatspaces\eatspaces
6849     % Undo catcode changes of \startcontents and \doprintindex
6850     % When called from @insertcopying or (short)caption, we need active
6851     % backslash to get it printed correctly.  Previously, we had
6852     % \catcode`\\=\other instead.  We'll see whether a problem appears
6853     % with macro expansion.                             --kasal, 19aug04
6854     \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6855     % ... and \example
6856     \spaceisspace
6857     %
6858     % Append \endinput to make sure that TeX does not see the ending newline.
6859     % I've verified that it is necessary both for e-TeX and for ordinary TeX
6860     %                                                   --kasal, 29nov03
6861     \scantokens{#1\endinput}%
6862   \endgroup
6863 }
6864
6865 \def\scanexp#1{%
6866   \edef\temp{\noexpand\scanmacro{#1}}%
6867   \temp
6868 }
6869
6870 \newcount\paramno   % Count of parameters
6871 \newtoks\macname    % Macro name
6872 \newif\ifrecursive  % Is it recursive?
6873
6874 % List of all defined macros in the form
6875 %    \definedummyword\macro1\definedummyword\macro2...
6876 % Currently is also contains all @aliases; the list can be split
6877 % if there is a need.
6878 \def\macrolist{}
6879
6880 % Add the macro to \macrolist
6881 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6882 \def\addtomacrolistxxx#1{%
6883      \toks0 = \expandafter{\macrolist\definedummyword#1}%
6884      \xdef\macrolist{\the\toks0}%
6885 }
6886
6887 % Utility routines.
6888 % This does \let #1 = #2, with \csnames; that is,
6889 %   \let \csname#1\endcsname = \csname#2\endcsname
6890 % (except of course we have to play expansion games).
6891 %
6892 \def\cslet#1#2{%
6893   \expandafter\let
6894   \csname#1\expandafter\endcsname
6895   \csname#2\endcsname
6896 }
6897
6898 % Trim leading and trailing spaces off a string.
6899 % Concepts from aro-bend problem 15 (see CTAN).
6900 {\catcode`\@=11
6901 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6902 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6903 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6904 \def\unbrace#1{#1}
6905 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6906 }
6907
6908 % Trim a single trailing ^^M off a string.
6909 {\catcode`\^^M=\other \catcode`\Q=3%
6910 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6911 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6912 \gdef\eatcrb#1Q#2Q{#1}%
6913 }
6914
6915 % Macro bodies are absorbed as an argument in a context where
6916 % all characters are catcode 10, 11 or 12, except \ which is active
6917 % (as in normal texinfo). It is necessary to change the definition of \.
6918
6919 % Non-ASCII encodings make 8-bit characters active, so un-activate
6920 % them to avoid their expansion.  Must do this non-globally, to
6921 % confine the change to the current group.
6922
6923 % It's necessary to have hard CRs when the macro is executed. This is
6924 % done by  making ^^M (\endlinechar) catcode 12 when reading the macro
6925 % body, and then making it the \newlinechar in \scanmacro.
6926
6927 \def\scanctxt{%
6928   \catcode`\"=\other
6929   \catcode`\+=\other
6930   \catcode`\<=\other
6931   \catcode`\>=\other
6932   \catcode`\@=\other
6933   \catcode`\^=\other
6934   \catcode`\_=\other
6935   \catcode`\|=\other
6936   \catcode`\~=\other
6937   \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6938 }
6939
6940 \def\scanargctxt{%
6941   \scanctxt
6942   \catcode`\\=\other
6943   \catcode`\^^M=\other
6944 }
6945
6946 \def\macrobodyctxt{%
6947   \scanctxt
6948   \catcode`\{=\other
6949   \catcode`\}=\other
6950   \catcode`\^^M=\other
6951   \usembodybackslash
6952 }
6953
6954 \def\macroargctxt{%
6955   \scanctxt
6956   \catcode`\\=\other
6957 }
6958
6959 % \mbodybackslash is the definition of \ in @macro bodies.
6960 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6961 % where N is the macro parameter number.
6962 % We define \csname macarg.\endcsname to be \realbackslash, so
6963 % \\ in macro replacement text gets you a backslash.
6964
6965 {\catcode`@=0 @catcode`@\=@active
6966  @gdef@usembodybackslash{@let\=@mbodybackslash}
6967  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6968 }
6969 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6970
6971 \def\macro{\recursivefalse\parsearg\macroxxx}
6972 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6973
6974 \def\macroxxx#1{%
6975   \getargs{#1}%           now \macname is the macname and \argl the arglist
6976   \ifx\argl\empty       % no arguments
6977      \paramno=0%
6978   \else
6979      \expandafter\parsemargdef \argl;%
6980   \fi
6981   \if1\csname ismacro.\the\macname\endcsname
6982      \message{Warning: redefining \the\macname}%
6983   \else
6984      \expandafter\ifx\csname \the\macname\endcsname \relax
6985      \else \errmessage{Macro name \the\macname\space already defined}\fi
6986      \global\cslet{macsave.\the\macname}{\the\macname}%
6987      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6988      \addtomacrolist{\the\macname}%
6989   \fi
6990   \begingroup \macrobodyctxt
6991   \ifrecursive \expandafter\parsermacbody
6992   \else \expandafter\parsemacbody
6993   \fi}
6994
6995 \parseargdef\unmacro{%
6996   \if1\csname ismacro.#1\endcsname
6997     \global\cslet{#1}{macsave.#1}%
6998     \global\expandafter\let \csname ismacro.#1\endcsname=0%
6999     % Remove the macro name from \macrolist:
7000     \begingroup
7001       \expandafter\let\csname#1\endcsname \relax
7002       \let\definedummyword\unmacrodo
7003       \xdef\macrolist{\macrolist}%
7004     \endgroup
7005   \else
7006     \errmessage{Macro #1 not defined}%
7007   \fi
7008 }
7009
7010 % Called by \do from \dounmacro on each macro.  The idea is to omit any
7011 % macro definitions that have been changed to \relax.
7012 %
7013 \def\unmacrodo#1{%
7014   \ifx #1\relax
7015     % remove this
7016   \else
7017     \noexpand\definedummyword \noexpand#1%
7018   \fi
7019 }
7020
7021 % This makes use of the obscure feature that if the last token of a
7022 % <parameter list> is #, then the preceding argument is delimited by
7023 % an opening brace, and that opening brace is not consumed.
7024 \def\getargs#1{\getargsxxx#1{}}
7025 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7026 \def\getmacname #1 #2\relax{\macname={#1}}
7027 \def\getmacargs#1{\def\argl{#1}}
7028
7029 % Parse the optional {params} list.  Set up \paramno and \paramlist
7030 % so \defmacro knows what to do.  Define \macarg.blah for each blah
7031 % in the params list, to be ##N where N is the position in that list.
7032 % That gets used by \mbodybackslash (above).
7033
7034 % We need to get `macro parameter char #' into several definitions.
7035 % The technique used is stolen from LaTeX:  let \hash be something
7036 % unexpandable, insert that wherever you need a #, and then redefine
7037 % it to # just before using the token list produced.
7038 %
7039 % The same technique is used to protect \eatspaces till just before
7040 % the macro is used.
7041
7042 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
7043         \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
7044 \def\parsemargdefxxx#1,{%
7045   \if#1;\let\next=\relax
7046   \else \let\next=\parsemargdefxxx
7047     \advance\paramno by 1%
7048     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7049         {\xeatspaces{\hash\the\paramno}}%
7050     \edef\paramlist{\paramlist\hash\the\paramno,}%
7051   \fi\next}
7052
7053 % These two commands read recursive and nonrecursive macro bodies.
7054 % (They're different since rec and nonrec macros end differently.)
7055
7056 \long\def\parsemacbody#1@end macro%
7057 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7058 \long\def\parsermacbody#1@end rmacro%
7059 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7060
7061 % This defines the macro itself. There are six cases: recursive and
7062 % nonrecursive macros of zero, one, and many arguments.
7063 % Much magic with \expandafter here.
7064 % \xdef is used so that macro definitions will survive the file
7065 % they're defined in; @include reads the file inside a group.
7066 \def\defmacro{%
7067   \let\hash=##% convert placeholders to macro parameter chars
7068   \ifrecursive
7069     \ifcase\paramno
7070     % 0
7071       \expandafter\xdef\csname\the\macname\endcsname{%
7072         \noexpand\scanmacro{\temp}}%
7073     \or % 1
7074       \expandafter\xdef\csname\the\macname\endcsname{%
7075          \bgroup\noexpand\macroargctxt
7076          \noexpand\braceorline
7077          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7078       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7079          \egroup\noexpand\scanmacro{\temp}}%
7080     \else % many
7081       \expandafter\xdef\csname\the\macname\endcsname{%
7082          \bgroup\noexpand\macroargctxt
7083          \noexpand\csname\the\macname xx\endcsname}%
7084       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7085           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7086       \expandafter\expandafter
7087       \expandafter\xdef
7088       \expandafter\expandafter
7089         \csname\the\macname xxx\endcsname
7090           \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7091     \fi
7092   \else
7093     \ifcase\paramno
7094     % 0
7095       \expandafter\xdef\csname\the\macname\endcsname{%
7096         \noexpand\norecurse{\the\macname}%
7097         \noexpand\scanmacro{\temp}\egroup}%
7098     \or % 1
7099       \expandafter\xdef\csname\the\macname\endcsname{%
7100          \bgroup\noexpand\macroargctxt
7101          \noexpand\braceorline
7102          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7103       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7104         \egroup
7105         \noexpand\norecurse{\the\macname}%
7106         \noexpand\scanmacro{\temp}\egroup}%
7107     \else % many
7108       \expandafter\xdef\csname\the\macname\endcsname{%
7109          \bgroup\noexpand\macroargctxt
7110          \expandafter\noexpand\csname\the\macname xx\endcsname}%
7111       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7112           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7113       \expandafter\expandafter
7114       \expandafter\xdef
7115       \expandafter\expandafter
7116       \csname\the\macname xxx\endcsname
7117       \paramlist{%
7118           \egroup
7119           \noexpand\norecurse{\the\macname}%
7120           \noexpand\scanmacro{\temp}\egroup}%
7121     \fi
7122   \fi}
7123
7124 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7125
7126 % \braceorline decides whether the next nonwhitespace character is a
7127 % {.  If so it reads up to the closing }, if not, it reads the whole
7128 % line.  Whatever was read is then fed to the next control sequence
7129 % as an argument (by \parsebrace or \parsearg)
7130 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7131 \def\braceorlinexxx{%
7132   \ifx\nchar\bgroup\else
7133     \expandafter\parsearg
7134   \fi \macnamexxx}
7135
7136
7137 % @alias.
7138 % We need some trickery to remove the optional spaces around the equal
7139 % sign.  Just make them active and then expand them all to nothing.
7140 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7141 \def\aliasxxx #1{\aliasyyy#1\relax}
7142 \def\aliasyyy #1=#2\relax{%
7143   {%
7144     \expandafter\let\obeyedspace=\empty
7145     \addtomacrolist{#1}%
7146     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7147   }%
7148   \next
7149 }
7150
7151
7152 \message{cross references,}
7153
7154 \newwrite\auxfile
7155 \newif\ifhavexrefs    % True if xref values are known.
7156 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
7157
7158 % @inforef is relatively simple.
7159 \def\inforef #1{\inforefzzz #1,,,,**}
7160 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7161   node \samp{\ignorespaces#1{}}}
7162
7163 % @node's only job in TeX is to define \lastnode, which is used in
7164 % cross-references.  The @node line might or might not have commas, and
7165 % might or might not have spaces before the first comma, like:
7166 % @node foo , bar , ...
7167 % We don't want such trailing spaces in the node name.
7168 %
7169 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7170 %
7171 % also remove a trailing comma, in case of something like this:
7172 % @node Help-Cross,  ,  , Cross-refs
7173 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7174 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7175
7176 \let\nwnode=\node
7177 \let\lastnode=\empty
7178
7179 % Write a cross-reference definition for the current node.  #1 is the
7180 % type (Ynumbered, Yappendix, Ynothing).
7181 %
7182 \def\donoderef#1{%
7183   \ifx\lastnode\empty\else
7184     \setref{\lastnode}{#1}%
7185     \global\let\lastnode=\empty
7186   \fi
7187 }
7188
7189 % @anchor{NAME} -- define xref target at arbitrary point.
7190 %
7191 \newcount\savesfregister
7192 %
7193 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7194 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7195 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7196
7197 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7198 % anchor), which consists of three parts:
7199 % 1) NAME-title - the current sectioning name taken from \lastsection,
7200 %                 or the anchor name.
7201 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
7202 %                 empty for anchors.
7203 % 3) NAME-pg    - the page number.
7204 %
7205 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
7206 % floats, there is an additional part, which is not written here:
7207 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
7208 %
7209 \def\setref#1#2{%
7210   \pdfmkdest{#1}%
7211   \iflinks
7212     {%
7213       \atdummies  % preserve commands, but don't expand them
7214       \edef\writexrdef##1##2{%
7215         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7216           ##1}{##2}}% these are parameters of \writexrdef
7217       }%
7218       \toks0 = \expandafter{\lastsection}%
7219       \immediate \writexrdef{title}{\the\toks0 }%
7220       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7221       \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7222     }%
7223   \fi
7224 }
7225
7226 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
7227 % the node name, #2 the name of the Info cross-reference, #3 the printed
7228 % node name, #4 the name of the Info file, #5 the name of the printed
7229 % manual.  All but the node name can be omitted.
7230 %
7231 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7232 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7233 \def\ref#1{\xrefX[#1,,,,,,,]}
7234 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7235   \unsepspaces
7236   \def\printedmanual{\ignorespaces #5}%
7237   \def\printedrefname{\ignorespaces #3}%
7238   \setbox1=\hbox{\printedmanual\unskip}%
7239   \setbox0=\hbox{\printedrefname\unskip}%
7240   \ifdim \wd0 = 0pt
7241     % No printed node name was explicitly given.
7242     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7243       % Use the node name inside the square brackets.
7244       \def\printedrefname{\ignorespaces #1}%
7245     \else
7246       % Use the actual chapter/section title appear inside
7247       % the square brackets.  Use the real section title if we have it.
7248       \ifdim \wd1 > 0pt
7249         % It is in another manual, so we don't have it.
7250         \def\printedrefname{\ignorespaces #1}%
7251       \else
7252         \ifhavexrefs
7253           % We know the real title if we have the xref values.
7254           \def\printedrefname{\refx{#1-title}{}}%
7255         \else
7256           % Otherwise just copy the Info node name.
7257           \def\printedrefname{\ignorespaces #1}%
7258         \fi%
7259       \fi
7260     \fi
7261   \fi
7262   %
7263   % Make link in pdf output.
7264   \ifpdf
7265     {\indexnofonts
7266      \turnoffactive
7267      % This expands tokens, so do it after making catcode changes, so _
7268      % etc. don't get their TeX definitions.
7269      \getfilename{#4}%
7270      %
7271      % See comments at \activebackslashdouble.
7272      {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7273       \backslashparens\pdfxrefdest}%
7274      %
7275      \leavevmode
7276      \startlink attr{/Border [0 0 0]}%
7277      \ifnum\filenamelength>0
7278        goto file{\the\filename.pdf} name{\pdfxrefdest}%
7279      \else
7280        goto name{\pdfmkpgn{\pdfxrefdest}}%
7281      \fi
7282     }%
7283     \setcolor{\linkcolor}%
7284   \fi
7285   %
7286   % Float references are printed completely differently: "Figure 1.2"
7287   % instead of "[somenode], p.3".  We distinguish them by the
7288   % LABEL-title being set to a magic string.
7289   {%
7290     % Have to otherify everything special to allow the \csname to
7291     % include an _ in the xref name, etc.
7292     \indexnofonts
7293     \turnoffactive
7294     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7295       \csname XR#1-title\endcsname
7296   }%
7297   \iffloat\Xthisreftitle
7298     % If the user specified the print name (third arg) to the ref,
7299     % print it instead of our usual "Figure 1.2".
7300     \ifdim\wd0 = 0pt
7301       \refx{#1-snt}{}%
7302     \else
7303       \printedrefname
7304     \fi
7305     %
7306     % if the user also gave the printed manual name (fifth arg), append
7307     % "in MANUALNAME".
7308     \ifdim \wd1 > 0pt
7309       \space \putwordin{} \cite{\printedmanual}%
7310     \fi
7311   \else
7312     % node/anchor (non-float) references.
7313     %
7314     % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7315     % insert empty discretionaries after hyphens, which means that it will
7316     % not find a line break at a hyphen in a node names.  Since some manuals
7317     % are best written with fairly long node names, containing hyphens, this
7318     % is a loss.  Therefore, we give the text of the node name again, so it
7319     % is as if TeX is seeing it for the first time.
7320     \ifdim \wd1 > 0pt
7321       \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7322     \else
7323       % _ (for example) has to be the character _ for the purposes of the
7324       % control sequence corresponding to the node, but it has to expand
7325       % into the usual \leavevmode...\vrule stuff for purposes of
7326       % printing. So we \turnoffactive for the \refx-snt, back on for the
7327       % printing, back off for the \refx-pg.
7328       {\turnoffactive
7329        % Only output a following space if the -snt ref is nonempty; for
7330        % @unnumbered and @anchor, it won't be.
7331        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7332        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7333       }%
7334       % output the `[mynode]' via a macro so it can be overridden.
7335       \xrefprintnodename\printedrefname
7336       %
7337       % But we always want a comma and a space:
7338       ,\space
7339       %
7340       % output the `page 3'.
7341       \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7342     \fi
7343   \fi
7344   \endlink
7345 \endgroup}
7346
7347 % This macro is called from \xrefX for the `[nodename]' part of xref
7348 % output.  It's a separate macro only so it can be changed more easily,
7349 % since square brackets don't work well in some documents.  Particularly
7350 % one that Bob is working on :).
7351 %
7352 \def\xrefprintnodename#1{[#1]}
7353
7354 % Things referred to by \setref.
7355 %
7356 \def\Ynothing{}
7357 \def\Yomitfromtoc{}
7358 \def\Ynumbered{%
7359   \ifnum\secno=0
7360     \putwordChapter@tie \the\chapno
7361   \else \ifnum\subsecno=0
7362     \putwordSection@tie \the\chapno.\the\secno
7363   \else \ifnum\subsubsecno=0
7364     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7365   \else
7366     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7367   \fi\fi\fi
7368 }
7369 \def\Yappendix{%
7370   \ifnum\secno=0
7371      \putwordAppendix@tie @char\the\appendixno{}%
7372   \else \ifnum\subsecno=0
7373      \putwordSection@tie @char\the\appendixno.\the\secno
7374   \else \ifnum\subsubsecno=0
7375     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7376   \else
7377     \putwordSection@tie
7378       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7379   \fi\fi\fi
7380 }
7381
7382 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7383 % If its value is nonempty, SUFFIX is output afterward.
7384 %
7385 \def\refx#1#2{%
7386   {%
7387     \indexnofonts
7388     \otherbackslash
7389     \expandafter\global\expandafter\let\expandafter\thisrefX
7390       \csname XR#1\endcsname
7391   }%
7392   \ifx\thisrefX\relax
7393     % If not defined, say something at least.
7394     \angleleft un\-de\-fined\angleright
7395     \iflinks
7396       \ifhavexrefs
7397         \message{\linenumber Undefined cross reference `#1'.}%
7398       \else
7399         \ifwarnedxrefs\else
7400           \global\warnedxrefstrue
7401           \message{Cross reference values unknown; you must run TeX again.}%
7402         \fi
7403       \fi
7404     \fi
7405   \else
7406     % It's defined, so just use it.
7407     \thisrefX
7408   \fi
7409   #2% Output the suffix in any case.
7410 }
7411
7412 % This is the macro invoked by entries in the aux file.  Usually it's
7413 % just a \def (we prepend XR to the control sequence name to avoid
7414 % collisions).  But if this is a float type, we have more work to do.
7415 %
7416 \def\xrdef#1#2{%
7417   {% The node name might contain 8-bit characters, which in our current
7418    % implementation are changed to commands like @'e.  Don't let these
7419    % mess up the control sequence name.
7420     \indexnofonts
7421     \turnoffactive
7422     \xdef\safexrefname{#1}%
7423   }%
7424   %
7425   \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7426   %
7427   % Was that xref control sequence that we just defined for a float?
7428   \expandafter\iffloat\csname XR\safexrefname\endcsname
7429     % it was a float, and we have the (safe) float type in \iffloattype.
7430     \expandafter\let\expandafter\floatlist
7431       \csname floatlist\iffloattype\endcsname
7432     %
7433     % Is this the first time we've seen this float type?
7434     \expandafter\ifx\floatlist\relax
7435       \toks0 = {\do}% yes, so just \do
7436     \else
7437       % had it before, so preserve previous elements in list.
7438       \toks0 = \expandafter{\floatlist\do}%
7439     \fi
7440     %
7441     % Remember this xref in the control sequence \floatlistFLOATTYPE,
7442     % for later use in \listoffloats.
7443     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7444       {\safexrefname}}%
7445   \fi
7446 }
7447
7448 % Read the last existing aux file, if any.  No error if none exists.
7449 %
7450 \def\tryauxfile{%
7451   \openin 1 \jobname.aux
7452   \ifeof 1 \else
7453     \readdatafile{aux}%
7454     \global\havexrefstrue
7455   \fi
7456   \closein 1
7457 }
7458
7459 \def\setupdatafile{%
7460   \catcode`\^^@=\other
7461   \catcode`\^^A=\other
7462   \catcode`\^^B=\other
7463   \catcode`\^^C=\other
7464   \catcode`\^^D=\other
7465   \catcode`\^^E=\other
7466   \catcode`\^^F=\other
7467   \catcode`\^^G=\other
7468   \catcode`\^^H=\other
7469   \catcode`\^^K=\other
7470   \catcode`\^^L=\other
7471   \catcode`\^^N=\other
7472   \catcode`\^^P=\other
7473   \catcode`\^^Q=\other
7474   \catcode`\^^R=\other
7475   \catcode`\^^S=\other
7476   \catcode`\^^T=\other
7477   \catcode`\^^U=\other
7478   \catcode`\^^V=\other
7479   \catcode`\^^W=\other
7480   \catcode`\^^X=\other
7481   \catcode`\^^Z=\other
7482   \catcode`\^^[=\other
7483   \catcode`\^^\=\other
7484   \catcode`\^^]=\other
7485   \catcode`\^^^=\other
7486   \catcode`\^^_=\other
7487   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7488   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
7489   % supported in the main text, it doesn't seem desirable.  Furthermore,
7490   % that is not enough: for node names that actually contain a ^
7491   % character, we would end up writing a line like this: 'xrdef {'hat
7492   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7493   % argument, and \hat is not an expandable control sequence.  It could
7494   % all be worked out, but why?  Either we support ^^ or we don't.
7495   %
7496   % The other change necessary for this was to define \auxhat:
7497   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7498   % and then to call \auxhat in \setq.
7499   %
7500   \catcode`\^=\other
7501   %
7502   % Special characters.  Should be turned off anyway, but...
7503   \catcode`\~=\other
7504   \catcode`\[=\other
7505   \catcode`\]=\other
7506   \catcode`\"=\other
7507   \catcode`\_=\other
7508   \catcode`\|=\other
7509   \catcode`\<=\other
7510   \catcode`\>=\other
7511   \catcode`\$=\other
7512   \catcode`\#=\other
7513   \catcode`\&=\other
7514   \catcode`\%=\other
7515   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7516   %
7517   % This is to support \ in node names and titles, since the \
7518   % characters end up in a \csname.  It's easier than
7519   % leaving it active and making its active definition an actual \
7520   % character.  What I don't understand is why it works in the *value*
7521   % of the xrdef.  Seems like it should be a catcode12 \, and that
7522   % should not typeset properly.  But it works, so I'm moving on for
7523   % now.  --karl, 15jan04.
7524   \catcode`\\=\other
7525   %
7526   % Make the characters 128-255 be printing characters.
7527   {%
7528     \count1=128
7529     \def\loop{%
7530       \catcode\count1=\other
7531       \advance\count1 by 1
7532       \ifnum \count1<256 \loop \fi
7533     }%
7534   }%
7535   %
7536   % @ is our escape character in .aux files, and we need braces.
7537   \catcode`\{=1
7538   \catcode`\}=2
7539   \catcode`\@=0
7540 }
7541
7542 \def\readdatafile#1{%
7543 \begingroup
7544   \setupdatafile
7545   \input\jobname.#1
7546 \endgroup}
7547
7548
7549 \message{insertions,}
7550 % including footnotes.
7551
7552 \newcount \footnoteno
7553
7554 % The trailing space in the following definition for supereject is
7555 % vital for proper filling; pages come out unaligned when you do a
7556 % pagealignmacro call if that space before the closing brace is
7557 % removed. (Generally, numeric constants should always be followed by a
7558 % space to prevent strange expansion errors.)
7559 \def\supereject{\par\penalty -20000\footnoteno =0 }
7560
7561 % @footnotestyle is meaningful for info output only.
7562 \let\footnotestyle=\comment
7563
7564 {\catcode `\@=11
7565 %
7566 % Auto-number footnotes.  Otherwise like plain.
7567 \gdef\footnote{%
7568   \let\indent=\ptexindent
7569   \let\noindent=\ptexnoindent
7570   \global\advance\footnoteno by \@ne
7571   \edef\thisfootno{$^{\the\footnoteno}$}%
7572   %
7573   % In case the footnote comes at the end of a sentence, preserve the
7574   % extra spacing after we do the footnote number.
7575   \let\@sf\empty
7576   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7577   %
7578   % Remove inadvertent blank space before typesetting the footnote number.
7579   \unskip
7580   \thisfootno\@sf
7581   \dofootnote
7582 }%
7583
7584 % Don't bother with the trickery in plain.tex to not require the
7585 % footnote text as a parameter.  Our footnotes don't need to be so general.
7586 %
7587 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7588 % \parseargline) fails inside footnotes because the tokens are fixed when
7589 % the footnote is read.  --karl, 16nov96.
7590 %
7591 \gdef\dofootnote{%
7592   \insert\footins\bgroup
7593   % We want to typeset this text as a normal paragraph, even if the
7594   % footnote reference occurs in (for example) a display environment.
7595   % So reset some parameters.
7596   \hsize=\pagewidth
7597   \interlinepenalty\interfootnotelinepenalty
7598   \splittopskip\ht\strutbox % top baseline for broken footnotes
7599   \splitmaxdepth\dp\strutbox
7600   \floatingpenalty\@MM
7601   \leftskip\z@skip
7602   \rightskip\z@skip
7603   \spaceskip\z@skip
7604   \xspaceskip\z@skip
7605   \parindent\defaultparindent
7606   %
7607   \smallfonts \rm
7608   %
7609   % Because we use hanging indentation in footnotes, a @noindent appears
7610   % to exdent this text, so make it be a no-op.  makeinfo does not use
7611   % hanging indentation so @noindent can still be needed within footnote
7612   % text after an @example or the like (not that this is good style).
7613   \let\noindent = \relax
7614   %
7615   % Hang the footnote text off the number.  Use \everypar in case the
7616   % footnote extends for more than one paragraph.
7617   \everypar = {\hang}%
7618   \textindent{\thisfootno}%
7619   %
7620   % Don't crash into the line above the footnote text.  Since this
7621   % expands into a box, it must come within the paragraph, lest it
7622   % provide a place where TeX can split the footnote.
7623   \footstrut
7624   \futurelet\next\fo@t
7625 }
7626 }%end \catcode `\@=11
7627
7628 % In case a @footnote appears in a vbox, save the footnote text and create
7629 % the real \insert just after the vbox finished.  Otherwise, the insertion
7630 % would be lost.
7631 % Similarly, if a @footnote appears inside an alignment, save the footnote
7632 % text to a box and make the \insert when a row of the table is finished.
7633 % And the same can be done for other insert classes.  --kasal, 16nov03.
7634
7635 % Replace the \insert primitive by a cheating macro.
7636 % Deeper inside, just make sure that the saved insertions are not spilled
7637 % out prematurely.
7638 %
7639 \def\startsavinginserts{%
7640   \ifx \insert\ptexinsert
7641     \let\insert\saveinsert
7642   \else
7643     \let\checkinserts\relax
7644   \fi
7645 }
7646
7647 % This \insert replacement works for both \insert\footins{foo} and
7648 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7649 %
7650 \def\saveinsert#1{%
7651   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7652   \afterassignment\next
7653   % swallow the left brace
7654   \let\temp =
7655 }
7656 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7657 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7658
7659 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7660
7661 \def\placesaveins#1{%
7662   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7663     {\box#1}%
7664 }
7665
7666 % eat @SAVE -- beware, all of them have catcode \other:
7667 {
7668   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
7669   \gdef\gobblesave @SAVE{}
7670 }
7671
7672 % initialization:
7673 \def\newsaveins #1{%
7674   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7675   \next
7676 }
7677 \def\newsaveinsX #1{%
7678   \csname newbox\endcsname #1%
7679   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7680     \checksaveins #1}%
7681 }
7682
7683 % initialize:
7684 \let\checkinserts\empty
7685 \newsaveins\footins
7686 \newsaveins\margin
7687
7688
7689 % @image.  We use the macros from epsf.tex to support this.
7690 % If epsf.tex is not installed and @image is used, we complain.
7691 %
7692 % Check for and read epsf.tex up front.  If we read it only at @image
7693 % time, we might be inside a group, and then its definitions would get
7694 % undone and the next image would fail.
7695 \openin 1 = epsf.tex
7696 \ifeof 1 \else
7697   % Do not bother showing banner with epsf.tex v2.7k (available in
7698   % doc/epsf.tex and on ctan).
7699   \def\epsfannounce{\toks0 = }%
7700   \input epsf.tex
7701 \fi
7702 \closein 1
7703 %
7704 % We will only complain once about lack of epsf.tex.
7705 \newif\ifwarnednoepsf
7706 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7707   work.  It is also included in the Texinfo distribution, or you can get
7708   it from ftp://tug.org/tex/epsf.tex.}
7709 %
7710 \def\image#1{%
7711   \ifx\epsfbox\undefined
7712     \ifwarnednoepsf \else
7713       \errhelp = \noepsfhelp
7714       \errmessage{epsf.tex not found, images will be ignored}%
7715       \global\warnednoepsftrue
7716     \fi
7717   \else
7718     \imagexxx #1,,,,,\finish
7719   \fi
7720 }
7721 %
7722 % Arguments to @image:
7723 % #1 is (mandatory) image filename; we tack on .eps extension.
7724 % #2 is (optional) width, #3 is (optional) height.
7725 % #4 is (ignored optional) html alt text.
7726 % #5 is (ignored optional) extension.
7727 % #6 is just the usual extra ignored arg for parsing stuff.
7728 \newif\ifimagevmode
7729 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7730   \catcode`\^^M = 5     % in case we're inside an example
7731   \normalturnoffactive  % allow _ et al. in names
7732   % If the image is by itself, center it.
7733   \ifvmode
7734     \imagevmodetrue
7735     \nobreak\medskip
7736     % Usually we'll have text after the image which will insert
7737     % \parskip glue, so insert it here too to equalize the space
7738     % above and below.
7739     \nobreak\vskip\parskip
7740     \nobreak
7741   \fi
7742   %
7743   % Leave vertical mode so that indentation from an enclosing
7744   % environment such as @quotation is respected.  On the other hand, if
7745   % it's at the top level, we don't want the normal paragraph indentation.
7746   \noindent
7747   %
7748   % Output the image.
7749   \ifpdf
7750     \dopdfimage{#1}{#2}{#3}%
7751   \else
7752     % \epsfbox itself resets \epsf?size at each figure.
7753     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7754     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7755     \epsfbox{#1.eps}%
7756   \fi
7757   %
7758   \ifimagevmode \medskip \fi  % space after the standalone image
7759 \endgroup}
7760
7761
7762 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7763 % etc.  We don't actually implement floating yet, we always include the
7764 % float "here".  But it seemed the best name for the future.
7765 %
7766 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7767
7768 % There may be a space before second and/or third parameter; delete it.
7769 \def\eatcommaspace#1, {#1,}
7770
7771 % #1 is the optional FLOATTYPE, the text label for this float, typically
7772 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
7773 % this float will not be numbered and cannot be referred to.
7774 %
7775 % #2 is the optional xref label.  Also must be present for the float to
7776 % be referable.
7777 %
7778 % #3 is the optional positioning argument; for now, it is ignored.  It
7779 % will somehow specify the positions allowed to float to (here, top, bottom).
7780 %
7781 % We keep a separate counter for each FLOATTYPE, which we reset at each
7782 % chapter-level command.
7783 \let\resetallfloatnos=\empty
7784 %
7785 \def\dofloat#1,#2,#3,#4\finish{%
7786   \let\thiscaption=\empty
7787   \let\thisshortcaption=\empty
7788   %
7789   % don't lose footnotes inside @float.
7790   %
7791   % BEWARE: when the floats start float, we have to issue warning whenever an
7792   % insert appears inside a float which could possibly float. --kasal, 26may04
7793   %
7794   \startsavinginserts
7795   %
7796   % We can't be used inside a paragraph.
7797   \par
7798   %
7799   \vtop\bgroup
7800     \def\floattype{#1}%
7801     \def\floatlabel{#2}%
7802     \def\floatloc{#3}% we do nothing with this yet.
7803     %
7804     \ifx\floattype\empty
7805       \let\safefloattype=\empty
7806     \else
7807       {%
7808         % the floattype might have accents or other special characters,
7809         % but we need to use it in a control sequence name.
7810         \indexnofonts
7811         \turnoffactive
7812         \xdef\safefloattype{\floattype}%
7813       }%
7814     \fi
7815     %
7816     % If label is given but no type, we handle that as the empty type.
7817     \ifx\floatlabel\empty \else
7818       % We want each FLOATTYPE to be numbered separately (Figure 1,
7819       % Table 1, Figure 2, ...).  (And if no label, no number.)
7820       %
7821       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7822       \global\advance\floatno by 1
7823       %
7824       {%
7825         % This magic value for \lastsection is output by \setref as the
7826         % XREFLABEL-title value.  \xrefX uses it to distinguish float
7827         % labels (which have a completely different output format) from
7828         % node and anchor labels.  And \xrdef uses it to construct the
7829         % lists of floats.
7830         %
7831         \edef\lastsection{\floatmagic=\safefloattype}%
7832         \setref{\floatlabel}{Yfloat}%
7833       }%
7834     \fi
7835     %
7836     % start with \parskip glue, I guess.
7837     \vskip\parskip
7838     %
7839     % Don't suppress indentation if a float happens to start a section.
7840     \restorefirstparagraphindent
7841 }
7842
7843 % we have these possibilities:
7844 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7845 % @float Foo,lbl & no caption:    Foo 1.1
7846 % @float Foo & @caption{Cap}:     Foo: Cap
7847 % @float Foo & no caption:        Foo
7848 % @float ,lbl & Caption{Cap}:     1.1: Cap
7849 % @float ,lbl & no caption:       1.1
7850 % @float & @caption{Cap}:         Cap
7851 % @float & no caption:
7852 %
7853 \def\Efloat{%
7854     \let\floatident = \empty
7855     %
7856     % In all cases, if we have a float type, it comes first.
7857     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7858     %
7859     % If we have an xref label, the number comes next.
7860     \ifx\floatlabel\empty \else
7861       \ifx\floattype\empty \else % if also had float type, need tie first.
7862         \appendtomacro\floatident{\tie}%
7863       \fi
7864       % the number.
7865       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7866     \fi
7867     %
7868     % Start the printed caption with what we've constructed in
7869     % \floatident, but keep it separate; we need \floatident again.
7870     \let\captionline = \floatident
7871     %
7872     \ifx\thiscaption\empty \else
7873       \ifx\floatident\empty \else
7874         \appendtomacro\captionline{: }% had ident, so need a colon between
7875       \fi
7876       %
7877       % caption text.
7878       \appendtomacro\captionline{\scanexp\thiscaption}%
7879     \fi
7880     %
7881     % If we have anything to print, print it, with space before.
7882     % Eventually this needs to become an \insert.
7883     \ifx\captionline\empty \else
7884       \vskip.5\parskip
7885       \captionline
7886       %
7887       % Space below caption.
7888       \vskip\parskip
7889     \fi
7890     %
7891     % If have an xref label, write the list of floats info.  Do this
7892     % after the caption, to avoid chance of it being a breakpoint.
7893     \ifx\floatlabel\empty \else
7894       % Write the text that goes in the lof to the aux file as
7895       % \floatlabel-lof.  Besides \floatident, we include the short
7896       % caption if specified, else the full caption if specified, else nothing.
7897       {%
7898         \atdummies
7899         %
7900         % since we read the caption text in the macro world, where ^^M
7901         % is turned into a normal character, we have to scan it back, so
7902         % we don't write the literal three characters "^^M" into the aux file.
7903         \scanexp{%
7904           \xdef\noexpand\gtemp{%
7905             \ifx\thisshortcaption\empty
7906               \thiscaption
7907             \else
7908               \thisshortcaption
7909             \fi
7910           }%
7911         }%
7912         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7913           \ifx\gtemp\empty \else : \gtemp \fi}}%
7914       }%
7915     \fi
7916   \egroup  % end of \vtop
7917   %
7918   % place the captured inserts
7919   %
7920   % BEWARE: when the floats start floating, we have to issue warning
7921   % whenever an insert appears inside a float which could possibly
7922   % float. --kasal, 26may04
7923   %
7924   \checkinserts
7925 }
7926
7927 % Append the tokens #2 to the definition of macro #1, not expanding either.
7928 %
7929 \def\appendtomacro#1#2{%
7930   \expandafter\def\expandafter#1\expandafter{#1#2}%
7931 }
7932
7933 % @caption, @shortcaption
7934 %
7935 \def\caption{\docaption\thiscaption}
7936 \def\shortcaption{\docaption\thisshortcaption}
7937 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7938 \def\defcaption#1#2{\egroup \def#1{#2}}
7939
7940 % The parameter is the control sequence identifying the counter we are
7941 % going to use.  Create it if it doesn't exist and assign it to \floatno.
7942 \def\getfloatno#1{%
7943   \ifx#1\relax
7944       % Haven't seen this figure type before.
7945       \csname newcount\endcsname #1%
7946       %
7947       % Remember to reset this floatno at the next chap.
7948       \expandafter\gdef\expandafter\resetallfloatnos
7949         \expandafter{\resetallfloatnos #1=0 }%
7950   \fi
7951   \let\floatno#1%
7952 }
7953
7954 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
7955 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
7956 % first read the @float command.
7957 %
7958 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7959
7960 % Magic string used for the XREFLABEL-title value, so \xrefX can
7961 % distinguish floats from other xref types.
7962 \def\floatmagic{!!float!!}
7963
7964 % #1 is the control sequence we are passed; we expand into a conditional
7965 % which is true if #1 represents a float ref.  That is, the magic
7966 % \lastsection value which we \setref above.
7967 %
7968 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7969 %
7970 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
7971 % (safe) float type for this float.  We set \iffloattype to #2.
7972 %
7973 \def\doiffloat#1=#2=#3\finish{%
7974   \def\temp{#1}%
7975   \def\iffloattype{#2}%
7976   \ifx\temp\floatmagic
7977 }
7978
7979 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7980 %
7981 \parseargdef\listoffloats{%
7982   \def\floattype{#1}% floattype
7983   {%
7984     % the floattype might have accents or other special characters,
7985     % but we need to use it in a control sequence name.
7986     \indexnofonts
7987     \turnoffactive
7988     \xdef\safefloattype{\floattype}%
7989   }%
7990   %
7991   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7992   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7993     \ifhavexrefs
7994       % if the user said @listoffloats foo but never @float foo.
7995       \message{\linenumber No `\safefloattype' floats to list.}%
7996     \fi
7997   \else
7998     \begingroup
7999       \leftskip=\tocindent  % indent these entries like a toc
8000       \let\do=\listoffloatsdo
8001       \csname floatlist\safefloattype\endcsname
8002     \endgroup
8003   \fi
8004 }
8005
8006 % This is called on each entry in a list of floats.  We're passed the
8007 % xref label, in the form LABEL-title, which is how we save it in the
8008 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
8009 % has the text we're supposed to typeset here.
8010 %
8011 % Figures without xref labels will not be included in the list (since
8012 % they won't appear in the aux file).
8013 %
8014 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8015 \def\listoffloatsdoentry#1-title\finish{{%
8016   % Can't fully expand XR#1-lof because it can contain anything.  Just
8017   % pass the control sequence.  On the other hand, XR#1-pg is just the
8018   % page number, and we want to fully expand that so we can get a link
8019   % in pdf output.
8020   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8021   %
8022   % use the same \entry macro we use to generate the TOC and index.
8023   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8024   \writeentry
8025 }}
8026
8027
8028 \message{localization,}
8029
8030 % For single-language documents, @documentlanguage is usually given very
8031 % early, just after @documentencoding.  Single argument is the language
8032 % (de) or locale (de_DE) abbreviation.
8033 %
8034 {
8035   \catcode`\_ = \active
8036   \globaldefs=1
8037 \parseargdef\documentlanguage{\begingroup
8038   \let_=\normalunderscore  % normal _ character for filenames
8039   \tex % read txi-??.tex file in plain TeX.
8040     % Read the file by the name they passed if it exists.
8041     \openin 1 txi-#1.tex
8042     \ifeof 1
8043       \documentlanguagetrywithoutunderscore{#1_\finish}%
8044     \else
8045       \globaldefs = 1  % everything in the txi-LL files needs to persist
8046       \input txi-#1.tex
8047     \fi
8048     \closein 1
8049   \endgroup % end raw TeX
8050 \endgroup}
8051 %
8052 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8053 % try txi-de.tex.
8054 %
8055 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8056   \openin 1 txi-#1.tex
8057   \ifeof 1
8058     \errhelp = \nolanghelp
8059     \errmessage{Cannot read language file txi-#1.tex}%
8060   \else
8061     \globaldefs = 1  % everything in the txi-LL files needs to persist
8062     \input txi-#1.tex
8063   \fi
8064   \closein 1
8065 }
8066 }% end of special _ catcode
8067 %
8068 \newhelp\nolanghelp{The given language definition file cannot be found or
8069 is empty.  Maybe you need to install it?  Putting it in the current
8070 directory should work if nowhere else does.}
8071
8072 % This macro is called from txi-??.tex files; the first argument is the
8073 % \language name to set (without the "\lang@" prefix), the second and
8074 % third args are \{left,right}hyphenmin.
8075 %
8076 % The language names to pass are determined when the format is built.
8077 % See the etex.log file created at that time, e.g.,
8078 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8079 %
8080 % With TeX Live 2008, etex now includes hyphenation patterns for all
8081 % available languages.  This means we can support hyphenation in
8082 % Texinfo, at least to some extent.  (This still doesn't solve the
8083 % accented characters problem.)
8084 %
8085 \catcode`@=11
8086 \def\txisetlanguage#1#2#3{%
8087   % do not set the language if the name is undefined in the current TeX.
8088   \expandafter\ifx\csname lang@#1\endcsname \relax
8089     \message{no patterns for #1}%
8090   \else
8091     \global\language = \csname lang@#1\endcsname
8092   \fi
8093   % but there is no harm in adjusting the hyphenmin values regardless.
8094   \global\lefthyphenmin = #2\relax
8095   \global\righthyphenmin = #3\relax
8096 }
8097
8098 % Helpers for encodings.
8099 % Set the catcode of characters 128 through 255 to the specified number.
8100 %
8101 \def\setnonasciicharscatcode#1{%
8102    \count255=128
8103    \loop\ifnum\count255<256
8104       \global\catcode\count255=#1\relax
8105       \advance\count255 by 1
8106    \repeat
8107 }
8108
8109 \def\setnonasciicharscatcodenonglobal#1{%
8110    \count255=128
8111    \loop\ifnum\count255<256
8112       \catcode\count255=#1\relax
8113       \advance\count255 by 1
8114    \repeat
8115 }
8116
8117 % @documentencoding sets the definition of non-ASCII characters
8118 % according to the specified encoding.
8119 %
8120 \parseargdef\documentencoding{%
8121   % Encoding being declared for the document.
8122   \def\declaredencoding{\csname #1.enc\endcsname}%
8123   %
8124   % Supported encodings: names converted to tokens in order to be able
8125   % to compare them with \ifx.
8126   \def\ascii{\csname US-ASCII.enc\endcsname}%
8127   \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8128   \def\latone{\csname ISO-8859-1.enc\endcsname}%
8129   \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8130   \def\utfeight{\csname UTF-8.enc\endcsname}%
8131   %
8132   \ifx \declaredencoding \ascii
8133      \asciichardefs
8134   %
8135   \else \ifx \declaredencoding \lattwo
8136      \setnonasciicharscatcode\active
8137      \lattwochardefs
8138   %
8139   \else \ifx \declaredencoding \latone
8140      \setnonasciicharscatcode\active
8141      \latonechardefs
8142   %
8143   \else \ifx \declaredencoding \latnine
8144      \setnonasciicharscatcode\active
8145      \latninechardefs
8146   %
8147   \else \ifx \declaredencoding \utfeight
8148      \setnonasciicharscatcode\active
8149      \utfeightchardefs
8150   %
8151   \else
8152     \message{Unknown document encoding #1, ignoring.}%
8153   %
8154   \fi % utfeight
8155   \fi % latnine
8156   \fi % latone
8157   \fi % lattwo
8158   \fi % ascii
8159 }
8160
8161 % A message to be logged when using a character that isn't available
8162 % the default font encoding (OT1).
8163 %
8164 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8165
8166 % Take account of \c (plain) vs. \, (Texinfo) difference.
8167 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8168
8169 % First, make active non-ASCII characters in order for them to be
8170 % correctly categorized when TeX reads the replacement text of
8171 % macros containing the character definitions.
8172 \setnonasciicharscatcode\active
8173 %
8174 % Latin1 (ISO-8859-1) character definitions.
8175 \def\latonechardefs{%
8176   \gdef^^a0{~}
8177   \gdef^^a1{\exclamdown}
8178   \gdef^^a2{\missingcharmsg{CENT SIGN}}
8179   \gdef^^a3{{\pounds}}
8180   \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8181   \gdef^^a5{\missingcharmsg{YEN SIGN}}
8182   \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8183   \gdef^^a7{\S}
8184   \gdef^^a8{\"{}}
8185   \gdef^^a9{\copyright}
8186   \gdef^^aa{\ordf}
8187   \gdef^^ab{\guillemetleft}
8188   \gdef^^ac{$\lnot$}
8189   \gdef^^ad{\-}
8190   \gdef^^ae{\registeredsymbol}
8191   \gdef^^af{\={}}
8192   %
8193   \gdef^^b0{\textdegree}
8194   \gdef^^b1{$\pm$}
8195   \gdef^^b2{$^2$}
8196   \gdef^^b3{$^3$}
8197   \gdef^^b4{\'{}}
8198   \gdef^^b5{$\mu$}
8199   \gdef^^b6{\P}
8200   %
8201   \gdef^^b7{$^.$}
8202   \gdef^^b8{\cedilla\ }
8203   \gdef^^b9{$^1$}
8204   \gdef^^ba{\ordm}
8205   %
8206   \gdef^^bb{\guilletright}
8207   \gdef^^bc{$1\over4$}
8208   \gdef^^bd{$1\over2$}
8209   \gdef^^be{$3\over4$}
8210   \gdef^^bf{\questiondown}
8211   %
8212   \gdef^^c0{\`A}
8213   \gdef^^c1{\'A}
8214   \gdef^^c2{\^A}
8215   \gdef^^c3{\~A}
8216   \gdef^^c4{\"A}
8217   \gdef^^c5{\ringaccent A}
8218   \gdef^^c6{\AE}
8219   \gdef^^c7{\cedilla C}
8220   \gdef^^c8{\`E}
8221   \gdef^^c9{\'E}
8222   \gdef^^ca{\^E}
8223   \gdef^^cb{\"E}
8224   \gdef^^cc{\`I}
8225   \gdef^^cd{\'I}
8226   \gdef^^ce{\^I}
8227   \gdef^^cf{\"I}
8228   %
8229   \gdef^^d0{\DH}
8230   \gdef^^d1{\~N}
8231   \gdef^^d2{\`O}
8232   \gdef^^d3{\'O}
8233   \gdef^^d4{\^O}
8234   \gdef^^d5{\~O}
8235   \gdef^^d6{\"O}
8236   \gdef^^d7{$\times$}
8237   \gdef^^d8{\O}
8238   \gdef^^d9{\`U}
8239   \gdef^^da{\'U}
8240   \gdef^^db{\^U}
8241   \gdef^^dc{\"U}
8242   \gdef^^dd{\'Y}
8243   \gdef^^de{\TH}
8244   \gdef^^df{\ss}
8245   %
8246   \gdef^^e0{\`a}
8247   \gdef^^e1{\'a}
8248   \gdef^^e2{\^a}
8249   \gdef^^e3{\~a}
8250   \gdef^^e4{\"a}
8251   \gdef^^e5{\ringaccent a}
8252   \gdef^^e6{\ae}
8253   \gdef^^e7{\cedilla c}
8254   \gdef^^e8{\`e}
8255   \gdef^^e9{\'e}
8256   \gdef^^ea{\^e}
8257   \gdef^^eb{\"e}
8258   \gdef^^ec{\`{\dotless i}}
8259   \gdef^^ed{\'{\dotless i}}
8260   \gdef^^ee{\^{\dotless i}}
8261   \gdef^^ef{\"{\dotless i}}
8262   %
8263   \gdef^^f0{\dh}
8264   \gdef^^f1{\~n}
8265   \gdef^^f2{\`o}
8266   \gdef^^f3{\'o}
8267   \gdef^^f4{\^o}
8268   \gdef^^f5{\~o}
8269   \gdef^^f6{\"o}
8270   \gdef^^f7{$\div$}
8271   \gdef^^f8{\o}
8272   \gdef^^f9{\`u}
8273   \gdef^^fa{\'u}
8274   \gdef^^fb{\^u}
8275   \gdef^^fc{\"u}
8276   \gdef^^fd{\'y}
8277   \gdef^^fe{\th}
8278   \gdef^^ff{\"y}
8279 }
8280
8281 % Latin9 (ISO-8859-15) encoding character definitions.
8282 \def\latninechardefs{%
8283   % Encoding is almost identical to Latin1.
8284   \latonechardefs
8285   %
8286   \gdef^^a4{\euro}
8287   \gdef^^a6{\v S}
8288   \gdef^^a8{\v s}
8289   \gdef^^b4{\v Z}
8290   \gdef^^b8{\v z}
8291   \gdef^^bc{\OE}
8292   \gdef^^bd{\oe}
8293   \gdef^^be{\"Y}
8294 }
8295
8296 % Latin2 (ISO-8859-2) character definitions.
8297 \def\lattwochardefs{%
8298   \gdef^^a0{~}
8299   \gdef^^a1{\ogonek{A}}
8300   \gdef^^a2{\u{}}
8301   \gdef^^a3{\L}
8302   \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8303   \gdef^^a5{\v L}
8304   \gdef^^a6{\'S}
8305   \gdef^^a7{\S}
8306   \gdef^^a8{\"{}}
8307   \gdef^^a9{\v S}
8308   \gdef^^aa{\cedilla S}
8309   \gdef^^ab{\v T}
8310   \gdef^^ac{\'Z}
8311   \gdef^^ad{\-}
8312   \gdef^^ae{\v Z}
8313   \gdef^^af{\dotaccent Z}
8314   %
8315   \gdef^^b0{\textdegree}
8316   \gdef^^b1{\ogonek{a}}
8317   \gdef^^b2{\ogonek{ }}
8318   \gdef^^b3{\l}
8319   \gdef^^b4{\'{}}
8320   \gdef^^b5{\v l}
8321   \gdef^^b6{\'s}
8322   \gdef^^b7{\v{}}
8323   \gdef^^b8{\cedilla\ }
8324   \gdef^^b9{\v s}
8325   \gdef^^ba{\cedilla s}
8326   \gdef^^bb{\v t}
8327   \gdef^^bc{\'z}
8328   \gdef^^bd{\H{}}
8329   \gdef^^be{\v z}
8330   \gdef^^bf{\dotaccent z}
8331   %
8332   \gdef^^c0{\'R}
8333   \gdef^^c1{\'A}
8334   \gdef^^c2{\^A}
8335   \gdef^^c3{\u A}
8336   \gdef^^c4{\"A}
8337   \gdef^^c5{\'L}
8338   \gdef^^c6{\'C}
8339   \gdef^^c7{\cedilla C}
8340   \gdef^^c8{\v C}
8341   \gdef^^c9{\'E}
8342   \gdef^^ca{\ogonek{E}}
8343   \gdef^^cb{\"E}
8344   \gdef^^cc{\v E}
8345   \gdef^^cd{\'I}
8346   \gdef^^ce{\^I}
8347   \gdef^^cf{\v D}
8348   %
8349   \gdef^^d0{\DH}
8350   \gdef^^d1{\'N}
8351   \gdef^^d2{\v N}
8352   \gdef^^d3{\'O}
8353   \gdef^^d4{\^O}
8354   \gdef^^d5{\H O}
8355   \gdef^^d6{\"O}
8356   \gdef^^d7{$\times$}
8357   \gdef^^d8{\v R}
8358   \gdef^^d9{\ringaccent U}
8359   \gdef^^da{\'U}
8360   \gdef^^db{\H U}
8361   \gdef^^dc{\"U}
8362   \gdef^^dd{\'Y}
8363   \gdef^^de{\cedilla T}
8364   \gdef^^df{\ss}
8365   %
8366   \gdef^^e0{\'r}
8367   \gdef^^e1{\'a}
8368   \gdef^^e2{\^a}
8369   \gdef^^e3{\u a}
8370   \gdef^^e4{\"a}
8371   \gdef^^e5{\'l}
8372   \gdef^^e6{\'c}
8373   \gdef^^e7{\cedilla c}
8374   \gdef^^e8{\v c}
8375   \gdef^^e9{\'e}
8376   \gdef^^ea{\ogonek{e}}
8377   \gdef^^eb{\"e}
8378   \gdef^^ec{\v e}
8379   \gdef^^ed{\'\i}
8380   \gdef^^ee{\^\i}
8381   \gdef^^ef{\v d}
8382   %
8383   \gdef^^f0{\dh}
8384   \gdef^^f1{\'n}
8385   \gdef^^f2{\v n}
8386   \gdef^^f3{\'o}
8387   \gdef^^f4{\^o}
8388   \gdef^^f5{\H o}
8389   \gdef^^f6{\"o}
8390   \gdef^^f7{$\div$}
8391   \gdef^^f8{\v r}
8392   \gdef^^f9{\ringaccent u}
8393   \gdef^^fa{\'u}
8394   \gdef^^fb{\H u}
8395   \gdef^^fc{\"u}
8396   \gdef^^fd{\'y}
8397   \gdef^^fe{\cedilla t}
8398   \gdef^^ff{\dotaccent{}}
8399 }
8400
8401 % UTF-8 character definitions.
8402 %
8403 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8404 % changes for Texinfo conventions.  It is included here under the GPL by
8405 % permission from Frank Mittelbach and the LaTeX team.
8406 %
8407 \newcount\countUTFx
8408 \newcount\countUTFy
8409 \newcount\countUTFz
8410
8411 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8412    \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8413 %
8414 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8415    \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8416 %
8417 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8418    \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8419
8420 \gdef\UTFviiiDefined#1{%
8421   \ifx #1\relax
8422     \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8423   \else
8424     \expandafter #1%
8425   \fi
8426 }
8427
8428 \begingroup
8429   \catcode`\~13
8430   \catcode`\"12
8431
8432   \def\UTFviiiLoop{%
8433     \global\catcode\countUTFx\active
8434     \uccode`\~\countUTFx
8435     \uppercase\expandafter{\UTFviiiTmp}%
8436     \advance\countUTFx by 1
8437     \ifnum\countUTFx < \countUTFy
8438       \expandafter\UTFviiiLoop
8439     \fi}
8440
8441   \countUTFx = "C2
8442   \countUTFy = "E0
8443   \def\UTFviiiTmp{%
8444     \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8445   \UTFviiiLoop
8446
8447   \countUTFx = "E0
8448   \countUTFy = "F0
8449   \def\UTFviiiTmp{%
8450     \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8451   \UTFviiiLoop
8452
8453   \countUTFx = "F0
8454   \countUTFy = "F4
8455   \def\UTFviiiTmp{%
8456     \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8457   \UTFviiiLoop
8458 \endgroup
8459
8460 \begingroup
8461   \catcode`\"=12
8462   \catcode`\<=12
8463   \catcode`\.=12
8464   \catcode`\,=12
8465   \catcode`\;=12
8466   \catcode`\!=12
8467   \catcode`\~=13
8468
8469   \gdef\DeclareUnicodeCharacter#1#2{%
8470     \countUTFz = "#1\relax
8471     \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8472     \begingroup
8473       \parseXMLCharref
8474       \def\UTFviiiTwoOctets##1##2{%
8475         \csname u8:##1\string ##2\endcsname}%
8476       \def\UTFviiiThreeOctets##1##2##3{%
8477         \csname u8:##1\string ##2\string ##3\endcsname}%
8478       \def\UTFviiiFourOctets##1##2##3##4{%
8479         \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8480       \expandafter\expandafter\expandafter\expandafter
8481        \expandafter\expandafter\expandafter
8482        \gdef\UTFviiiTmp{#2}%
8483     \endgroup}
8484
8485   \gdef\parseXMLCharref{%
8486     \ifnum\countUTFz < "A0\relax
8487       \errhelp = \EMsimple
8488       \errmessage{Cannot define Unicode char value < 00A0}%
8489     \else\ifnum\countUTFz < "800\relax
8490       \parseUTFviiiA,%
8491       \parseUTFviiiB C\UTFviiiTwoOctets.,%
8492     \else\ifnum\countUTFz < "10000\relax
8493       \parseUTFviiiA;%
8494       \parseUTFviiiA,%
8495       \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8496     \else
8497       \parseUTFviiiA;%
8498       \parseUTFviiiA,%
8499       \parseUTFviiiA!%
8500       \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8501     \fi\fi\fi
8502   }
8503
8504   \gdef\parseUTFviiiA#1{%
8505     \countUTFx = \countUTFz
8506     \divide\countUTFz by 64
8507     \countUTFy = \countUTFz
8508     \multiply\countUTFz by 64
8509     \advance\countUTFx by -\countUTFz
8510     \advance\countUTFx by 128
8511     \uccode `#1\countUTFx
8512     \countUTFz = \countUTFy}
8513
8514   \gdef\parseUTFviiiB#1#2#3#4{%
8515     \advance\countUTFz by "#10\relax
8516     \uccode `#3\countUTFz
8517     \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8518 \endgroup
8519
8520 \def\utfeightchardefs{%
8521   \DeclareUnicodeCharacter{00A0}{\tie}
8522   \DeclareUnicodeCharacter{00A1}{\exclamdown}
8523   \DeclareUnicodeCharacter{00A3}{\pounds}
8524   \DeclareUnicodeCharacter{00A8}{\"{ }}
8525   \DeclareUnicodeCharacter{00A9}{\copyright}
8526   \DeclareUnicodeCharacter{00AA}{\ordf}
8527   \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8528   \DeclareUnicodeCharacter{00AD}{\-}
8529   \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8530   \DeclareUnicodeCharacter{00AF}{\={ }}
8531
8532   \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8533   \DeclareUnicodeCharacter{00B4}{\'{ }}
8534   \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8535   \DeclareUnicodeCharacter{00BA}{\ordm}
8536   \DeclareUnicodeCharacter{00BB}{\guillemetright}
8537   \DeclareUnicodeCharacter{00BF}{\questiondown}
8538
8539   \DeclareUnicodeCharacter{00C0}{\`A}
8540   \DeclareUnicodeCharacter{00C1}{\'A}
8541   \DeclareUnicodeCharacter{00C2}{\^A}
8542   \DeclareUnicodeCharacter{00C3}{\~A}
8543   \DeclareUnicodeCharacter{00C4}{\"A}
8544   \DeclareUnicodeCharacter{00C5}{\AA}
8545   \DeclareUnicodeCharacter{00C6}{\AE}
8546   \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8547   \DeclareUnicodeCharacter{00C8}{\`E}
8548   \DeclareUnicodeCharacter{00C9}{\'E}
8549   \DeclareUnicodeCharacter{00CA}{\^E}
8550   \DeclareUnicodeCharacter{00CB}{\"E}
8551   \DeclareUnicodeCharacter{00CC}{\`I}
8552   \DeclareUnicodeCharacter{00CD}{\'I}
8553   \DeclareUnicodeCharacter{00CE}{\^I}
8554   \DeclareUnicodeCharacter{00CF}{\"I}
8555
8556   \DeclareUnicodeCharacter{00D0}{\DH}
8557   \DeclareUnicodeCharacter{00D1}{\~N}
8558   \DeclareUnicodeCharacter{00D2}{\`O}
8559   \DeclareUnicodeCharacter{00D3}{\'O}
8560   \DeclareUnicodeCharacter{00D4}{\^O}
8561   \DeclareUnicodeCharacter{00D5}{\~O}
8562   \DeclareUnicodeCharacter{00D6}{\"O}
8563   \DeclareUnicodeCharacter{00D8}{\O}
8564   \DeclareUnicodeCharacter{00D9}{\`U}
8565   \DeclareUnicodeCharacter{00DA}{\'U}
8566   \DeclareUnicodeCharacter{00DB}{\^U}
8567   \DeclareUnicodeCharacter{00DC}{\"U}
8568   \DeclareUnicodeCharacter{00DD}{\'Y}
8569   \DeclareUnicodeCharacter{00DE}{\TH}
8570   \DeclareUnicodeCharacter{00DF}{\ss}
8571
8572   \DeclareUnicodeCharacter{00E0}{\`a}
8573   \DeclareUnicodeCharacter{00E1}{\'a}
8574   \DeclareUnicodeCharacter{00E2}{\^a}
8575   \DeclareUnicodeCharacter{00E3}{\~a}
8576   \DeclareUnicodeCharacter{00E4}{\"a}
8577   \DeclareUnicodeCharacter{00E5}{\aa}
8578   \DeclareUnicodeCharacter{00E6}{\ae}
8579   \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8580   \DeclareUnicodeCharacter{00E8}{\`e}
8581   \DeclareUnicodeCharacter{00E9}{\'e}
8582   \DeclareUnicodeCharacter{00EA}{\^e}
8583   \DeclareUnicodeCharacter{00EB}{\"e}
8584   \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8585   \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8586   \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8587   \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8588
8589   \DeclareUnicodeCharacter{00F0}{\dh}
8590   \DeclareUnicodeCharacter{00F1}{\~n}
8591   \DeclareUnicodeCharacter{00F2}{\`o}
8592   \DeclareUnicodeCharacter{00F3}{\'o}
8593   \DeclareUnicodeCharacter{00F4}{\^o}
8594   \DeclareUnicodeCharacter{00F5}{\~o}
8595   \DeclareUnicodeCharacter{00F6}{\"o}
8596   \DeclareUnicodeCharacter{00F8}{\o}
8597   \DeclareUnicodeCharacter{00F9}{\`u}
8598   \DeclareUnicodeCharacter{00FA}{\'u}
8599   \DeclareUnicodeCharacter{00FB}{\^u}
8600   \DeclareUnicodeCharacter{00FC}{\"u}
8601   \DeclareUnicodeCharacter{00FD}{\'y}
8602   \DeclareUnicodeCharacter{00FE}{\th}
8603   \DeclareUnicodeCharacter{00FF}{\"y}
8604
8605   \DeclareUnicodeCharacter{0100}{\=A}
8606   \DeclareUnicodeCharacter{0101}{\=a}
8607   \DeclareUnicodeCharacter{0102}{\u{A}}
8608   \DeclareUnicodeCharacter{0103}{\u{a}}
8609   \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8610   \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8611   \DeclareUnicodeCharacter{0106}{\'C}
8612   \DeclareUnicodeCharacter{0107}{\'c}
8613   \DeclareUnicodeCharacter{0108}{\^C}
8614   \DeclareUnicodeCharacter{0109}{\^c}
8615   \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8616   \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8617   \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8618   \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8619   \DeclareUnicodeCharacter{010C}{\v{C}}
8620   \DeclareUnicodeCharacter{010D}{\v{c}}
8621   \DeclareUnicodeCharacter{010E}{\v{D}}
8622
8623   \DeclareUnicodeCharacter{0112}{\=E}
8624   \DeclareUnicodeCharacter{0113}{\=e}
8625   \DeclareUnicodeCharacter{0114}{\u{E}}
8626   \DeclareUnicodeCharacter{0115}{\u{e}}
8627   \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8628   \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8629   \DeclareUnicodeCharacter{011A}{\v{E}}
8630   \DeclareUnicodeCharacter{011B}{\v{e}}
8631   \DeclareUnicodeCharacter{011C}{\^G}
8632   \DeclareUnicodeCharacter{011D}{\^g}
8633   \DeclareUnicodeCharacter{011E}{\u{G}}
8634   \DeclareUnicodeCharacter{011F}{\u{g}}
8635
8636   \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8637   \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8638   \DeclareUnicodeCharacter{0124}{\^H}
8639   \DeclareUnicodeCharacter{0125}{\^h}
8640   \DeclareUnicodeCharacter{0128}{\~I}
8641   \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8642   \DeclareUnicodeCharacter{012A}{\=I}
8643   \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8644   \DeclareUnicodeCharacter{012C}{\u{I}}
8645   \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8646
8647   \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8648   \DeclareUnicodeCharacter{0131}{\dotless{i}}
8649   \DeclareUnicodeCharacter{0132}{IJ}
8650   \DeclareUnicodeCharacter{0133}{ij}
8651   \DeclareUnicodeCharacter{0134}{\^J}
8652   \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8653   \DeclareUnicodeCharacter{0139}{\'L}
8654   \DeclareUnicodeCharacter{013A}{\'l}
8655
8656   \DeclareUnicodeCharacter{0141}{\L}
8657   \DeclareUnicodeCharacter{0142}{\l}
8658   \DeclareUnicodeCharacter{0143}{\'N}
8659   \DeclareUnicodeCharacter{0144}{\'n}
8660   \DeclareUnicodeCharacter{0147}{\v{N}}
8661   \DeclareUnicodeCharacter{0148}{\v{n}}
8662   \DeclareUnicodeCharacter{014C}{\=O}
8663   \DeclareUnicodeCharacter{014D}{\=o}
8664   \DeclareUnicodeCharacter{014E}{\u{O}}
8665   \DeclareUnicodeCharacter{014F}{\u{o}}
8666
8667   \DeclareUnicodeCharacter{0150}{\H{O}}
8668   \DeclareUnicodeCharacter{0151}{\H{o}}
8669   \DeclareUnicodeCharacter{0152}{\OE}
8670   \DeclareUnicodeCharacter{0153}{\oe}
8671   \DeclareUnicodeCharacter{0154}{\'R}
8672   \DeclareUnicodeCharacter{0155}{\'r}
8673   \DeclareUnicodeCharacter{0158}{\v{R}}
8674   \DeclareUnicodeCharacter{0159}{\v{r}}
8675   \DeclareUnicodeCharacter{015A}{\'S}
8676   \DeclareUnicodeCharacter{015B}{\'s}
8677   \DeclareUnicodeCharacter{015C}{\^S}
8678   \DeclareUnicodeCharacter{015D}{\^s}
8679   \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8680   \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8681
8682   \DeclareUnicodeCharacter{0160}{\v{S}}
8683   \DeclareUnicodeCharacter{0161}{\v{s}}
8684   \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8685   \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8686   \DeclareUnicodeCharacter{0164}{\v{T}}
8687
8688   \DeclareUnicodeCharacter{0168}{\~U}
8689   \DeclareUnicodeCharacter{0169}{\~u}
8690   \DeclareUnicodeCharacter{016A}{\=U}
8691   \DeclareUnicodeCharacter{016B}{\=u}
8692   \DeclareUnicodeCharacter{016C}{\u{U}}
8693   \DeclareUnicodeCharacter{016D}{\u{u}}
8694   \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8695   \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8696
8697   \DeclareUnicodeCharacter{0170}{\H{U}}
8698   \DeclareUnicodeCharacter{0171}{\H{u}}
8699   \DeclareUnicodeCharacter{0174}{\^W}
8700   \DeclareUnicodeCharacter{0175}{\^w}
8701   \DeclareUnicodeCharacter{0176}{\^Y}
8702   \DeclareUnicodeCharacter{0177}{\^y}
8703   \DeclareUnicodeCharacter{0178}{\"Y}
8704   \DeclareUnicodeCharacter{0179}{\'Z}
8705   \DeclareUnicodeCharacter{017A}{\'z}
8706   \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8707   \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8708   \DeclareUnicodeCharacter{017D}{\v{Z}}
8709   \DeclareUnicodeCharacter{017E}{\v{z}}
8710
8711   \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8712   \DeclareUnicodeCharacter{01C5}{D\v{z}}
8713   \DeclareUnicodeCharacter{01C6}{d\v{z}}
8714   \DeclareUnicodeCharacter{01C7}{LJ}
8715   \DeclareUnicodeCharacter{01C8}{Lj}
8716   \DeclareUnicodeCharacter{01C9}{lj}
8717   \DeclareUnicodeCharacter{01CA}{NJ}
8718   \DeclareUnicodeCharacter{01CB}{Nj}
8719   \DeclareUnicodeCharacter{01CC}{nj}
8720   \DeclareUnicodeCharacter{01CD}{\v{A}}
8721   \DeclareUnicodeCharacter{01CE}{\v{a}}
8722   \DeclareUnicodeCharacter{01CF}{\v{I}}
8723
8724   \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8725   \DeclareUnicodeCharacter{01D1}{\v{O}}
8726   \DeclareUnicodeCharacter{01D2}{\v{o}}
8727   \DeclareUnicodeCharacter{01D3}{\v{U}}
8728   \DeclareUnicodeCharacter{01D4}{\v{u}}
8729
8730   \DeclareUnicodeCharacter{01E2}{\={\AE}}
8731   \DeclareUnicodeCharacter{01E3}{\={\ae}}
8732   \DeclareUnicodeCharacter{01E6}{\v{G}}
8733   \DeclareUnicodeCharacter{01E7}{\v{g}}
8734   \DeclareUnicodeCharacter{01E8}{\v{K}}
8735   \DeclareUnicodeCharacter{01E9}{\v{k}}
8736
8737   \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8738   \DeclareUnicodeCharacter{01F1}{DZ}
8739   \DeclareUnicodeCharacter{01F2}{Dz}
8740   \DeclareUnicodeCharacter{01F3}{dz}
8741   \DeclareUnicodeCharacter{01F4}{\'G}
8742   \DeclareUnicodeCharacter{01F5}{\'g}
8743   \DeclareUnicodeCharacter{01F8}{\`N}
8744   \DeclareUnicodeCharacter{01F9}{\`n}
8745   \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8746   \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8747   \DeclareUnicodeCharacter{01FE}{\'{\O}}
8748   \DeclareUnicodeCharacter{01FF}{\'{\o}}
8749
8750   \DeclareUnicodeCharacter{021E}{\v{H}}
8751   \DeclareUnicodeCharacter{021F}{\v{h}}
8752
8753   \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8754   \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8755   \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8756   \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8757   \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8758   \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8759
8760   \DeclareUnicodeCharacter{0232}{\=Y}
8761   \DeclareUnicodeCharacter{0233}{\=y}
8762   \DeclareUnicodeCharacter{0237}{\dotless{j}}
8763
8764   \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8765
8766   \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8767   \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8768   \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8769   \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8770   \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8771   \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8772   \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8773   \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8774   \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8775   \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8776   \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8777   \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8778
8779   \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8780   \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8781
8782   \DeclareUnicodeCharacter{1E20}{\=G}
8783   \DeclareUnicodeCharacter{1E21}{\=g}
8784   \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8785   \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8786   \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8787   \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8788   \DeclareUnicodeCharacter{1E26}{\"H}
8789   \DeclareUnicodeCharacter{1E27}{\"h}
8790
8791   \DeclareUnicodeCharacter{1E30}{\'K}
8792   \DeclareUnicodeCharacter{1E31}{\'k}
8793   \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8794   \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8795   \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8796   \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8797   \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8798   \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8799   \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8800   \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8801   \DeclareUnicodeCharacter{1E3E}{\'M}
8802   \DeclareUnicodeCharacter{1E3F}{\'m}
8803
8804   \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8805   \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8806   \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8807   \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8808   \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8809   \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8810   \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8811   \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8812   \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8813   \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8814
8815   \DeclareUnicodeCharacter{1E54}{\'P}
8816   \DeclareUnicodeCharacter{1E55}{\'p}
8817   \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8818   \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8819   \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8820   \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8821   \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8822   \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8823   \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8824   \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8825
8826   \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8827   \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8828   \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8829   \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8830   \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8831   \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8832   \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8833   \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8834   \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8835   \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8836
8837   \DeclareUnicodeCharacter{1E7C}{\~V}
8838   \DeclareUnicodeCharacter{1E7D}{\~v}
8839   \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8840   \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8841
8842   \DeclareUnicodeCharacter{1E80}{\`W}
8843   \DeclareUnicodeCharacter{1E81}{\`w}
8844   \DeclareUnicodeCharacter{1E82}{\'W}
8845   \DeclareUnicodeCharacter{1E83}{\'w}
8846   \DeclareUnicodeCharacter{1E84}{\"W}
8847   \DeclareUnicodeCharacter{1E85}{\"w}
8848   \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8849   \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8850   \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8851   \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8852   \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8853   \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8854   \DeclareUnicodeCharacter{1E8C}{\"X}
8855   \DeclareUnicodeCharacter{1E8D}{\"x}
8856   \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8857   \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8858
8859   \DeclareUnicodeCharacter{1E90}{\^Z}
8860   \DeclareUnicodeCharacter{1E91}{\^z}
8861   \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8862   \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8863   \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8864   \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8865   \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8866   \DeclareUnicodeCharacter{1E97}{\"t}
8867   \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8868   \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8869
8870   \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8871   \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8872
8873   \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8874   \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8875   \DeclareUnicodeCharacter{1EBC}{\~E}
8876   \DeclareUnicodeCharacter{1EBD}{\~e}
8877
8878   \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8879   \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8880   \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8881   \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8882
8883   \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8884   \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8885
8886   \DeclareUnicodeCharacter{1EF2}{\`Y}
8887   \DeclareUnicodeCharacter{1EF3}{\`y}
8888   \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8889
8890   \DeclareUnicodeCharacter{1EF8}{\~Y}
8891   \DeclareUnicodeCharacter{1EF9}{\~y}
8892
8893   \DeclareUnicodeCharacter{2013}{--}
8894   \DeclareUnicodeCharacter{2014}{---}
8895   \DeclareUnicodeCharacter{2018}{\quoteleft}
8896   \DeclareUnicodeCharacter{2019}{\quoteright}
8897   \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8898   \DeclareUnicodeCharacter{201C}{\quotedblleft}
8899   \DeclareUnicodeCharacter{201D}{\quotedblright}
8900   \DeclareUnicodeCharacter{201E}{\quotedblbase}
8901   \DeclareUnicodeCharacter{2022}{\bullet}
8902   \DeclareUnicodeCharacter{2026}{\dots}
8903   \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8904   \DeclareUnicodeCharacter{203A}{\guilsinglright}
8905   \DeclareUnicodeCharacter{20AC}{\euro}
8906
8907   \DeclareUnicodeCharacter{2192}{\expansion}
8908   \DeclareUnicodeCharacter{21D2}{\result}
8909
8910   \DeclareUnicodeCharacter{2212}{\minus}
8911   \DeclareUnicodeCharacter{2217}{\point}
8912   \DeclareUnicodeCharacter{2261}{\equiv}
8913 }% end of \utfeightchardefs
8914
8915
8916 % US-ASCII character definitions.
8917 \def\asciichardefs{% nothing need be done
8918    \relax
8919 }
8920
8921 % Make non-ASCII characters printable again for compatibility with
8922 % existing Texinfo documents that may use them, even without declaring a
8923 % document encoding.
8924 %
8925 \setnonasciicharscatcode \other
8926
8927
8928 \message{formatting,}
8929
8930 \newdimen\defaultparindent \defaultparindent = 15pt
8931
8932 \chapheadingskip = 15pt plus 4pt minus 2pt
8933 \secheadingskip = 12pt plus 3pt minus 2pt
8934 \subsecheadingskip = 9pt plus 2pt minus 2pt
8935
8936 % Prevent underfull vbox error messages.
8937 \vbadness = 10000
8938
8939 % Don't be very finicky about underfull hboxes, either.
8940 \hbadness = 6666
8941
8942 % Following George Bush, get rid of widows and orphans.
8943 \widowpenalty=10000
8944 \clubpenalty=10000
8945
8946 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8947 % using an old version of TeX, don't do anything.  We want the amount of
8948 % stretch added to depend on the line length, hence the dependence on
8949 % \hsize.  We call this whenever the paper size is set.
8950 %
8951 \def\setemergencystretch{%
8952   \ifx\emergencystretch\thisisundefined
8953     % Allow us to assign to \emergencystretch anyway.
8954     \def\emergencystretch{\dimen0}%
8955   \else
8956     \emergencystretch = .15\hsize
8957   \fi
8958 }
8959
8960 % Parameters in order: 1) textheight; 2) textwidth;
8961 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8962 % 7) physical page height; 8) physical page width.
8963 %
8964 % We also call \setleading{\textleading}, so the caller should define
8965 % \textleading.  The caller should also set \parskip.
8966 %
8967 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8968   \voffset = #3\relax
8969   \topskip = #6\relax
8970   \splittopskip = \topskip
8971   %
8972   \vsize = #1\relax
8973   \advance\vsize by \topskip
8974   \outervsize = \vsize
8975   \advance\outervsize by 2\topandbottommargin
8976   \pageheight = \vsize
8977   %
8978   \hsize = #2\relax
8979   \outerhsize = \hsize
8980   \advance\outerhsize by 0.5in
8981   \pagewidth = \hsize
8982   %
8983   \normaloffset = #4\relax
8984   \bindingoffset = #5\relax
8985   %
8986   \ifpdf
8987     \pdfpageheight #7\relax
8988     \pdfpagewidth #8\relax
8989     % if we don't reset these, they will remain at "1 true in" of
8990     % whatever layout pdftex was dumped with.
8991     \pdfhorigin = 1 true in
8992     \pdfvorigin = 1 true in
8993   \fi
8994   %
8995   \setleading{\textleading}
8996   %
8997   \parindent = \defaultparindent
8998   \setemergencystretch
8999 }
9000
9001 % @letterpaper (the default).
9002 \def\letterpaper{{\globaldefs = 1
9003   \parskip = 3pt plus 2pt minus 1pt
9004   \textleading = 13.2pt
9005   %
9006   % If page is nothing but text, make it come out even.
9007   \internalpagesizes{607.2pt}{6in}% that's 46 lines
9008                     {\voffset}{.25in}%
9009                     {\bindingoffset}{36pt}%
9010                     {11in}{8.5in}%
9011 }}
9012
9013 % Use @smallbook to reset parameters for 7x9.25 trim size.
9014 \def\smallbook{{\globaldefs = 1
9015   \parskip = 2pt plus 1pt
9016   \textleading = 12pt
9017   %
9018   \internalpagesizes{7.5in}{5in}%
9019                     {-.2in}{0in}%
9020                     {\bindingoffset}{16pt}%
9021                     {9.25in}{7in}%
9022   %
9023   \lispnarrowing = 0.3in
9024   \tolerance = 700
9025   \hfuzz = 1pt
9026   \contentsrightmargin = 0pt
9027   \defbodyindent = .5cm
9028 }}
9029
9030 % Use @smallerbook to reset parameters for 6x9 trim size.
9031 % (Just testing, parameters still in flux.)
9032 \def\smallerbook{{\globaldefs = 1
9033   \parskip = 1.5pt plus 1pt
9034   \textleading = 12pt
9035   %
9036   \internalpagesizes{7.4in}{4.8in}%
9037                     {-.2in}{-.4in}%
9038                     {0pt}{14pt}%
9039                     {9in}{6in}%
9040   %
9041   \lispnarrowing = 0.25in
9042   \tolerance = 700
9043   \hfuzz = 1pt
9044   \contentsrightmargin = 0pt
9045   \defbodyindent = .4cm
9046 }}
9047
9048 % Use @afourpaper to print on European A4 paper.
9049 \def\afourpaper{{\globaldefs = 1
9050   \parskip = 3pt plus 2pt minus 1pt
9051   \textleading = 13.2pt
9052   %
9053   % Double-side printing via postscript on Laserjet 4050
9054   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9055   % To change the settings for a different printer or situation, adjust
9056   % \normaloffset until the front-side and back-side texts align.  Then
9057   % do the same for \bindingoffset.  You can set these for testing in
9058   % your texinfo source file like this:
9059   % @tex
9060   % \global\normaloffset = -6mm
9061   % \global\bindingoffset = 10mm
9062   % @end tex
9063   \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9064                     {\voffset}{\hoffset}%
9065                     {\bindingoffset}{44pt}%
9066                     {297mm}{210mm}%
9067   %
9068   \tolerance = 700
9069   \hfuzz = 1pt
9070   \contentsrightmargin = 0pt
9071   \defbodyindent = 5mm
9072 }}
9073
9074 % Use @afivepaper to print on European A5 paper.
9075 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9076 % He also recommends making @example and @lisp be small.
9077 \def\afivepaper{{\globaldefs = 1
9078   \parskip = 2pt plus 1pt minus 0.1pt
9079   \textleading = 12.5pt
9080   %
9081   \internalpagesizes{160mm}{120mm}%
9082                     {\voffset}{\hoffset}%
9083                     {\bindingoffset}{8pt}%
9084                     {210mm}{148mm}%
9085   %
9086   \lispnarrowing = 0.2in
9087   \tolerance = 800
9088   \hfuzz = 1.2pt
9089   \contentsrightmargin = 0pt
9090   \defbodyindent = 2mm
9091   \tableindent = 12mm
9092 }}
9093
9094 % A specific text layout, 24x15cm overall, intended for A4 paper.
9095 \def\afourlatex{{\globaldefs = 1
9096   \afourpaper
9097   \internalpagesizes{237mm}{150mm}%
9098                     {\voffset}{4.6mm}%
9099                     {\bindingoffset}{7mm}%
9100                     {297mm}{210mm}%
9101   %
9102   % Must explicitly reset to 0 because we call \afourpaper.
9103   \globaldefs = 0
9104 }}
9105
9106 % Use @afourwide to print on A4 paper in landscape format.
9107 \def\afourwide{{\globaldefs = 1
9108   \afourpaper
9109   \internalpagesizes{241mm}{165mm}%
9110                     {\voffset}{-2.95mm}%
9111                     {\bindingoffset}{7mm}%
9112                     {297mm}{210mm}%
9113   \globaldefs = 0
9114 }}
9115
9116 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9117 % Perhaps we should allow setting the margins, \topskip, \parskip,
9118 % and/or leading, also. Or perhaps we should compute them somehow.
9119 %
9120 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9121 \def\pagesizesyyy#1,#2,#3\finish{{%
9122   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9123   \globaldefs = 1
9124   %
9125   \parskip = 3pt plus 2pt minus 1pt
9126   \setleading{\textleading}%
9127   %
9128   \dimen0 = #1\relax
9129   \advance\dimen0 by \voffset
9130   %
9131   \dimen2 = \hsize
9132   \advance\dimen2 by \normaloffset
9133   %
9134   \internalpagesizes{#1}{\hsize}%
9135                     {\voffset}{\normaloffset}%
9136                     {\bindingoffset}{44pt}%
9137                     {\dimen0}{\dimen2}%
9138 }}
9139
9140 % Set default to letter.
9141 %
9142 \letterpaper
9143
9144
9145 \message{and turning on texinfo input format.}
9146
9147 % DEL is a comment character, in case @c does not suffice.
9148 \catcode`\^^? = 14
9149
9150 % Define macros to output various characters with catcode for normal text.
9151 \catcode`\"=\other
9152 \catcode`\~=\other
9153 \catcode`\^=\other
9154 \catcode`\_=\other
9155 \catcode`\|=\other
9156 \catcode`\<=\other
9157 \catcode`\>=\other
9158 \catcode`\+=\other
9159 \catcode`\$=\other
9160 \def\normaldoublequote{"}
9161 \def\normaltilde{~}
9162 \def\normalcaret{^}
9163 \def\normalunderscore{_}
9164 \def\normalverticalbar{|}
9165 \def\normalless{<}
9166 \def\normalgreater{>}
9167 \def\normalplus{+}
9168 \def\normaldollar{$}%$ font-lock fix
9169
9170 % This macro is used to make a character print one way in \tt
9171 % (where it can probably be output as-is), and another way in other fonts,
9172 % where something hairier probably needs to be done.
9173 %
9174 % #1 is what to print if we are indeed using \tt; #2 is what to print
9175 % otherwise.  Since all the Computer Modern typewriter fonts have zero
9176 % interword stretch (and shrink), and it is reasonable to expect all
9177 % typewriter fonts to have this, we can check that font parameter.
9178 %
9179 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9180
9181 % Same as above, but check for italic font.  Actually this also catches
9182 % non-italic slanted fonts since it is impossible to distinguish them from
9183 % italic fonts.  But since this is only used by $ and it uses \sl anyway
9184 % this is not a problem.
9185 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9186
9187 % Turn off all special characters except @
9188 % (and those which the user can use as if they were ordinary).
9189 % Most of these we simply print from the \tt font, but for some, we can
9190 % use math or other variants that look better in normal text.
9191
9192 \catcode`\"=\active
9193 \def\activedoublequote{{\tt\char34}}
9194 \let"=\activedoublequote
9195 \catcode`\~=\active
9196 \def~{{\tt\char126}}
9197 \chardef\hat=`\^
9198 \catcode`\^=\active
9199 \def^{{\tt \hat}}
9200
9201 \catcode`\_=\active
9202 \def_{\ifusingtt\normalunderscore\_}
9203 \let\realunder=_
9204 % Subroutine for the previous macro.
9205 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9206
9207 \catcode`\|=\active
9208 \def|{{\tt\char124}}
9209 \chardef \less=`\<
9210 \catcode`\<=\active
9211 \def<{{\tt \less}}
9212 \chardef \gtr=`\>
9213 \catcode`\>=\active
9214 \def>{{\tt \gtr}}
9215 \catcode`\+=\active
9216 \def+{{\tt \char 43}}
9217 \catcode`\$=\active
9218 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9219
9220 % If a .fmt file is being used, characters that might appear in a file
9221 % name cannot be active until we have parsed the command line.
9222 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9223 % \otherifyactive is called near the end of this file.
9224 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9225
9226 % Used sometimes to turn off (effectively) the active characters even after
9227 % parsing them.
9228 \def\turnoffactive{%
9229   \normalturnoffactive
9230   \otherbackslash
9231 }
9232
9233 \catcode`\@=0
9234
9235 % \backslashcurfont outputs one backslash character in current font,
9236 % as in \char`\\.
9237 \global\chardef\backslashcurfont=`\\
9238 \global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
9239
9240 % \realbackslash is an actual character `\' with catcode other, and
9241 % \doublebackslash is two of them (for the pdf outlines).
9242 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9243
9244 % In texinfo, backslash is an active character; it prints the backslash
9245 % in fixed width font.
9246 \catcode`\\=\active
9247 @def@normalbackslash{{@tt@backslashcurfont}}
9248 % On startup, @fixbackslash assigns:
9249 %  @let \ = @normalbackslash
9250
9251 % \rawbackslash defines an active \ to do \backslashcurfont.
9252 % \otherbackslash defines an active \ to be a literal `\' character with
9253 % catcode other.
9254 @gdef@rawbackslash{@let\=@backslashcurfont}
9255 @gdef@otherbackslash{@let\=@realbackslash}
9256
9257 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9258 % the literal character `\'.
9259 %
9260 @def@normalturnoffactive{%
9261   @let\=@normalbackslash
9262   @let"=@normaldoublequote
9263   @let~=@normaltilde
9264   @let^=@normalcaret
9265   @let_=@normalunderscore
9266   @let|=@normalverticalbar
9267   @let<=@normalless
9268   @let>=@normalgreater
9269   @let+=@normalplus
9270   @let$=@normaldollar %$ font-lock fix
9271   @markupsetuplqdefault
9272   @markupsetuprqdefault
9273   @unsepspaces
9274 }
9275
9276 % Make _ and + \other characters, temporarily.
9277 % This is canceled by @fixbackslash.
9278 @otherifyactive
9279
9280 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9281 % That is what \eatinput is for; after that, the `\' should revert to printing
9282 % a backslash.
9283 %
9284 @gdef@eatinput input texinfo{@fixbackslash}
9285 @global@let\ = @eatinput
9286
9287 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9288 % the first `\' in the file would cause an error. This macro tries to fix
9289 % that, assuming it is called before the first `\' could plausibly occur.
9290 % Also turn back on active characters that might appear in the input
9291 % file name, in case not using a pre-dumped format.
9292 %
9293 @gdef@fixbackslash{%
9294   @ifx\@eatinput @let\ = @normalbackslash @fi
9295   @catcode`+=@active
9296   @catcode`@_=@active
9297 }
9298
9299 % Say @foo, not \foo, in error messages.
9300 @escapechar = `@@
9301
9302 % These look ok in all fonts, so just make them not special.
9303 @catcode`@& = @other
9304 @catcode`@# = @other
9305 @catcode`@% = @other
9306
9307 @c Finally, make ` and ' active, so that txicodequoteundirected and
9308 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
9309 @c don't make ` and ' active, @code will not get them as active chars.
9310 @c Do this last of all since we use ` in the previous @catcode assignments.
9311 @catcode`@'=@active
9312 @catcode`@`=@active
9313 @markupsetuplqdefault
9314 @markupsetuprqdefault
9315
9316 @c Local variables:
9317 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9318 @c page-delimiter: "^\\\\message"
9319 @c time-stamp-start: "def\\\\texinfoversion{"
9320 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9321 @c time-stamp-end: "}"
9322 @c End:
9323
9324 @c vim:sw=2:
9325
9326 @ignore
9327    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
9328 @end ignore