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