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