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