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