gnulib-tool: Fix indentation.
[gnulib.git] / build-aux / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2012-07-29.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\*{\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 % Macros to be used within @titlepage:
3273
3274 \let\subtitlerm=\tenrm
3275 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3276
3277 \parseargdef\title{%
3278   \checkenv\titlepage
3279   \leftline{\titlefonts\rmisbold #1}
3280   % print a rule at the page bottom also.
3281   \finishedtitlepagefalse
3282   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3283 }
3284
3285 \parseargdef\subtitle{%
3286   \checkenv\titlepage
3287   {\subtitlefont \rightline{#1}}%
3288 }
3289
3290 % @author should come last, but may come many times.
3291 % It can also be used inside @quotation.
3292 %
3293 \parseargdef\author{%
3294   \def\temp{\quotation}%
3295   \ifx\thisenv\temp
3296     \def\quotationauthor{#1}% printed in \Equotation.
3297   \else
3298     \checkenv\titlepage
3299     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3300     {\secfonts\rmisbold \leftline{#1}}%
3301   \fi
3302 }
3303
3304
3305 % Set up page headings and footings.
3306
3307 \let\thispage=\folio
3308
3309 \newtoks\evenheadline    % headline on even pages
3310 \newtoks\oddheadline     % headline on odd pages
3311 \newtoks\evenfootline    % footline on even pages
3312 \newtoks\oddfootline     % footline on odd pages
3313
3314 % Now make TeX use those variables
3315 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3316                             \else \the\evenheadline \fi}}
3317 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3318                             \else \the\evenfootline \fi}\HEADINGShook}
3319 \let\HEADINGShook=\relax
3320
3321 % Commands to set those variables.
3322 % For example, this is what  @headings on  does
3323 % @evenheading @thistitle|@thispage|@thischapter
3324 % @oddheading @thischapter|@thispage|@thistitle
3325 % @evenfooting @thisfile||
3326 % @oddfooting ||@thisfile
3327
3328
3329 \def\evenheading{\parsearg\evenheadingxxx}
3330 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3331 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3332 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3333
3334 \def\oddheading{\parsearg\oddheadingxxx}
3335 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3336 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3337 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3338
3339 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3340
3341 \def\evenfooting{\parsearg\evenfootingxxx}
3342 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3343 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3344 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3345
3346 \def\oddfooting{\parsearg\oddfootingxxx}
3347 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3348 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3349   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3350   %
3351   % Leave some space for the footline.  Hopefully ok to assume
3352   % @evenfooting will not be used by itself.
3353   \global\advance\pageheight by -12pt
3354   \global\advance\vsize by -12pt
3355 }
3356
3357 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3358
3359 % @evenheadingmarks top     \thischapter <- chapter at the top of a page
3360 % @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
3361 %
3362 % The same set of arguments for:
3363 %
3364 % @oddheadingmarks
3365 % @evenfootingmarks
3366 % @oddfootingmarks
3367 % @everyheadingmarks
3368 % @everyfootingmarks
3369
3370 \def\evenheadingmarks{\headingmarks{even}{heading}}
3371 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3372 \def\evenfootingmarks{\headingmarks{even}{footing}}
3373 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3374 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3375                           \headingmarks{odd}{heading}{#1} }
3376 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3377                           \headingmarks{odd}{footing}{#1} }
3378 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3379 \def\headingmarks#1#2#3 {%
3380   \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3381   \global\expandafter\let\csname get#1#2marks\endcsname \temp
3382 }
3383
3384 \everyheadingmarks bottom
3385 \everyfootingmarks bottom
3386
3387 % @headings double      turns headings on for double-sided printing.
3388 % @headings single      turns headings on for single-sided printing.
3389 % @headings off         turns them off.
3390 % @headings on          same as @headings double, retained for compatibility.
3391 % @headings after       turns on double-sided headings after this page.
3392 % @headings doubleafter turns on double-sided headings after this page.
3393 % @headings singleafter turns on single-sided headings after this page.
3394 % By default, they are off at the start of a document,
3395 % and turned `on' after @end titlepage.
3396
3397 \def\headings #1 {\csname HEADINGS#1\endcsname}
3398
3399 \def\headingsoff{% non-global headings elimination
3400   \evenheadline={\hfil}\evenfootline={\hfil}%
3401    \oddheadline={\hfil}\oddfootline={\hfil}%
3402 }
3403
3404 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3405 \HEADINGSoff  % it's the default
3406
3407 % When we turn headings on, set the page number to 1.
3408 % For double-sided printing, put current file name in lower left corner,
3409 % chapter name on inside top of right hand pages, document
3410 % title on inside top of left hand pages, and page numbers on outside top
3411 % edge of all pages.
3412 \def\HEADINGSdouble{%
3413 \global\pageno=1
3414 \global\evenfootline={\hfil}
3415 \global\oddfootline={\hfil}
3416 \global\evenheadline={\line{\folio\hfil\thistitle}}
3417 \global\oddheadline={\line{\thischapter\hfil\folio}}
3418 \global\let\contentsalignmacro = \chapoddpage
3419 }
3420 \let\contentsalignmacro = \chappager
3421
3422 % For single-sided printing, chapter title goes across top left of page,
3423 % page number on top right.
3424 \def\HEADINGSsingle{%
3425 \global\pageno=1
3426 \global\evenfootline={\hfil}
3427 \global\oddfootline={\hfil}
3428 \global\evenheadline={\line{\thischapter\hfil\folio}}
3429 \global\oddheadline={\line{\thischapter\hfil\folio}}
3430 \global\let\contentsalignmacro = \chappager
3431 }
3432 \def\HEADINGSon{\HEADINGSdouble}
3433
3434 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3435 \let\HEADINGSdoubleafter=\HEADINGSafter
3436 \def\HEADINGSdoublex{%
3437 \global\evenfootline={\hfil}
3438 \global\oddfootline={\hfil}
3439 \global\evenheadline={\line{\folio\hfil\thistitle}}
3440 \global\oddheadline={\line{\thischapter\hfil\folio}}
3441 \global\let\contentsalignmacro = \chapoddpage
3442 }
3443
3444 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3445 \def\HEADINGSsinglex{%
3446 \global\evenfootline={\hfil}
3447 \global\oddfootline={\hfil}
3448 \global\evenheadline={\line{\thischapter\hfil\folio}}
3449 \global\oddheadline={\line{\thischapter\hfil\folio}}
3450 \global\let\contentsalignmacro = \chappager
3451 }
3452
3453 % Subroutines used in generating headings
3454 % This produces Day Month Year style of output.
3455 % Only define if not already defined, in case a txi-??.tex file has set
3456 % up a different format (e.g., txi-cs.tex does this).
3457 \ifx\today\thisisundefined
3458 \def\today{%
3459   \number\day\space
3460   \ifcase\month
3461   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3462   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3463   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3464   \fi
3465   \space\number\year}
3466 \fi
3467
3468 % @settitle line...  specifies the title of the document, for headings.
3469 % It generates no output of its own.
3470 \def\thistitle{\putwordNoTitle}
3471 \def\settitle{\parsearg{\gdef\thistitle}}
3472
3473
3474 \message{tables,}
3475 % Tables -- @table, @ftable, @vtable, @item(x).
3476
3477 % default indentation of table text
3478 \newdimen\tableindent \tableindent=.8in
3479 % default indentation of @itemize and @enumerate text
3480 \newdimen\itemindent  \itemindent=.3in
3481 % margin between end of table item and start of table text.
3482 \newdimen\itemmargin  \itemmargin=.1in
3483
3484 % used internally for \itemindent minus \itemmargin
3485 \newdimen\itemmax
3486
3487 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3488 % these defs.
3489 % They also define \itemindex
3490 % to index the item name in whatever manner is desired (perhaps none).
3491
3492 \newif\ifitemxneedsnegativevskip
3493
3494 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3495
3496 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3497 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3498
3499 \def\itemzzz #1{\begingroup %
3500   \advance\hsize by -\rightskip
3501   \advance\hsize by -\tableindent
3502   \setbox0=\hbox{\itemindicate{#1}}%
3503   \itemindex{#1}%
3504   \nobreak % This prevents a break before @itemx.
3505   %
3506   % If the item text does not fit in the space we have, put it on a line
3507   % by itself, and do not allow a page break either before or after that
3508   % line.  We do not start a paragraph here because then if the next
3509   % command is, e.g., @kindex, the whatsit would get put into the
3510   % horizontal list on a line by itself, resulting in extra blank space.
3511   \ifdim \wd0>\itemmax
3512     %
3513     % Make this a paragraph so we get the \parskip glue and wrapping,
3514     % but leave it ragged-right.
3515     \begingroup
3516       \advance\leftskip by-\tableindent
3517       \advance\hsize by\tableindent
3518       \advance\rightskip by0pt plus1fil\relax
3519       \leavevmode\unhbox0\par
3520     \endgroup
3521     %
3522     % We're going to be starting a paragraph, but we don't want the
3523     % \parskip glue -- logically it's part of the @item we just started.
3524     \nobreak \vskip-\parskip
3525     %
3526     % Stop a page break at the \parskip glue coming up.  However, if
3527     % what follows is an environment such as @example, there will be no
3528     % \parskip glue; then the negative vskip we just inserted would
3529     % cause the example and the item to crash together.  So we use this
3530     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3531     % \parskip glue after all.  Section titles are handled this way also.
3532     %
3533     \penalty 10001
3534     \endgroup
3535     \itemxneedsnegativevskipfalse
3536   \else
3537     % The item text fits into the space.  Start a paragraph, so that the
3538     % following text (if any) will end up on the same line.
3539     \noindent
3540     % Do this with kerns and \unhbox so that if there is a footnote in
3541     % the item text, it can migrate to the main vertical list and
3542     % eventually be printed.
3543     \nobreak\kern-\tableindent
3544     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3545     \unhbox0
3546     \nobreak\kern\dimen0
3547     \endgroup
3548     \itemxneedsnegativevskiptrue
3549   \fi
3550 }
3551
3552 \def\item{\errmessage{@item while not in a list environment}}
3553 \def\itemx{\errmessage{@itemx while not in a list environment}}
3554
3555 % @table, @ftable, @vtable.
3556 \envdef\table{%
3557   \let\itemindex\gobble
3558   \tablecheck{table}%
3559 }
3560 \envdef\ftable{%
3561   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3562   \tablecheck{ftable}%
3563 }
3564 \envdef\vtable{%
3565   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3566   \tablecheck{vtable}%
3567 }
3568 \def\tablecheck#1{%
3569   \ifnum \the\catcode`\^^M=\active
3570     \endgroup
3571     \errmessage{This command won't work in this context; perhaps the problem is
3572       that we are \inenvironment\thisenv}%
3573     \def\next{\doignore{#1}}%
3574   \else
3575     \let\next\tablex
3576   \fi
3577   \next
3578 }
3579 \def\tablex#1{%
3580   \def\itemindicate{#1}%
3581   \parsearg\tabley
3582 }
3583 \def\tabley#1{%
3584   {%
3585     \makevalueexpandable
3586     \edef\temp{\noexpand\tablez #1\space\space\space}%
3587     \expandafter
3588   }\temp \endtablez
3589 }
3590 \def\tablez #1 #2 #3 #4\endtablez{%
3591   \aboveenvbreak
3592   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3593   \ifnum 0#2>0 \tableindent=#2\mil \fi
3594   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3595   \itemmax=\tableindent
3596   \advance \itemmax by -\itemmargin
3597   \advance \leftskip by \tableindent
3598   \exdentamount=\tableindent
3599   \parindent = 0pt
3600   \parskip = \smallskipamount
3601   \ifdim \parskip=0pt \parskip=2pt \fi
3602   \let\item = \internalBitem
3603   \let\itemx = \internalBitemx
3604 }
3605 \def\Etable{\endgraf\afterenvbreak}
3606 \let\Eftable\Etable
3607 \let\Evtable\Etable
3608 \let\Eitemize\Etable
3609 \let\Eenumerate\Etable
3610
3611 % This is the counter used by @enumerate, which is really @itemize
3612
3613 \newcount \itemno
3614
3615 \envdef\itemize{\parsearg\doitemize}
3616
3617 \def\doitemize#1{%
3618   \aboveenvbreak
3619   \itemmax=\itemindent
3620   \advance\itemmax by -\itemmargin
3621   \advance\leftskip by \itemindent
3622   \exdentamount=\itemindent
3623   \parindent=0pt
3624   \parskip=\smallskipamount
3625   \ifdim\parskip=0pt \parskip=2pt \fi
3626   %
3627   % Try typesetting the item mark that if the document erroneously says
3628   % something like @itemize @samp (intending @table), there's an error
3629   % right away at the @itemize.  It's not the best error message in the
3630   % world, but it's better than leaving it to the @item.  This means if
3631   % the user wants an empty mark, they have to say @w{} not just @w.
3632   \def\itemcontents{#1}%
3633   \setbox0 = \hbox{\itemcontents}%
3634   %
3635   % @itemize with no arg is equivalent to @itemize @bullet.
3636   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3637   %
3638   \let\item=\itemizeitem
3639 }
3640
3641 % Definition of @item while inside @itemize and @enumerate.
3642 %
3643 \def\itemizeitem{%
3644   \advance\itemno by 1  % for enumerations
3645   {\let\par=\endgraf \smallbreak}% reasonable place to break
3646   {%
3647    % If the document has an @itemize directly after a section title, a
3648    % \nobreak will be last on the list, and \sectionheading will have
3649    % done a \vskip-\parskip.  In that case, we don't want to zero
3650    % parskip, or the item text will crash with the heading.  On the
3651    % other hand, when there is normal text preceding the item (as there
3652    % usually is), we do want to zero parskip, or there would be too much
3653    % space.  In that case, we won't have a \nobreak before.  At least
3654    % that's the theory.
3655    \ifnum\lastpenalty<10000 \parskip=0in \fi
3656    \noindent
3657    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3658    %
3659    \vadjust{\penalty 1200}}% not good to break after first line of item.
3660   \flushcr
3661 }
3662
3663 % \splitoff TOKENS\endmark defines \first to be the first token in
3664 % TOKENS, and \rest to be the remainder.
3665 %
3666 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3667
3668 % Allow an optional argument of an uppercase letter, lowercase letter,
3669 % or number, to specify the first label in the enumerated list.  No
3670 % argument is the same as `1'.
3671 %
3672 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
3673 \def\enumeratey #1 #2\endenumeratey{%
3674   % If we were given no argument, pretend we were given `1'.
3675   \def\thearg{#1}%
3676   \ifx\thearg\empty \def\thearg{1}\fi
3677   %
3678   % Detect if the argument is a single token.  If so, it might be a
3679   % letter.  Otherwise, the only valid thing it can be is a number.
3680   % (We will always have one token, because of the test we just made.
3681   % This is a good thing, since \splitoff doesn't work given nothing at
3682   % all -- the first parameter is undelimited.)
3683   \expandafter\splitoff\thearg\endmark
3684   \ifx\rest\empty
3685     % Only one token in the argument.  It could still be anything.
3686     % A ``lowercase letter'' is one whose \lccode is nonzero.
3687     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3688     %   not equal to itself.
3689     % Otherwise, we assume it's a number.
3690     %
3691     % We need the \relax at the end of the \ifnum lines to stop TeX from
3692     % continuing to look for a <number>.
3693     %
3694     \ifnum\lccode\expandafter`\thearg=0\relax
3695       \numericenumerate % a number (we hope)
3696     \else
3697       % It's a letter.
3698       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3699         \lowercaseenumerate % lowercase letter
3700       \else
3701         \uppercaseenumerate % uppercase letter
3702       \fi
3703     \fi
3704   \else
3705     % Multiple tokens in the argument.  We hope it's a number.
3706     \numericenumerate
3707   \fi
3708 }
3709
3710 % An @enumerate whose labels are integers.  The starting integer is
3711 % given in \thearg.
3712 %
3713 \def\numericenumerate{%
3714   \itemno = \thearg
3715   \startenumeration{\the\itemno}%
3716 }
3717
3718 % The starting (lowercase) letter is in \thearg.
3719 \def\lowercaseenumerate{%
3720   \itemno = \expandafter`\thearg
3721   \startenumeration{%
3722     % Be sure we're not beyond the end of the alphabet.
3723     \ifnum\itemno=0
3724       \errmessage{No more lowercase letters in @enumerate; get a bigger
3725                   alphabet}%
3726     \fi
3727     \char\lccode\itemno
3728   }%
3729 }
3730
3731 % The starting (uppercase) letter is in \thearg.
3732 \def\uppercaseenumerate{%
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 uppercase letters in @enumerate; get a bigger
3738                   alphabet}
3739     \fi
3740     \char\uccode\itemno
3741   }%
3742 }
3743
3744 % Call \doitemize, adding a period to the first argument and supplying the
3745 % common last two arguments.  Also subtract one from the initial value in
3746 % \itemno, since @item increments \itemno.
3747 %
3748 \def\startenumeration#1{%
3749   \advance\itemno by -1
3750   \doitemize{#1.}\flushcr
3751 }
3752
3753 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3754 % to @enumerate.
3755 %
3756 \def\alphaenumerate{\enumerate{a}}
3757 \def\capsenumerate{\enumerate{A}}
3758 \def\Ealphaenumerate{\Eenumerate}
3759 \def\Ecapsenumerate{\Eenumerate}
3760
3761
3762 % @multitable macros
3763 % Amy Hendrickson, 8/18/94, 3/6/96
3764 %
3765 % @multitable ... @end multitable will make as many columns as desired.
3766 % Contents of each column will wrap at width given in preamble.  Width
3767 % can be specified either with sample text given in a template line,
3768 % or in percent of \hsize, the current width of text on page.
3769
3770 % Table can continue over pages but will only break between lines.
3771
3772 % To make preamble:
3773 %
3774 % Either define widths of columns in terms of percent of \hsize:
3775 %   @multitable @columnfractions .25 .3 .45
3776 %   @item ...
3777 %
3778 %   Numbers following @columnfractions are the percent of the total
3779 %   current hsize to be used for each column. You may use as many
3780 %   columns as desired.
3781
3782
3783 % Or use a template:
3784 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3785 %   @item ...
3786 %   using the widest term desired in each column.
3787
3788 % Each new table line starts with @item, each subsequent new column
3789 % starts with @tab. Empty columns may be produced by supplying @tab's
3790 % with nothing between them for as many times as empty columns are needed,
3791 % ie, @tab@tab@tab will produce two empty columns.
3792
3793 % @item, @tab do not need to be on their own lines, but it will not hurt
3794 % if they are.
3795
3796 % Sample multitable:
3797
3798 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3799 %   @item first col stuff @tab second col stuff @tab third col
3800 %   @item
3801 %   first col stuff
3802 %   @tab
3803 %   second col stuff
3804 %   @tab
3805 %   third col
3806 %   @item first col stuff @tab second col stuff
3807 %   @tab Many paragraphs of text may be used in any column.
3808 %
3809 %         They will wrap at the width determined by the template.
3810 %   @item@tab@tab This will be in third column.
3811 %   @end multitable
3812
3813 % Default dimensions may be reset by user.
3814 % @multitableparskip is vertical space between paragraphs in table.
3815 % @multitableparindent is paragraph indent in table.
3816 % @multitablecolmargin is horizontal space to be left between columns.
3817 % @multitablelinespace is space to leave between table items, baseline
3818 %                                                            to baseline.
3819 %   0pt means it depends on current normal line spacing.
3820 %
3821 \newskip\multitableparskip
3822 \newskip\multitableparindent
3823 \newdimen\multitablecolspace
3824 \newskip\multitablelinespace
3825 \multitableparskip=0pt
3826 \multitableparindent=6pt
3827 \multitablecolspace=12pt
3828 \multitablelinespace=0pt
3829
3830 % Macros used to set up halign preamble:
3831 %
3832 \let\endsetuptable\relax
3833 \def\xendsetuptable{\endsetuptable}
3834 \let\columnfractions\relax
3835 \def\xcolumnfractions{\columnfractions}
3836 \newif\ifsetpercent
3837
3838 % #1 is the @columnfraction, usually a decimal number like .5, but might
3839 % be just 1.  We just use it, whatever it is.
3840 %
3841 \def\pickupwholefraction#1 {%
3842   \global\advance\colcount by 1
3843   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3844   \setuptable
3845 }
3846
3847 \newcount\colcount
3848 \def\setuptable#1{%
3849   \def\firstarg{#1}%
3850   \ifx\firstarg\xendsetuptable
3851     \let\go = \relax
3852   \else
3853     \ifx\firstarg\xcolumnfractions
3854       \global\setpercenttrue
3855     \else
3856       \ifsetpercent
3857          \let\go\pickupwholefraction
3858       \else
3859          \global\advance\colcount by 1
3860          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3861                    % separator; typically that is always in the input, anyway.
3862          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3863       \fi
3864     \fi
3865     \ifx\go\pickupwholefraction
3866       % Put the argument back for the \pickupwholefraction call, so
3867       % we'll always have a period there to be parsed.
3868       \def\go{\pickupwholefraction#1}%
3869     \else
3870       \let\go = \setuptable
3871     \fi%
3872   \fi
3873   \go
3874 }
3875
3876 % multitable-only commands.
3877 %
3878 % @headitem starts a heading row, which we typeset in bold.
3879 % Assignments have to be global since we are inside the implicit group
3880 % of an alignment entry.  \everycr resets \everytab so we don't have to
3881 % undo it ourselves.
3882 \def\headitemfont{\b}% for people to use in the template row; not changeable
3883 \def\headitem{%
3884   \checkenv\multitable
3885   \crcr
3886   \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3887   \the\everytab % for the first item
3888 }%
3889 %
3890 % A \tab used to include \hskip1sp.  But then the space in a template
3891 % line is not enough.  That is bad.  So let's go back to just `&' until
3892 % we again encounter the problem the 1sp was intended to solve.
3893 %                                       --karl, nathan@acm.org, 20apr99.
3894 \def\tab{\checkenv\multitable &\the\everytab}%
3895
3896 % @multitable ... @end multitable definitions:
3897 %
3898 \newtoks\everytab  % insert after every tab.
3899 %
3900 \envdef\multitable{%
3901   \vskip\parskip
3902   \startsavinginserts
3903   %
3904   % @item within a multitable starts a normal row.
3905   % We use \def instead of \let so that if one of the multitable entries
3906   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3907   % \endtemplate) expanding \doitemize.
3908   \def\item{\crcr}%
3909   %
3910   \tolerance=9500
3911   \hbadness=9500
3912   \setmultitablespacing
3913   \parskip=\multitableparskip
3914   \parindent=\multitableparindent
3915   \overfullrule=0pt
3916   \global\colcount=0
3917   %
3918   \everycr = {%
3919     \noalign{%
3920       \global\everytab={}%
3921       \global\colcount=0 % Reset the column counter.
3922       % Check for saved footnotes, etc.
3923       \checkinserts
3924       % Keeps underfull box messages off when table breaks over pages.
3925       %\filbreak
3926         % Maybe so, but it also creates really weird page breaks when the
3927         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
3928         % problem manifests itself, so it can be fixed for real --karl.
3929     }%
3930   }%
3931   %
3932   \parsearg\domultitable
3933 }
3934 \def\domultitable#1{%
3935   % To parse everything between @multitable and @item:
3936   \setuptable#1 \endsetuptable
3937   %
3938   % This preamble sets up a generic column definition, which will
3939   % be used as many times as user calls for columns.
3940   % \vtop will set a single line and will also let text wrap and
3941   % continue for many paragraphs if desired.
3942   \halign\bgroup &%
3943     \global\advance\colcount by 1
3944     \multistrut
3945     \vtop{%
3946       % Use the current \colcount to find the correct column width:
3947       \hsize=\expandafter\csname col\the\colcount\endcsname
3948       %
3949       % In order to keep entries from bumping into each other
3950       % we will add a \leftskip of \multitablecolspace to all columns after
3951       % the first one.
3952       %
3953       % If a template has been used, we will add \multitablecolspace
3954       % to the width of each template entry.
3955       %
3956       % If the user has set preamble in terms of percent of \hsize we will
3957       % use that dimension as the width of the column, and the \leftskip
3958       % will keep entries from bumping into each other.  Table will start at
3959       % left margin and final column will justify at right margin.
3960       %
3961       % Make sure we don't inherit \rightskip from the outer environment.
3962       \rightskip=0pt
3963       \ifnum\colcount=1
3964         % The first column will be indented with the surrounding text.
3965         \advance\hsize by\leftskip
3966       \else
3967         \ifsetpercent \else
3968           % If user has not set preamble in terms of percent of \hsize
3969           % we will advance \hsize by \multitablecolspace.
3970           \advance\hsize by \multitablecolspace
3971         \fi
3972        % In either case we will make \leftskip=\multitablecolspace:
3973       \leftskip=\multitablecolspace
3974       \fi
3975       % Ignoring space at the beginning and end avoids an occasional spurious
3976       % blank line, when TeX decides to break the line at the space before the
3977       % box from the multistrut, so the strut ends up on a line by itself.
3978       % For example:
3979       % @multitable @columnfractions .11 .89
3980       % @item @code{#}
3981       % @tab Legal holiday which is valid in major parts of the whole country.
3982       % Is automatically provided with highlighting sequences respectively
3983       % marking characters.
3984       \noindent\ignorespaces##\unskip\multistrut
3985     }\cr
3986 }
3987 \def\Emultitable{%
3988   \crcr
3989   \egroup % end the \halign
3990   \global\setpercentfalse
3991 }
3992
3993 \def\setmultitablespacing{%
3994   \def\multistrut{\strut}% just use the standard line spacing
3995   %
3996   % Compute \multitablelinespace (if not defined by user) for use in
3997   % \multitableparskip calculation.  We used define \multistrut based on
3998   % this, but (ironically) that caused the spacing to be off.
3999   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4000 \ifdim\multitablelinespace=0pt
4001 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4002 \global\advance\multitablelinespace by-\ht0
4003 \fi
4004 % Test to see if parskip is larger than space between lines of
4005 % table. If not, do nothing.
4006 %        If so, set to same dimension as multitablelinespace.
4007 \ifdim\multitableparskip>\multitablelinespace
4008 \global\multitableparskip=\multitablelinespace
4009 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4010                                       % than skip between lines in the table.
4011 \fi%
4012 \ifdim\multitableparskip=0pt
4013 \global\multitableparskip=\multitablelinespace
4014 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4015                                       % than skip between lines in the table.
4016 \fi}
4017
4018
4019 \message{conditionals,}
4020
4021 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4022 % @ifnotxml always succeed.  They currently do nothing; we don't
4023 % attempt to check whether the conditionals are properly nested.  But we
4024 % have to remember that they are conditionals, so that @end doesn't
4025 % attempt to close an environment group.
4026 %
4027 \def\makecond#1{%
4028   \expandafter\let\csname #1\endcsname = \relax
4029   \expandafter\let\csname iscond.#1\endcsname = 1
4030 }
4031 \makecond{iftex}
4032 \makecond{ifnotdocbook}
4033 \makecond{ifnothtml}
4034 \makecond{ifnotinfo}
4035 \makecond{ifnotplaintext}
4036 \makecond{ifnotxml}
4037
4038 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4039 %
4040 \def\direntry{\doignore{direntry}}
4041 \def\documentdescription{\doignore{documentdescription}}
4042 \def\docbook{\doignore{docbook}}
4043 \def\html{\doignore{html}}
4044 \def\ifdocbook{\doignore{ifdocbook}}
4045 \def\ifhtml{\doignore{ifhtml}}
4046 \def\ifinfo{\doignore{ifinfo}}
4047 \def\ifnottex{\doignore{ifnottex}}
4048 \def\ifplaintext{\doignore{ifplaintext}}
4049 \def\ifxml{\doignore{ifxml}}
4050 \def\ignore{\doignore{ignore}}
4051 \def\menu{\doignore{menu}}
4052 \def\xml{\doignore{xml}}
4053
4054 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4055 %
4056 % A count to remember the depth of nesting.
4057 \newcount\doignorecount
4058
4059 \def\doignore#1{\begingroup
4060   % Scan in ``verbatim'' mode:
4061   \obeylines
4062   \catcode`\@ = \other
4063   \catcode`\{ = \other
4064   \catcode`\} = \other
4065   %
4066   % Make sure that spaces turn into tokens that match what \doignoretext wants.
4067   \spaceisspace
4068   %
4069   % Count number of #1's that we've seen.
4070   \doignorecount = 0
4071   %
4072   % Swallow text until we reach the matching `@end #1'.
4073   \dodoignore{#1}%
4074 }
4075
4076 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4077   \obeylines %
4078   %
4079   \gdef\dodoignore#1{%
4080     % #1 contains the command name as a string, e.g., `ifinfo'.
4081     %
4082     % Define a command to find the next `@end #1'.
4083     \long\def\doignoretext##1^^M@end #1{%
4084       \doignoretextyyy##1^^M@#1\_STOP_}%
4085     %
4086     % And this command to find another #1 command, at the beginning of a
4087     % line.  (Otherwise, we would consider a line `@c @ifset', for
4088     % example, to count as an @ifset for nesting.)
4089     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4090     %
4091     % And now expand that command.
4092     \doignoretext ^^M%
4093   }%
4094 }
4095
4096 \def\doignoreyyy#1{%
4097   \def\temp{#1}%
4098   \ifx\temp\empty                       % Nothing found.
4099     \let\next\doignoretextzzz
4100   \else                                 % Found a nested condition, ...
4101     \advance\doignorecount by 1
4102     \let\next\doignoretextyyy           % ..., look for another.
4103     % If we're here, #1 ends with ^^M\ifinfo (for example).
4104   \fi
4105   \next #1% the token \_STOP_ is present just after this macro.
4106 }
4107
4108 % We have to swallow the remaining "\_STOP_".
4109 %
4110 \def\doignoretextzzz#1{%
4111   \ifnum\doignorecount = 0      % We have just found the outermost @end.
4112     \let\next\enddoignore
4113   \else                         % Still inside a nested condition.
4114     \advance\doignorecount by -1
4115     \let\next\doignoretext      % Look for the next @end.
4116   \fi
4117   \next
4118 }
4119
4120 % Finish off ignored text.
4121 { \obeylines%
4122   % Ignore anything after the last `@end #1'; this matters in verbatim
4123   % environments, where otherwise the newline after an ignored conditional
4124   % would result in a blank line in the output.
4125   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4126 }
4127
4128
4129 % @set VAR sets the variable VAR to an empty value.
4130 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4131 %
4132 % Since we want to separate VAR from REST-OF-LINE (which might be
4133 % empty), we can't just use \parsearg; we have to insert a space of our
4134 % own to delimit the rest of the line, and then take it out again if we
4135 % didn't need it.
4136 % We rely on the fact that \parsearg sets \catcode`\ =10.
4137 %
4138 \parseargdef\set{\setyyy#1 \endsetyyy}
4139 \def\setyyy#1 #2\endsetyyy{%
4140   {%
4141     \makevalueexpandable
4142     \def\temp{#2}%
4143     \edef\next{\gdef\makecsname{SET#1}}%
4144     \ifx\temp\empty
4145       \next{}%
4146     \else
4147       \setzzz#2\endsetzzz
4148     \fi
4149   }%
4150 }
4151 % Remove the trailing space \setxxx inserted.
4152 \def\setzzz#1 \endsetzzz{\next{#1}}
4153
4154 % @clear VAR clears (i.e., unsets) the variable VAR.
4155 %
4156 \parseargdef\clear{%
4157   {%
4158     \makevalueexpandable
4159     \global\expandafter\let\csname SET#1\endcsname=\relax
4160   }%
4161 }
4162
4163 % @value{foo} gets the text saved in variable foo.
4164 \def\value{\begingroup\makevalueexpandable\valuexxx}
4165 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4166 {
4167   \catcode`\- = \active \catcode`\_ = \active
4168   %
4169   \gdef\makevalueexpandable{%
4170     \let\value = \expandablevalue
4171     % We don't want these characters active, ...
4172     \catcode`\-=\other \catcode`\_=\other
4173     % ..., but we might end up with active ones in the argument if
4174     % we're called from @code, as @code{@value{foo-bar_}}, though.
4175     % So \let them to their normal equivalents.
4176     \let-\realdash \let_\normalunderscore
4177   }
4178 }
4179
4180 % We have this subroutine so that we can handle at least some @value's
4181 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4182 % The command has to be fully expandable (if the variable is set), since
4183 % the result winds up in the index file.  This means that if the
4184 % variable's value contains other Texinfo commands, it's almost certain
4185 % it will fail (although perhaps we could fix that with sufficient work
4186 % to do a one-level expansion on the result, instead of complete).
4187 %
4188 \def\expandablevalue#1{%
4189   \expandafter\ifx\csname SET#1\endcsname\relax
4190     {[No value for ``#1'']}%
4191     \message{Variable `#1', used in @value, is not set.}%
4192   \else
4193     \csname SET#1\endcsname
4194   \fi
4195 }
4196
4197 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4198 % with @set.
4199 %
4200 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4201 %
4202 \makecond{ifset}
4203 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4204 \def\doifset#1#2{%
4205   {%
4206     \makevalueexpandable
4207     \let\next=\empty
4208     \expandafter\ifx\csname SET#2\endcsname\relax
4209       #1% If not set, redefine \next.
4210     \fi
4211     \expandafter
4212   }\next
4213 }
4214 \def\ifsetfail{\doignore{ifset}}
4215
4216 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4217 % defined with @set, or has been undefined with @clear.
4218 %
4219 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4220 % above code: if the variable is not set, do nothing, if it is set,
4221 % then redefine \next to \ifclearfail.
4222 %
4223 \makecond{ifclear}
4224 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4225 \def\ifclearfail{\doignore{ifclear}}
4226
4227 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4228 % without the @) is in fact defined.  We can only feasibly check at the
4229 % TeX level, so something like `mathcode' is going to considered
4230 % defined even though it is not a Texinfo command.
4231
4232 \makecond{ifcommanddefined}
4233 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4234 %
4235 \def\doifcmddefined#1#2{{%
4236     \makevalueexpandable
4237     \let\next=\empty
4238     \expandafter\ifx\csname #2\endcsname\relax
4239       #1% If not defined, \let\next as above.
4240     \fi
4241     \expandafter
4242   }\next
4243 }
4244 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4245
4246 % @ifcommandnotdefined CMD ... handlded similar to @ifclear above.
4247 \makecond{ifcommandnotdefined}
4248 \def\ifcommandnotdefined{%
4249   \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4250 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4251
4252 % Set the `txicommandconditionals' variable, so documents have a way to
4253 % test if the @ifcommand...defined conditionals are available.
4254 \set txicommandconditionals
4255
4256 % @dircategory CATEGORY  -- specify a category of the dir file
4257 % which this file should belong to.  Ignore this in TeX.
4258 \let\dircategory=\comment
4259
4260 % @defininfoenclose.
4261 \let\definfoenclose=\comment
4262
4263
4264 \message{indexing,}
4265 % Index generation facilities
4266
4267 % Define \newwrite to be identical to plain tex's \newwrite
4268 % except not \outer, so it can be used within macros and \if's.
4269 \edef\newwrite{\makecsname{ptexnewwrite}}
4270
4271 % \newindex {foo} defines an index named foo.
4272 % It automatically defines \fooindex such that
4273 % \fooindex ...rest of line... puts an entry in the index foo.
4274 % It also defines \fooindfile to be the number of the output channel for
4275 % the file that accumulates this index.  The file's extension is foo.
4276 % The name of an index should be no more than 2 characters long
4277 % for the sake of vms.
4278 %
4279 \def\newindex#1{%
4280   \iflinks
4281     \expandafter\newwrite \csname#1indfile\endcsname
4282     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4283   \fi
4284   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
4285     \noexpand\doindex{#1}}
4286 }
4287
4288 % @defindex foo  ==  \newindex{foo}
4289 %
4290 \def\defindex{\parsearg\newindex}
4291
4292 % Define @defcodeindex, like @defindex except put all entries in @code.
4293 %
4294 \def\defcodeindex{\parsearg\newcodeindex}
4295 %
4296 \def\newcodeindex#1{%
4297   \iflinks
4298     \expandafter\newwrite \csname#1indfile\endcsname
4299     \openout \csname#1indfile\endcsname \jobname.#1
4300   \fi
4301   \expandafter\xdef\csname#1index\endcsname{%
4302     \noexpand\docodeindex{#1}}%
4303 }
4304
4305
4306 % @synindex foo bar    makes index foo feed into index bar.
4307 % Do this instead of @defindex foo if you don't want it as a separate index.
4308 %
4309 % @syncodeindex foo bar   similar, but put all entries made for index foo
4310 % inside @code.
4311 %
4312 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4313 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4314
4315 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4316 % #3 the target index (bar).
4317 \def\dosynindex#1#2#3{%
4318   % Only do \closeout if we haven't already done it, else we'll end up
4319   % closing the target index.
4320   \expandafter \ifx\csname donesynindex#2\endcsname \relax
4321     % The \closeout helps reduce unnecessary open files; the limit on the
4322     % Acorn RISC OS is a mere 16 files.
4323     \expandafter\closeout\csname#2indfile\endcsname
4324     \expandafter\let\csname donesynindex#2\endcsname = 1
4325   \fi
4326   % redefine \fooindfile:
4327   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4328   \expandafter\let\csname#2indfile\endcsname=\temp
4329   % redefine \fooindex:
4330   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4331 }
4332
4333 % Define \doindex, the driver for all \fooindex macros.
4334 % Argument #1 is generated by the calling \fooindex macro,
4335 %  and it is "foo", the name of the index.
4336
4337 % \doindex just uses \parsearg; it calls \doind for the actual work.
4338 % This is because \doind is more useful to call from other macros.
4339
4340 % There is also \dosubind {index}{topic}{subtopic}
4341 % which makes an entry in a two-level index such as the operation index.
4342
4343 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4344 \def\singleindexer #1{\doind{\indexname}{#1}}
4345
4346 % like the previous two, but they put @code around the argument.
4347 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4348 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4349
4350 % Take care of Texinfo commands that can appear in an index entry.
4351 % Since there are some commands we want to expand, and others we don't,
4352 % we have to laboriously prevent expansion for those that we don't.
4353 %
4354 \def\indexdummies{%
4355   \escapechar = `\\     % use backslash in output files.
4356   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4357   \def\ {\realbackslash\space }%
4358   %
4359   % Need these unexpandable (because we define \tt as a dummy)
4360   % definitions when @{ or @} appear in index entry text.  Also, more
4361   % complicated, when \tex is in effect and \{ is a \delimiter again.
4362   % We can't use \lbracecmd and \rbracecmd because texindex assumes
4363   % braces and backslashes are used only as delimiters.  Perhaps we
4364   % should define @lbrace and @rbrace commands a la @comma.
4365   \def\{{{\tt\char123}}%
4366   \def\}{{\tt\char125}}%
4367   %
4368   % I don't entirely understand this, but when an index entry is
4369   % generated from a macro call, the \endinput which \scanmacro inserts
4370   % causes processing to be prematurely terminated.  This is,
4371   % apparently, because \indexsorttmp is fully expanded, and \endinput
4372   % is an expandable command.  The redefinition below makes \endinput
4373   % disappear altogether for that purpose -- although logging shows that
4374   % processing continues to some further point.  On the other hand, it
4375   % seems \endinput does not hurt in the printed index arg, since that
4376   % is still getting written without apparent harm.
4377   %
4378   % Sample source (mac-idx3.tex, reported by Graham Percival to
4379   % help-texinfo, 22may06):
4380   % @macro funindex {WORD}
4381   % @findex xyz
4382   % @end macro
4383   % ...
4384   % @funindex commtest
4385   %
4386   % The above is not enough to reproduce the bug, but it gives the flavor.
4387   %
4388   % Sample whatsit resulting:
4389   % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4390   %
4391   % So:
4392   \let\endinput = \empty
4393   %
4394   % Do the redefinitions.
4395   \commondummies
4396 }
4397
4398 % For the aux and toc files, @ is the escape character.  So we want to
4399 % redefine everything using @ as the escape character (instead of
4400 % \realbackslash, still used for index files).  When everything uses @,
4401 % this will be simpler.
4402 %
4403 \def\atdummies{%
4404   \def\@{@@}%
4405   \def\ {@ }%
4406   \let\{ = \lbraceatcmd
4407   \let\} = \rbraceatcmd
4408   %
4409   % Do the redefinitions.
4410   \commondummies
4411   \otherbackslash
4412 }
4413
4414 % Called from \indexdummies and \atdummies.
4415 %
4416 \def\commondummies{%
4417   %
4418   % \definedummyword defines \#1 as \string\#1\space, thus effectively
4419   % preventing its expansion.  This is used only for control words,
4420   % not control letters, because the \space would be incorrect for
4421   % control characters, but is needed to separate the control word
4422   % from whatever follows.
4423   %
4424   % For control letters, we have \definedummyletter, which omits the
4425   % space.
4426   %
4427   % These can be used both for control words that take an argument and
4428   % those that do not.  If it is followed by {arg} in the input, then
4429   % that will dutifully get written to the index (or wherever).
4430   %
4431   \def\definedummyword  ##1{\def##1{\string##1\space}}%
4432   \def\definedummyletter##1{\def##1{\string##1}}%
4433   \let\definedummyaccent\definedummyletter
4434   %
4435   \commondummiesnofonts
4436   %
4437   \definedummyletter\_%
4438   \definedummyletter\-%
4439   %
4440   % Non-English letters.
4441   \definedummyword\AA
4442   \definedummyword\AE
4443   \definedummyword\DH
4444   \definedummyword\L
4445   \definedummyword\O
4446   \definedummyword\OE
4447   \definedummyword\TH
4448   \definedummyword\aa
4449   \definedummyword\ae
4450   \definedummyword\dh
4451   \definedummyword\exclamdown
4452   \definedummyword\l
4453   \definedummyword\o
4454   \definedummyword\oe
4455   \definedummyword\ordf
4456   \definedummyword\ordm
4457   \definedummyword\questiondown
4458   \definedummyword\ss
4459   \definedummyword\th
4460   %
4461   % Although these internal commands shouldn't show up, sometimes they do.
4462   \definedummyword\bf
4463   \definedummyword\gtr
4464   \definedummyword\hat
4465   \definedummyword\less
4466   \definedummyword\sf
4467   \definedummyword\sl
4468   \definedummyword\tclose
4469   \definedummyword\tt
4470   %
4471   \definedummyword\LaTeX
4472   \definedummyword\TeX
4473   %
4474   % Assorted special characters.
4475   \definedummyword\arrow
4476   \definedummyword\bullet
4477   \definedummyword\comma
4478   \definedummyword\copyright
4479   \definedummyword\registeredsymbol
4480   \definedummyword\dots
4481   \definedummyword\enddots
4482   \definedummyword\entrybreak
4483   \definedummyword\equiv
4484   \definedummyword\error
4485   \definedummyword\euro
4486   \definedummyword\expansion
4487   \definedummyword\geq
4488   \definedummyword\guillemetleft
4489   \definedummyword\guillemetright
4490   \definedummyword\guilsinglleft
4491   \definedummyword\guilsinglright
4492   \definedummyword\lbracechar
4493   \definedummyword\leq
4494   \definedummyword\minus
4495   \definedummyword\ogonek
4496   \definedummyword\pounds
4497   \definedummyword\point
4498   \definedummyword\print
4499   \definedummyword\quotedblbase
4500   \definedummyword\quotedblleft
4501   \definedummyword\quotedblright
4502   \definedummyword\quoteleft
4503   \definedummyword\quoteright
4504   \definedummyword\quotesinglbase
4505   \definedummyword\rbracechar
4506   \definedummyword\result
4507   \definedummyword\textdegree
4508   %
4509   % We want to disable all macros so that they are not expanded by \write.
4510   \macrolist
4511   %
4512   \normalturnoffactive
4513   %
4514   % Handle some cases of @value -- where it does not contain any
4515   % (non-fully-expandable) commands.
4516   \makevalueexpandable
4517 }
4518
4519 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4520 %
4521 \def\commondummiesnofonts{%
4522   % Control letters and accents.
4523   \definedummyletter\!%
4524   \definedummyaccent\"%
4525   \definedummyaccent\'%
4526   \definedummyletter\*%
4527   \definedummyaccent\,%
4528   \definedummyletter\.%
4529   \definedummyletter\/%
4530   \definedummyletter\:%
4531   \definedummyaccent\=%
4532   \definedummyletter\?%
4533   \definedummyaccent\^%
4534   \definedummyaccent\`%
4535   \definedummyaccent\~%
4536   \definedummyword\u
4537   \definedummyword\v
4538   \definedummyword\H
4539   \definedummyword\dotaccent
4540   \definedummyword\ogonek
4541   \definedummyword\ringaccent
4542   \definedummyword\tieaccent
4543   \definedummyword\ubaraccent
4544   \definedummyword\udotaccent
4545   \definedummyword\dotless
4546   %
4547   % Texinfo font commands.
4548   \definedummyword\b
4549   \definedummyword\i
4550   \definedummyword\r
4551   \definedummyword\sansserif
4552   \definedummyword\sc
4553   \definedummyword\slanted
4554   \definedummyword\t
4555   %
4556   % Commands that take arguments.
4557   \definedummyword\abbr
4558   \definedummyword\acronym
4559   \definedummyword\anchor
4560   \definedummyword\cite
4561   \definedummyword\code
4562   \definedummyword\command
4563   \definedummyword\dfn
4564   \definedummyword\dmn
4565   \definedummyword\email
4566   \definedummyword\emph
4567   \definedummyword\env
4568   \definedummyword\file
4569   \definedummyword\image
4570   \definedummyword\indicateurl
4571   \definedummyword\inforef
4572   \definedummyword\kbd
4573   \definedummyword\key
4574   \definedummyword\math
4575   \definedummyword\option
4576   \definedummyword\pxref
4577   \definedummyword\ref
4578   \definedummyword\samp
4579   \definedummyword\strong
4580   \definedummyword\tie
4581   \definedummyword\uref
4582   \definedummyword\url
4583   \definedummyword\var
4584   \definedummyword\verb
4585   \definedummyword\w
4586   \definedummyword\xref
4587 }
4588
4589 % \indexnofonts is used when outputting the strings to sort the index
4590 % by, and when constructing control sequence names.  It eliminates all
4591 % control sequences and just writes whatever the best ASCII sort string
4592 % would be for a given command (usually its argument).
4593 %
4594 \def\indexnofonts{%
4595   % Accent commands should become @asis.
4596   \def\definedummyaccent##1{\let##1\asis}%
4597   % We can just ignore other control letters.
4598   \def\definedummyletter##1{\let##1\empty}%
4599   % All control words become @asis by default; overrides below.
4600   \let\definedummyword\definedummyaccent
4601   %
4602   \commondummiesnofonts
4603   %
4604   % Don't no-op \tt, since it isn't a user-level command
4605   % and is used in the definitions of the active chars like <, >, |, etc.
4606   % Likewise with the other plain tex font commands.
4607   %\let\tt=\asis
4608   %
4609   \def\ { }%
4610   \def\@{@}%
4611   \def\_{\normalunderscore}%
4612   \def\-{}% @- shouldn't affect sorting
4613   %
4614   % Unfortunately, texindex is not prepared to handle braces in the
4615   % content at all.  So for index sorting, we map @{ and @} to strings
4616   % starting with |, since that ASCII character is between ASCII { and }.
4617   \def\{{|a}%
4618   \def\lbracechar{|a}%
4619   %
4620   \def\}{|b}%
4621   \def\rbracechar{|b}%
4622   %
4623   % Non-English letters.
4624   \def\AA{AA}%
4625   \def\AE{AE}%
4626   \def\DH{DZZ}%
4627   \def\L{L}%
4628   \def\OE{OE}%
4629   \def\O{O}%
4630   \def\TH{ZZZ}%
4631   \def\aa{aa}%
4632   \def\ae{ae}%
4633   \def\dh{dzz}%
4634   \def\exclamdown{!}%
4635   \def\l{l}%
4636   \def\oe{oe}%
4637   \def\ordf{a}%
4638   \def\ordm{o}%
4639   \def\o{o}%
4640   \def\questiondown{?}%
4641   \def\ss{ss}%
4642   \def\th{zzz}%
4643   %
4644   \def\LaTeX{LaTeX}%
4645   \def\TeX{TeX}%
4646   %
4647   % Assorted special characters.
4648   % (The following {} will end up in the sort string, but that's ok.)
4649   \def\arrow{->}%
4650   \def\bullet{bullet}%
4651   \def\comma{,}%
4652   \def\copyright{copyright}%
4653   \def\dots{...}%
4654   \def\enddots{...}%
4655   \def\equiv{==}%
4656   \def\error{error}%
4657   \def\euro{euro}%
4658   \def\expansion{==>}%
4659   \def\geq{>=}%
4660   \def\guillemetleft{<<}%
4661   \def\guillemetright{>>}%
4662   \def\guilsinglleft{<}%
4663   \def\guilsinglright{>}%
4664   \def\leq{<=}%
4665   \def\minus{-}%
4666   \def\point{.}%
4667   \def\pounds{pounds}%
4668   \def\print{-|}%
4669   \def\quotedblbase{"}%
4670   \def\quotedblleft{"}%
4671   \def\quotedblright{"}%
4672   \def\quoteleft{`}%
4673   \def\quoteright{'}%
4674   \def\quotesinglbase{,}%
4675   \def\registeredsymbol{R}%
4676   \def\result{=>}%
4677   \def\textdegree{o}%
4678   %
4679   \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4680   \else \indexlquoteignore \fi
4681   %
4682   % We need to get rid of all macros, leaving only the arguments (if present).
4683   % Of course this is not nearly correct, but it is the best we can do for now.
4684   % makeinfo does not expand macros in the argument to @deffn, which ends up
4685   % writing an index entry, and texindex isn't prepared for an index sort entry
4686   % that starts with \.
4687   %
4688   % Since macro invocations are followed by braces, we can just redefine them
4689   % to take a single TeX argument.  The case of a macro invocation that
4690   % goes to end-of-line is not handled.
4691   %
4692   \macrolist
4693 }
4694
4695 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4696 % ignore left quotes in the sort term.
4697 {\catcode`\`=\active
4698  \gdef\indexlquoteignore{\let`=\empty}}
4699
4700 \let\indexbackslash=0  %overridden during \printindex.
4701 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4702
4703 % Most index entries go through here, but \dosubind is the general case.
4704 % #1 is the index name, #2 is the entry text.
4705 \def\doind#1#2{\dosubind{#1}{#2}{}}
4706
4707 % Workhorse for all \fooindexes.
4708 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4709 % empty if called from \doind, as we usually are (the main exception
4710 % is with most defuns, which call us directly).
4711 %
4712 \def\dosubind#1#2#3{%
4713   \iflinks
4714   {%
4715     % Store the main index entry text (including the third arg).
4716     \toks0 = {#2}%
4717     % If third arg is present, precede it with a space.
4718     \def\thirdarg{#3}%
4719     \ifx\thirdarg\empty \else
4720       \toks0 = \expandafter{\the\toks0 \space #3}%
4721     \fi
4722     %
4723     \edef\writeto{\csname#1indfile\endcsname}%
4724     %
4725     \safewhatsit\dosubindwrite
4726   }%
4727   \fi
4728 }
4729
4730 % Write the entry in \toks0 to the index file:
4731 %
4732 \def\dosubindwrite{%
4733   % Put the index entry in the margin if desired.
4734   \ifx\SETmarginindex\relax\else
4735     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4736   \fi
4737   %
4738   % Remember, we are within a group.
4739   \indexdummies % Must do this here, since \bf, etc expand at this stage
4740   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4741       % so it will be output as is; and it will print as backslash.
4742   %
4743   % Process the index entry with all font commands turned off, to
4744   % get the string to sort by.
4745   {\indexnofonts
4746    \edef\temp{\the\toks0}% need full expansion
4747    \xdef\indexsorttmp{\temp}%
4748   }%
4749   %
4750   % Set up the complete index entry, with both the sort key and
4751   % the original text, including any font commands.  We write
4752   % three arguments to \entry to the .?? file (four in the
4753   % subentry case), texindex reduces to two when writing the .??s
4754   % sorted result.
4755   \edef\temp{%
4756     \write\writeto{%
4757       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4758   }%
4759   \temp
4760 }
4761
4762 % Take care of unwanted page breaks/skips around a whatsit:
4763 %
4764 % If a skip is the last thing on the list now, preserve it
4765 % by backing up by \lastskip, doing the \write, then inserting
4766 % the skip again.  Otherwise, the whatsit generated by the
4767 % \write or \pdfdest will make \lastskip zero.  The result is that
4768 % sequences like this:
4769 % @end defun
4770 % @tindex whatever
4771 % @defun ...
4772 % will have extra space inserted, because the \medbreak in the
4773 % start of the @defun won't see the skip inserted by the @end of
4774 % the previous defun.
4775 %
4776 % But don't do any of this if we're not in vertical mode.  We
4777 % don't want to do a \vskip and prematurely end a paragraph.
4778 %
4779 % Avoid page breaks due to these extra skips, too.
4780 %
4781 % But wait, there is a catch there:
4782 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
4783 % sufficient for this purpose, as it ignores stretch and shrink parts
4784 % of the skip.  The only way seems to be to check the textual
4785 % representation of the skip.
4786 %
4787 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4788 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4789 %
4790 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4791 %
4792 \newskip\whatsitskip
4793 \newcount\whatsitpenalty
4794 %
4795 % ..., ready, GO:
4796 %
4797 \def\safewhatsit#1{\ifhmode
4798   #1%
4799  \else
4800   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4801   \whatsitskip = \lastskip
4802   \edef\lastskipmacro{\the\lastskip}%
4803   \whatsitpenalty = \lastpenalty
4804   %
4805   % If \lastskip is nonzero, that means the last item was a
4806   % skip.  And since a skip is discardable, that means this
4807   % -\whatsitskip glue we're inserting is preceded by a
4808   % non-discardable item, therefore it is not a potential
4809   % breakpoint, therefore no \nobreak needed.
4810   \ifx\lastskipmacro\zeroskipmacro
4811   \else
4812     \vskip-\whatsitskip
4813   \fi
4814   %
4815   #1%
4816   %
4817   \ifx\lastskipmacro\zeroskipmacro
4818     % If \lastskip was zero, perhaps the last item was a penalty, and
4819     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
4820     % to re-insert the same penalty (values >10000 are used for various
4821     % signals); since we just inserted a non-discardable item, any
4822     % following glue (such as a \parskip) would be a breakpoint.  For example:
4823     %   @deffn deffn-whatever
4824     %   @vindex index-whatever
4825     %   Description.
4826     % would allow a break between the index-whatever whatsit
4827     % and the "Description." paragraph.
4828     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4829   \else
4830     % On the other hand, if we had a nonzero \lastskip,
4831     % this make-up glue would be preceded by a non-discardable item
4832     % (the whatsit from the \write), so we must insert a \nobreak.
4833     \nobreak\vskip\whatsitskip
4834   \fi
4835 \fi}
4836
4837 % The index entry written in the file actually looks like
4838 %  \entry {sortstring}{page}{topic}
4839 % or
4840 %  \entry {sortstring}{page}{topic}{subtopic}
4841 % The texindex program reads in these files and writes files
4842 % containing these kinds of lines:
4843 %  \initial {c}
4844 %     before the first topic whose initial is c
4845 %  \entry {topic}{pagelist}
4846 %     for a topic that is used without subtopics
4847 %  \primary {topic}
4848 %     for the beginning of a topic that is used with subtopics
4849 %  \secondary {subtopic}{pagelist}
4850 %     for each subtopic.
4851
4852 % Define the user-accessible indexing commands
4853 % @findex, @vindex, @kindex, @cindex.
4854
4855 \def\findex {\fnindex}
4856 \def\kindex {\kyindex}
4857 \def\cindex {\cpindex}
4858 \def\vindex {\vrindex}
4859 \def\tindex {\tpindex}
4860 \def\pindex {\pgindex}
4861
4862 \def\cindexsub {\begingroup\obeylines\cindexsub}
4863 {\obeylines %
4864 \gdef\cindexsub "#1" #2^^M{\endgroup %
4865 \dosubind{cp}{#2}{#1}}}
4866
4867 % Define the macros used in formatting output of the sorted index material.
4868
4869 % @printindex causes a particular index (the ??s file) to get printed.
4870 % It does not print any chapter heading (usually an @unnumbered).
4871 %
4872 \parseargdef\printindex{\begingroup
4873   \dobreak \chapheadingskip{10000}%
4874   %
4875   \smallfonts \rm
4876   \tolerance = 9500
4877   \plainfrenchspacing
4878   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4879   %
4880   % See if the index file exists and is nonempty.
4881   % Change catcode of @ here so that if the index file contains
4882   % \initial {@}
4883   % as its first line, TeX doesn't complain about mismatched braces
4884   % (because it thinks @} is a control sequence).
4885   \catcode`\@ = 11
4886   \openin 1 \jobname.#1s
4887   \ifeof 1
4888     % \enddoublecolumns gets confused if there is no text in the index,
4889     % and it loses the chapter title and the aux file entries for the
4890     % index.  The easiest way to prevent this problem is to make sure
4891     % there is some text.
4892     \putwordIndexNonexistent
4893   \else
4894     %
4895     % If the index file exists but is empty, then \openin leaves \ifeof
4896     % false.  We have to make TeX try to read something from the file, so
4897     % it can discover if there is anything in it.
4898     \read 1 to \temp
4899     \ifeof 1
4900       \putwordIndexIsEmpty
4901     \else
4902       % Index files are almost Texinfo source, but we use \ as the escape
4903       % character.  It would be better to use @, but that's too big a change
4904       % to make right now.
4905       \def\indexbackslash{\backslashcurfont}%
4906       \catcode`\\ = 0
4907       \escapechar = `\\
4908       \begindoublecolumns
4909       \input \jobname.#1s
4910       \enddoublecolumns
4911     \fi
4912   \fi
4913   \closein 1
4914 \endgroup}
4915
4916 % These macros are used by the sorted index file itself.
4917 % Change them to control the appearance of the index.
4918
4919 \def\initial#1{{%
4920   % Some minor font changes for the special characters.
4921   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4922   %
4923   % Remove any glue we may have, we'll be inserting our own.
4924   \removelastskip
4925   %
4926   % We like breaks before the index initials, so insert a bonus.
4927   \nobreak
4928   \vskip 0pt plus 3\baselineskip
4929   \penalty 0
4930   \vskip 0pt plus -3\baselineskip
4931   %
4932   % Typeset the initial.  Making this add up to a whole number of
4933   % baselineskips increases the chance of the dots lining up from column
4934   % to column.  It still won't often be perfect, because of the stretch
4935   % we need before each entry, but it's better.
4936   %
4937   % No shrink because it confuses \balancecolumns.
4938   \vskip 1.67\baselineskip plus .5\baselineskip
4939   \leftline{\secbf #1}%
4940   % Do our best not to break after the initial.
4941   \nobreak
4942   \vskip .33\baselineskip plus .1\baselineskip
4943 }}
4944
4945 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4946 % then page number (#2) flushed to the right margin.  It is used for index
4947 % and table of contents entries.  The paragraph is indented by \leftskip.
4948 %
4949 % A straightforward implementation would start like this:
4950 %       \def\entry#1#2{...
4951 % But this freezes the catcodes in the argument, and can cause problems to
4952 % @code, which sets - active.  This problem was fixed by a kludge---
4953 % ``-'' was active throughout whole index, but this isn't really right.
4954 % The right solution is to prevent \entry from swallowing the whole text.
4955 %                                 --kasal, 21nov03
4956 \def\entry{%
4957   \begingroup
4958     %
4959     % Start a new paragraph if necessary, so our assignments below can't
4960     % affect previous text.
4961     \par
4962     %
4963     % Do not fill out the last line with white space.
4964     \parfillskip = 0in
4965     %
4966     % No extra space above this paragraph.
4967     \parskip = 0in
4968     %
4969     % Do not prefer a separate line ending with a hyphen to fewer lines.
4970     \finalhyphendemerits = 0
4971     %
4972     % \hangindent is only relevant when the entry text and page number
4973     % don't both fit on one line.  In that case, bob suggests starting the
4974     % dots pretty far over on the line.  Unfortunately, a large
4975     % indentation looks wrong when the entry text itself is broken across
4976     % lines.  So we use a small indentation and put up with long leaders.
4977     %
4978     % \hangafter is reset to 1 (which is the value we want) at the start
4979     % of each paragraph, so we need not do anything with that.
4980     \hangindent = 2em
4981     %
4982     % When the entry text needs to be broken, just fill out the first line
4983     % with blank space.
4984     \rightskip = 0pt plus1fil
4985     %
4986     % A bit of stretch before each entry for the benefit of balancing
4987     % columns.
4988     \vskip 0pt plus1pt
4989     %
4990     % When reading the text of entry, convert explicit line breaks
4991     % from @* into spaces.  The user might give these in long section
4992     % titles, for instance.
4993     \def\*{\unskip\space\ignorespaces}%
4994     \def\entrybreak{\hfil\break}%
4995     %
4996     % Swallow the left brace of the text (first parameter):
4997     \afterassignment\doentry
4998     \let\temp =
4999 }
5000 \def\entrybreak{\unskip\space\ignorespaces}%
5001 \def\doentry{%
5002     \bgroup % Instead of the swallowed brace.
5003       \noindent
5004       \aftergroup\finishentry
5005       % And now comes the text of the entry.
5006 }
5007 \def\finishentry#1{%
5008     % #1 is the page number.
5009     %
5010     % The following is kludged to not output a line of dots in the index if
5011     % there are no page numbers.  The next person who breaks this will be
5012     % cursed by a Unix daemon.
5013     \setbox\boxA = \hbox{#1}%
5014     \ifdim\wd\boxA = 0pt
5015       \ %
5016     \else
5017       %
5018       % If we must, put the page number on a line of its own, and fill out
5019       % this line with blank space.  (The \hfil is overwhelmed with the
5020       % fill leaders glue in \indexdotfill if the page number does fit.)
5021       \hfil\penalty50
5022       \null\nobreak\indexdotfill % Have leaders before the page number.
5023       %
5024       % The `\ ' here is removed by the implicit \unskip that TeX does as
5025       % part of (the primitive) \par.  Without it, a spurious underfull
5026       % \hbox ensues.
5027       \ifpdf
5028         \pdfgettoks#1.%
5029         \ \the\toksA
5030       \else
5031         \ #1%
5032       \fi
5033     \fi
5034     \par
5035   \endgroup
5036 }
5037
5038 % Like plain.tex's \dotfill, except uses up at least 1 em.
5039 \def\indexdotfill{\cleaders
5040   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5041
5042 \def\primary #1{\line{#1\hfil}}
5043
5044 \newskip\secondaryindent \secondaryindent=0.5cm
5045 \def\secondary#1#2{{%
5046   \parfillskip=0in
5047   \parskip=0in
5048   \hangindent=1in
5049   \hangafter=1
5050   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5051   \ifpdf
5052     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5053   \else
5054     #2
5055   \fi
5056   \par
5057 }}
5058
5059 % Define two-column mode, which we use to typeset indexes.
5060 % Adapted from the TeXbook, page 416, which is to say,
5061 % the manmac.tex format used to print the TeXbook itself.
5062 \catcode`\@=11
5063
5064 \newbox\partialpage
5065 \newdimen\doublecolumnhsize
5066
5067 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5068   % Grab any single-column material above us.
5069   \output = {%
5070     %
5071     % Here is a possibility not foreseen in manmac: if we accumulate a
5072     % whole lot of material, we might end up calling this \output
5073     % routine twice in a row (see the doublecol-lose test, which is
5074     % essentially a couple of indexes with @setchapternewpage off).  In
5075     % that case we just ship out what is in \partialpage with the normal
5076     % output routine.  Generally, \partialpage will be empty when this
5077     % runs and this will be a no-op.  See the indexspread.tex test case.
5078     \ifvoid\partialpage \else
5079       \onepageout{\pagecontents\partialpage}%
5080     \fi
5081     %
5082     \global\setbox\partialpage = \vbox{%
5083       % Unvbox the main output page.
5084       \unvbox\PAGE
5085       \kern-\topskip \kern\baselineskip
5086     }%
5087   }%
5088   \eject % run that output routine to set \partialpage
5089   %
5090   % Use the double-column output routine for subsequent pages.
5091   \output = {\doublecolumnout}%
5092   %
5093   % Change the page size parameters.  We could do this once outside this
5094   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5095   % format, but then we repeat the same computation.  Repeating a couple
5096   % of assignments once per index is clearly meaningless for the
5097   % execution time, so we may as well do it in one place.
5098   %
5099   % First we halve the line length, less a little for the gutter between
5100   % the columns.  We compute the gutter based on the line length, so it
5101   % changes automatically with the paper format.  The magic constant
5102   % below is chosen so that the gutter has the same value (well, +-<1pt)
5103   % as it did when we hard-coded it.
5104   %
5105   % We put the result in a separate register, \doublecolumhsize, so we
5106   % can restore it in \pagesofar, after \hsize itself has (potentially)
5107   % been clobbered.
5108   %
5109   \doublecolumnhsize = \hsize
5110     \advance\doublecolumnhsize by -.04154\hsize
5111     \divide\doublecolumnhsize by 2
5112   \hsize = \doublecolumnhsize
5113   %
5114   % Double the \vsize as well.  (We don't need a separate register here,
5115   % since nobody clobbers \vsize.)
5116   \vsize = 2\vsize
5117 }
5118
5119 % The double-column output routine for all double-column pages except
5120 % the last.
5121 %
5122 \def\doublecolumnout{%
5123   \splittopskip=\topskip \splitmaxdepth=\maxdepth
5124   % Get the available space for the double columns -- the normal
5125   % (undoubled) page height minus any material left over from the
5126   % previous page.
5127   \dimen@ = \vsize
5128   \divide\dimen@ by 2
5129   \advance\dimen@ by -\ht\partialpage
5130   %
5131   % box0 will be the left-hand column, box2 the right.
5132   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5133   \onepageout\pagesofar
5134   \unvbox255
5135   \penalty\outputpenalty
5136 }
5137 %
5138 % Re-output the contents of the output page -- any previous material,
5139 % followed by the two boxes we just split, in box0 and box2.
5140 \def\pagesofar{%
5141   \unvbox\partialpage
5142   %
5143   \hsize = \doublecolumnhsize
5144   \wd0=\hsize \wd2=\hsize
5145   \hbox to\pagewidth{\box0\hfil\box2}%
5146 }
5147 %
5148 % All done with double columns.
5149 \def\enddoublecolumns{%
5150   % The following penalty ensures that the page builder is exercised
5151   % _before_ we change the output routine.  This is necessary in the
5152   % following situation:
5153   %
5154   % The last section of the index consists only of a single entry.
5155   % Before this section, \pagetotal is less than \pagegoal, so no
5156   % break occurs before the last section starts.  However, the last
5157   % section, consisting of \initial and the single \entry, does not
5158   % fit on the page and has to be broken off.  Without the following
5159   % penalty the page builder will not be exercised until \eject
5160   % below, and by that time we'll already have changed the output
5161   % routine to the \balancecolumns version, so the next-to-last
5162   % double-column page will be processed with \balancecolumns, which
5163   % is wrong:  The two columns will go to the main vertical list, with
5164   % the broken-off section in the recent contributions.  As soon as
5165   % the output routine finishes, TeX starts reconsidering the page
5166   % break.  The two columns and the broken-off section both fit on the
5167   % page, because the two columns now take up only half of the page
5168   % goal.  When TeX sees \eject from below which follows the final
5169   % section, it invokes the new output routine that we've set after
5170   % \balancecolumns below; \onepageout will try to fit the two columns
5171   % and the final section into the vbox of \pageheight (see
5172   % \pagebody), causing an overfull box.
5173   %
5174   % Note that glue won't work here, because glue does not exercise the
5175   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5176   \penalty0
5177   %
5178   \output = {%
5179     % Split the last of the double-column material.  Leave it on the
5180     % current page, no automatic page break.
5181     \balancecolumns
5182     %
5183     % If we end up splitting too much material for the current page,
5184     % though, there will be another page break right after this \output
5185     % invocation ends.  Having called \balancecolumns once, we do not
5186     % want to call it again.  Therefore, reset \output to its normal
5187     % definition right away.  (We hope \balancecolumns will never be
5188     % called on to balance too much material, but if it is, this makes
5189     % the output somewhat more palatable.)
5190     \global\output = {\onepageout{\pagecontents\PAGE}}%
5191   }%
5192   \eject
5193   \endgroup % started in \begindoublecolumns
5194   %
5195   % \pagegoal was set to the doubled \vsize above, since we restarted
5196   % the current page.  We're now back to normal single-column
5197   % typesetting, so reset \pagegoal to the normal \vsize (after the
5198   % \endgroup where \vsize got restored).
5199   \pagegoal = \vsize
5200 }
5201 %
5202 % Called at the end of the double column material.
5203 \def\balancecolumns{%
5204   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5205   \dimen@ = \ht0
5206   \advance\dimen@ by \topskip
5207   \advance\dimen@ by-\baselineskip
5208   \divide\dimen@ by 2 % target to split to
5209   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5210   \splittopskip = \topskip
5211   % Loop until we get a decent breakpoint.
5212   {%
5213     \vbadness = 10000
5214     \loop
5215       \global\setbox3 = \copy0
5216       \global\setbox1 = \vsplit3 to \dimen@
5217     \ifdim\ht3>\dimen@
5218       \global\advance\dimen@ by 1pt
5219     \repeat
5220   }%
5221   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5222   \setbox0=\vbox to\dimen@{\unvbox1}%
5223   \setbox2=\vbox to\dimen@{\unvbox3}%
5224   %
5225   \pagesofar
5226 }
5227 \catcode`\@ = \other
5228
5229
5230 \message{sectioning,}
5231 % Chapters, sections, etc.
5232
5233 % Let's start with @part.
5234 \outer\parseargdef\part{\partzzz{#1}}
5235 \def\partzzz#1{%
5236   \chapoddpage
5237   \null
5238   \vskip.3\vsize  % move it down on the page a bit
5239   \begingroup
5240     \noindent \titlefonts\rmisbold #1\par % the text
5241     \let\lastnode=\empty      % no node to associate with
5242     \writetocentry{part}{#1}{}% but put it in the toc
5243     \headingsoff              % no headline or footline on the part page
5244     \chapoddpage
5245   \endgroup
5246 }
5247
5248 % \unnumberedno is an oxymoron.  But we count the unnumbered
5249 % sections so that we can refer to them unambiguously in the pdf
5250 % outlines by their "section number".  We avoid collisions with chapter
5251 % numbers by starting them at 10000.  (If a document ever has 10000
5252 % chapters, we're in trouble anyway, I'm sure.)
5253 \newcount\unnumberedno \unnumberedno = 10000
5254 \newcount\chapno
5255 \newcount\secno        \secno=0
5256 \newcount\subsecno     \subsecno=0
5257 \newcount\subsubsecno  \subsubsecno=0
5258
5259 % This counter is funny since it counts through charcodes of letters A, B, ...
5260 \newcount\appendixno  \appendixno = `\@
5261 %
5262 % \def\appendixletter{\char\the\appendixno}
5263 % We do the following ugly conditional instead of the above simple
5264 % construct for the sake of pdftex, which needs the actual
5265 % letter in the expansion, not just typeset.
5266 %
5267 \def\appendixletter{%
5268   \ifnum\appendixno=`A A%
5269   \else\ifnum\appendixno=`B B%
5270   \else\ifnum\appendixno=`C C%
5271   \else\ifnum\appendixno=`D D%
5272   \else\ifnum\appendixno=`E E%
5273   \else\ifnum\appendixno=`F F%
5274   \else\ifnum\appendixno=`G G%
5275   \else\ifnum\appendixno=`H H%
5276   \else\ifnum\appendixno=`I I%
5277   \else\ifnum\appendixno=`J J%
5278   \else\ifnum\appendixno=`K K%
5279   \else\ifnum\appendixno=`L L%
5280   \else\ifnum\appendixno=`M M%
5281   \else\ifnum\appendixno=`N N%
5282   \else\ifnum\appendixno=`O O%
5283   \else\ifnum\appendixno=`P P%
5284   \else\ifnum\appendixno=`Q Q%
5285   \else\ifnum\appendixno=`R R%
5286   \else\ifnum\appendixno=`S S%
5287   \else\ifnum\appendixno=`T T%
5288   \else\ifnum\appendixno=`U U%
5289   \else\ifnum\appendixno=`V V%
5290   \else\ifnum\appendixno=`W W%
5291   \else\ifnum\appendixno=`X X%
5292   \else\ifnum\appendixno=`Y Y%
5293   \else\ifnum\appendixno=`Z Z%
5294   % The \the is necessary, despite appearances, because \appendixletter is
5295   % expanded while writing the .toc file.  \char\appendixno is not
5296   % expandable, thus it is written literally, thus all appendixes come out
5297   % with the same letter (or @) in the toc without it.
5298   \else\char\the\appendixno
5299   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5300   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5301
5302 % Each @chapter defines these (using marks) as the number+name, number
5303 % and name of the chapter.  Page headings and footings can use
5304 % these.  @section does likewise.
5305 \def\thischapter{}
5306 \def\thischapternum{}
5307 \def\thischaptername{}
5308 \def\thissection{}
5309 \def\thissectionnum{}
5310 \def\thissectionname{}
5311
5312 \newcount\absseclevel % used to calculate proper heading level
5313 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5314
5315 % @raisesections: treat @section as chapter, @subsection as section, etc.
5316 \def\raisesections{\global\advance\secbase by -1}
5317 \let\up=\raisesections % original BFox name
5318
5319 % @lowersections: treat @chapter as section, @section as subsection, etc.
5320 \def\lowersections{\global\advance\secbase by 1}
5321 \let\down=\lowersections % original BFox name
5322
5323 % we only have subsub.
5324 \chardef\maxseclevel = 3
5325 %
5326 % A numbered section within an unnumbered changes to unnumbered too.
5327 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5328 \chardef\unnlevel = \maxseclevel
5329 %
5330 % Trace whether the current chapter is an appendix or not:
5331 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5332 \def\chapheadtype{N}
5333
5334 % Choose a heading macro
5335 % #1 is heading type
5336 % #2 is heading level
5337 % #3 is text for heading
5338 \def\genhead#1#2#3{%
5339   % Compute the abs. sec. level:
5340   \absseclevel=#2
5341   \advance\absseclevel by \secbase
5342   % Make sure \absseclevel doesn't fall outside the range:
5343   \ifnum \absseclevel < 0
5344     \absseclevel = 0
5345   \else
5346     \ifnum \absseclevel > 3
5347       \absseclevel = 3
5348     \fi
5349   \fi
5350   % The heading type:
5351   \def\headtype{#1}%
5352   \if \headtype U%
5353     \ifnum \absseclevel < \unnlevel
5354       \chardef\unnlevel = \absseclevel
5355     \fi
5356   \else
5357     % Check for appendix sections:
5358     \ifnum \absseclevel = 0
5359       \edef\chapheadtype{\headtype}%
5360     \else
5361       \if \headtype A\if \chapheadtype N%
5362         \errmessage{@appendix... within a non-appendix chapter}%
5363       \fi\fi
5364     \fi
5365     % Check for numbered within unnumbered:
5366     \ifnum \absseclevel > \unnlevel
5367       \def\headtype{U}%
5368     \else
5369       \chardef\unnlevel = 3
5370     \fi
5371   \fi
5372   % Now print the heading:
5373   \if \headtype U%
5374     \ifcase\absseclevel
5375         \unnumberedzzz{#3}%
5376     \or \unnumberedseczzz{#3}%
5377     \or \unnumberedsubseczzz{#3}%
5378     \or \unnumberedsubsubseczzz{#3}%
5379     \fi
5380   \else
5381     \if \headtype A%
5382       \ifcase\absseclevel
5383           \appendixzzz{#3}%
5384       \or \appendixsectionzzz{#3}%
5385       \or \appendixsubseczzz{#3}%
5386       \or \appendixsubsubseczzz{#3}%
5387       \fi
5388     \else
5389       \ifcase\absseclevel
5390           \chapterzzz{#3}%
5391       \or \seczzz{#3}%
5392       \or \numberedsubseczzz{#3}%
5393       \or \numberedsubsubseczzz{#3}%
5394       \fi
5395     \fi
5396   \fi
5397   \suppressfirstparagraphindent
5398 }
5399
5400 % an interface:
5401 \def\numhead{\genhead N}
5402 \def\apphead{\genhead A}
5403 \def\unnmhead{\genhead U}
5404
5405 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
5406 % all lower-level sectioning counters to zero.
5407 %
5408 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5409 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
5410 \let\chaplevelprefix = \empty
5411 %
5412 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5413 \def\chapterzzz#1{%
5414   % section resetting is \global in case the chapter is in a group, such
5415   % as an @include file.
5416   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5417     \global\advance\chapno by 1
5418   %
5419   % Used for \float.
5420   \gdef\chaplevelprefix{\the\chapno.}%
5421   \resetallfloatnos
5422   %
5423   % \putwordChapter can contain complex things in translations.
5424   \toks0=\expandafter{\putwordChapter}%
5425   \message{\the\toks0 \space \the\chapno}%
5426   %
5427   % Write the actual heading.
5428   \chapmacro{#1}{Ynumbered}{\the\chapno}%
5429   %
5430   % So @section and the like are numbered underneath this chapter.
5431   \global\let\section = \numberedsec
5432   \global\let\subsection = \numberedsubsec
5433   \global\let\subsubsection = \numberedsubsubsec
5434 }
5435
5436 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5437 %
5438 \def\appendixzzz#1{%
5439   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5440     \global\advance\appendixno by 1
5441   \gdef\chaplevelprefix{\appendixletter.}%
5442   \resetallfloatnos
5443   %
5444   % \putwordAppendix can contain complex things in translations.
5445   \toks0=\expandafter{\putwordAppendix}%
5446   \message{\the\toks0 \space \appendixletter}%
5447   %
5448   \chapmacro{#1}{Yappendix}{\appendixletter}%
5449   %
5450   \global\let\section = \appendixsec
5451   \global\let\subsection = \appendixsubsec
5452   \global\let\subsubsection = \appendixsubsubsec
5453 }
5454
5455 % normally unnmhead0 calls unnumberedzzz:
5456 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5457 \def\unnumberedzzz#1{%
5458   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5459     \global\advance\unnumberedno by 1
5460   %
5461   % Since an unnumbered has no number, no prefix for figures.
5462   \global\let\chaplevelprefix = \empty
5463   \resetallfloatnos
5464   %
5465   % This used to be simply \message{#1}, but TeX fully expands the
5466   % argument to \message.  Therefore, if #1 contained @-commands, TeX
5467   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
5468   % expanded @cite (which turns out to cause errors because \cite is meant
5469   % to be executed, not expanded).
5470   %
5471   % Anyway, we don't want the fully-expanded definition of @cite to appear
5472   % as a result of the \message, we just want `@cite' itself.  We use
5473   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5474   % simply yielding the contents of <toks register>.  (We also do this for
5475   % the toc entries.)
5476   \toks0 = {#1}%
5477   \message{(\the\toks0)}%
5478   %
5479   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5480   %
5481   \global\let\section = \unnumberedsec
5482   \global\let\subsection = \unnumberedsubsec
5483   \global\let\subsubsection = \unnumberedsubsubsec
5484 }
5485
5486 % @centerchap is like @unnumbered, but the heading is centered.
5487 \outer\parseargdef\centerchap{%
5488   % Well, we could do the following in a group, but that would break
5489   % an assumption that \chapmacro is called at the outermost level.
5490   % Thus we are safer this way:         --kasal, 24feb04
5491   \let\centerparametersmaybe = \centerparameters
5492   \unnmhead0{#1}%
5493   \let\centerparametersmaybe = \relax
5494 }
5495
5496 % @top is like @unnumbered.
5497 \let\top\unnumbered
5498
5499 % Sections.
5500
5501 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5502 \def\seczzz#1{%
5503   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5504   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5505 }
5506
5507 % normally calls appendixsectionzzz:
5508 \outer\parseargdef\appendixsection{\apphead1{#1}}
5509 \def\appendixsectionzzz#1{%
5510   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5511   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5512 }
5513 \let\appendixsec\appendixsection
5514
5515 % normally calls unnumberedseczzz:
5516 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5517 \def\unnumberedseczzz#1{%
5518   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5519   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5520 }
5521
5522 % Subsections.
5523
5524 % normally calls numberedsubseczzz:
5525 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5526 \def\numberedsubseczzz#1{%
5527   \global\subsubsecno=0  \global\advance\subsecno by 1
5528   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5529 }
5530
5531 % normally calls appendixsubseczzz:
5532 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5533 \def\appendixsubseczzz#1{%
5534   \global\subsubsecno=0  \global\advance\subsecno by 1
5535   \sectionheading{#1}{subsec}{Yappendix}%
5536                  {\appendixletter.\the\secno.\the\subsecno}%
5537 }
5538
5539 % normally calls unnumberedsubseczzz:
5540 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5541 \def\unnumberedsubseczzz#1{%
5542   \global\subsubsecno=0  \global\advance\subsecno by 1
5543   \sectionheading{#1}{subsec}{Ynothing}%
5544                  {\the\unnumberedno.\the\secno.\the\subsecno}%
5545 }
5546
5547 % Subsubsections.
5548
5549 % normally numberedsubsubseczzz:
5550 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5551 \def\numberedsubsubseczzz#1{%
5552   \global\advance\subsubsecno by 1
5553   \sectionheading{#1}{subsubsec}{Ynumbered}%
5554                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5555 }
5556
5557 % normally appendixsubsubseczzz:
5558 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5559 \def\appendixsubsubseczzz#1{%
5560   \global\advance\subsubsecno by 1
5561   \sectionheading{#1}{subsubsec}{Yappendix}%
5562                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5563 }
5564
5565 % normally unnumberedsubsubseczzz:
5566 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5567 \def\unnumberedsubsubseczzz#1{%
5568   \global\advance\subsubsecno by 1
5569   \sectionheading{#1}{subsubsec}{Ynothing}%
5570                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5571 }
5572
5573 % These macros control what the section commands do, according
5574 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5575 % Define them by default for a numbered chapter.
5576 \let\section = \numberedsec
5577 \let\subsection = \numberedsubsec
5578 \let\subsubsection = \numberedsubsubsec
5579
5580 % Define @majorheading, @heading and @subheading
5581
5582 % NOTE on use of \vbox for chapter headings, section headings, and such:
5583 %       1) We use \vbox rather than the earlier \line to permit
5584 %          overlong headings to fold.
5585 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
5586 %          heading is obnoxious; this forbids it.
5587 %       3) Likewise, headings look best if no \parindent is used, and
5588 %          if justification is not attempted.  Hence \raggedright.
5589
5590 \def\majorheading{%
5591   {\advance\chapheadingskip by 10pt \chapbreak }%
5592   \parsearg\chapheadingzzz
5593 }
5594
5595 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5596 \def\chapheadingzzz#1{%
5597   {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5598                     \parindent=0pt\ptexraggedright
5599                     \rmisbold #1\hfill}}%
5600   \bigskip \par\penalty 200\relax
5601   \suppressfirstparagraphindent
5602 }
5603
5604 % @heading, @subheading, @subsubheading.
5605 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5606   \suppressfirstparagraphindent}
5607 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5608   \suppressfirstparagraphindent}
5609 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5610   \suppressfirstparagraphindent}
5611
5612 % These macros generate a chapter, section, etc. heading only
5613 % (including whitespace, linebreaking, etc. around it),
5614 % given all the information in convenient, parsed form.
5615
5616 % Args are the skip and penalty (usually negative)
5617 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5618
5619 % Parameter controlling skip before chapter headings (if needed)
5620 \newskip\chapheadingskip
5621
5622 % Define plain chapter starts, and page on/off switching for it.
5623 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5624 \def\chappager{\par\vfill\supereject}
5625 % Because \domark is called before \chapoddpage, the filler page will
5626 % get the headings for the next chapter, which is wrong.  But we don't
5627 % care -- we just disable all headings on the filler page.
5628 \def\chapoddpage{%
5629   \chappager
5630   \ifodd\pageno \else
5631     \begingroup
5632       \headingsoff
5633       \null
5634       \chappager
5635     \endgroup
5636   \fi
5637 }
5638
5639 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5640
5641 \def\CHAPPAGoff{%
5642 \global\let\contentsalignmacro = \chappager
5643 \global\let\pchapsepmacro=\chapbreak
5644 \global\let\pagealignmacro=\chappager}
5645
5646 \def\CHAPPAGon{%
5647 \global\let\contentsalignmacro = \chappager
5648 \global\let\pchapsepmacro=\chappager
5649 \global\let\pagealignmacro=\chappager
5650 \global\def\HEADINGSon{\HEADINGSsingle}}
5651
5652 \def\CHAPPAGodd{%
5653 \global\let\contentsalignmacro = \chapoddpage
5654 \global\let\pchapsepmacro=\chapoddpage
5655 \global\let\pagealignmacro=\chapoddpage
5656 \global\def\HEADINGSon{\HEADINGSdouble}}
5657
5658 \CHAPPAGon
5659
5660 % Chapter opening.
5661 %
5662 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5663 % Yappendix, Yomitfromtoc), #3 the chapter number.
5664 %
5665 % To test against our argument.
5666 \def\Ynothingkeyword{Ynothing}
5667 \def\Yomitfromtockeyword{Yomitfromtoc}
5668 \def\Yappendixkeyword{Yappendix}
5669 %
5670 \def\chapmacro#1#2#3{%
5671   % Insert the first mark before the heading break (see notes for \domark).
5672   \let\prevchapterdefs=\lastchapterdefs
5673   \let\prevsectiondefs=\lastsectiondefs
5674   \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5675                         \gdef\thissection{}}%
5676   %
5677   \def\temptype{#2}%
5678   \ifx\temptype\Ynothingkeyword
5679     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5680                           \gdef\thischapter{\thischaptername}}%
5681   \else\ifx\temptype\Yomitfromtockeyword
5682     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5683                           \gdef\thischapter{}}%
5684   \else\ifx\temptype\Yappendixkeyword
5685     \toks0={#1}%
5686     \xdef\lastchapterdefs{%
5687       \gdef\noexpand\thischaptername{\the\toks0}%
5688       \gdef\noexpand\thischapternum{\appendixletter}%
5689       % \noexpand\putwordAppendix avoids expanding indigestible
5690       % commands in some of the translations.
5691       \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5692                                  \noexpand\thischapternum:
5693                                  \noexpand\thischaptername}%
5694     }%
5695   \else
5696     \toks0={#1}%
5697     \xdef\lastchapterdefs{%
5698       \gdef\noexpand\thischaptername{\the\toks0}%
5699       \gdef\noexpand\thischapternum{\the\chapno}%
5700       % \noexpand\putwordChapter avoids expanding indigestible
5701       % commands in some of the translations.
5702       \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5703                                  \noexpand\thischapternum:
5704                                  \noexpand\thischaptername}%
5705     }%
5706   \fi\fi\fi
5707   %
5708   % Output the mark.  Pass it through \safewhatsit, to take care of
5709   % the preceding space.
5710   \safewhatsit\domark
5711   %
5712   % Insert the chapter heading break.
5713   \pchapsepmacro
5714   %
5715   % Now the second mark, after the heading break.  No break points
5716   % between here and the heading.
5717   \let\prevchapterdefs=\lastchapterdefs
5718   \let\prevsectiondefs=\lastsectiondefs
5719   \domark
5720   %
5721   {%
5722     \chapfonts \rmisbold
5723     %
5724     % Have to define \lastsection before calling \donoderef, because the
5725     % xref code eventually uses it.  On the other hand, it has to be called
5726     % after \pchapsepmacro, or the headline will change too soon.
5727     \gdef\lastsection{#1}%
5728     %
5729     % Only insert the separating space if we have a chapter/appendix
5730     % number, and don't print the unnumbered ``number''.
5731     \ifx\temptype\Ynothingkeyword
5732       \setbox0 = \hbox{}%
5733       \def\toctype{unnchap}%
5734     \else\ifx\temptype\Yomitfromtockeyword
5735       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5736       \def\toctype{omit}%
5737     \else\ifx\temptype\Yappendixkeyword
5738       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5739       \def\toctype{app}%
5740     \else
5741       \setbox0 = \hbox{#3\enspace}%
5742       \def\toctype{numchap}%
5743     \fi\fi\fi
5744     %
5745     % Write the toc entry for this chapter.  Must come before the
5746     % \donoderef, because we include the current node name in the toc
5747     % entry, and \donoderef resets it to empty.
5748     \writetocentry{\toctype}{#1}{#3}%
5749     %
5750     % For pdftex, we have to write out the node definition (aka, make
5751     % the pdfdest) after any page break, but before the actual text has
5752     % been typeset.  If the destination for the pdf outline is after the
5753     % text, then jumping from the outline may wind up with the text not
5754     % being visible, for instance under high magnification.
5755     \donoderef{#2}%
5756     %
5757     % Typeset the actual heading.
5758     \nobreak % Avoid page breaks at the interline glue.
5759     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5760           \hangindent=\wd0 \centerparametersmaybe
5761           \unhbox0 #1\par}%
5762   }%
5763   \nobreak\bigskip % no page break after a chapter title
5764   \nobreak
5765 }
5766
5767 % @centerchap -- centered and unnumbered.
5768 \let\centerparametersmaybe = \relax
5769 \def\centerparameters{%
5770   \advance\rightskip by 3\rightskip
5771   \leftskip = \rightskip
5772   \parfillskip = 0pt
5773 }
5774
5775
5776 % I don't think this chapter style is supported any more, so I'm not
5777 % updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
5778 %
5779 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5780 %
5781 \def\unnchfopen #1{%
5782 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5783                        \parindent=0pt\ptexraggedright
5784                        \rmisbold #1\hfill}}\bigskip \par\nobreak
5785 }
5786 \def\chfopen #1#2{\chapoddpage {\chapfonts
5787 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5788 \par\penalty 5000 %
5789 }
5790 \def\centerchfopen #1{%
5791 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5792                        \parindent=0pt
5793                        \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5794 }
5795 \def\CHAPFopen{%
5796   \global\let\chapmacro=\chfopen
5797   \global\let\centerchapmacro=\centerchfopen}
5798
5799
5800 % Section titles.  These macros combine the section number parts and
5801 % call the generic \sectionheading to do the printing.
5802 %
5803 \newskip\secheadingskip
5804 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5805
5806 % Subsection titles.
5807 \newskip\subsecheadingskip
5808 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5809
5810 % Subsubsection titles.
5811 \def\subsubsecheadingskip{\subsecheadingskip}
5812 \def\subsubsecheadingbreak{\subsecheadingbreak}
5813
5814
5815 % Print any size, any type, section title.
5816 %
5817 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5818 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5819 % section number.
5820 %
5821 \def\seckeyword{sec}
5822 %
5823 \def\sectionheading#1#2#3#4{%
5824   {%
5825     \checkenv{}% should not be in an environment.
5826     %
5827     % Switch to the right set of fonts.
5828     \csname #2fonts\endcsname \rmisbold
5829     %
5830     \def\sectionlevel{#2}%
5831     \def\temptype{#3}%
5832     %
5833     % Insert first mark before the heading break (see notes for \domark).
5834     \let\prevsectiondefs=\lastsectiondefs
5835     \ifx\temptype\Ynothingkeyword
5836       \ifx\sectionlevel\seckeyword
5837         \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5838                               \gdef\thissection{\thissectionname}}%
5839       \fi
5840     \else\ifx\temptype\Yomitfromtockeyword
5841       % Don't redefine \thissection.
5842     \else\ifx\temptype\Yappendixkeyword
5843       \ifx\sectionlevel\seckeyword
5844         \toks0={#1}%
5845         \xdef\lastsectiondefs{%
5846           \gdef\noexpand\thissectionname{\the\toks0}%
5847           \gdef\noexpand\thissectionnum{#4}%
5848           % \noexpand\putwordSection avoids expanding indigestible
5849           % commands in some of the translations.
5850           \gdef\noexpand\thissection{\noexpand\putwordSection{}
5851                                      \noexpand\thissectionnum:
5852                                      \noexpand\thissectionname}%
5853         }%
5854       \fi
5855     \else
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     \fi\fi\fi
5869     %
5870     % Go into vertical mode.  Usually we'll already be there, but we
5871     % don't want the following whatsit to end up in a preceding paragraph
5872     % if the document didn't happen to have a blank line.
5873     \par
5874     %
5875     % Output the mark.  Pass it through \safewhatsit, to take care of
5876     % the preceding space.
5877     \safewhatsit\domark
5878     %
5879     % Insert space above the heading.
5880     \csname #2headingbreak\endcsname
5881     %
5882     % Now the second mark, after the heading break.  No break points
5883     % between here and the heading.
5884     \let\prevsectiondefs=\lastsectiondefs
5885     \domark
5886     %
5887     % Only insert the space after the number if we have a section number.
5888     \ifx\temptype\Ynothingkeyword
5889       \setbox0 = \hbox{}%
5890       \def\toctype{unn}%
5891       \gdef\lastsection{#1}%
5892     \else\ifx\temptype\Yomitfromtockeyword
5893       % for @headings -- no section number, don't include in toc,
5894       % and don't redefine \lastsection.
5895       \setbox0 = \hbox{}%
5896       \def\toctype{omit}%
5897       \let\sectionlevel=\empty
5898     \else\ifx\temptype\Yappendixkeyword
5899       \setbox0 = \hbox{#4\enspace}%
5900       \def\toctype{app}%
5901       \gdef\lastsection{#1}%
5902     \else
5903       \setbox0 = \hbox{#4\enspace}%
5904       \def\toctype{num}%
5905       \gdef\lastsection{#1}%
5906     \fi\fi\fi
5907     %
5908     % Write the toc entry (before \donoderef).  See comments in \chapmacro.
5909     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5910     %
5911     % Write the node reference (= pdf destination for pdftex).
5912     % Again, see comments in \chapmacro.
5913     \donoderef{#3}%
5914     %
5915     % Interline glue will be inserted when the vbox is completed.
5916     % That glue will be a valid breakpoint for the page, since it'll be
5917     % preceded by a whatsit (usually from the \donoderef, or from the
5918     % \writetocentry if there was no node).  We don't want to allow that
5919     % break, since then the whatsits could end up on page n while the
5920     % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
5921     \nobreak
5922     %
5923     % Output the actual section heading.
5924     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5925           \hangindent=\wd0  % zero if no section number
5926           \unhbox0 #1}%
5927   }%
5928   % Add extra space after the heading -- half of whatever came above it.
5929   % Don't allow stretch, though.
5930   \kern .5 \csname #2headingskip\endcsname
5931   %
5932   % Do not let the kern be a potential breakpoint, as it would be if it
5933   % was followed by glue.
5934   \nobreak
5935   %
5936   % We'll almost certainly start a paragraph next, so don't let that
5937   % glue accumulate.  (Not a breakpoint because it's preceded by a
5938   % discardable item.)  However, when a paragraph is not started next
5939   % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5940   % or the negative glue will cause weirdly wrong output, typically
5941   % obscuring the section heading with something else.
5942   \vskip-\parskip
5943   %
5944   % This is so the last item on the main vertical list is a known
5945   % \penalty > 10000, so \startdefun, etc., can recognize the situation
5946   % and do the needful.
5947   \penalty 10001
5948 }
5949
5950
5951 \message{toc,}
5952 % Table of contents.
5953 \newwrite\tocfile
5954
5955 % Write an entry to the toc file, opening it if necessary.
5956 % Called from @chapter, etc.
5957 %
5958 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5959 % We append the current node name (if any) and page number as additional
5960 % arguments for the \{chap,sec,...}entry macros which will eventually
5961 % read this.  The node name is used in the pdf outlines as the
5962 % destination to jump to.
5963 %
5964 % We open the .toc file for writing here instead of at @setfilename (or
5965 % any other fixed time) so that @contents can be anywhere in the document.
5966 % But if #1 is `omit', then we don't do anything.  This is used for the
5967 % table of contents chapter openings themselves.
5968 %
5969 \newif\iftocfileopened
5970 \def\omitkeyword{omit}%
5971 %
5972 \def\writetocentry#1#2#3{%
5973   \edef\writetoctype{#1}%
5974   \ifx\writetoctype\omitkeyword \else
5975     \iftocfileopened\else
5976       \immediate\openout\tocfile = \jobname.toc
5977       \global\tocfileopenedtrue
5978     \fi
5979     %
5980     \iflinks
5981       {\atdummies
5982        \edef\temp{%
5983          \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5984        \temp
5985       }%
5986     \fi
5987   \fi
5988   %
5989   % Tell \shipout to create a pdf destination on each page, if we're
5990   % writing pdf.  These are used in the table of contents.  We can't
5991   % just write one on every page because the title pages are numbered
5992   % 1 and 2 (the page numbers aren't printed), and so are the first
5993   % two pages of the document.  Thus, we'd have two destinations named
5994   % `1', and two named `2'.
5995   \ifpdf \global\pdfmakepagedesttrue \fi
5996 }
5997
5998
5999 % These characters do not print properly in the Computer Modern roman
6000 % fonts, so we must take special care.  This is more or less redundant
6001 % with the Texinfo input format setup at the end of this file.
6002 %
6003 \def\activecatcodes{%
6004   \catcode`\"=\active
6005   \catcode`\$=\active
6006   \catcode`\<=\active
6007   \catcode`\>=\active
6008   \catcode`\\=\active
6009   \catcode`\^=\active
6010   \catcode`\_=\active
6011   \catcode`\|=\active
6012   \catcode`\~=\active
6013 }
6014
6015
6016 % Read the toc file, which is essentially Texinfo input.
6017 \def\readtocfile{%
6018   \setupdatafile
6019   \activecatcodes
6020   \input \tocreadfilename
6021 }
6022
6023 \newskip\contentsrightmargin \contentsrightmargin=1in
6024 \newcount\savepageno
6025 \newcount\lastnegativepageno \lastnegativepageno = -1
6026
6027 % Prepare to read what we've written to \tocfile.
6028 %
6029 \def\startcontents#1{%
6030   % If @setchapternewpage on, and @headings double, the contents should
6031   % start on an odd page, unlike chapters.  Thus, we maintain
6032   % \contentsalignmacro in parallel with \pagealignmacro.
6033   % From: Torbjorn Granlund <tege@matematik.su.se>
6034   \contentsalignmacro
6035   \immediate\closeout\tocfile
6036   %
6037   % Don't need to put `Contents' or `Short Contents' in the headline.
6038   % It is abundantly clear what they are.
6039   \chapmacro{#1}{Yomitfromtoc}{}%
6040   %
6041   \savepageno = \pageno
6042   \begingroup                  % Set up to handle contents files properly.
6043     \raggedbottom              % Worry more about breakpoints than the bottom.
6044     \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6045     %
6046     % Roman numerals for page numbers.
6047     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6048 }
6049
6050 % redefined for the two-volume lispref.  We always output on
6051 % \jobname.toc even if this is redefined.
6052 %
6053 \def\tocreadfilename{\jobname.toc}
6054
6055 % Normal (long) toc.
6056 %
6057 \def\contents{%
6058   \startcontents{\putwordTOC}%
6059     \openin 1 \tocreadfilename\space
6060     \ifeof 1 \else
6061       \readtocfile
6062     \fi
6063     \vfill \eject
6064     \contentsalignmacro % in case @setchapternewpage odd is in effect
6065     \ifeof 1 \else
6066       \pdfmakeoutlines
6067     \fi
6068     \closein 1
6069   \endgroup
6070   \lastnegativepageno = \pageno
6071   \global\pageno = \savepageno
6072 }
6073
6074 % And just the chapters.
6075 \def\summarycontents{%
6076   \startcontents{\putwordShortTOC}%
6077     %
6078     \let\partentry = \shortpartentry
6079     \let\numchapentry = \shortchapentry
6080     \let\appentry = \shortchapentry
6081     \let\unnchapentry = \shortunnchapentry
6082     % We want a true roman here for the page numbers.
6083     \secfonts
6084     \let\rm=\shortcontrm \let\bf=\shortcontbf
6085     \let\sl=\shortcontsl \let\tt=\shortconttt
6086     \rm
6087     \hyphenpenalty = 10000
6088     \advance\baselineskip by 1pt % Open it up a little.
6089     \def\numsecentry##1##2##3##4{}
6090     \let\appsecentry = \numsecentry
6091     \let\unnsecentry = \numsecentry
6092     \let\numsubsecentry = \numsecentry
6093     \let\appsubsecentry = \numsecentry
6094     \let\unnsubsecentry = \numsecentry
6095     \let\numsubsubsecentry = \numsecentry
6096     \let\appsubsubsecentry = \numsecentry
6097     \let\unnsubsubsecentry = \numsecentry
6098     \openin 1 \tocreadfilename\space
6099     \ifeof 1 \else
6100       \readtocfile
6101     \fi
6102     \closein 1
6103     \vfill \eject
6104     \contentsalignmacro % in case @setchapternewpage odd is in effect
6105   \endgroup
6106   \lastnegativepageno = \pageno
6107   \global\pageno = \savepageno
6108 }
6109 \let\shortcontents = \summarycontents
6110
6111 % Typeset the label for a chapter or appendix for the short contents.
6112 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6113 %
6114 \def\shortchaplabel#1{%
6115   % This space should be enough, since a single number is .5em, and the
6116   % widest letter (M) is 1em, at least in the Computer Modern fonts.
6117   % But use \hss just in case.
6118   % (This space doesn't include the extra space that gets added after
6119   % the label; that gets put in by \shortchapentry above.)
6120   %
6121   % We'd like to right-justify chapter numbers, but that looks strange
6122   % with appendix letters.  And right-justifying numbers and
6123   % left-justifying letters looks strange when there is less than 10
6124   % chapters.  Have to read the whole toc once to know how many chapters
6125   % there are before deciding ...
6126   \hbox to 1em{#1\hss}%
6127 }
6128
6129 % These macros generate individual entries in the table of contents.
6130 % The first argument is the chapter or section name.
6131 % The last argument is the page number.
6132 % The arguments in between are the chapter number, section number, ...
6133
6134 % Parts, in the main contents.  Replace the part number, which doesn't
6135 % exist, with an empty box.  Let's hope all the numbers have the same width.
6136 % Also ignore the page number, which is conventionally not printed.
6137 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6138 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6139 %
6140 % Parts, in the short toc.
6141 \def\shortpartentry#1#2#3#4{%
6142   \penalty-300
6143   \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6144   \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6145 }
6146
6147 % Chapters, in the main contents.
6148 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6149 %
6150 % Chapters, in the short toc.
6151 % See comments in \dochapentry re vbox and related settings.
6152 \def\shortchapentry#1#2#3#4{%
6153   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6154 }
6155
6156 % Appendices, in the main contents.
6157 % Need the word Appendix, and a fixed-size box.
6158 %
6159 \def\appendixbox#1{%
6160   % We use M since it's probably the widest letter.
6161   \setbox0 = \hbox{\putwordAppendix{} M}%
6162   \hbox to \wd0{\putwordAppendix{} #1\hss}}
6163 %
6164 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6165
6166 % Unnumbered chapters.
6167 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6168 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6169
6170 % Sections.
6171 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6172 \let\appsecentry=\numsecentry
6173 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6174
6175 % Subsections.
6176 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6177 \let\appsubsecentry=\numsubsecentry
6178 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6179
6180 % And subsubsections.
6181 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6182 \let\appsubsubsecentry=\numsubsubsecentry
6183 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6184
6185 % This parameter controls the indentation of the various levels.
6186 % Same as \defaultparindent.
6187 \newdimen\tocindent \tocindent = 15pt
6188
6189 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6190 % page number.
6191 %
6192 % If the toc has to be broken over pages, we want it to be at chapters
6193 % if at all possible; hence the \penalty.
6194 \def\dochapentry#1#2{%
6195    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6196    \begingroup
6197      \chapentryfonts
6198      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6199    \endgroup
6200    \nobreak\vskip .25\baselineskip plus.1\baselineskip
6201 }
6202
6203 \def\dosecentry#1#2{\begingroup
6204   \secentryfonts \leftskip=\tocindent
6205   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6206 \endgroup}
6207
6208 \def\dosubsecentry#1#2{\begingroup
6209   \subsecentryfonts \leftskip=2\tocindent
6210   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6211 \endgroup}
6212
6213 \def\dosubsubsecentry#1#2{\begingroup
6214   \subsubsecentryfonts \leftskip=3\tocindent
6215   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6216 \endgroup}
6217
6218 % We use the same \entry macro as for the index entries.
6219 \let\tocentry = \entry
6220
6221 % Space between chapter (or whatever) number and the title.
6222 \def\labelspace{\hskip1em \relax}
6223
6224 \def\dopageno#1{{\rm #1}}
6225 \def\doshortpageno#1{{\rm #1}}
6226
6227 \def\chapentryfonts{\secfonts \rm}
6228 \def\secentryfonts{\textfonts}
6229 \def\subsecentryfonts{\textfonts}
6230 \def\subsubsecentryfonts{\textfonts}
6231
6232
6233 \message{environments,}
6234 % @foo ... @end foo.
6235
6236 % @tex ... @end tex    escapes into raw TeX temporarily.
6237 % One exception: @ is still an escape character, so that @end tex works.
6238 % But \@ or @@ will get a plain @ character.
6239
6240 \envdef\tex{%
6241   \setupmarkupstyle{tex}%
6242   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6243   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6244   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6245   \catcode `\%=14
6246   \catcode `\+=\other
6247   \catcode `\"=\other
6248   \catcode `\|=\other
6249   \catcode `\<=\other
6250   \catcode `\>=\other
6251   \catcode`\`=\other
6252   \catcode`\'=\other
6253   \escapechar=`\\
6254   %
6255   % ' is active in math mode (mathcode"8000).  So reset it, and all our
6256   % other math active characters (just in case), to plain's definitions.
6257   \mathactive
6258   %
6259   \let\b=\ptexb
6260   \let\bullet=\ptexbullet
6261   \let\c=\ptexc
6262   \let\,=\ptexcomma
6263   \let\.=\ptexdot
6264   \let\dots=\ptexdots
6265   \let\equiv=\ptexequiv
6266   \let\!=\ptexexclam
6267   \let\i=\ptexi
6268   \let\indent=\ptexindent
6269   \let\noindent=\ptexnoindent
6270   \let\{=\ptexlbrace
6271   \let\+=\tabalign
6272   \let\}=\ptexrbrace
6273   \let\/=\ptexslash
6274   \let\*=\ptexstar
6275   \let\t=\ptext
6276   \expandafter \let\csname top\endcsname=\ptextop  % outer
6277   \let\frenchspacing=\plainfrenchspacing
6278   %
6279   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6280   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6281   \def\@{@}%
6282 }
6283 % There is no need to define \Etex.
6284
6285 % Define @lisp ... @end lisp.
6286 % @lisp environment forms a group so it can rebind things,
6287 % including the definition of @end lisp (which normally is erroneous).
6288
6289 % Amount to narrow the margins by for @lisp.
6290 \newskip\lispnarrowing \lispnarrowing=0.4in
6291
6292 % This is the definition that ^^M gets inside @lisp, @example, and other
6293 % such environments.  \null is better than a space, since it doesn't
6294 % have any width.
6295 \def\lisppar{\null\endgraf}
6296
6297 % This space is always present above and below environments.
6298 \newskip\envskipamount \envskipamount = 0pt
6299
6300 % Make spacing and below environment symmetrical.  We use \parskip here
6301 % to help in doing that, since in @example-like environments \parskip
6302 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6303 % start of the next paragraph will insert \parskip.
6304 %
6305 \def\aboveenvbreak{{%
6306   % =10000 instead of <10000 because of a special case in \itemzzz and
6307   % \sectionheading, q.v.
6308   \ifnum \lastpenalty=10000 \else
6309     \advance\envskipamount by \parskip
6310     \endgraf
6311     \ifdim\lastskip<\envskipamount
6312       \removelastskip
6313       % it's not a good place to break if the last penalty was \nobreak
6314       % or better ...
6315       \ifnum\lastpenalty<10000 \penalty-50 \fi
6316       \vskip\envskipamount
6317     \fi
6318   \fi
6319 }}
6320
6321 \let\afterenvbreak = \aboveenvbreak
6322
6323 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
6324 % also clear it, so that its embedded environments do the narrowing again.
6325 \let\nonarrowing=\relax
6326
6327 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6328 % environment contents.
6329 \font\circle=lcircle10
6330 \newdimen\circthick
6331 \newdimen\cartouter\newdimen\cartinner
6332 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6333 \circthick=\fontdimen8\circle
6334 %
6335 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6336 \def\ctr{{\hskip 6pt\circle\char'010}}
6337 \def\cbl{{\circle\char'012\hskip -6pt}}
6338 \def\cbr{{\hskip 6pt\circle\char'011}}
6339 \def\carttop{\hbox to \cartouter{\hskip\lskip
6340         \ctl\leaders\hrule height\circthick\hfil\ctr
6341         \hskip\rskip}}
6342 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6343         \cbl\leaders\hrule height\circthick\hfil\cbr
6344         \hskip\rskip}}
6345 %
6346 \newskip\lskip\newskip\rskip
6347
6348 \envdef\cartouche{%
6349   \ifhmode\par\fi  % can't be in the midst of a paragraph.
6350   \startsavinginserts
6351   \lskip=\leftskip \rskip=\rightskip
6352   \leftskip=0pt\rightskip=0pt % we want these *outside*.
6353   \cartinner=\hsize \advance\cartinner by-\lskip
6354   \advance\cartinner by-\rskip
6355   \cartouter=\hsize
6356   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
6357                                 % side, and for 6pt waste from
6358                                 % each corner char, and rule thickness
6359   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6360   % Flag to tell @lisp, etc., not to narrow margin.
6361   \let\nonarrowing = t%
6362   %
6363   % If this cartouche directly follows a sectioning command, we need the
6364   % \parskip glue (backspaced over by default) or the cartouche can
6365   % collide with the section heading.
6366   \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6367   %
6368   \vbox\bgroup
6369       \baselineskip=0pt\parskip=0pt\lineskip=0pt
6370       \carttop
6371       \hbox\bgroup
6372           \hskip\lskip
6373           \vrule\kern3pt
6374           \vbox\bgroup
6375               \kern3pt
6376               \hsize=\cartinner
6377               \baselineskip=\normbskip
6378               \lineskip=\normlskip
6379               \parskip=\normpskip
6380               \vskip -\parskip
6381               \comment % For explanation, see the end of def\group.
6382 }
6383 \def\Ecartouche{%
6384               \ifhmode\par\fi
6385               \kern3pt
6386           \egroup
6387           \kern3pt\vrule
6388           \hskip\rskip
6389       \egroup
6390       \cartbot
6391   \egroup
6392   \checkinserts
6393 }
6394
6395
6396 % This macro is called at the beginning of all the @example variants,
6397 % inside a group.
6398 \newdimen\nonfillparindent
6399 \def\nonfillstart{%
6400   \aboveenvbreak
6401   \hfuzz = 12pt % Don't be fussy
6402   \sepspaces % Make spaces be word-separators rather than space tokens.
6403   \let\par = \lisppar % don't ignore blank lines
6404   \obeylines % each line of input is a line of output
6405   \parskip = 0pt
6406   % Turn off paragraph indentation but redefine \indent to emulate
6407   % the normal \indent.
6408   \nonfillparindent=\parindent
6409   \parindent = 0pt
6410   \let\indent\nonfillindent
6411   %
6412   \emergencystretch = 0pt % don't try to avoid overfull boxes
6413   \ifx\nonarrowing\relax
6414     \advance \leftskip by \lispnarrowing
6415     \exdentamount=\lispnarrowing
6416   \else
6417     \let\nonarrowing = \relax
6418   \fi
6419   \let\exdent=\nofillexdent
6420 }
6421
6422 \begingroup
6423 \obeyspaces
6424 % We want to swallow spaces (but not other tokens) after the fake
6425 % @indent in our nonfill-environments, where spaces are normally
6426 % active and set to @tie, resulting in them not being ignored after
6427 % @indent.
6428 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6429 \gdef\nonfillindentcheck{%
6430 \ifx\temp %
6431 \expandafter\nonfillindentgobble%
6432 \else%
6433 \leavevmode\nonfillindentbox%
6434 \fi%
6435 }%
6436 \endgroup
6437 \def\nonfillindentgobble#1{\nonfillindent}
6438 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6439
6440 % If you want all examples etc. small: @set dispenvsize small.
6441 % If you want even small examples the full size: @set dispenvsize nosmall.
6442 % This affects the following displayed environments:
6443 %    @example, @display, @format, @lisp
6444 %
6445 \def\smallword{small}
6446 \def\nosmallword{nosmall}
6447 \let\SETdispenvsize\relax
6448 \def\setnormaldispenv{%
6449   \ifx\SETdispenvsize\smallword
6450     % end paragraph for sake of leading, in case document has no blank
6451     % line.  This is redundant with what happens in \aboveenvbreak, but
6452     % we need to do it before changing the fonts, and it's inconvenient
6453     % to change the fonts afterward.
6454     \ifnum \lastpenalty=10000 \else \endgraf \fi
6455     \smallexamplefonts \rm
6456   \fi
6457 }
6458 \def\setsmalldispenv{%
6459   \ifx\SETdispenvsize\nosmallword
6460   \else
6461     \ifnum \lastpenalty=10000 \else \endgraf \fi
6462     \smallexamplefonts \rm
6463   \fi
6464 }
6465
6466 % We often define two environments, @foo and @smallfoo.
6467 % Let's do it in one command.  #1 is the env name, #2 the definition.
6468 \def\makedispenvdef#1#2{%
6469   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6470   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6471   \expandafter\let\csname E#1\endcsname \afterenvbreak
6472   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6473 }
6474
6475 % Define two environment synonyms (#1 and #2) for an environment.
6476 \def\maketwodispenvdef#1#2#3{%
6477   \makedispenvdef{#1}{#3}%
6478   \makedispenvdef{#2}{#3}%
6479 }
6480 %
6481 % @lisp: indented, narrowed, typewriter font;
6482 % @example: same as @lisp.
6483 %
6484 % @smallexample and @smalllisp: use smaller fonts.
6485 % Originally contributed by Pavel@xerox.
6486 %
6487 \maketwodispenvdef{lisp}{example}{%
6488   \nonfillstart
6489   \tt\setupmarkupstyle{example}%
6490   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6491   \gobble % eat return
6492 }
6493 % @display/@smalldisplay: same as @lisp except keep current font.
6494 %
6495 \makedispenvdef{display}{%
6496   \nonfillstart
6497   \gobble
6498 }
6499
6500 % @format/@smallformat: same as @display except don't narrow margins.
6501 %
6502 \makedispenvdef{format}{%
6503   \let\nonarrowing = t%
6504   \nonfillstart
6505   \gobble
6506 }
6507
6508 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6509 \envdef\flushleft{%
6510   \let\nonarrowing = t%
6511   \nonfillstart
6512   \gobble
6513 }
6514 \let\Eflushleft = \afterenvbreak
6515
6516 % @flushright.
6517 %
6518 \envdef\flushright{%
6519   \let\nonarrowing = t%
6520   \nonfillstart
6521   \advance\leftskip by 0pt plus 1fill\relax
6522   \gobble
6523 }
6524 \let\Eflushright = \afterenvbreak
6525
6526
6527 % @raggedright does more-or-less normal line breaking but no right
6528 % justification.  From plain.tex.
6529 \envdef\raggedright{%
6530   \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6531 }
6532 \let\Eraggedright\par
6533
6534 \envdef\raggedleft{%
6535   \parindent=0pt \leftskip0pt plus2em
6536   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6537   \hbadness=10000 % Last line will usually be underfull, so turn off
6538                   % badness reporting.
6539 }
6540 \let\Eraggedleft\par
6541
6542 \envdef\raggedcenter{%
6543   \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6544   \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6545   \hbadness=10000 % Last line will usually be underfull, so turn off
6546                   % badness reporting.
6547 }
6548 \let\Eraggedcenter\par
6549
6550
6551 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6552 % and narrows the margins.  We keep \parskip nonzero in general, since
6553 % we're doing normal filling.  So, when using \aboveenvbreak and
6554 % \afterenvbreak, temporarily make \parskip 0.
6555 %
6556 \makedispenvdef{quotation}{\quotationstart}
6557 %
6558 \def\quotationstart{%
6559   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6560   \parindent=0pt
6561   %
6562   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6563   \ifx\nonarrowing\relax
6564     \advance\leftskip by \lispnarrowing
6565     \advance\rightskip by \lispnarrowing
6566     \exdentamount = \lispnarrowing
6567   \else
6568     \let\nonarrowing = \relax
6569   \fi
6570   \parsearg\quotationlabel
6571 }
6572
6573 % We have retained a nonzero parskip for the environment, since we're
6574 % doing normal filling.
6575 %
6576 \def\Equotation{%
6577   \par
6578   \ifx\quotationauthor\thisisundefined\else
6579     % indent a bit.
6580     \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6581   \fi
6582   {\parskip=0pt \afterenvbreak}%
6583 }
6584 \def\Esmallquotation{\Equotation}
6585
6586 % If we're given an argument, typeset it in bold with a colon after.
6587 \def\quotationlabel#1{%
6588   \def\temp{#1}%
6589   \ifx\temp\empty \else
6590     {\bf #1: }%
6591   \fi
6592 }
6593
6594
6595 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6596 % If we want to allow any <char> as delimiter,
6597 % we need the curly braces so that makeinfo sees the @verb command, eg:
6598 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
6599 %
6600 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
6601 %
6602 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6603 % active too.  Otherwise, they get lost as the first character on a
6604 % verbatim line.
6605 \def\dospecials{%
6606   \do\ \do\\\do\{\do\}\do\$\do\&%
6607   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6608   \do\<\do\>\do\|\do\@\do+\do\"%
6609   % Don't do the quotes -- if we do, @set txicodequoteundirected and
6610   % @set txicodequotebacktick will not have effect on @verb and
6611   % @verbatim, and ?` and !` ligatures won't get disabled.
6612   %\do\`\do\'%
6613 }
6614 %
6615 % [Knuth] p. 380
6616 \def\uncatcodespecials{%
6617   \def\do##1{\catcode`##1=\other}\dospecials}
6618 %
6619 % Setup for the @verb command.
6620 %
6621 % Eight spaces for a tab
6622 \begingroup
6623   \catcode`\^^I=\active
6624   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6625 \endgroup
6626 %
6627 \def\setupverb{%
6628   \tt  % easiest (and conventionally used) font for verbatim
6629   \def\par{\leavevmode\endgraf}%
6630   \setupmarkupstyle{verb}%
6631   \tabeightspaces
6632   % Respect line breaks,
6633   % print special symbols as themselves, and
6634   % make each space count
6635   % must do in this order:
6636   \obeylines \uncatcodespecials \sepspaces
6637 }
6638
6639 % Setup for the @verbatim environment
6640 %
6641 % Real tab expansion.
6642 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6643 %
6644 % We typeset each line of the verbatim in an \hbox, so we can handle
6645 % tabs.  The \global is in case the verbatim line starts with an accent,
6646 % or some other command that starts with a begin-group.  Otherwise, the
6647 % entire \verbbox would disappear at the corresponding end-group, before
6648 % it is typeset.  Meanwhile, we can't have nested verbatim commands
6649 % (can we?), so the \global won't be overwriting itself.
6650 \newbox\verbbox
6651 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6652 %
6653 \begingroup
6654   \catcode`\^^I=\active
6655   \gdef\tabexpand{%
6656     \catcode`\^^I=\active
6657     \def^^I{\leavevmode\egroup
6658       \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6659       \divide\dimen\verbbox by\tabw
6660       \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6661       \advance\dimen\verbbox by\tabw  % advance to next multiple of \tabw
6662       \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6663     }%
6664   }
6665 \endgroup
6666
6667 % start the verbatim environment.
6668 \def\setupverbatim{%
6669   \let\nonarrowing = t%
6670   \nonfillstart
6671   \tt % easiest (and conventionally used) font for verbatim
6672   % The \leavevmode here is for blank lines.  Otherwise, we would
6673   % never \starttabox and the \egroup would end verbatim mode.
6674   \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6675   \tabexpand
6676   \setupmarkupstyle{verbatim}%
6677   % Respect line breaks,
6678   % print special symbols as themselves, and
6679   % make each space count.
6680   % Must do in this order:
6681   \obeylines \uncatcodespecials \sepspaces
6682   \everypar{\starttabbox}%
6683 }
6684
6685 % Do the @verb magic: verbatim text is quoted by unique
6686 % delimiter characters.  Before first delimiter expect a
6687 % right brace, after last delimiter expect closing brace:
6688 %
6689 %    \def\doverb'{'<char>#1<char>'}'{#1}
6690 %
6691 % [Knuth] p. 382; only eat outer {}
6692 \begingroup
6693   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6694   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6695 \endgroup
6696 %
6697 \def\verb{\begingroup\setupverb\doverb}
6698 %
6699 %
6700 % Do the @verbatim magic: define the macro \doverbatim so that
6701 % the (first) argument ends when '@end verbatim' is reached, ie:
6702 %
6703 %     \def\doverbatim#1@end verbatim{#1}
6704 %
6705 % For Texinfo it's a lot easier than for LaTeX,
6706 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6707 % we need not redefine '\', '{' and '}'.
6708 %
6709 % Inspired by LaTeX's verbatim command set [latex.ltx]
6710 %
6711 \begingroup
6712   \catcode`\ =\active
6713   \obeylines %
6714   % ignore everything up to the first ^^M, that's the newline at the end
6715   % of the @verbatim input line itself.  Otherwise we get an extra blank
6716   % line in the output.
6717   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6718   % We really want {...\end verbatim} in the body of the macro, but
6719   % without the active space; thus we have to use \xdef and \gobble.
6720 \endgroup
6721 %
6722 \envdef\verbatim{%
6723     \setupverbatim\doverbatim
6724 }
6725 \let\Everbatim = \afterenvbreak
6726
6727
6728 % @verbatiminclude FILE - insert text of file in verbatim environment.
6729 %
6730 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6731 %
6732 \def\doverbatiminclude#1{%
6733   {%
6734     \makevalueexpandable
6735     \setupverbatim
6736     \indexnofonts       % Allow `@@' and other weird things in file names.
6737     \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6738     \input #1
6739     \afterenvbreak
6740   }%
6741 }
6742
6743 % @copying ... @end copying.
6744 % Save the text away for @insertcopying later.
6745 %
6746 % We save the uninterpreted tokens, rather than creating a box.
6747 % Saving the text in a box would be much easier, but then all the
6748 % typesetting commands (@smallbook, font changes, etc.) have to be done
6749 % beforehand -- and a) we want @copying to be done first in the source
6750 % file; b) letting users define the frontmatter in as flexible order as
6751 % possible is very desirable.
6752 %
6753 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6754 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6755 %
6756 \def\insertcopying{%
6757   \begingroup
6758     \parindent = 0pt  % paragraph indentation looks wrong on title page
6759     \scanexp\copyingtext
6760   \endgroup
6761 }
6762
6763
6764 \message{defuns,}
6765 % @defun etc.
6766
6767 \newskip\defbodyindent \defbodyindent=.4in
6768 \newskip\defargsindent \defargsindent=50pt
6769 \newskip\deflastargmargin \deflastargmargin=18pt
6770 \newcount\defunpenalty
6771
6772 % Start the processing of @deffn:
6773 \def\startdefun{%
6774   \ifnum\lastpenalty<10000
6775     \medbreak
6776     \defunpenalty=10003 % Will keep this @deffn together with the
6777                         % following @def command, see below.
6778   \else
6779     % If there are two @def commands in a row, we'll have a \nobreak,
6780     % which is there to keep the function description together with its
6781     % header.  But if there's nothing but headers, we need to allow a
6782     % break somewhere.  Check specifically for penalty 10002, inserted
6783     % by \printdefunline, instead of 10000, since the sectioning
6784     % commands also insert a nobreak penalty, and we don't want to allow
6785     % a break between a section heading and a defun.
6786     %
6787     % As a further refinement, we avoid "club" headers by signalling
6788     % with penalty of 10003 after the very first @deffn in the
6789     % sequence (see above), and penalty of 10002 after any following
6790     % @def command.
6791     \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6792     %
6793     % Similarly, after a section heading, do not allow a break.
6794     % But do insert the glue.
6795     \medskip  % preceded by discardable penalty, so not a breakpoint
6796   \fi
6797   %
6798   \parindent=0in
6799   \advance\leftskip by \defbodyindent
6800   \exdentamount=\defbodyindent
6801 }
6802
6803 \def\dodefunx#1{%
6804   % First, check whether we are in the right environment:
6805   \checkenv#1%
6806   %
6807   % As above, allow line break if we have multiple x headers in a row.
6808   % It's not a great place, though.
6809   \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6810   %
6811   % And now, it's time to reuse the body of the original defun:
6812   \expandafter\gobbledefun#1%
6813 }
6814 \def\gobbledefun#1\startdefun{}
6815
6816 % \printdefunline \deffnheader{text}
6817 %
6818 \def\printdefunline#1#2{%
6819   \begingroup
6820     % call \deffnheader:
6821     #1#2 \endheader
6822     % common ending:
6823     \interlinepenalty = 10000
6824     \advance\rightskip by 0pt plus 1fil\relax
6825     \endgraf
6826     \nobreak\vskip -\parskip
6827     \penalty\defunpenalty  % signal to \startdefun and \dodefunx
6828     % Some of the @defun-type tags do not enable magic parentheses,
6829     % rendering the following check redundant.  But we don't optimize.
6830     \checkparencounts
6831   \endgroup
6832 }
6833
6834 \def\Edefun{\endgraf\medbreak}
6835
6836 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6837 % the only thing remaining is to define \deffnheader.
6838 %
6839 \def\makedefun#1{%
6840   \expandafter\let\csname E#1\endcsname = \Edefun
6841   \edef\temp{\noexpand\domakedefun
6842     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6843   \temp
6844 }
6845
6846 % \domakedefun \deffn \deffnx \deffnheader
6847 %
6848 % Define \deffn and \deffnx, without parameters.
6849 % \deffnheader has to be defined explicitly.
6850 %
6851 \def\domakedefun#1#2#3{%
6852   \envdef#1{%
6853     \startdefun
6854     \doingtypefnfalse    % distinguish typed functions from all else
6855     \parseargusing\activeparens{\printdefunline#3}%
6856   }%
6857   \def#2{\dodefunx#1}%
6858   \def#3%
6859 }
6860
6861 \newif\ifdoingtypefn       % doing typed function?
6862 \newif\ifrettypeownline    % typeset return type on its own line?
6863
6864 % @deftypefnnewline on|off says whether the return type of typed functions
6865 % are printed on their own line.  This affects @deftypefn, @deftypefun,
6866 % @deftypeop, and @deftypemethod.
6867
6868 \parseargdef\deftypefnnewline{%
6869   \def\temp{#1}%
6870   \ifx\temp\onword
6871     \expandafter\let\csname SETtxideftypefnnl\endcsname
6872       = \empty
6873   \else\ifx\temp\offword
6874     \expandafter\let\csname SETtxideftypefnnl\endcsname
6875       = \relax
6876   \else
6877     \errhelp = \EMsimple
6878     \errmessage{Unknown @txideftypefnnl value `\temp',
6879                 must be on|off}%
6880   \fi\fi
6881 }
6882
6883 % Untyped functions:
6884
6885 % @deffn category name args
6886 \makedefun{deffn}{\deffngeneral{}}
6887
6888 % @deffn category class name args
6889 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6890
6891 % \defopon {category on}class name args
6892 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6893
6894 % \deffngeneral {subind}category name args
6895 %
6896 \def\deffngeneral#1#2 #3 #4\endheader{%
6897   % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6898   \dosubind{fn}{\code{#3}}{#1}%
6899   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6900 }
6901
6902 % Typed functions:
6903
6904 % @deftypefn category type name args
6905 \makedefun{deftypefn}{\deftypefngeneral{}}
6906
6907 % @deftypeop category class type name args
6908 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6909
6910 % \deftypeopon {category on}class type name args
6911 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6912
6913 % \deftypefngeneral {subind}category type name args
6914 %
6915 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6916   \dosubind{fn}{\code{#4}}{#1}%
6917   \doingtypefntrue
6918   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6919 }
6920
6921 % Typed variables:
6922
6923 % @deftypevr category type var args
6924 \makedefun{deftypevr}{\deftypecvgeneral{}}
6925
6926 % @deftypecv category class type var args
6927 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6928
6929 % \deftypecvof {category of}class type var args
6930 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6931
6932 % \deftypecvgeneral {subind}category type var args
6933 %
6934 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6935   \dosubind{vr}{\code{#4}}{#1}%
6936   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6937 }
6938
6939 % Untyped variables:
6940
6941 % @defvr category var args
6942 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6943
6944 % @defcv category class var args
6945 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6946
6947 % \defcvof {category of}class var args
6948 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6949
6950 % Types:
6951
6952 % @deftp category name args
6953 \makedefun{deftp}#1 #2 #3\endheader{%
6954   \doind{tp}{\code{#2}}%
6955   \defname{#1}{}{#2}\defunargs{#3\unskip}%
6956 }
6957
6958 % Remaining @defun-like shortcuts:
6959 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6960 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6961 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6962 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6963 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6964 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6965 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6966 \makedefun{defmethod}{\defopon\putwordMethodon}
6967 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6968 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6969 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6970
6971 % \defname, which formats the name of the @def (not the args).
6972 % #1 is the category, such as "Function".
6973 % #2 is the return type, if any.
6974 % #3 is the function name.
6975 %
6976 % We are followed by (but not passed) the arguments, if any.
6977 %
6978 \def\defname#1#2#3{%
6979   \par
6980   % Get the values of \leftskip and \rightskip as they were outside the @def...
6981   \advance\leftskip by -\defbodyindent
6982   %
6983   % Determine if we are typesetting the return type of a typed function
6984   % on a line by itself.
6985   \rettypeownlinefalse
6986   \ifdoingtypefn  % doing a typed function specifically?
6987     % then check user option for putting return type on its own line:
6988     \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
6989       \rettypeownlinetrue
6990     \fi
6991   \fi
6992   %
6993   % How we'll format the category name.  Putting it in brackets helps
6994   % distinguish it from the body text that may end up on the next line
6995   % just below it.
6996   \def\temp{#1}%
6997   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6998   %
6999   % Figure out line sizes for the paragraph shape.  We'll always have at
7000   % least two.
7001   \tempnum = 2
7002   %
7003   % The first line needs space for \box0; but if \rightskip is nonzero,
7004   % we need only space for the part of \box0 which exceeds it:
7005   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
7006   %
7007   % If doing a return type on its own line, we'll have another line.
7008   \ifrettypeownline
7009     \advance\tempnum by 1
7010     \def\maybeshapeline{0in \hsize}%
7011   \else
7012     \def\maybeshapeline{}%
7013   \fi
7014   %
7015   % The continuations:
7016   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
7017   %
7018   % The final paragraph shape:
7019   \parshape \tempnum  0in \dimen0  \maybeshapeline  \defargsindent \dimen2
7020   %
7021   % Put the category name at the right margin.
7022   \noindent
7023   \hbox to 0pt{%
7024     \hfil\box0 \kern-\hsize
7025     % \hsize has to be shortened this way:
7026     \kern\leftskip
7027     % Intentionally do not respect \rightskip, since we need the space.
7028   }%
7029   %
7030   % Allow all lines to be underfull without complaint:
7031   \tolerance=10000 \hbadness=10000
7032   \exdentamount=\defbodyindent
7033   {%
7034     % defun fonts. We use typewriter by default (used to be bold) because:
7035     % . we're printing identifiers, they should be in tt in principle.
7036     % . in languages with many accents, such as Czech or French, it's
7037     %   common to leave accents off identifiers.  The result looks ok in
7038     %   tt, but exceedingly strange in rm.
7039     % . we don't want -- and --- to be treated as ligatures.
7040     % . this still does not fix the ?` and !` ligatures, but so far no
7041     %   one has made identifiers using them :).
7042     \df \tt
7043     \def\temp{#2}% text of the return type
7044     \ifx\temp\empty\else
7045       \tclose{\temp}% typeset the return type
7046       \ifrettypeownline
7047         % put return type on its own line; prohibit line break following:
7048         \hfil\vadjust{\nobreak}\break  
7049       \else
7050         \space  % type on same line, so just followed by a space
7051       \fi
7052     \fi           % no return type
7053     #3% output function name
7054   }%
7055   {\rm\enskip}% hskip 0.5 em of \tenrm
7056   %
7057   \boldbrax
7058   % arguments will be output next, if any.
7059 }
7060
7061 % Print arguments in slanted roman (not ttsl), inconsistently with using
7062 % tt for the name.  This is because literal text is sometimes needed in
7063 % the argument list (groff manual), and ttsl and tt are not very
7064 % distinguishable.  Prevent hyphenation at `-' chars.
7065 %
7066 \def\defunargs#1{%
7067   % use sl by default (not ttsl),
7068   % tt for the names.
7069   \df \sl \hyphenchar\font=0
7070   %
7071   % On the other hand, if an argument has two dashes (for instance), we
7072   % want a way to get ttsl.  Let's try @var for that.
7073   \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7074   #1%
7075   \sl\hyphenchar\font=45
7076 }
7077
7078 % We want ()&[] to print specially on the defun line.
7079 %
7080 \def\activeparens{%
7081   \catcode`\(=\active \catcode`\)=\active
7082   \catcode`\[=\active \catcode`\]=\active
7083   \catcode`\&=\active
7084 }
7085
7086 % Make control sequences which act like normal parenthesis chars.
7087 \let\lparen = ( \let\rparen = )
7088
7089 % Be sure that we always have a definition for `(', etc.  For example,
7090 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7091 % so TeX would otherwise complain about undefined control sequence.
7092 {
7093   \activeparens
7094   \global\let(=\lparen \global\let)=\rparen
7095   \global\let[=\lbrack \global\let]=\rbrack
7096   \global\let& = \&
7097
7098   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7099   \gdef\magicamp{\let&=\amprm}
7100 }
7101
7102 \newcount\parencount
7103
7104 % If we encounter &foo, then turn on ()-hacking afterwards
7105 \newif\ifampseen
7106 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7107
7108 \def\parenfont{%
7109   \ifampseen
7110     % At the first level, print parens in roman,
7111     % otherwise use the default font.
7112     \ifnum \parencount=1 \rm \fi
7113   \else
7114     % The \sf parens (in \boldbrax) actually are a little bolder than
7115     % the contained text.  This is especially needed for [ and ] .
7116     \sf
7117   \fi
7118 }
7119 \def\infirstlevel#1{%
7120   \ifampseen
7121     \ifnum\parencount=1
7122       #1%
7123     \fi
7124   \fi
7125 }
7126 \def\bfafterword#1 {#1 \bf}
7127
7128 \def\opnr{%
7129   \global\advance\parencount by 1
7130   {\parenfont(}%
7131   \infirstlevel \bfafterword
7132 }
7133 \def\clnr{%
7134   {\parenfont)}%
7135   \infirstlevel \sl
7136   \global\advance\parencount by -1
7137 }
7138
7139 \newcount\brackcount
7140 \def\lbrb{%
7141   \global\advance\brackcount by 1
7142   {\bf[}%
7143 }
7144 \def\rbrb{%
7145   {\bf]}%
7146   \global\advance\brackcount by -1
7147 }
7148
7149 \def\checkparencounts{%
7150   \ifnum\parencount=0 \else \badparencount \fi
7151   \ifnum\brackcount=0 \else \badbrackcount \fi
7152 }
7153 % these should not use \errmessage; the glibc manual, at least, actually
7154 % has such constructs (when documenting function pointers).
7155 \def\badparencount{%
7156   \message{Warning: unbalanced parentheses in @def...}%
7157   \global\parencount=0
7158 }
7159 \def\badbrackcount{%
7160   \message{Warning: unbalanced square brackets in @def...}%
7161   \global\brackcount=0
7162 }
7163
7164
7165 \message{macros,}
7166 % @macro.
7167
7168 % To do this right we need a feature of e-TeX, \scantokens,
7169 % which we arrange to emulate with a temporary file in ordinary TeX.
7170 \ifx\eTeXversion\thisisundefined
7171   \newwrite\macscribble
7172   \def\scantokens#1{%
7173     \toks0={#1}%
7174     \immediate\openout\macscribble=\jobname.tmp
7175     \immediate\write\macscribble{\the\toks0}%
7176     \immediate\closeout\macscribble
7177     \input \jobname.tmp
7178   }
7179 \fi
7180
7181 \def\scanmacro#1{\begingroup
7182   \newlinechar`\^^M
7183   \let\xeatspaces\eatspaces
7184   %
7185   % Undo catcode changes of \startcontents and \doprintindex
7186   % When called from @insertcopying or (short)caption, we need active
7187   % backslash to get it printed correctly.  Previously, we had
7188   % \catcode`\\=\other instead.  We'll see whether a problem appears
7189   % with macro expansion.                               --kasal, 19aug04
7190   \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7191   %
7192   % ... and for \example:
7193   \spaceisspace
7194   %
7195   % The \empty here causes a following catcode 5 newline to be eaten as
7196   % part of reading whitespace after a control sequence.  It does not
7197   % eat a catcode 13 newline.  There's no good way to handle the two
7198   % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7199   % would then have different behavior).  See the Macro Details node in
7200   % the manual for the workaround we recommend for macros and
7201   % line-oriented commands.
7202   % 
7203   \scantokens{#1\empty}%
7204 \endgroup}
7205
7206 \def\scanexp#1{%
7207   \edef\temp{\noexpand\scanmacro{#1}}%
7208   \temp
7209 }
7210
7211 \newcount\paramno   % Count of parameters
7212 \newtoks\macname    % Macro name
7213 \newif\ifrecursive  % Is it recursive?
7214
7215 % List of all defined macros in the form
7216 %    \definedummyword\macro1\definedummyword\macro2...
7217 % Currently is also contains all @aliases; the list can be split
7218 % if there is a need.
7219 \def\macrolist{}
7220
7221 % Add the macro to \macrolist
7222 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7223 \def\addtomacrolistxxx#1{%
7224      \toks0 = \expandafter{\macrolist\definedummyword#1}%
7225      \xdef\macrolist{\the\toks0}%
7226 }
7227
7228 % Utility routines.
7229 % This does \let #1 = #2, with \csnames; that is,
7230 %   \let \csname#1\endcsname = \csname#2\endcsname
7231 % (except of course we have to play expansion games).
7232 %
7233 \def\cslet#1#2{%
7234   \expandafter\let
7235   \csname#1\expandafter\endcsname
7236   \csname#2\endcsname
7237 }
7238
7239 % Trim leading and trailing spaces off a string.
7240 % Concepts from aro-bend problem 15 (see CTAN).
7241 {\catcode`\@=11
7242 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7243 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7244 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7245 \def\unbrace#1{#1}
7246 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7247 }
7248
7249 % Trim a single trailing ^^M off a string.
7250 {\catcode`\^^M=\other \catcode`\Q=3%
7251 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7252 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7253 \gdef\eatcrb#1Q#2Q{#1}%
7254 }
7255
7256 % Macro bodies are absorbed as an argument in a context where
7257 % all characters are catcode 10, 11 or 12, except \ which is active
7258 % (as in normal texinfo). It is necessary to change the definition of \
7259 % to recognize macro arguments; this is the job of \mbodybackslash.
7260 %
7261 % Non-ASCII encodings make 8-bit characters active, so un-activate
7262 % them to avoid their expansion.  Must do this non-globally, to
7263 % confine the change to the current group.
7264 %
7265 % It's necessary to have hard CRs when the macro is executed. This is
7266 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7267 % body, and then making it the \newlinechar in \scanmacro.
7268 %
7269 \def\scanctxt{% used as subroutine
7270   \catcode`\"=\other
7271   \catcode`\+=\other
7272   \catcode`\<=\other
7273   \catcode`\>=\other
7274   \catcode`\@=\other
7275   \catcode`\^=\other
7276   \catcode`\_=\other
7277   \catcode`\|=\other
7278   \catcode`\~=\other
7279   \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7280 }
7281
7282 \def\scanargctxt{% used for copying and captions, not macros.
7283   \scanctxt
7284   \catcode`\\=\other
7285   \catcode`\^^M=\other
7286 }
7287
7288 \def\macrobodyctxt{% used for @macro definitions
7289   \scanctxt
7290   \catcode`\{=\other
7291   \catcode`\}=\other
7292   \catcode`\^^M=\other
7293   \usembodybackslash
7294 }
7295
7296 \def\macroargctxt{% used when scanning invocations
7297   \scanctxt
7298   \catcode`\\=0
7299 }
7300 % why catcode 0 for \ in the above?  To recognize \\ \{ \} as "escapes"
7301 % for the single characters \ { }.  Thus, we end up with the "commands"
7302 % that would be written @\ @{ @} in a Texinfo document.
7303
7304 % We already have @{ and @}.  For @\, we define it here, and only for
7305 % this purpose, to produce a typewriter backslash (so, the @\ that we
7306 % define for @math can't be used with @macro calls):
7307 %
7308 \def\\{\normalbackslash}%
7309
7310 % We would like to do this for \, too, since that is what makeinfo does.
7311 % But it is not possible, because Texinfo already has a command @, for a
7312 % cedilla accent.  Documents must use @comma{} instead.
7313 %
7314 % \anythingelse will almost certainly be an error of some kind.
7315
7316
7317 % \mbodybackslash is the definition of \ in @macro bodies.
7318 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7319 % where N is the macro parameter number.
7320 % We define \csname macarg.\endcsname to be \realbackslash, so
7321 % \\ in macro replacement text gets you a backslash.
7322 %
7323 {\catcode`@=0 @catcode`@\=@active
7324  @gdef@usembodybackslash{@let\=@mbodybackslash}
7325  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7326 }
7327 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7328
7329 \def\margbackslash#1{\char`\#1 }
7330
7331 \def\macro{\recursivefalse\parsearg\macroxxx}
7332 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7333
7334 \def\macroxxx#1{%
7335   \getargs{#1}% now \macname is the macname and \argl the arglist
7336   \ifx\argl\empty       % no arguments
7337      \paramno=0\relax
7338   \else
7339      \expandafter\parsemargdef \argl;%
7340      \if\paramno>256\relax
7341        \ifx\eTeXversion\thisisundefined
7342          \errhelp = \EMsimple
7343          \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7344        \fi
7345      \fi
7346   \fi
7347   \if1\csname ismacro.\the\macname\endcsname
7348      \message{Warning: redefining \the\macname}%
7349   \else
7350      \expandafter\ifx\csname \the\macname\endcsname \relax
7351      \else \errmessage{Macro name \the\macname\space already defined}\fi
7352      \global\cslet{macsave.\the\macname}{\the\macname}%
7353      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7354      \addtomacrolist{\the\macname}%
7355   \fi
7356   \begingroup \macrobodyctxt
7357   \ifrecursive \expandafter\parsermacbody
7358   \else \expandafter\parsemacbody
7359   \fi}
7360
7361 \parseargdef\unmacro{%
7362   \if1\csname ismacro.#1\endcsname
7363     \global\cslet{#1}{macsave.#1}%
7364     \global\expandafter\let \csname ismacro.#1\endcsname=0%
7365     % Remove the macro name from \macrolist:
7366     \begingroup
7367       \expandafter\let\csname#1\endcsname \relax
7368       \let\definedummyword\unmacrodo
7369       \xdef\macrolist{\macrolist}%
7370     \endgroup
7371   \else
7372     \errmessage{Macro #1 not defined}%
7373   \fi
7374 }
7375
7376 % Called by \do from \dounmacro on each macro.  The idea is to omit any
7377 % macro definitions that have been changed to \relax.
7378 %
7379 \def\unmacrodo#1{%
7380   \ifx #1\relax
7381     % remove this
7382   \else
7383     \noexpand\definedummyword \noexpand#1%
7384   \fi
7385 }
7386
7387 % This makes use of the obscure feature that if the last token of a
7388 % <parameter list> is #, then the preceding argument is delimited by
7389 % an opening brace, and that opening brace is not consumed.
7390 \def\getargs#1{\getargsxxx#1{}}
7391 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7392 \def\getmacname#1 #2\relax{\macname={#1}}
7393 \def\getmacargs#1{\def\argl{#1}}
7394
7395 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7396 \edef\texiatcatcode{\the\catcode`\@}
7397 \catcode `@=11\relax
7398
7399 % Parse the optional {params} list.  Set up \paramno and \paramlist
7400 % so \defmacro knows what to do.  Define \macarg.BLAH for each BLAH
7401 % in the params list to some hook where the argument si to be expanded.  If
7402 % there are less than 10 arguments that hook is to be replaced by ##N where N
7403 % is the position in that list, that is to say the macro arguments are to be
7404 % defined `a la TeX in the macro body.  
7405 %
7406 % That gets used by \mbodybackslash (above).
7407 %
7408 % We need to get `macro parameter char #' into several definitions.
7409 % The technique used is stolen from LaTeX: let \hash be something
7410 % unexpandable, insert that wherever you need a #, and then redefine
7411 % it to # just before using the token list produced.
7412 %
7413 % The same technique is used to protect \eatspaces till just before
7414 % the macro is used.
7415 %
7416 % If there are 10 or more arguments, a different technique is used, where the
7417 % hook remains in the body, and when macro is to be expanded the body is
7418 % processed again to replace the arguments.
7419 %
7420 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7421 % argument N value and then \edef  the body (nothing else will expand because of
7422 % the catcode regime underwhich the body was input).
7423 %
7424 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7425 % arguments, you need that no macro has more than 256 arguments, otherwise an
7426 % error is produced.
7427 \def\parsemargdef#1;{%
7428   \paramno=0\def\paramlist{}%
7429   \let\hash\relax
7430   \let\xeatspaces\relax
7431   \parsemargdefxxx#1,;,%
7432   % In case that there are 10 or more arguments we parse again the arguments
7433   % list to set new definitions for the \macarg.BLAH macros corresponding to
7434   % each BLAH argument. It was anyhow needed to parse already once this list
7435   % in order to count the arguments, and as macros with at most 9 arguments
7436   % are by far more frequent than macro with 10 or more arguments, defining
7437   % twice the \macarg.BLAH macros does not cost too much processing power.
7438   \ifnum\paramno<10\relax\else
7439     \paramno0\relax
7440     \parsemmanyargdef@@#1,;,% 10 or more arguments
7441   \fi
7442 }
7443 \def\parsemargdefxxx#1,{%
7444   \if#1;\let\next=\relax
7445   \else \let\next=\parsemargdefxxx
7446     \advance\paramno by 1
7447     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7448         {\xeatspaces{\hash\the\paramno}}%
7449     \edef\paramlist{\paramlist\hash\the\paramno,}%
7450   \fi\next}
7451
7452 \def\parsemmanyargdef@@#1,{%
7453   \if#1;\let\next=\relax
7454   \else 
7455     \let\next=\parsemmanyargdef@@
7456     \edef\tempb{\eatspaces{#1}}%
7457     \expandafter\def\expandafter\tempa
7458        \expandafter{\csname macarg.\tempb\endcsname}%
7459     % Note that we need some extra \noexpand\noexpand, this is because we
7460     % don't want \the  to be expanded in the \parsermacbody  as it uses an
7461     % \xdef .
7462     \expandafter\edef\tempa
7463       {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7464     \advance\paramno by 1\relax
7465   \fi\next}
7466
7467 % These two commands read recursive and nonrecursive macro bodies.
7468 % (They're different since rec and nonrec macros end differently.)
7469 %
7470
7471 \catcode `\@\texiatcatcode
7472 \long\def\parsemacbody#1@end macro%
7473 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7474 \long\def\parsermacbody#1@end rmacro%
7475 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7476 \catcode `\@=11\relax
7477
7478 \let\endargs@\relax
7479 \let\nil@\relax
7480 \def\nilm@{\nil@}%
7481 \long\def\nillm@{\nil@}%
7482
7483 % This macro is expanded during the Texinfo macro expansion, not during its
7484 % definition.  It gets all the arguments values and assigns them to macros
7485 % macarg.ARGNAME
7486 %
7487 % #1 is the macro name
7488 % #2 is the list of argument names
7489 % #3 is the list of argument values
7490 \def\getargvals@#1#2#3{%
7491   \def\macargdeflist@{}%
7492   \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7493   \def\paramlist{#2,\nil@}%
7494   \def\macroname{#1}%
7495   \begingroup
7496   \macroargctxt
7497   \def\argvaluelist{#3,\nil@}%
7498   \def\@tempa{#3}%
7499   \ifx\@tempa\empty
7500     \setemptyargvalues@
7501   \else
7502     \getargvals@@
7503   \fi
7504 }
7505
7506
7507 \def\getargvals@@{%
7508   \ifx\paramlist\nilm@
7509       % Some sanity check needed here that \argvaluelist is also empty.
7510       \ifx\argvaluelist\nillm@
7511       \else
7512         \errhelp = \EMsimple
7513         \errmessage{Too many arguments in macro `\macroname'!}%
7514       \fi
7515       \let\next\macargexpandinbody@
7516   \else
7517     \ifx\argvaluelist\nillm@
7518        % No more arguments values passed to macro.  Set remaining named-arg
7519        % macros to empty.
7520        \let\next\setemptyargvalues@
7521     \else
7522       % pop current arg name into \@tempb
7523       \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7524       \expandafter\@tempa\expandafter{\paramlist}%
7525        % pop current argument value into \@tempc
7526       \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7527       \expandafter\@tempa\expandafter{\argvaluelist}%
7528        % Here \@tempb is the current arg name and \@tempc is the current arg value.
7529        % First place the new argument macro definition into \@tempd
7530        \expandafter\macname\expandafter{\@tempc}%
7531        \expandafter\let\csname macarg.\@tempb\endcsname\relax
7532        \expandafter\def\expandafter\@tempe\expandafter{%
7533          \csname macarg.\@tempb\endcsname}%
7534        \edef\@tempd{\long\def\@tempe{\the\macname}}%
7535        \push@\@tempd\macargdeflist@
7536        \let\next\getargvals@@
7537     \fi
7538   \fi
7539   \next
7540 }
7541
7542 \def\push@#1#2{%
7543   \expandafter\expandafter\expandafter\def
7544   \expandafter\expandafter\expandafter#2%
7545   \expandafter\expandafter\expandafter{%
7546   \expandafter#1#2}%
7547 }
7548
7549 % Replace arguments by their values in the macro body, and place the result
7550 % in macro \@tempa
7551 \def\macvalstoargs@{%
7552   %  To do this we use the property that token registers that are \the'ed
7553   % within an \edef  expand only once. So we are going to place all argument
7554   % values into respective token registers.
7555   %
7556   % First we save the token context, and initialize argument numbering.
7557   \begingroup
7558     \paramno0\relax
7559     % Then, for each argument number #N, we place the corresponding argument
7560     % value into a new token list register \toks#N
7561     \expandafter\putargsintokens@\saveparamlist@,;,%
7562     % Then, we expand the body so that argument are replaced by their
7563     % values. The trick for values not to be expanded themselves is that they
7564     % are within tokens and that tokens expand only once in an \edef .
7565     \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7566     % Now we restore the token stack pointer to free the token list registers
7567     % which we have used, but we make sure that expanded body is saved after
7568     % group.
7569     \expandafter
7570   \endgroup
7571   \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7572   }
7573
7574 \def\macargexpandinbody@{% 
7575   %% Define the named-macro outside of this group and then close this group. 
7576   \expandafter
7577   \endgroup
7578   \macargdeflist@
7579   % First the replace in body the macro arguments by their values, the result
7580   % is in \@tempa .
7581   \macvalstoargs@
7582   % Then we point at the \norecurse or \gobble (for recursive) macro value
7583   % with \@tempb .
7584   \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7585   % Depending on whether it is recursive or not, we need some tailing
7586   % \egroup .
7587   \ifx\@tempb\gobble
7588      \let\@tempc\relax
7589   \else
7590      \let\@tempc\egroup
7591   \fi
7592   % And now we do the real job:
7593   \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7594   \@tempd
7595 }
7596
7597 \def\putargsintokens@#1,{%
7598   \if#1;\let\next\relax
7599   \else
7600     \let\next\putargsintokens@
7601     % First we allocate the new token list register, and give it a temporary
7602     % alias \@tempb .
7603     \toksdef\@tempb\the\paramno
7604     % Then we place the argument value into that token list register.
7605     \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7606     \expandafter\@tempb\expandafter{\@tempa}%
7607     \advance\paramno by 1\relax
7608   \fi
7609   \next
7610 }
7611
7612 % Save the token stack pointer into macro #1
7613 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7614 % Restore the token stack pointer from number in macro #1
7615 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7616 % newtoks that can be used non \outer .
7617 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7618
7619 % Tailing missing arguments are set to empty
7620 \def\setemptyargvalues@{%
7621   \ifx\paramlist\nilm@
7622     \let\next\macargexpandinbody@
7623   \else
7624     \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7625     \let\next\setemptyargvalues@
7626   \fi
7627   \next
7628 }
7629
7630 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7631   \expandafter\def\expandafter\@tempa\expandafter{%
7632     \expandafter\def\csname macarg.#1\endcsname{}}%
7633   \push@\@tempa\macargdeflist@
7634   \def\paramlist{#2}%
7635 }
7636
7637 % #1 is the element target macro
7638 % #2 is the list macro
7639 % #3,#4\endargs@ is the list value
7640 \def\pop@#1#2#3,#4\endargs@{%
7641    \def#1{#3}%
7642    \def#2{#4}%
7643 }
7644 \long\def\longpop@#1#2#3,#4\endargs@{%
7645    \long\def#1{#3}%
7646    \long\def#2{#4}%
7647 }
7648
7649 % This defines a Texinfo @macro. There are eight cases: recursive and
7650 % nonrecursive macros of zero, one, up to nine, and many arguments.
7651 % Much magic with \expandafter here.
7652 % \xdef is used so that macro definitions will survive the file
7653 % they're defined in; @include reads the file inside a group.
7654 %
7655 \def\defmacro{%
7656   \let\hash=##% convert placeholders to macro parameter chars
7657   \ifrecursive
7658     \ifcase\paramno
7659     % 0
7660       \expandafter\xdef\csname\the\macname\endcsname{%
7661         \noexpand\scanmacro{\temp}}%
7662     \or % 1
7663       \expandafter\xdef\csname\the\macname\endcsname{%
7664          \bgroup\noexpand\macroargctxt
7665          \noexpand\braceorline
7666          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7667       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7668          \egroup\noexpand\scanmacro{\temp}}%
7669     \else
7670       \ifnum\paramno<10\relax % at most 9
7671         \expandafter\xdef\csname\the\macname\endcsname{%
7672            \bgroup\noexpand\macroargctxt
7673            \noexpand\csname\the\macname xx\endcsname}%
7674         \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7675             \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7676         \expandafter\expandafter
7677         \expandafter\xdef
7678         \expandafter\expandafter
7679           \csname\the\macname xxx\endcsname
7680             \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7681       \else % 10 or more
7682         \expandafter\xdef\csname\the\macname\endcsname{%
7683           \noexpand\getargvals@{\the\macname}{\argl}%
7684         }%    
7685         \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7686         \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7687       \fi
7688     \fi
7689   \else
7690     \ifcase\paramno
7691     % 0
7692       \expandafter\xdef\csname\the\macname\endcsname{%
7693         \noexpand\norecurse{\the\macname}%
7694         \noexpand\scanmacro{\temp}\egroup}%
7695     \or % 1
7696       \expandafter\xdef\csname\the\macname\endcsname{%
7697          \bgroup\noexpand\macroargctxt
7698          \noexpand\braceorline
7699          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7700       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7701         \egroup
7702         \noexpand\norecurse{\the\macname}%
7703         \noexpand\scanmacro{\temp}\egroup}%
7704     \else % at most 9
7705       \ifnum\paramno<10\relax
7706         \expandafter\xdef\csname\the\macname\endcsname{%
7707            \bgroup\noexpand\macroargctxt
7708            \expandafter\noexpand\csname\the\macname xx\endcsname}%
7709         \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7710             \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7711         \expandafter\expandafter
7712         \expandafter\xdef
7713         \expandafter\expandafter
7714         \csname\the\macname xxx\endcsname
7715         \paramlist{%
7716             \egroup
7717             \noexpand\norecurse{\the\macname}%
7718             \noexpand\scanmacro{\temp}\egroup}%
7719       \else % 10 or more:
7720         \expandafter\xdef\csname\the\macname\endcsname{%
7721           \noexpand\getargvals@{\the\macname}{\argl}%
7722         }%
7723         \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7724         \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7725       \fi
7726     \fi
7727   \fi}
7728
7729 \catcode `\@\texiatcatcode\relax
7730
7731 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7732
7733 % \braceorline decides whether the next nonwhitespace character is a
7734 % {.  If so it reads up to the closing }, if not, it reads the whole
7735 % line.  Whatever was read is then fed to the next control sequence
7736 % as an argument (by \parsebrace or \parsearg).
7737
7738 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7739 \def\braceorlinexxx{%
7740   \ifx\nchar\bgroup\else
7741     \expandafter\parsearg
7742   \fi \macnamexxx}
7743
7744
7745 % @alias.
7746 % We need some trickery to remove the optional spaces around the equal
7747 % sign.  Make them active and then expand them all to nothing.
7748 %
7749 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7750 \def\aliasxxx #1{\aliasyyy#1\relax}
7751 \def\aliasyyy #1=#2\relax{%
7752   {%
7753     \expandafter\let\obeyedspace=\empty
7754     \addtomacrolist{#1}%
7755     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7756   }%
7757   \next
7758 }
7759
7760
7761 \message{cross references,}
7762
7763 \newwrite\auxfile
7764 \newif\ifhavexrefs    % True if xref values are known.
7765 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
7766
7767 % @inforef is relatively simple.
7768 \def\inforef #1{\inforefzzz #1,,,,**}
7769 \def\inforefzzz #1,#2,#3,#4**{%
7770   \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7771   node \samp{\ignorespaces#1{}}}
7772
7773 % @node's only job in TeX is to define \lastnode, which is used in
7774 % cross-references.  The @node line might or might not have commas, and
7775 % might or might not have spaces before the first comma, like:
7776 % @node foo , bar , ...
7777 % We don't want such trailing spaces in the node name.
7778 %
7779 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7780 %
7781 % also remove a trailing comma, in case of something like this:
7782 % @node Help-Cross,  ,  , Cross-refs
7783 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7784 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7785
7786 \let\nwnode=\node
7787 \let\lastnode=\empty
7788
7789 % Write a cross-reference definition for the current node.  #1 is the
7790 % type (Ynumbered, Yappendix, Ynothing).
7791 %
7792 \def\donoderef#1{%
7793   \ifx\lastnode\empty\else
7794     \setref{\lastnode}{#1}%
7795     \global\let\lastnode=\empty
7796   \fi
7797 }
7798
7799 % @anchor{NAME} -- define xref target at arbitrary point.
7800 %
7801 \newcount\savesfregister
7802 %
7803 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7804 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7805 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7806
7807 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7808 % anchor), which consists of three parts:
7809 % 1) NAME-title - the current sectioning name taken from \lastsection,
7810 %                 or the anchor name.
7811 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
7812 %                 empty for anchors.
7813 % 3) NAME-pg    - the page number.
7814 %
7815 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
7816 % floats, there is an additional part, which is not written here:
7817 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
7818 %
7819 \def\setref#1#2{%
7820   \pdfmkdest{#1}%
7821   \iflinks
7822     {%
7823       \atdummies  % preserve commands, but don't expand them
7824       \edef\writexrdef##1##2{%
7825         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7826           ##1}{##2}}% these are parameters of \writexrdef
7827       }%
7828       \toks0 = \expandafter{\lastsection}%
7829       \immediate \writexrdef{title}{\the\toks0 }%
7830       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7831       \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7832     }%
7833   \fi
7834 }
7835
7836 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7837 % automatically in xrefs, if the third arg is not explicitly specified.
7838 % This was provided as a "secret" @set xref-automatic-section-title
7839 % variable, now it's official.
7840
7841 \parseargdef\xrefautomaticsectiontitle{%
7842   \def\temp{#1}%
7843   \ifx\temp\onword
7844     \expandafter\let\csname SETxref-automatic-section-title\endcsname
7845       = \empty
7846   \else\ifx\temp\offword
7847     \expandafter\let\csname SETxref-automatic-section-title\endcsname
7848       = \relax
7849   \else
7850     \errhelp = \EMsimple
7851     \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7852                 must be on|off}%
7853   \fi\fi
7854 }
7855
7856\f
7857 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
7858 % the node name, #2 the name of the Info cross-reference, #3 the printed
7859 % node name, #4 the name of the Info file, #5 the name of the printed
7860 % manual.  All but the node name can be omitted.
7861 %
7862 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7863 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7864 \def\ref#1{\xrefX[#1,,,,,,,]}
7865 %
7866 \newbox\toprefbox
7867 \newbox\printedrefnamebox
7868 \newbox\infofilenamebox
7869 \newbox\printedmanualbox
7870 %
7871 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7872   \unsepspaces
7873   %
7874   % Get args without leading/trailing spaces.
7875   \def\printedrefname{\ignorespaces #3}%
7876   \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7877   %
7878   \def\infofilename{\ignorespaces #4}%
7879   \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7880   %
7881   \def\printedmanual{\ignorespaces #5}%
7882   \setbox\printedmanualbox  = \hbox{\printedmanual\unskip}%
7883   %
7884   % If the printed reference name (arg #3) was not explicitly given in
7885   % the @xref, figure out what we want to use.
7886   \ifdim \wd\printedrefnamebox = 0pt
7887     % No printed node name was explicitly given.
7888     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7889       % Not auto section-title: use node name inside the square brackets.
7890       \def\printedrefname{\ignorespaces #1}%
7891     \else
7892       % Auto section-title: use chapter/section title inside
7893       % the square brackets if we have it.
7894       \ifdim \wd\printedmanualbox > 0pt
7895         % It is in another manual, so we don't have it; use node name.
7896         \def\printedrefname{\ignorespaces #1}%
7897       \else
7898         \ifhavexrefs
7899           % We (should) know the real title if we have the xref values.
7900           \def\printedrefname{\refx{#1-title}{}}%
7901         \else
7902           % Otherwise just copy the Info node name.
7903           \def\printedrefname{\ignorespaces #1}%
7904         \fi%
7905       \fi
7906     \fi
7907   \fi
7908   %
7909   % Make link in pdf output.
7910   \ifpdf
7911     {\indexnofonts
7912      \turnoffactive
7913      \makevalueexpandable
7914      % This expands tokens, so do it after making catcode changes, so _
7915      % etc. don't get their TeX definitions.  This ignores all spaces in
7916      % #4, including (wrongly) those in the middle of the filename.
7917      \getfilename{#4}%
7918      %
7919      % This (wrongly) does not take account of leading or trailing
7920      % spaces in #1, which should be ignored.
7921      \edef\pdfxrefdest{#1}%
7922      \ifx\pdfxrefdest\empty
7923        \def\pdfxrefdest{Top}% no empty targets
7924      \else
7925        \txiescapepdf\pdfxrefdest  % escape PDF special chars
7926      \fi
7927      %
7928      \leavevmode
7929      \startlink attr{/Border [0 0 0]}%
7930      \ifnum\filenamelength>0
7931        goto file{\the\filename.pdf} name{\pdfxrefdest}%
7932      \else
7933        goto name{\pdfmkpgn{\pdfxrefdest}}%
7934      \fi
7935     }%
7936     \setcolor{\linkcolor}%
7937   \fi
7938   %
7939   % Float references are printed completely differently: "Figure 1.2"
7940   % instead of "[somenode], p.3".  We distinguish them by the
7941   % LABEL-title being set to a magic string.
7942   {%
7943     % Have to otherify everything special to allow the \csname to
7944     % include an _ in the xref name, etc.
7945     \indexnofonts
7946     \turnoffactive
7947     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7948       \csname XR#1-title\endcsname
7949   }%
7950   \iffloat\Xthisreftitle
7951     % If the user specified the print name (third arg) to the ref,
7952     % print it instead of our usual "Figure 1.2".
7953     \ifdim\wd\printedrefnamebox = 0pt
7954       \refx{#1-snt}{}%
7955     \else
7956       \printedrefname
7957     \fi
7958     %
7959     % If the user also gave the printed manual name (fifth arg), append
7960     % "in MANUALNAME".
7961     \ifdim \wd\printedmanualbox > 0pt
7962       \space \putwordin{} \cite{\printedmanual}%
7963     \fi
7964   \else
7965     % node/anchor (non-float) references.
7966     % 
7967     % If we use \unhbox to print the node names, TeX does not insert
7968     % empty discretionaries after hyphens, which means that it will not
7969     % find a line break at a hyphen in a node names.  Since some manuals
7970     % are best written with fairly long node names, containing hyphens,
7971     % this is a loss.  Therefore, we give the text of the node name
7972     % again, so it is as if TeX is seeing it for the first time.
7973     % 
7974     \ifdim \wd\printedmanualbox > 0pt
7975       % Cross-manual reference with a printed manual name.
7976       % 
7977       \crossmanualxref{\cite{\printedmanual\unskip}}%
7978     %
7979     \else\ifdim \wd\infofilenamebox > 0pt
7980       % Cross-manual reference with only an info filename (arg 4), no
7981       % printed manual name (arg 5).  This is essentially the same as
7982       % the case above; we output the filename, since we have nothing else.
7983       % 
7984       \crossmanualxref{\code{\infofilename\unskip}}%
7985     %
7986     \else
7987       % Reference within this manual.
7988       %
7989       % _ (for example) has to be the character _ for the purposes of the
7990       % control sequence corresponding to the node, but it has to expand
7991       % into the usual \leavevmode...\vrule stuff for purposes of
7992       % printing. So we \turnoffactive for the \refx-snt, back on for the
7993       % printing, back off for the \refx-pg.
7994       {\turnoffactive
7995        % Only output a following space if the -snt ref is nonempty; for
7996        % @unnumbered and @anchor, it won't be.
7997        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7998        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7999       }%
8000       % output the `[mynode]' via the macro below so it can be overridden.
8001       \xrefprintnodename\printedrefname
8002       %
8003       % But we always want a comma and a space:
8004       ,\space
8005       %
8006       % output the `page 3'.
8007       \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8008     \fi\fi
8009   \fi
8010   \endlink
8011 \endgroup}
8012
8013 % Output a cross-manual xref to #1.  Used just above (twice).
8014
8015 % Only include the text "Section ``foo'' in" if the foo is neither
8016 % missing or Top.  Thus, @xref{,,,foo,The Foo Manual} outputs simply
8017 % "see The Foo Manual", the idea being to refer to the whole manual.
8018
8019 % But, this being TeX, we can't easily compare our node name against the
8020 % string "Top" while ignoring the possible spaces before and after in
8021 % the input.  By adding the arbitrary 7sp below, we make it much less
8022 % likely that a real node name would have the same width as "Top" (e.g.,
8023 % in a monospaced font).  Hopefully it will never happen in practice.
8024
8025 % For the same basic reason, we retypeset the "Top" at every
8026 % reference, since the current font is indeterminate.
8027
8028 \def\crossmanualxref#1{%
8029   \setbox\toprefbox = \hbox{Top\kern7sp}%
8030   \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8031   \ifdim \wd2 > 7sp  % nonempty?
8032     \ifdim \wd2 = \wd\toprefbox \else  % same as Top?
8033       \putwordSection{} ``\printedrefname'' \putwordin{}\space
8034     \fi
8035   \fi
8036   #1%
8037 }
8038
8039 % This macro is called from \xrefX for the `[nodename]' part of xref
8040 % output.  It's a separate macro only so it can be changed more easily,
8041 % since square brackets don't work well in some documents.  Particularly
8042 % one that Bob is working on :).
8043 %
8044 \def\xrefprintnodename#1{[#1]}
8045
8046 % Things referred to by \setref.
8047 %
8048 \def\Ynothing{}
8049 \def\Yomitfromtoc{}
8050 \def\Ynumbered{%
8051   \ifnum\secno=0
8052     \putwordChapter@tie \the\chapno
8053   \else \ifnum\subsecno=0
8054     \putwordSection@tie \the\chapno.\the\secno
8055   \else \ifnum\subsubsecno=0
8056     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8057   \else
8058     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8059   \fi\fi\fi
8060 }
8061 \def\Yappendix{%
8062   \ifnum\secno=0
8063      \putwordAppendix@tie @char\the\appendixno{}%
8064   \else \ifnum\subsecno=0
8065      \putwordSection@tie @char\the\appendixno.\the\secno
8066   \else \ifnum\subsubsecno=0
8067     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8068   \else
8069     \putwordSection@tie
8070       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8071   \fi\fi\fi
8072 }
8073
8074 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8075 % If its value is nonempty, SUFFIX is output afterward.
8076 %
8077 \def\refx#1#2{%
8078   {%
8079     \indexnofonts
8080     \otherbackslash
8081     \expandafter\global\expandafter\let\expandafter\thisrefX
8082       \csname XR#1\endcsname
8083   }%
8084   \ifx\thisrefX\relax
8085     % If not defined, say something at least.
8086     \angleleft un\-de\-fined\angleright
8087     \iflinks
8088       \ifhavexrefs
8089         {\toks0 = {#1}% avoid expansion of possibly-complex value
8090          \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8091       \else
8092         \ifwarnedxrefs\else
8093           \global\warnedxrefstrue
8094           \message{Cross reference values unknown; you must run TeX again.}%
8095         \fi
8096       \fi
8097     \fi
8098   \else
8099     % It's defined, so just use it.
8100     \thisrefX
8101   \fi
8102   #2% Output the suffix in any case.
8103 }
8104
8105 % This is the macro invoked by entries in the aux file.  Usually it's
8106 % just a \def (we prepend XR to the control sequence name to avoid
8107 % collisions).  But if this is a float type, we have more work to do.
8108 %
8109 \def\xrdef#1#2{%
8110   {% The node name might contain 8-bit characters, which in our current
8111    % implementation are changed to commands like @'e.  Don't let these
8112    % mess up the control sequence name.
8113     \indexnofonts
8114     \turnoffactive
8115     \xdef\safexrefname{#1}%
8116   }%
8117   %
8118   \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8119   %
8120   % Was that xref control sequence that we just defined for a float?
8121   \expandafter\iffloat\csname XR\safexrefname\endcsname
8122     % it was a float, and we have the (safe) float type in \iffloattype.
8123     \expandafter\let\expandafter\floatlist
8124       \csname floatlist\iffloattype\endcsname
8125     %
8126     % Is this the first time we've seen this float type?
8127     \expandafter\ifx\floatlist\relax
8128       \toks0 = {\do}% yes, so just \do
8129     \else
8130       % had it before, so preserve previous elements in list.
8131       \toks0 = \expandafter{\floatlist\do}%
8132     \fi
8133     %
8134     % Remember this xref in the control sequence \floatlistFLOATTYPE,
8135     % for later use in \listoffloats.
8136     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8137       {\safexrefname}}%
8138   \fi
8139 }
8140
8141 % Read the last existing aux file, if any.  No error if none exists.
8142 %
8143 \def\tryauxfile{%
8144   \openin 1 \jobname.aux
8145   \ifeof 1 \else
8146     \readdatafile{aux}%
8147     \global\havexrefstrue
8148   \fi
8149   \closein 1
8150 }
8151
8152 \def\setupdatafile{%
8153   \catcode`\^^@=\other
8154   \catcode`\^^A=\other
8155   \catcode`\^^B=\other
8156   \catcode`\^^C=\other
8157   \catcode`\^^D=\other
8158   \catcode`\^^E=\other
8159   \catcode`\^^F=\other
8160   \catcode`\^^G=\other
8161   \catcode`\^^H=\other
8162   \catcode`\^^K=\other
8163   \catcode`\^^L=\other
8164   \catcode`\^^N=\other
8165   \catcode`\^^P=\other
8166   \catcode`\^^Q=\other
8167   \catcode`\^^R=\other
8168   \catcode`\^^S=\other
8169   \catcode`\^^T=\other
8170   \catcode`\^^U=\other
8171   \catcode`\^^V=\other
8172   \catcode`\^^W=\other
8173   \catcode`\^^X=\other
8174   \catcode`\^^Z=\other
8175   \catcode`\^^[=\other
8176   \catcode`\^^\=\other
8177   \catcode`\^^]=\other
8178   \catcode`\^^^=\other
8179   \catcode`\^^_=\other
8180   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8181   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
8182   % supported in the main text, it doesn't seem desirable.  Furthermore,
8183   % that is not enough: for node names that actually contain a ^
8184   % character, we would end up writing a line like this: 'xrdef {'hat
8185   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8186   % argument, and \hat is not an expandable control sequence.  It could
8187   % all be worked out, but why?  Either we support ^^ or we don't.
8188   %
8189   % The other change necessary for this was to define \auxhat:
8190   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8191   % and then to call \auxhat in \setq.
8192   %
8193   \catcode`\^=\other
8194   %
8195   % Special characters.  Should be turned off anyway, but...
8196   \catcode`\~=\other
8197   \catcode`\[=\other
8198   \catcode`\]=\other
8199   \catcode`\"=\other
8200   \catcode`\_=\other
8201   \catcode`\|=\other
8202   \catcode`\<=\other
8203   \catcode`\>=\other
8204   \catcode`\$=\other
8205   \catcode`\#=\other
8206   \catcode`\&=\other
8207   \catcode`\%=\other
8208   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8209   %
8210   % This is to support \ in node names and titles, since the \
8211   % characters end up in a \csname.  It's easier than
8212   % leaving it active and making its active definition an actual \
8213   % character.  What I don't understand is why it works in the *value*
8214   % of the xrdef.  Seems like it should be a catcode12 \, and that
8215   % should not typeset properly.  But it works, so I'm moving on for
8216   % now.  --karl, 15jan04.
8217   \catcode`\\=\other
8218   %
8219   % Make the characters 128-255 be printing characters.
8220   {%
8221     \count1=128
8222     \def\loop{%
8223       \catcode\count1=\other
8224       \advance\count1 by 1
8225       \ifnum \count1<256 \loop \fi
8226     }%
8227   }%
8228   %
8229   % @ is our escape character in .aux files, and we need braces.
8230   \catcode`\{=1
8231   \catcode`\}=2
8232   \catcode`\@=0
8233 }
8234
8235 \def\readdatafile#1{%
8236 \begingroup
8237   \setupdatafile
8238   \input\jobname.#1
8239 \endgroup}
8240
8241
8242 \message{insertions,}
8243 % including footnotes.
8244
8245 \newcount \footnoteno
8246
8247 % The trailing space in the following definition for supereject is
8248 % vital for proper filling; pages come out unaligned when you do a
8249 % pagealignmacro call if that space before the closing brace is
8250 % removed. (Generally, numeric constants should always be followed by a
8251 % space to prevent strange expansion errors.)
8252 \def\supereject{\par\penalty -20000\footnoteno =0 }
8253
8254 % @footnotestyle is meaningful for Info output only.
8255 \let\footnotestyle=\comment
8256
8257 {\catcode `\@=11
8258 %
8259 % Auto-number footnotes.  Otherwise like plain.
8260 \gdef\footnote{%
8261   \let\indent=\ptexindent
8262   \let\noindent=\ptexnoindent
8263   \global\advance\footnoteno by \@ne
8264   \edef\thisfootno{$^{\the\footnoteno}$}%
8265   %
8266   % In case the footnote comes at the end of a sentence, preserve the
8267   % extra spacing after we do the footnote number.
8268   \let\@sf\empty
8269   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8270   %
8271   % Remove inadvertent blank space before typesetting the footnote number.
8272   \unskip
8273   \thisfootno\@sf
8274   \dofootnote
8275 }%
8276
8277 % Don't bother with the trickery in plain.tex to not require the
8278 % footnote text as a parameter.  Our footnotes don't need to be so general.
8279 %
8280 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8281 % \parseargline) fails inside footnotes because the tokens are fixed when
8282 % the footnote is read.  --karl, 16nov96.
8283 %
8284 \gdef\dofootnote{%
8285   \insert\footins\bgroup
8286   % We want to typeset this text as a normal paragraph, even if the
8287   % footnote reference occurs in (for example) a display environment.
8288   % So reset some parameters.
8289   \hsize=\pagewidth
8290   \interlinepenalty\interfootnotelinepenalty
8291   \splittopskip\ht\strutbox % top baseline for broken footnotes
8292   \splitmaxdepth\dp\strutbox
8293   \floatingpenalty\@MM
8294   \leftskip\z@skip
8295   \rightskip\z@skip
8296   \spaceskip\z@skip
8297   \xspaceskip\z@skip
8298   \parindent\defaultparindent
8299   %
8300   \smallfonts \rm
8301   %
8302   % Because we use hanging indentation in footnotes, a @noindent appears
8303   % to exdent this text, so make it be a no-op.  makeinfo does not use
8304   % hanging indentation so @noindent can still be needed within footnote
8305   % text after an @example or the like (not that this is good style).
8306   \let\noindent = \relax
8307   %
8308   % Hang the footnote text off the number.  Use \everypar in case the
8309   % footnote extends for more than one paragraph.
8310   \everypar = {\hang}%
8311   \textindent{\thisfootno}%
8312   %
8313   % Don't crash into the line above the footnote text.  Since this
8314   % expands into a box, it must come within the paragraph, lest it
8315   % provide a place where TeX can split the footnote.
8316   \footstrut
8317   %
8318   % Invoke rest of plain TeX footnote routine.
8319   \futurelet\next\fo@t
8320 }
8321 }%end \catcode `\@=11
8322
8323 % In case a @footnote appears in a vbox, save the footnote text and create
8324 % the real \insert just after the vbox finished.  Otherwise, the insertion
8325 % would be lost.
8326 % Similarly, if a @footnote appears inside an alignment, save the footnote
8327 % text to a box and make the \insert when a row of the table is finished.
8328 % And the same can be done for other insert classes.  --kasal, 16nov03.
8329
8330 % Replace the \insert primitive by a cheating macro.
8331 % Deeper inside, just make sure that the saved insertions are not spilled
8332 % out prematurely.
8333 %
8334 \def\startsavinginserts{%
8335   \ifx \insert\ptexinsert
8336     \let\insert\saveinsert
8337   \else
8338     \let\checkinserts\relax
8339   \fi
8340 }
8341
8342 % This \insert replacement works for both \insert\footins{foo} and
8343 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8344 %
8345 \def\saveinsert#1{%
8346   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8347   \afterassignment\next
8348   % swallow the left brace
8349   \let\temp =
8350 }
8351 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8352 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8353
8354 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8355
8356 \def\placesaveins#1{%
8357   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8358     {\box#1}%
8359 }
8360
8361 % eat @SAVE -- beware, all of them have catcode \other:
8362 {
8363   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
8364   \gdef\gobblesave @SAVE{}
8365 }
8366
8367 % initialization:
8368 \def\newsaveins #1{%
8369   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8370   \next
8371 }
8372 \def\newsaveinsX #1{%
8373   \csname newbox\endcsname #1%
8374   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8375     \checksaveins #1}%
8376 }
8377
8378 % initialize:
8379 \let\checkinserts\empty
8380 \newsaveins\footins
8381 \newsaveins\margin
8382
8383
8384 % @image.  We use the macros from epsf.tex to support this.
8385 % If epsf.tex is not installed and @image is used, we complain.
8386 %
8387 % Check for and read epsf.tex up front.  If we read it only at @image
8388 % time, we might be inside a group, and then its definitions would get
8389 % undone and the next image would fail.
8390 \openin 1 = epsf.tex
8391 \ifeof 1 \else
8392   % Do not bother showing banner with epsf.tex v2.7k (available in
8393   % doc/epsf.tex and on ctan).
8394   \def\epsfannounce{\toks0 = }%
8395   \input epsf.tex
8396 \fi
8397 \closein 1
8398 %
8399 % We will only complain once about lack of epsf.tex.
8400 \newif\ifwarnednoepsf
8401 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8402   work.  It is also included in the Texinfo distribution, or you can get
8403   it from ftp://tug.org/tex/epsf.tex.}
8404 %
8405 \def\image#1{%
8406   \ifx\epsfbox\thisisundefined
8407     \ifwarnednoepsf \else
8408       \errhelp = \noepsfhelp
8409       \errmessage{epsf.tex not found, images will be ignored}%
8410       \global\warnednoepsftrue
8411     \fi
8412   \else
8413     \imagexxx #1,,,,,\finish
8414   \fi
8415 }
8416 %
8417 % Arguments to @image:
8418 % #1 is (mandatory) image filename; we tack on .eps extension.
8419 % #2 is (optional) width, #3 is (optional) height.
8420 % #4 is (ignored optional) html alt text.
8421 % #5 is (ignored optional) extension.
8422 % #6 is just the usual extra ignored arg for parsing stuff.
8423 \newif\ifimagevmode
8424 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8425   \catcode`\^^M = 5     % in case we're inside an example
8426   \normalturnoffactive  % allow _ et al. in names
8427   % If the image is by itself, center it.
8428   \ifvmode
8429     \imagevmodetrue
8430   \else \ifx\centersub\centerV
8431     % for @center @image, we need a vbox so we can have our vertical space
8432     \imagevmodetrue
8433     \vbox\bgroup % vbox has better behavior than vtop herev
8434   \fi\fi
8435   %
8436   \ifimagevmode
8437     \nobreak\medskip
8438     % Usually we'll have text after the image which will insert
8439     % \parskip glue, so insert it here too to equalize the space
8440     % above and below.
8441     \nobreak\vskip\parskip
8442     \nobreak
8443   \fi
8444   %
8445   % Leave vertical mode so that indentation from an enclosing
8446   %  environment such as @quotation is respected.
8447   % However, if we're at the top level, we don't want the
8448   %  normal paragraph indentation.
8449   % On the other hand, if we are in the case of @center @image, we don't
8450   %  want to start a paragraph, which will create a hsize-width box and
8451   %  eradicate the centering.
8452   \ifx\centersub\centerV\else \noindent \fi
8453   %
8454   % Output the image.
8455   \ifpdf
8456     \dopdfimage{#1}{#2}{#3}%
8457   \else
8458     % \epsfbox itself resets \epsf?size at each figure.
8459     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8460     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8461     \epsfbox{#1.eps}%
8462   \fi
8463   %
8464   \ifimagevmode
8465     \medskip  % space after a standalone image
8466   \fi  
8467   \ifx\centersub\centerV \egroup \fi
8468 \endgroup}
8469
8470
8471 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8472 % etc.  We don't actually implement floating yet, we always include the
8473 % float "here".  But it seemed the best name for the future.
8474 %
8475 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8476
8477 % There may be a space before second and/or third parameter; delete it.
8478 \def\eatcommaspace#1, {#1,}
8479
8480 % #1 is the optional FLOATTYPE, the text label for this float, typically
8481 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
8482 % this float will not be numbered and cannot be referred to.
8483 %
8484 % #2 is the optional xref label.  Also must be present for the float to
8485 % be referable.
8486 %
8487 % #3 is the optional positioning argument; for now, it is ignored.  It
8488 % will somehow specify the positions allowed to float to (here, top, bottom).
8489 %
8490 % We keep a separate counter for each FLOATTYPE, which we reset at each
8491 % chapter-level command.
8492 \let\resetallfloatnos=\empty
8493 %
8494 \def\dofloat#1,#2,#3,#4\finish{%
8495   \let\thiscaption=\empty
8496   \let\thisshortcaption=\empty
8497   %
8498   % don't lose footnotes inside @float.
8499   %
8500   % BEWARE: when the floats start float, we have to issue warning whenever an
8501   % insert appears inside a float which could possibly float. --kasal, 26may04
8502   %
8503   \startsavinginserts
8504   %
8505   % We can't be used inside a paragraph.
8506   \par
8507   %
8508   \vtop\bgroup
8509     \def\floattype{#1}%
8510     \def\floatlabel{#2}%
8511     \def\floatloc{#3}% we do nothing with this yet.
8512     %
8513     \ifx\floattype\empty
8514       \let\safefloattype=\empty
8515     \else
8516       {%
8517         % the floattype might have accents or other special characters,
8518         % but we need to use it in a control sequence name.
8519         \indexnofonts
8520         \turnoffactive
8521         \xdef\safefloattype{\floattype}%
8522       }%
8523     \fi
8524     %
8525     % If label is given but no type, we handle that as the empty type.
8526     \ifx\floatlabel\empty \else
8527       % We want each FLOATTYPE to be numbered separately (Figure 1,
8528       % Table 1, Figure 2, ...).  (And if no label, no number.)
8529       %
8530       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8531       \global\advance\floatno by 1
8532       %
8533       {%
8534         % This magic value for \lastsection is output by \setref as the
8535         % XREFLABEL-title value.  \xrefX uses it to distinguish float
8536         % labels (which have a completely different output format) from
8537         % node and anchor labels.  And \xrdef uses it to construct the
8538         % lists of floats.
8539         %
8540         \edef\lastsection{\floatmagic=\safefloattype}%
8541         \setref{\floatlabel}{Yfloat}%
8542       }%
8543     \fi
8544     %
8545     % start with \parskip glue, I guess.
8546     \vskip\parskip
8547     %
8548     % Don't suppress indentation if a float happens to start a section.
8549     \restorefirstparagraphindent
8550 }
8551
8552 % we have these possibilities:
8553 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8554 % @float Foo,lbl & no caption:    Foo 1.1
8555 % @float Foo & @caption{Cap}:     Foo: Cap
8556 % @float Foo & no caption:        Foo
8557 % @float ,lbl & Caption{Cap}:     1.1: Cap
8558 % @float ,lbl & no caption:       1.1
8559 % @float & @caption{Cap}:         Cap
8560 % @float & no caption:
8561 %
8562 \def\Efloat{%
8563     \let\floatident = \empty
8564     %
8565     % In all cases, if we have a float type, it comes first.
8566     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8567     %
8568     % If we have an xref label, the number comes next.
8569     \ifx\floatlabel\empty \else
8570       \ifx\floattype\empty \else % if also had float type, need tie first.
8571         \appendtomacro\floatident{\tie}%
8572       \fi
8573       % the number.
8574       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8575     \fi
8576     %
8577     % Start the printed caption with what we've constructed in
8578     % \floatident, but keep it separate; we need \floatident again.
8579     \let\captionline = \floatident
8580     %
8581     \ifx\thiscaption\empty \else
8582       \ifx\floatident\empty \else
8583         \appendtomacro\captionline{: }% had ident, so need a colon between
8584       \fi
8585       %
8586       % caption text.
8587       \appendtomacro\captionline{\scanexp\thiscaption}%
8588     \fi
8589     %
8590     % If we have anything to print, print it, with space before.
8591     % Eventually this needs to become an \insert.
8592     \ifx\captionline\empty \else
8593       \vskip.5\parskip
8594       \captionline
8595       %
8596       % Space below caption.
8597       \vskip\parskip
8598     \fi
8599     %
8600     % If have an xref label, write the list of floats info.  Do this
8601     % after the caption, to avoid chance of it being a breakpoint.
8602     \ifx\floatlabel\empty \else
8603       % Write the text that goes in the lof to the aux file as
8604       % \floatlabel-lof.  Besides \floatident, we include the short
8605       % caption if specified, else the full caption if specified, else nothing.
8606       {%
8607         \atdummies
8608         %
8609         % since we read the caption text in the macro world, where ^^M
8610         % is turned into a normal character, we have to scan it back, so
8611         % we don't write the literal three characters "^^M" into the aux file.
8612         \scanexp{%
8613           \xdef\noexpand\gtemp{%
8614             \ifx\thisshortcaption\empty
8615               \thiscaption
8616             \else
8617               \thisshortcaption
8618             \fi
8619           }%
8620         }%
8621         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8622           \ifx\gtemp\empty \else : \gtemp \fi}}%
8623       }%
8624     \fi
8625   \egroup  % end of \vtop
8626   %
8627   % place the captured inserts
8628   %
8629   % BEWARE: when the floats start floating, we have to issue warning
8630   % whenever an insert appears inside a float which could possibly
8631   % float. --kasal, 26may04
8632   %
8633   \checkinserts
8634 }
8635
8636 % Append the tokens #2 to the definition of macro #1, not expanding either.
8637 %
8638 \def\appendtomacro#1#2{%
8639   \expandafter\def\expandafter#1\expandafter{#1#2}%
8640 }
8641
8642 % @caption, @shortcaption
8643 %
8644 \def\caption{\docaption\thiscaption}
8645 \def\shortcaption{\docaption\thisshortcaption}
8646 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8647 \def\defcaption#1#2{\egroup \def#1{#2}}
8648
8649 % The parameter is the control sequence identifying the counter we are
8650 % going to use.  Create it if it doesn't exist and assign it to \floatno.
8651 \def\getfloatno#1{%
8652   \ifx#1\relax
8653       % Haven't seen this figure type before.
8654       \csname newcount\endcsname #1%
8655       %
8656       % Remember to reset this floatno at the next chap.
8657       \expandafter\gdef\expandafter\resetallfloatnos
8658         \expandafter{\resetallfloatnos #1=0 }%
8659   \fi
8660   \let\floatno#1%
8661 }
8662
8663 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
8664 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
8665 % first read the @float command.
8666 %
8667 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8668
8669 % Magic string used for the XREFLABEL-title value, so \xrefX can
8670 % distinguish floats from other xref types.
8671 \def\floatmagic{!!float!!}
8672
8673 % #1 is the control sequence we are passed; we expand into a conditional
8674 % which is true if #1 represents a float ref.  That is, the magic
8675 % \lastsection value which we \setref above.
8676 %
8677 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8678 %
8679 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
8680 % (safe) float type for this float.  We set \iffloattype to #2.
8681 %
8682 \def\doiffloat#1=#2=#3\finish{%
8683   \def\temp{#1}%
8684   \def\iffloattype{#2}%
8685   \ifx\temp\floatmagic
8686 }
8687
8688 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8689 %
8690 \parseargdef\listoffloats{%
8691   \def\floattype{#1}% floattype
8692   {%
8693     % the floattype might have accents or other special characters,
8694     % but we need to use it in a control sequence name.
8695     \indexnofonts
8696     \turnoffactive
8697     \xdef\safefloattype{\floattype}%
8698   }%
8699   %
8700   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8701   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8702     \ifhavexrefs
8703       % if the user said @listoffloats foo but never @float foo.
8704       \message{\linenumber No `\safefloattype' floats to list.}%
8705     \fi
8706   \else
8707     \begingroup
8708       \leftskip=\tocindent  % indent these entries like a toc
8709       \let\do=\listoffloatsdo
8710       \csname floatlist\safefloattype\endcsname
8711     \endgroup
8712   \fi
8713 }
8714
8715 % This is called on each entry in a list of floats.  We're passed the
8716 % xref label, in the form LABEL-title, which is how we save it in the
8717 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
8718 % has the text we're supposed to typeset here.
8719 %
8720 % Figures without xref labels will not be included in the list (since
8721 % they won't appear in the aux file).
8722 %
8723 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8724 \def\listoffloatsdoentry#1-title\finish{{%
8725   % Can't fully expand XR#1-lof because it can contain anything.  Just
8726   % pass the control sequence.  On the other hand, XR#1-pg is just the
8727   % page number, and we want to fully expand that so we can get a link
8728   % in pdf output.
8729   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8730   %
8731   % use the same \entry macro we use to generate the TOC and index.
8732   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8733   \writeentry
8734 }}
8735
8736
8737 \message{localization,}
8738
8739 % For single-language documents, @documentlanguage is usually given very
8740 % early, just after @documentencoding.  Single argument is the language
8741 % (de) or locale (de_DE) abbreviation.
8742 %
8743 {
8744   \catcode`\_ = \active
8745   \globaldefs=1
8746 \parseargdef\documentlanguage{\begingroup
8747   \let_=\normalunderscore  % normal _ character for filenames
8748   \tex % read txi-??.tex file in plain TeX.
8749     % Read the file by the name they passed if it exists.
8750     \openin 1 txi-#1.tex
8751     \ifeof 1
8752       \documentlanguagetrywithoutunderscore{#1_\finish}%
8753     \else
8754       \globaldefs = 1  % everything in the txi-LL files needs to persist
8755       \input txi-#1.tex
8756     \fi
8757     \closein 1
8758   \endgroup % end raw TeX
8759 \endgroup}
8760 %
8761 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8762 % try txi-de.tex.
8763 %
8764 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8765   \openin 1 txi-#1.tex
8766   \ifeof 1
8767     \errhelp = \nolanghelp
8768     \errmessage{Cannot read language file txi-#1.tex}%
8769   \else
8770     \globaldefs = 1  % everything in the txi-LL files needs to persist
8771     \input txi-#1.tex
8772   \fi
8773   \closein 1
8774 }
8775 }% end of special _ catcode
8776 %
8777 \newhelp\nolanghelp{The given language definition file cannot be found or
8778 is empty.  Maybe you need to install it?  Putting it in the current
8779 directory should work if nowhere else does.}
8780
8781 % This macro is called from txi-??.tex files; the first argument is the
8782 % \language name to set (without the "\lang@" prefix), the second and
8783 % third args are \{left,right}hyphenmin.
8784 %
8785 % The language names to pass are determined when the format is built.
8786 % See the etex.log file created at that time, e.g.,
8787 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8788 %
8789 % With TeX Live 2008, etex now includes hyphenation patterns for all
8790 % available languages.  This means we can support hyphenation in
8791 % Texinfo, at least to some extent.  (This still doesn't solve the
8792 % accented characters problem.)
8793 %
8794 \catcode`@=11
8795 \def\txisetlanguage#1#2#3{%
8796   % do not set the language if the name is undefined in the current TeX.
8797   \expandafter\ifx\csname lang@#1\endcsname \relax
8798     \message{no patterns for #1}%
8799   \else
8800     \global\language = \csname lang@#1\endcsname
8801   \fi
8802   % but there is no harm in adjusting the hyphenmin values regardless.
8803   \global\lefthyphenmin = #2\relax
8804   \global\righthyphenmin = #3\relax
8805 }
8806
8807 % Helpers for encodings.
8808 % Set the catcode of characters 128 through 255 to the specified number.
8809 %
8810 \def\setnonasciicharscatcode#1{%
8811    \count255=128
8812    \loop\ifnum\count255<256
8813       \global\catcode\count255=#1\relax
8814       \advance\count255 by 1
8815    \repeat
8816 }
8817
8818 \def\setnonasciicharscatcodenonglobal#1{%
8819    \count255=128
8820    \loop\ifnum\count255<256
8821       \catcode\count255=#1\relax
8822       \advance\count255 by 1
8823    \repeat
8824 }
8825
8826 % @documentencoding sets the definition of non-ASCII characters
8827 % according to the specified encoding.
8828 %
8829 \parseargdef\documentencoding{%
8830   % Encoding being declared for the document.
8831   \def\declaredencoding{\csname #1.enc\endcsname}%
8832   %
8833   % Supported encodings: names converted to tokens in order to be able
8834   % to compare them with \ifx.
8835   \def\ascii{\csname US-ASCII.enc\endcsname}%
8836   \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8837   \def\latone{\csname ISO-8859-1.enc\endcsname}%
8838   \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8839   \def\utfeight{\csname UTF-8.enc\endcsname}%
8840   %
8841   \ifx \declaredencoding \ascii
8842      \asciichardefs
8843   %
8844   \else \ifx \declaredencoding \lattwo
8845      \setnonasciicharscatcode\active
8846      \lattwochardefs
8847   %
8848   \else \ifx \declaredencoding \latone
8849      \setnonasciicharscatcode\active
8850      \latonechardefs
8851   %
8852   \else \ifx \declaredencoding \latnine
8853      \setnonasciicharscatcode\active
8854      \latninechardefs
8855   %
8856   \else \ifx \declaredencoding \utfeight
8857      \setnonasciicharscatcode\active
8858      \utfeightchardefs
8859   %
8860   \else
8861     \message{Unknown document encoding #1, ignoring.}%
8862   %
8863   \fi % utfeight
8864   \fi % latnine
8865   \fi % latone
8866   \fi % lattwo
8867   \fi % ascii
8868 }
8869
8870 % A message to be logged when using a character that isn't available
8871 % the default font encoding (OT1).
8872 %
8873 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8874
8875 % Take account of \c (plain) vs. \, (Texinfo) difference.
8876 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8877
8878 % First, make active non-ASCII characters in order for them to be
8879 % correctly categorized when TeX reads the replacement text of
8880 % macros containing the character definitions.
8881 \setnonasciicharscatcode\active
8882 %
8883 % Latin1 (ISO-8859-1) character definitions.
8884 \def\latonechardefs{%
8885   \gdef^^a0{\tie}
8886   \gdef^^a1{\exclamdown}
8887   \gdef^^a2{\missingcharmsg{CENT SIGN}}
8888   \gdef^^a3{{\pounds}}
8889   \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8890   \gdef^^a5{\missingcharmsg{YEN SIGN}}
8891   \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8892   \gdef^^a7{\S}
8893   \gdef^^a8{\"{}}
8894   \gdef^^a9{\copyright}
8895   \gdef^^aa{\ordf}
8896   \gdef^^ab{\guillemetleft}
8897   \gdef^^ac{$\lnot$}
8898   \gdef^^ad{\-}
8899   \gdef^^ae{\registeredsymbol}
8900   \gdef^^af{\={}}
8901   %
8902   \gdef^^b0{\textdegree}
8903   \gdef^^b1{$\pm$}
8904   \gdef^^b2{$^2$}
8905   \gdef^^b3{$^3$}
8906   \gdef^^b4{\'{}}
8907   \gdef^^b5{$\mu$}
8908   \gdef^^b6{\P}
8909   %
8910   \gdef^^b7{$^.$}
8911   \gdef^^b8{\cedilla\ }
8912   \gdef^^b9{$^1$}
8913   \gdef^^ba{\ordm}
8914   %
8915   \gdef^^bb{\guillemetright}
8916   \gdef^^bc{$1\over4$}
8917   \gdef^^bd{$1\over2$}
8918   \gdef^^be{$3\over4$}
8919   \gdef^^bf{\questiondown}
8920   %
8921   \gdef^^c0{\`A}
8922   \gdef^^c1{\'A}
8923   \gdef^^c2{\^A}
8924   \gdef^^c3{\~A}
8925   \gdef^^c4{\"A}
8926   \gdef^^c5{\ringaccent A}
8927   \gdef^^c6{\AE}
8928   \gdef^^c7{\cedilla C}
8929   \gdef^^c8{\`E}
8930   \gdef^^c9{\'E}
8931   \gdef^^ca{\^E}
8932   \gdef^^cb{\"E}
8933   \gdef^^cc{\`I}
8934   \gdef^^cd{\'I}
8935   \gdef^^ce{\^I}
8936   \gdef^^cf{\"I}
8937   %
8938   \gdef^^d0{\DH}
8939   \gdef^^d1{\~N}
8940   \gdef^^d2{\`O}
8941   \gdef^^d3{\'O}
8942   \gdef^^d4{\^O}
8943   \gdef^^d5{\~O}
8944   \gdef^^d6{\"O}
8945   \gdef^^d7{$\times$}
8946   \gdef^^d8{\O}
8947   \gdef^^d9{\`U}
8948   \gdef^^da{\'U}
8949   \gdef^^db{\^U}
8950   \gdef^^dc{\"U}
8951   \gdef^^dd{\'Y}
8952   \gdef^^de{\TH}
8953   \gdef^^df{\ss}
8954   %
8955   \gdef^^e0{\`a}
8956   \gdef^^e1{\'a}
8957   \gdef^^e2{\^a}
8958   \gdef^^e3{\~a}
8959   \gdef^^e4{\"a}
8960   \gdef^^e5{\ringaccent a}
8961   \gdef^^e6{\ae}
8962   \gdef^^e7{\cedilla c}
8963   \gdef^^e8{\`e}
8964   \gdef^^e9{\'e}
8965   \gdef^^ea{\^e}
8966   \gdef^^eb{\"e}
8967   \gdef^^ec{\`{\dotless i}}
8968   \gdef^^ed{\'{\dotless i}}
8969   \gdef^^ee{\^{\dotless i}}
8970   \gdef^^ef{\"{\dotless i}}
8971   %
8972   \gdef^^f0{\dh}
8973   \gdef^^f1{\~n}
8974   \gdef^^f2{\`o}
8975   \gdef^^f3{\'o}
8976   \gdef^^f4{\^o}
8977   \gdef^^f5{\~o}
8978   \gdef^^f6{\"o}
8979   \gdef^^f7{$\div$}
8980   \gdef^^f8{\o}
8981   \gdef^^f9{\`u}
8982   \gdef^^fa{\'u}
8983   \gdef^^fb{\^u}
8984   \gdef^^fc{\"u}
8985   \gdef^^fd{\'y}
8986   \gdef^^fe{\th}
8987   \gdef^^ff{\"y}
8988 }
8989
8990 % Latin9 (ISO-8859-15) encoding character definitions.
8991 \def\latninechardefs{%
8992   % Encoding is almost identical to Latin1.
8993   \latonechardefs
8994   %
8995   \gdef^^a4{\euro}
8996   \gdef^^a6{\v S}
8997   \gdef^^a8{\v s}
8998   \gdef^^b4{\v Z}
8999   \gdef^^b8{\v z}
9000   \gdef^^bc{\OE}
9001   \gdef^^bd{\oe}
9002   \gdef^^be{\"Y}
9003 }
9004
9005 % Latin2 (ISO-8859-2) character definitions.
9006 \def\lattwochardefs{%
9007   \gdef^^a0{\tie}
9008   \gdef^^a1{\ogonek{A}}
9009   \gdef^^a2{\u{}}
9010   \gdef^^a3{\L}
9011   \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9012   \gdef^^a5{\v L}
9013   \gdef^^a6{\'S}
9014   \gdef^^a7{\S}
9015   \gdef^^a8{\"{}}
9016   \gdef^^a9{\v S}
9017   \gdef^^aa{\cedilla S}
9018   \gdef^^ab{\v T}
9019   \gdef^^ac{\'Z}
9020   \gdef^^ad{\-}
9021   \gdef^^ae{\v Z}
9022   \gdef^^af{\dotaccent Z}
9023   %
9024   \gdef^^b0{\textdegree}
9025   \gdef^^b1{\ogonek{a}}
9026   \gdef^^b2{\ogonek{ }}
9027   \gdef^^b3{\l}
9028   \gdef^^b4{\'{}}
9029   \gdef^^b5{\v l}
9030   \gdef^^b6{\'s}
9031   \gdef^^b7{\v{}}
9032   \gdef^^b8{\cedilla\ }
9033   \gdef^^b9{\v s}
9034   \gdef^^ba{\cedilla s}
9035   \gdef^^bb{\v t}
9036   \gdef^^bc{\'z}
9037   \gdef^^bd{\H{}}
9038   \gdef^^be{\v z}
9039   \gdef^^bf{\dotaccent z}
9040   %
9041   \gdef^^c0{\'R}
9042   \gdef^^c1{\'A}
9043   \gdef^^c2{\^A}
9044   \gdef^^c3{\u A}
9045   \gdef^^c4{\"A}
9046   \gdef^^c5{\'L}
9047   \gdef^^c6{\'C}
9048   \gdef^^c7{\cedilla C}
9049   \gdef^^c8{\v C}
9050   \gdef^^c9{\'E}
9051   \gdef^^ca{\ogonek{E}}
9052   \gdef^^cb{\"E}
9053   \gdef^^cc{\v E}
9054   \gdef^^cd{\'I}
9055   \gdef^^ce{\^I}
9056   \gdef^^cf{\v D}
9057   %
9058   \gdef^^d0{\DH}
9059   \gdef^^d1{\'N}
9060   \gdef^^d2{\v N}
9061   \gdef^^d3{\'O}
9062   \gdef^^d4{\^O}
9063   \gdef^^d5{\H O}
9064   \gdef^^d6{\"O}
9065   \gdef^^d7{$\times$}
9066   \gdef^^d8{\v R}
9067   \gdef^^d9{\ringaccent U}
9068   \gdef^^da{\'U}
9069   \gdef^^db{\H U}
9070   \gdef^^dc{\"U}
9071   \gdef^^dd{\'Y}
9072   \gdef^^de{\cedilla T}
9073   \gdef^^df{\ss}
9074   %
9075   \gdef^^e0{\'r}
9076   \gdef^^e1{\'a}
9077   \gdef^^e2{\^a}
9078   \gdef^^e3{\u a}
9079   \gdef^^e4{\"a}
9080   \gdef^^e5{\'l}
9081   \gdef^^e6{\'c}
9082   \gdef^^e7{\cedilla c}
9083   \gdef^^e8{\v c}
9084   \gdef^^e9{\'e}
9085   \gdef^^ea{\ogonek{e}}
9086   \gdef^^eb{\"e}
9087   \gdef^^ec{\v e}
9088   \gdef^^ed{\'{\dotless{i}}}
9089   \gdef^^ee{\^{\dotless{i}}}
9090   \gdef^^ef{\v d}
9091   %
9092   \gdef^^f0{\dh}
9093   \gdef^^f1{\'n}
9094   \gdef^^f2{\v n}
9095   \gdef^^f3{\'o}
9096   \gdef^^f4{\^o}
9097   \gdef^^f5{\H o}
9098   \gdef^^f6{\"o}
9099   \gdef^^f7{$\div$}
9100   \gdef^^f8{\v r}
9101   \gdef^^f9{\ringaccent u}
9102   \gdef^^fa{\'u}
9103   \gdef^^fb{\H u}
9104   \gdef^^fc{\"u}
9105   \gdef^^fd{\'y}
9106   \gdef^^fe{\cedilla t}
9107   \gdef^^ff{\dotaccent{}}
9108 }
9109
9110 % UTF-8 character definitions.
9111 %
9112 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9113 % changes for Texinfo conventions.  It is included here under the GPL by
9114 % permission from Frank Mittelbach and the LaTeX team.
9115 %
9116 \newcount\countUTFx
9117 \newcount\countUTFy
9118 \newcount\countUTFz
9119
9120 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9121    \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9122 %
9123 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9124    \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9125 %
9126 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9127    \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9128
9129 \gdef\UTFviiiDefined#1{%
9130   \ifx #1\relax
9131     \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9132   \else
9133     \expandafter #1%
9134   \fi
9135 }
9136
9137 \begingroup
9138   \catcode`\~13
9139   \catcode`\"12
9140
9141   \def\UTFviiiLoop{%
9142     \global\catcode\countUTFx\active
9143     \uccode`\~\countUTFx
9144     \uppercase\expandafter{\UTFviiiTmp}%
9145     \advance\countUTFx by 1
9146     \ifnum\countUTFx < \countUTFy
9147       \expandafter\UTFviiiLoop
9148     \fi}
9149
9150   \countUTFx = "C2
9151   \countUTFy = "E0
9152   \def\UTFviiiTmp{%
9153     \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9154   \UTFviiiLoop
9155
9156   \countUTFx = "E0
9157   \countUTFy = "F0
9158   \def\UTFviiiTmp{%
9159     \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9160   \UTFviiiLoop
9161
9162   \countUTFx = "F0
9163   \countUTFy = "F4
9164   \def\UTFviiiTmp{%
9165     \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9166   \UTFviiiLoop
9167 \endgroup
9168
9169 \begingroup
9170   \catcode`\"=12
9171   \catcode`\<=12
9172   \catcode`\.=12
9173   \catcode`\,=12
9174   \catcode`\;=12
9175   \catcode`\!=12
9176   \catcode`\~=13
9177
9178   \gdef\DeclareUnicodeCharacter#1#2{%
9179     \countUTFz = "#1\relax
9180     %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9181     \begingroup
9182       \parseXMLCharref
9183       \def\UTFviiiTwoOctets##1##2{%
9184         \csname u8:##1\string ##2\endcsname}%
9185       \def\UTFviiiThreeOctets##1##2##3{%
9186         \csname u8:##1\string ##2\string ##3\endcsname}%
9187       \def\UTFviiiFourOctets##1##2##3##4{%
9188         \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9189       \expandafter\expandafter\expandafter\expandafter
9190        \expandafter\expandafter\expandafter
9191        \gdef\UTFviiiTmp{#2}%
9192     \endgroup}
9193
9194   \gdef\parseXMLCharref{%
9195     \ifnum\countUTFz < "A0\relax
9196       \errhelp = \EMsimple
9197       \errmessage{Cannot define Unicode char value < 00A0}%
9198     \else\ifnum\countUTFz < "800\relax
9199       \parseUTFviiiA,%
9200       \parseUTFviiiB C\UTFviiiTwoOctets.,%
9201     \else\ifnum\countUTFz < "10000\relax
9202       \parseUTFviiiA;%
9203       \parseUTFviiiA,%
9204       \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9205     \else
9206       \parseUTFviiiA;%
9207       \parseUTFviiiA,%
9208       \parseUTFviiiA!%
9209       \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9210     \fi\fi\fi
9211   }
9212
9213   \gdef\parseUTFviiiA#1{%
9214     \countUTFx = \countUTFz
9215     \divide\countUTFz by 64
9216     \countUTFy = \countUTFz
9217     \multiply\countUTFz by 64
9218     \advance\countUTFx by -\countUTFz
9219     \advance\countUTFx by 128
9220     \uccode `#1\countUTFx
9221     \countUTFz = \countUTFy}
9222
9223   \gdef\parseUTFviiiB#1#2#3#4{%
9224     \advance\countUTFz by "#10\relax
9225     \uccode `#3\countUTFz
9226     \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9227 \endgroup
9228
9229 \def\utfeightchardefs{%
9230   \DeclareUnicodeCharacter{00A0}{\tie}
9231   \DeclareUnicodeCharacter{00A1}{\exclamdown}
9232   \DeclareUnicodeCharacter{00A3}{\pounds}
9233   \DeclareUnicodeCharacter{00A8}{\"{ }}
9234   \DeclareUnicodeCharacter{00A9}{\copyright}
9235   \DeclareUnicodeCharacter{00AA}{\ordf}
9236   \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9237   \DeclareUnicodeCharacter{00AD}{\-}
9238   \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9239   \DeclareUnicodeCharacter{00AF}{\={ }}
9240
9241   \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9242   \DeclareUnicodeCharacter{00B4}{\'{ }}
9243   \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9244   \DeclareUnicodeCharacter{00BA}{\ordm}
9245   \DeclareUnicodeCharacter{00BB}{\guillemetright}
9246   \DeclareUnicodeCharacter{00BF}{\questiondown}
9247
9248   \DeclareUnicodeCharacter{00C0}{\`A}
9249   \DeclareUnicodeCharacter{00C1}{\'A}
9250   \DeclareUnicodeCharacter{00C2}{\^A}
9251   \DeclareUnicodeCharacter{00C3}{\~A}
9252   \DeclareUnicodeCharacter{00C4}{\"A}
9253   \DeclareUnicodeCharacter{00C5}{\AA}
9254   \DeclareUnicodeCharacter{00C6}{\AE}
9255   \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9256   \DeclareUnicodeCharacter{00C8}{\`E}
9257   \DeclareUnicodeCharacter{00C9}{\'E}
9258   \DeclareUnicodeCharacter{00CA}{\^E}
9259   \DeclareUnicodeCharacter{00CB}{\"E}
9260   \DeclareUnicodeCharacter{00CC}{\`I}
9261   \DeclareUnicodeCharacter{00CD}{\'I}
9262   \DeclareUnicodeCharacter{00CE}{\^I}
9263   \DeclareUnicodeCharacter{00CF}{\"I}
9264
9265   \DeclareUnicodeCharacter{00D0}{\DH}
9266   \DeclareUnicodeCharacter{00D1}{\~N}
9267   \DeclareUnicodeCharacter{00D2}{\`O}
9268   \DeclareUnicodeCharacter{00D3}{\'O}
9269   \DeclareUnicodeCharacter{00D4}{\^O}
9270   \DeclareUnicodeCharacter{00D5}{\~O}
9271   \DeclareUnicodeCharacter{00D6}{\"O}
9272   \DeclareUnicodeCharacter{00D8}{\O}
9273   \DeclareUnicodeCharacter{00D9}{\`U}
9274   \DeclareUnicodeCharacter{00DA}{\'U}
9275   \DeclareUnicodeCharacter{00DB}{\^U}
9276   \DeclareUnicodeCharacter{00DC}{\"U}
9277   \DeclareUnicodeCharacter{00DD}{\'Y}
9278   \DeclareUnicodeCharacter{00DE}{\TH}
9279   \DeclareUnicodeCharacter{00DF}{\ss}
9280
9281   \DeclareUnicodeCharacter{00E0}{\`a}
9282   \DeclareUnicodeCharacter{00E1}{\'a}
9283   \DeclareUnicodeCharacter{00E2}{\^a}
9284   \DeclareUnicodeCharacter{00E3}{\~a}
9285   \DeclareUnicodeCharacter{00E4}{\"a}
9286   \DeclareUnicodeCharacter{00E5}{\aa}
9287   \DeclareUnicodeCharacter{00E6}{\ae}
9288   \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9289   \DeclareUnicodeCharacter{00E8}{\`e}
9290   \DeclareUnicodeCharacter{00E9}{\'e}
9291   \DeclareUnicodeCharacter{00EA}{\^e}
9292   \DeclareUnicodeCharacter{00EB}{\"e}
9293   \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9294   \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9295   \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9296   \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9297
9298   \DeclareUnicodeCharacter{00F0}{\dh}
9299   \DeclareUnicodeCharacter{00F1}{\~n}
9300   \DeclareUnicodeCharacter{00F2}{\`o}
9301   \DeclareUnicodeCharacter{00F3}{\'o}
9302   \DeclareUnicodeCharacter{00F4}{\^o}
9303   \DeclareUnicodeCharacter{00F5}{\~o}
9304   \DeclareUnicodeCharacter{00F6}{\"o}
9305   \DeclareUnicodeCharacter{00F8}{\o}
9306   \DeclareUnicodeCharacter{00F9}{\`u}
9307   \DeclareUnicodeCharacter{00FA}{\'u}
9308   \DeclareUnicodeCharacter{00FB}{\^u}
9309   \DeclareUnicodeCharacter{00FC}{\"u}
9310   \DeclareUnicodeCharacter{00FD}{\'y}
9311   \DeclareUnicodeCharacter{00FE}{\th}
9312   \DeclareUnicodeCharacter{00FF}{\"y}
9313
9314   \DeclareUnicodeCharacter{0100}{\=A}
9315   \DeclareUnicodeCharacter{0101}{\=a}
9316   \DeclareUnicodeCharacter{0102}{\u{A}}
9317   \DeclareUnicodeCharacter{0103}{\u{a}}
9318   \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9319   \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9320   \DeclareUnicodeCharacter{0106}{\'C}
9321   \DeclareUnicodeCharacter{0107}{\'c}
9322   \DeclareUnicodeCharacter{0108}{\^C}
9323   \DeclareUnicodeCharacter{0109}{\^c}
9324   \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9325   \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9326   \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9327   \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9328   \DeclareUnicodeCharacter{010C}{\v{C}}
9329   \DeclareUnicodeCharacter{010D}{\v{c}}
9330   \DeclareUnicodeCharacter{010E}{\v{D}}
9331
9332   \DeclareUnicodeCharacter{0112}{\=E}
9333   \DeclareUnicodeCharacter{0113}{\=e}
9334   \DeclareUnicodeCharacter{0114}{\u{E}}
9335   \DeclareUnicodeCharacter{0115}{\u{e}}
9336   \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9337   \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9338   \DeclareUnicodeCharacter{011A}{\v{E}}
9339   \DeclareUnicodeCharacter{011B}{\v{e}}
9340   \DeclareUnicodeCharacter{011C}{\^G}
9341   \DeclareUnicodeCharacter{011D}{\^g}
9342   \DeclareUnicodeCharacter{011E}{\u{G}}
9343   \DeclareUnicodeCharacter{011F}{\u{g}}
9344
9345   \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9346   \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9347   \DeclareUnicodeCharacter{0124}{\^H}
9348   \DeclareUnicodeCharacter{0125}{\^h}
9349   \DeclareUnicodeCharacter{0128}{\~I}
9350   \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9351   \DeclareUnicodeCharacter{012A}{\=I}
9352   \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9353   \DeclareUnicodeCharacter{012C}{\u{I}}
9354   \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9355
9356   \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9357   \DeclareUnicodeCharacter{0131}{\dotless{i}}
9358   \DeclareUnicodeCharacter{0132}{IJ}
9359   \DeclareUnicodeCharacter{0133}{ij}
9360   \DeclareUnicodeCharacter{0134}{\^J}
9361   \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9362   \DeclareUnicodeCharacter{0139}{\'L}
9363   \DeclareUnicodeCharacter{013A}{\'l}
9364
9365   \DeclareUnicodeCharacter{0141}{\L}
9366   \DeclareUnicodeCharacter{0142}{\l}
9367   \DeclareUnicodeCharacter{0143}{\'N}
9368   \DeclareUnicodeCharacter{0144}{\'n}
9369   \DeclareUnicodeCharacter{0147}{\v{N}}
9370   \DeclareUnicodeCharacter{0148}{\v{n}}
9371   \DeclareUnicodeCharacter{014C}{\=O}
9372   \DeclareUnicodeCharacter{014D}{\=o}
9373   \DeclareUnicodeCharacter{014E}{\u{O}}
9374   \DeclareUnicodeCharacter{014F}{\u{o}}
9375
9376   \DeclareUnicodeCharacter{0150}{\H{O}}
9377   \DeclareUnicodeCharacter{0151}{\H{o}}
9378   \DeclareUnicodeCharacter{0152}{\OE}
9379   \DeclareUnicodeCharacter{0153}{\oe}
9380   \DeclareUnicodeCharacter{0154}{\'R}
9381   \DeclareUnicodeCharacter{0155}{\'r}
9382   \DeclareUnicodeCharacter{0158}{\v{R}}
9383   \DeclareUnicodeCharacter{0159}{\v{r}}
9384   \DeclareUnicodeCharacter{015A}{\'S}
9385   \DeclareUnicodeCharacter{015B}{\'s}
9386   \DeclareUnicodeCharacter{015C}{\^S}
9387   \DeclareUnicodeCharacter{015D}{\^s}
9388   \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9389   \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9390
9391   \DeclareUnicodeCharacter{0160}{\v{S}}
9392   \DeclareUnicodeCharacter{0161}{\v{s}}
9393   \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9394   \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9395   \DeclareUnicodeCharacter{0164}{\v{T}}
9396
9397   \DeclareUnicodeCharacter{0168}{\~U}
9398   \DeclareUnicodeCharacter{0169}{\~u}
9399   \DeclareUnicodeCharacter{016A}{\=U}
9400   \DeclareUnicodeCharacter{016B}{\=u}
9401   \DeclareUnicodeCharacter{016C}{\u{U}}
9402   \DeclareUnicodeCharacter{016D}{\u{u}}
9403   \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9404   \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9405
9406   \DeclareUnicodeCharacter{0170}{\H{U}}
9407   \DeclareUnicodeCharacter{0171}{\H{u}}
9408   \DeclareUnicodeCharacter{0174}{\^W}
9409   \DeclareUnicodeCharacter{0175}{\^w}
9410   \DeclareUnicodeCharacter{0176}{\^Y}
9411   \DeclareUnicodeCharacter{0177}{\^y}
9412   \DeclareUnicodeCharacter{0178}{\"Y}
9413   \DeclareUnicodeCharacter{0179}{\'Z}
9414   \DeclareUnicodeCharacter{017A}{\'z}
9415   \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9416   \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9417   \DeclareUnicodeCharacter{017D}{\v{Z}}
9418   \DeclareUnicodeCharacter{017E}{\v{z}}
9419
9420   \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9421   \DeclareUnicodeCharacter{01C5}{D\v{z}}
9422   \DeclareUnicodeCharacter{01C6}{d\v{z}}
9423   \DeclareUnicodeCharacter{01C7}{LJ}
9424   \DeclareUnicodeCharacter{01C8}{Lj}
9425   \DeclareUnicodeCharacter{01C9}{lj}
9426   \DeclareUnicodeCharacter{01CA}{NJ}
9427   \DeclareUnicodeCharacter{01CB}{Nj}
9428   \DeclareUnicodeCharacter{01CC}{nj}
9429   \DeclareUnicodeCharacter{01CD}{\v{A}}
9430   \DeclareUnicodeCharacter{01CE}{\v{a}}
9431   \DeclareUnicodeCharacter{01CF}{\v{I}}
9432
9433   \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9434   \DeclareUnicodeCharacter{01D1}{\v{O}}
9435   \DeclareUnicodeCharacter{01D2}{\v{o}}
9436   \DeclareUnicodeCharacter{01D3}{\v{U}}
9437   \DeclareUnicodeCharacter{01D4}{\v{u}}
9438
9439   \DeclareUnicodeCharacter{01E2}{\={\AE}}
9440   \DeclareUnicodeCharacter{01E3}{\={\ae}}
9441   \DeclareUnicodeCharacter{01E6}{\v{G}}
9442   \DeclareUnicodeCharacter{01E7}{\v{g}}
9443   \DeclareUnicodeCharacter{01E8}{\v{K}}
9444   \DeclareUnicodeCharacter{01E9}{\v{k}}
9445
9446   \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9447   \DeclareUnicodeCharacter{01F1}{DZ}
9448   \DeclareUnicodeCharacter{01F2}{Dz}
9449   \DeclareUnicodeCharacter{01F3}{dz}
9450   \DeclareUnicodeCharacter{01F4}{\'G}
9451   \DeclareUnicodeCharacter{01F5}{\'g}
9452   \DeclareUnicodeCharacter{01F8}{\`N}
9453   \DeclareUnicodeCharacter{01F9}{\`n}
9454   \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9455   \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9456   \DeclareUnicodeCharacter{01FE}{\'{\O}}
9457   \DeclareUnicodeCharacter{01FF}{\'{\o}}
9458
9459   \DeclareUnicodeCharacter{021E}{\v{H}}
9460   \DeclareUnicodeCharacter{021F}{\v{h}}
9461
9462   \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9463   \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9464   \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9465   \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9466   \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9467   \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9468
9469   \DeclareUnicodeCharacter{0232}{\=Y}
9470   \DeclareUnicodeCharacter{0233}{\=y}
9471   \DeclareUnicodeCharacter{0237}{\dotless{j}}
9472
9473   \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9474
9475   \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9476   \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9477   \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9478   \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9479   \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9480   \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9481   \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9482   \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9483   \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9484   \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9485   \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9486   \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9487
9488   \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9489   \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9490
9491   \DeclareUnicodeCharacter{1E20}{\=G}
9492   \DeclareUnicodeCharacter{1E21}{\=g}
9493   \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9494   \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9495   \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9496   \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9497   \DeclareUnicodeCharacter{1E26}{\"H}
9498   \DeclareUnicodeCharacter{1E27}{\"h}
9499
9500   \DeclareUnicodeCharacter{1E30}{\'K}
9501   \DeclareUnicodeCharacter{1E31}{\'k}
9502   \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9503   \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9504   \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9505   \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9506   \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9507   \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9508   \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9509   \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9510   \DeclareUnicodeCharacter{1E3E}{\'M}
9511   \DeclareUnicodeCharacter{1E3F}{\'m}
9512
9513   \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9514   \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9515   \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9516   \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9517   \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9518   \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9519   \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9520   \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9521   \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9522   \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9523
9524   \DeclareUnicodeCharacter{1E54}{\'P}
9525   \DeclareUnicodeCharacter{1E55}{\'p}
9526   \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9527   \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9528   \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9529   \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9530   \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9531   \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9532   \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9533   \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9534
9535   \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9536   \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9537   \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9538   \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9539   \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9540   \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9541   \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9542   \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9543   \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9544   \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9545
9546   \DeclareUnicodeCharacter{1E7C}{\~V}
9547   \DeclareUnicodeCharacter{1E7D}{\~v}
9548   \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9549   \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9550
9551   \DeclareUnicodeCharacter{1E80}{\`W}
9552   \DeclareUnicodeCharacter{1E81}{\`w}
9553   \DeclareUnicodeCharacter{1E82}{\'W}
9554   \DeclareUnicodeCharacter{1E83}{\'w}
9555   \DeclareUnicodeCharacter{1E84}{\"W}
9556   \DeclareUnicodeCharacter{1E85}{\"w}
9557   \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9558   \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9559   \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9560   \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9561   \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9562   \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9563   \DeclareUnicodeCharacter{1E8C}{\"X}
9564   \DeclareUnicodeCharacter{1E8D}{\"x}
9565   \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9566   \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9567
9568   \DeclareUnicodeCharacter{1E90}{\^Z}
9569   \DeclareUnicodeCharacter{1E91}{\^z}
9570   \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9571   \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9572   \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9573   \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9574   \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9575   \DeclareUnicodeCharacter{1E97}{\"t}
9576   \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9577   \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9578
9579   \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9580   \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9581
9582   \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9583   \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9584   \DeclareUnicodeCharacter{1EBC}{\~E}
9585   \DeclareUnicodeCharacter{1EBD}{\~e}
9586
9587   \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9588   \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9589   \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9590   \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9591
9592   \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9593   \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9594
9595   \DeclareUnicodeCharacter{1EF2}{\`Y}
9596   \DeclareUnicodeCharacter{1EF3}{\`y}
9597   \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9598
9599   \DeclareUnicodeCharacter{1EF8}{\~Y}
9600   \DeclareUnicodeCharacter{1EF9}{\~y}
9601
9602   \DeclareUnicodeCharacter{2013}{--}
9603   \DeclareUnicodeCharacter{2014}{---}
9604   \DeclareUnicodeCharacter{2018}{\quoteleft}
9605   \DeclareUnicodeCharacter{2019}{\quoteright}
9606   \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9607   \DeclareUnicodeCharacter{201C}{\quotedblleft}
9608   \DeclareUnicodeCharacter{201D}{\quotedblright}
9609   \DeclareUnicodeCharacter{201E}{\quotedblbase}
9610   \DeclareUnicodeCharacter{2022}{\bullet}
9611   \DeclareUnicodeCharacter{2026}{\dots}
9612   \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9613   \DeclareUnicodeCharacter{203A}{\guilsinglright}
9614   \DeclareUnicodeCharacter{20AC}{\euro}
9615
9616   \DeclareUnicodeCharacter{2192}{\expansion}
9617   \DeclareUnicodeCharacter{21D2}{\result}
9618
9619   \DeclareUnicodeCharacter{2212}{\minus}
9620   \DeclareUnicodeCharacter{2217}{\point}
9621   \DeclareUnicodeCharacter{2261}{\equiv}
9622 }% end of \utfeightchardefs
9623
9624
9625 % US-ASCII character definitions.
9626 \def\asciichardefs{% nothing need be done
9627    \relax
9628 }
9629
9630 % Make non-ASCII characters printable again for compatibility with
9631 % existing Texinfo documents that may use them, even without declaring a
9632 % document encoding.
9633 %
9634 \setnonasciicharscatcode \other
9635
9636
9637 \message{formatting,}
9638
9639 \newdimen\defaultparindent \defaultparindent = 15pt
9640
9641 \chapheadingskip = 15pt plus 4pt minus 2pt
9642 \secheadingskip = 12pt plus 3pt minus 2pt
9643 \subsecheadingskip = 9pt plus 2pt minus 2pt
9644
9645 % Prevent underfull vbox error messages.
9646 \vbadness = 10000
9647
9648 % Don't be very finicky about underfull hboxes, either.
9649 \hbadness = 6666
9650
9651 % Following George Bush, get rid of widows and orphans.
9652 \widowpenalty=10000
9653 \clubpenalty=10000
9654
9655 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9656 % using an old version of TeX, don't do anything.  We want the amount of
9657 % stretch added to depend on the line length, hence the dependence on
9658 % \hsize.  We call this whenever the paper size is set.
9659 %
9660 \def\setemergencystretch{%
9661   \ifx\emergencystretch\thisisundefined
9662     % Allow us to assign to \emergencystretch anyway.
9663     \def\emergencystretch{\dimen0}%
9664   \else
9665     \emergencystretch = .15\hsize
9666   \fi
9667 }
9668
9669 % Parameters in order: 1) textheight; 2) textwidth;
9670 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9671 % 7) physical page height; 8) physical page width.
9672 %
9673 % We also call \setleading{\textleading}, so the caller should define
9674 % \textleading.  The caller should also set \parskip.
9675 %
9676 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9677   \voffset = #3\relax
9678   \topskip = #6\relax
9679   \splittopskip = \topskip
9680   %
9681   \vsize = #1\relax
9682   \advance\vsize by \topskip
9683   \outervsize = \vsize
9684   \advance\outervsize by 2\topandbottommargin
9685   \pageheight = \vsize
9686   %
9687   \hsize = #2\relax
9688   \outerhsize = \hsize
9689   \advance\outerhsize by 0.5in
9690   \pagewidth = \hsize
9691   %
9692   \normaloffset = #4\relax
9693   \bindingoffset = #5\relax
9694   %
9695   \ifpdf
9696     \pdfpageheight #7\relax
9697     \pdfpagewidth #8\relax
9698     % if we don't reset these, they will remain at "1 true in" of
9699     % whatever layout pdftex was dumped with.
9700     \pdfhorigin = 1 true in
9701     \pdfvorigin = 1 true in
9702   \fi
9703   %
9704   \setleading{\textleading}
9705   %
9706   \parindent = \defaultparindent
9707   \setemergencystretch
9708 }
9709
9710 % @letterpaper (the default).
9711 \def\letterpaper{{\globaldefs = 1
9712   \parskip = 3pt plus 2pt minus 1pt
9713   \textleading = 13.2pt
9714   %
9715   % If page is nothing but text, make it come out even.
9716   \internalpagesizes{607.2pt}{6in}% that's 46 lines
9717                     {\voffset}{.25in}%
9718                     {\bindingoffset}{36pt}%
9719                     {11in}{8.5in}%
9720 }}
9721
9722 % Use @smallbook to reset parameters for 7x9.25 trim size.
9723 \def\smallbook{{\globaldefs = 1
9724   \parskip = 2pt plus 1pt
9725   \textleading = 12pt
9726   %
9727   \internalpagesizes{7.5in}{5in}%
9728                     {-.2in}{0in}%
9729                     {\bindingoffset}{16pt}%
9730                     {9.25in}{7in}%
9731   %
9732   \lispnarrowing = 0.3in
9733   \tolerance = 700
9734   \hfuzz = 1pt
9735   \contentsrightmargin = 0pt
9736   \defbodyindent = .5cm
9737 }}
9738
9739 % Use @smallerbook to reset parameters for 6x9 trim size.
9740 % (Just testing, parameters still in flux.)
9741 \def\smallerbook{{\globaldefs = 1
9742   \parskip = 1.5pt plus 1pt
9743   \textleading = 12pt
9744   %
9745   \internalpagesizes{7.4in}{4.8in}%
9746                     {-.2in}{-.4in}%
9747                     {0pt}{14pt}%
9748                     {9in}{6in}%
9749   %
9750   \lispnarrowing = 0.25in
9751   \tolerance = 700
9752   \hfuzz = 1pt
9753   \contentsrightmargin = 0pt
9754   \defbodyindent = .4cm
9755 }}
9756
9757 % Use @afourpaper to print on European A4 paper.
9758 \def\afourpaper{{\globaldefs = 1
9759   \parskip = 3pt plus 2pt minus 1pt
9760   \textleading = 13.2pt
9761   %
9762   % Double-side printing via postscript on Laserjet 4050
9763   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9764   % To change the settings for a different printer or situation, adjust
9765   % \normaloffset until the front-side and back-side texts align.  Then
9766   % do the same for \bindingoffset.  You can set these for testing in
9767   % your texinfo source file like this:
9768   % @tex
9769   % \global\normaloffset = -6mm
9770   % \global\bindingoffset = 10mm
9771   % @end tex
9772   \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9773                     {\voffset}{\hoffset}%
9774                     {\bindingoffset}{44pt}%
9775                     {297mm}{210mm}%
9776   %
9777   \tolerance = 700
9778   \hfuzz = 1pt
9779   \contentsrightmargin = 0pt
9780   \defbodyindent = 5mm
9781 }}
9782
9783 % Use @afivepaper to print on European A5 paper.
9784 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9785 % He also recommends making @example and @lisp be small.
9786 \def\afivepaper{{\globaldefs = 1
9787   \parskip = 2pt plus 1pt minus 0.1pt
9788   \textleading = 12.5pt
9789   %
9790   \internalpagesizes{160mm}{120mm}%
9791                     {\voffset}{\hoffset}%
9792                     {\bindingoffset}{8pt}%
9793                     {210mm}{148mm}%
9794   %
9795   \lispnarrowing = 0.2in
9796   \tolerance = 800
9797   \hfuzz = 1.2pt
9798   \contentsrightmargin = 0pt
9799   \defbodyindent = 2mm
9800   \tableindent = 12mm
9801 }}
9802
9803 % A specific text layout, 24x15cm overall, intended for A4 paper.
9804 \def\afourlatex{{\globaldefs = 1
9805   \afourpaper
9806   \internalpagesizes{237mm}{150mm}%
9807                     {\voffset}{4.6mm}%
9808                     {\bindingoffset}{7mm}%
9809                     {297mm}{210mm}%
9810   %
9811   % Must explicitly reset to 0 because we call \afourpaper.
9812   \globaldefs = 0
9813 }}
9814
9815 % Use @afourwide to print on A4 paper in landscape format.
9816 \def\afourwide{{\globaldefs = 1
9817   \afourpaper
9818   \internalpagesizes{241mm}{165mm}%
9819                     {\voffset}{-2.95mm}%
9820                     {\bindingoffset}{7mm}%
9821                     {297mm}{210mm}%
9822   \globaldefs = 0
9823 }}
9824
9825 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9826 % Perhaps we should allow setting the margins, \topskip, \parskip,
9827 % and/or leading, also. Or perhaps we should compute them somehow.
9828 %
9829 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9830 \def\pagesizesyyy#1,#2,#3\finish{{%
9831   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9832   \globaldefs = 1
9833   %
9834   \parskip = 3pt plus 2pt minus 1pt
9835   \setleading{\textleading}%
9836   %
9837   \dimen0 = #1\relax
9838   \advance\dimen0 by \voffset
9839   %
9840   \dimen2 = \hsize
9841   \advance\dimen2 by \normaloffset
9842   %
9843   \internalpagesizes{#1}{\hsize}%
9844                     {\voffset}{\normaloffset}%
9845                     {\bindingoffset}{44pt}%
9846                     {\dimen0}{\dimen2}%
9847 }}
9848
9849 % Set default to letter.
9850 %
9851 \letterpaper
9852
9853
9854 \message{and turning on texinfo input format.}
9855
9856 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9857
9858 % DEL is a comment character, in case @c does not suffice.
9859 \catcode`\^^? = 14
9860
9861 % Define macros to output various characters with catcode for normal text.
9862 \catcode`\"=\other \def\normaldoublequote{"}
9863 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9864 \catcode`\+=\other \def\normalplus{+}
9865 \catcode`\<=\other \def\normalless{<}
9866 \catcode`\>=\other \def\normalgreater{>}
9867 \catcode`\^=\other \def\normalcaret{^}
9868 \catcode`\_=\other \def\normalunderscore{_}
9869 \catcode`\|=\other \def\normalverticalbar{|}
9870 \catcode`\~=\other \def\normaltilde{~}
9871
9872 % This macro is used to make a character print one way in \tt
9873 % (where it can probably be output as-is), and another way in other fonts,
9874 % where something hairier probably needs to be done.
9875 %
9876 % #1 is what to print if we are indeed using \tt; #2 is what to print
9877 % otherwise.  Since all the Computer Modern typewriter fonts have zero
9878 % interword stretch (and shrink), and it is reasonable to expect all
9879 % typewriter fonts to have this, we can check that font parameter.
9880 %
9881 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9882
9883 % Same as above, but check for italic font.  Actually this also catches
9884 % non-italic slanted fonts since it is impossible to distinguish them from
9885 % italic fonts.  But since this is only used by $ and it uses \sl anyway
9886 % this is not a problem.
9887 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9888
9889 % Turn off all special characters except @
9890 % (and those which the user can use as if they were ordinary).
9891 % Most of these we simply print from the \tt font, but for some, we can
9892 % use math or other variants that look better in normal text.
9893
9894 \catcode`\"=\active
9895 \def\activedoublequote{{\tt\char34}}
9896 \let"=\activedoublequote
9897 \catcode`\~=\active
9898 \def~{{\tt\char126}}
9899 \chardef\hat=`\^
9900 \catcode`\^=\active
9901 \def^{{\tt \hat}}
9902
9903 \catcode`\_=\active
9904 \def_{\ifusingtt\normalunderscore\_}
9905 \let\realunder=_
9906 % Subroutine for the previous macro.
9907 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9908
9909 \catcode`\|=\active
9910 \def|{{\tt\char124}}
9911 \chardef \less=`\<
9912 \catcode`\<=\active
9913 \def<{{\tt \less}}
9914 \chardef \gtr=`\>
9915 \catcode`\>=\active
9916 \def>{{\tt \gtr}}
9917 \catcode`\+=\active
9918 \def+{{\tt \char 43}}
9919 \catcode`\$=\active
9920 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9921
9922 % If a .fmt file is being used, characters that might appear in a file
9923 % name cannot be active until we have parsed the command line.
9924 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9925 % \otherifyactive is called near the end of this file.
9926 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9927
9928 % Used sometimes to turn off (effectively) the active characters even after
9929 % parsing them.
9930 \def\turnoffactive{%
9931   \normalturnoffactive
9932   \otherbackslash
9933 }
9934
9935 \catcode`\@=0
9936
9937 % \backslashcurfont outputs one backslash character in current font,
9938 % as in \char`\\.
9939 \global\chardef\backslashcurfont=`\\
9940 \global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
9941
9942 % \realbackslash is an actual character `\' with catcode other, and
9943 % \doublebackslash is two of them (for the pdf outlines).
9944 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9945
9946 % In texinfo, backslash is an active character; it prints the backslash
9947 % in fixed width font.
9948 \catcode`\\=\active  % @ for escape char from now on.
9949
9950 % The story here is that in math mode, the \char of \backslashcurfont
9951 % ends up printing the roman \ from the math symbol font (because \char
9952 % in math mode uses the \mathcode, and plain.tex sets
9953 % \mathcode`\\="026E).  It seems better for @backslashchar{} to always
9954 % print a typewriter backslash, hence we use an explicit \mathchar,
9955 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
9956 % ignored family value; char position "5C).  We can't use " for the
9957 % usual hex value because it has already been made active.
9958 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
9959 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
9960
9961 % On startup, @fixbackslash assigns:
9962 %  @let \ = @normalbackslash
9963 % \rawbackslash defines an active \ to do \backslashcurfont.
9964 % \otherbackslash defines an active \ to be a literal `\' character with
9965 % catcode other.  We switch back and forth between these.
9966 @gdef@rawbackslash{@let\=@backslashcurfont}
9967 @gdef@otherbackslash{@let\=@realbackslash}
9968
9969 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9970 % the literal character `\'.
9971 %
9972 @def@normalturnoffactive{%
9973   @let"=@normaldoublequote
9974   @let$=@normaldollar %$ font-lock fix
9975   @let+=@normalplus
9976   @let<=@normalless
9977   @let>=@normalgreater
9978   @let\=@normalbackslash
9979   @let^=@normalcaret
9980   @let_=@normalunderscore
9981   @let|=@normalverticalbar
9982   @let~=@normaltilde
9983   @markupsetuplqdefault
9984   @markupsetuprqdefault
9985   @unsepspaces
9986 }
9987
9988 % Make _ and + \other characters, temporarily.
9989 % This is canceled by @fixbackslash.
9990 @otherifyactive
9991
9992 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9993 % That is what \eatinput is for; after that, the `\' should revert to printing
9994 % a backslash.
9995 %
9996 @gdef@eatinput input texinfo{@fixbackslash}
9997 @global@let\ = @eatinput
9998
9999 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10000 % the first `\' in the file would cause an error. This macro tries to fix
10001 % that, assuming it is called before the first `\' could plausibly occur.
10002 % Also turn back on active characters that might appear in the input
10003 % file name, in case not using a pre-dumped format.
10004 %
10005 @gdef@fixbackslash{%
10006   @ifx\@eatinput @let\ = @normalbackslash @fi
10007   @catcode`+=@active
10008   @catcode`@_=@active
10009 }
10010
10011 % Say @foo, not \foo, in error messages.
10012 @escapechar = `@@
10013
10014 % These (along with & and #) are made active for url-breaking, so need
10015 % active definitions as the normal characters.
10016 @def@normaldot{.}
10017 @def@normalquest{?}
10018 @def@normalslash{/}
10019
10020 % These look ok in all fonts, so just make them not special.
10021 % @hashchar{} gets its own user-level command, because of #line.
10022 @catcode`@& = @other @def@normalamp{&}
10023 @catcode`@# = @other @def@normalhash{#}
10024 @catcode`@% = @other @def@normalpercent{%}
10025
10026 @let @hashchar = @normalhash
10027
10028 @c Finally, make ` and ' active, so that txicodequoteundirected and
10029 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
10030 @c don't make ` and ' active, @code will not get them as active chars.
10031 @c Do this last of all since we use ` in the previous @catcode assignments.
10032 @catcode`@'=@active
10033 @catcode`@`=@active
10034 @markupsetuplqdefault
10035 @markupsetuprqdefault
10036
10037 @c Local variables:
10038 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10039 @c page-delimiter: "^\\\\message"
10040 @c time-stamp-start: "def\\\\texinfoversion{"
10041 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10042 @c time-stamp-end: "}"
10043 @c End:
10044
10045 @c vim:sw=2:
10046
10047 @ignore
10048    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
10049 @end ignore