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