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