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