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