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