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