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