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