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