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