prepare for running sanity.sh and uploading if it works
[alioth/cvs.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{2005-01-30.17}
7 %
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software
10 % 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., 59 Temple Place - Suite 330,
25 % Boston, MA 02111-1307, 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 \message{Basics,}
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 % In some macros, we cannot use the `\? notation---the left quote is
157 % in some cases the escape char.
158 \chardef\colonChar = `\:
159 \chardef\commaChar = `\,
160 \chardef\dotChar   = `\.
161 \chardef\exclamChar= `\!
162 \chardef\questChar = `\?
163 \chardef\semiChar  = `\;
164 \chardef\underChar = `\_
165
166 \chardef\spaceChar = `\ %
167 \chardef\spacecat = 10
168 \def\spaceisspace{\catcode\spaceChar=\spacecat}
169
170 % Ignore a token.
171 %
172 \def\gobble#1{}
173
174 % The following is used inside several \edef's.
175 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
176
177 % Hyphenation fixes.
178 \hyphenation{
179   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
180   ap-pen-dix bit-map bit-maps
181   data-base data-bases eshell fall-ing half-way long-est man-u-script
182   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
183   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
184   spell-ing spell-ings
185   stand-alone strong-est time-stamp time-stamps which-ever white-space
186   wide-spread wrap-around
187 }
188
189 % Margin to add to right of even pages, to left of odd pages.
190 \newdimen\bindingoffset
191 \newdimen\normaloffset
192 \newdimen\pagewidth \newdimen\pageheight
193
194 % For a final copy, take out the rectangles
195 % that mark overfull boxes (in case you have decided
196 % that the text looks ok even though it passes the margin).
197 %
198 \def\finalout{\overfullrule=0pt}
199
200 % @| inserts a changebar to the left of the current line.  It should
201 % surround any changed text.  This approach does *not* work if the
202 % change spans more than two lines of output.  To handle that, we would
203 % have adopt a much more difficult approach (putting marks into the main
204 % vertical list for the beginning and end of each change).
205 %
206 \def\|{%
207   % \vadjust can only be used in horizontal mode.
208   \leavevmode
209   %
210   % Append this vertical mode material after the current line in the output.
211   \vadjust{%
212     % We want to insert a rule with the height and depth of the current
213     % leading; that is exactly what \strutbox is supposed to record.
214     \vskip-\baselineskip
215     %
216     % \vadjust-items are inserted at the left edge of the type.  So
217     % the \llap here moves out into the left-hand margin.
218     \llap{%
219       %
220       % For a thicker or thinner bar, change the `1pt'.
221       \vrule height\baselineskip width1pt
222       %
223       % This is the space between the bar and the text.
224       \hskip 12pt
225     }%
226   }%
227 }
228
229 % Sometimes it is convenient to have everything in the transcript file
230 % and nothing on the terminal.  We don't just call \tracingall here,
231 % since that produces some useless output on the terminal.  We also make
232 % some effort to order the tracing commands to reduce output in the log
233 % file; cf. trace.sty in LaTeX.
234 %
235 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
236 \def\loggingall{%
237   \tracingstats2
238   \tracingpages1
239   \tracinglostchars2  % 2 gives us more in etex
240   \tracingparagraphs1
241   \tracingoutput1
242   \tracingmacros2
243   \tracingrestores1
244   \showboxbreadth\maxdimen \showboxdepth\maxdimen
245   \ifx\eTeXversion\undefined\else % etex gives us more logging
246     \tracingscantokens1
247     \tracingifs1
248     \tracinggroups1
249     \tracingnesting2
250     \tracingassigns1
251   \fi
252   \tracingcommands3  % 3 gives us more in etex
253   \errorcontextlines16
254 }%
255
256 % add check for \lastpenalty to plain's definitions.  If the last thing
257 % we did was a \nobreak, we don't want to insert more space.
258 %
259 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
260   \removelastskip\penalty-50\smallskip\fi\fi}
261 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
262   \removelastskip\penalty-100\medskip\fi\fi}
263 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
264   \removelastskip\penalty-200\bigskip\fi\fi}
265
266 % For @cropmarks command.
267 % Do @cropmarks to get crop marks.
268 %
269 \newif\ifcropmarks
270 \let\cropmarks = \cropmarkstrue
271 %
272 % Dimensions to add cropmarks at corners.
273 % Added by P. A. MacKay, 12 Nov. 1986
274 %
275 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
276 \newdimen\cornerlong  \cornerlong=1pc
277 \newdimen\cornerthick \cornerthick=.3pt
278 \newdimen\topandbottommargin \topandbottommargin=.75in
279
280 % Main output routine.
281 \chardef\PAGE = 255
282 \output = {\onepageout{\pagecontents\PAGE}}
283
284 \newbox\headlinebox
285 \newbox\footlinebox
286
287 % \onepageout takes a vbox as an argument.  Note that \pagecontents
288 % does insertions, but you have to call it yourself.
289 \def\onepageout#1{%
290   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
291   %
292   \ifodd\pageno  \advance\hoffset by \bindingoffset
293   \else \advance\hoffset by -\bindingoffset\fi
294   %
295   % Do this outside of the \shipout so @code etc. will be expanded in
296   % the headline as they should be, not taken literally (outputting ''code).
297   \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
298   \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
299   %
300   {%
301     % Have to do this stuff outside the \shipout because we want it to
302     % take effect in \write's, yet the group defined by the \vbox ends
303     % before the \shipout runs.
304     %
305     \escapechar = `\\     % use backslash in output files.
306     \indexdummies         % don't expand commands in the output.
307     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
308                    % the page break happens to be in the middle of an example.
309     \shipout\vbox{%
310       % Do this early so pdf references go to the beginning of the page.
311       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
312       %
313       \ifcropmarks \vbox to \outervsize\bgroup
314         \hsize = \outerhsize
315         \vskip-\topandbottommargin
316         \vtop to0pt{%
317           \line{\ewtop\hfil\ewtop}%
318           \nointerlineskip
319           \line{%
320             \vbox{\moveleft\cornerthick\nstop}%
321             \hfill
322             \vbox{\moveright\cornerthick\nstop}%
323           }%
324           \vss}%
325         \vskip\topandbottommargin
326         \line\bgroup
327           \hfil % center the page within the outer (page) hsize.
328           \ifodd\pageno\hskip\bindingoffset\fi
329           \vbox\bgroup
330       \fi
331       %
332       \unvbox\headlinebox
333       \pagebody{#1}%
334       \ifdim\ht\footlinebox > 0pt
335         % Only leave this space if the footline is nonempty.
336         % (We lessened \vsize for it in \oddfootingxxx.)
337         % The \baselineskip=24pt in plain's \makefootline has no effect.
338         \vskip 2\baselineskip
339         \unvbox\footlinebox
340       \fi
341       %
342       \ifcropmarks
343           \egroup % end of \vbox\bgroup
344         \hfil\egroup % end of (centering) \line\bgroup
345         \vskip\topandbottommargin plus1fill minus1fill
346         \boxmaxdepth = \cornerthick
347         \vbox to0pt{\vss
348           \line{%
349             \vbox{\moveleft\cornerthick\nsbot}%
350             \hfill
351             \vbox{\moveright\cornerthick\nsbot}%
352           }%
353           \nointerlineskip
354           \line{\ewbot\hfil\ewbot}%
355         }%
356       \egroup % \vbox from first cropmarks clause
357       \fi
358     }% end of \shipout\vbox
359   }% end of group with \normalturnoffactive
360   \advancepageno
361   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
362 }
363
364 \newinsert\margin \dimen\margin=\maxdimen
365
366 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
367 {\catcode`\@ =11
368 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
369 % marginal hacks, juha@viisa.uucp (Juha Takala)
370 \ifvoid\margin\else % marginal info is present
371   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
372 \dimen@=\dp#1 \unvbox#1
373 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
374 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
375 }
376
377 % Here are the rules for the cropmarks.  Note that they are
378 % offset so that the space between them is truly \outerhsize or \outervsize
379 % (P. A. MacKay, 12 November, 1986)
380 %
381 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
382 \def\nstop{\vbox
383   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
384 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
385 \def\nsbot{\vbox
386   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
387
388 % Parse an argument, then pass it to #1.  The argument is the rest of
389 % the input line (except we remove a trailing comment).  #1 should be a
390 % macro which expects an ordinary undelimited TeX argument.
391 %
392 \def\parsearg{\parseargusing{}}
393 \def\parseargusing#1#2{%
394   \def\next{#2}%
395   \begingroup
396     \obeylines
397     \spaceisspace
398     #1%
399     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
400 }
401
402 {\obeylines %
403   \gdef\parseargline#1^^M{%
404     \endgroup % End of the group started in \parsearg.
405     \argremovecomment #1\comment\ArgTerm%
406   }%
407 }
408
409 % First remove any @comment, then any @c comment.
410 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
411 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
412
413 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
414 %
415 % \argremovec might leave us with trailing space, e.g.,
416 %    @end itemize  @c foo
417 % This space token undergoes the same procedure and is eventually removed
418 % by \finishparsearg.
419 %
420 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
421 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
422 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
423   \def\temp{#3}%
424   \ifx\temp\empty
425     % We cannot use \next here, as it holds the macro to run;
426     % thus we reuse \temp.
427     \let\temp\finishparsearg
428   \else
429     \let\temp\argcheckspaces
430   \fi
431   % Put the space token in:
432   \temp#1 #3\ArgTerm
433 }
434
435 % If a _delimited_ argument is enclosed in braces, they get stripped; so
436 % to get _exactly_ the rest of the line, we had to prevent such situation.
437 % We prepended an \empty token at the very beginning and we expand it now,
438 % just before passing the control to \next.
439 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
440 % either the null string, or it ends with \^^M---thus there is no danger
441 % that a pair of braces would be stripped.
442 %
443 % But first, we have to remove the trailing space token.
444 %
445 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
446
447 % \parseargdef\foo{...}
448 %       is roughly equivalent to
449 % \def\foo{\parsearg\Xfoo}
450 % \def\Xfoo#1{...}
451 %
452 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
453 % favourite TeX trick.  --kasal, 16nov03
454
455 \def\parseargdef#1{%
456   \expandafter \doparseargdef \csname\string#1\endcsname #1%
457 }
458 \def\doparseargdef#1#2{%
459   \def#2{\parsearg#1}%
460   \def#1##1%
461 }
462
463 % Several utility definitions with active space:
464 {
465   \obeyspaces
466   \gdef\obeyedspace{ }
467
468   % Make each space character in the input produce a normal interword
469   % space in the output.  Don't allow a line break at this space, as this
470   % is used only in environments like @example, where each line of input
471   % should produce a line of output anyway.
472   %
473   \gdef\sepspaces{\obeyspaces\let =\tie}
474
475   % If an index command is used in an @example environment, any spaces
476   % therein should become regular spaces in the raw index file, not the
477   % expansion of \tie (\leavevmode \penalty \@M \ ).
478   \gdef\unsepspaces{\let =\space}
479 }
480
481
482 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
483
484 % Define the framework for environments in texinfo.tex.  It's used like this:
485 %
486 %   \envdef\foo{...}
487 %   \def\Efoo{...}
488 %
489 % It's the responsibility of \envdef to insert \begingroup before the
490 % actual body; @end closes the group after calling \Efoo.  \envdef also
491 % defines \thisenv, so the current environment is known; @end checks
492 % whether the environment name matches.  The \checkenv macro can also be
493 % used to check whether the current environment is the one expected.
494 %
495 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
496 % are not treated as enviroments; they don't open a group.  (The
497 % implementation of @end takes care not to call \endgroup in this
498 % special case.)
499
500
501 % At runtime, environments start with this:
502 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
503 % initialize
504 \let\thisenv\empty
505
506 % ... but they get defined via ``\envdef\foo{...}'':
507 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
508 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
509
510 % Check whether we're in the right environment:
511 \def\checkenv#1{%
512   \def\temp{#1}%
513   \ifx\thisenv\temp
514   \else
515     \badenverr
516   \fi
517 }
518
519 % Evironment mismatch, #1 expected:
520 \def\badenverr{%
521   \errhelp = \EMsimple
522   \errmessage{This command can appear only \inenvironment\temp,
523     not \inenvironment\thisenv}%
524 }
525 \def\inenvironment#1{%
526   \ifx#1\empty
527     out of any environment%
528   \else
529     in environment \expandafter\string#1%
530   \fi
531 }
532
533 % @end foo executes the definition of \Efoo.
534 % But first, it executes a specialized version of \checkenv
535 %
536 \parseargdef\end{%
537   \if 1\csname iscond.#1\endcsname
538   \else
539     % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
540     \expandafter\checkenv\csname#1\endcsname
541     \csname E#1\endcsname
542     \endgroup
543   \fi
544 }
545
546 \newhelp\EMsimple{Press RETURN to continue.}
547
548
549 %% Simple single-character @ commands
550
551 % @@ prints an @
552 % Kludge this until the fonts are right (grr).
553 \def\@{{\tt\char64}}
554
555 % This is turned off because it was never documented
556 % and you can use @w{...} around a quote to suppress ligatures.
557 %% Define @` and @' to be the same as ` and '
558 %% but suppressing ligatures.
559 %\def\`{{`}}
560 %\def\'{{'}}
561
562 % Used to generate quoted braces.
563 \def\mylbrace {{\tt\char123}}
564 \def\myrbrace {{\tt\char125}}
565 \let\{=\mylbrace
566 \let\}=\myrbrace
567 \begingroup
568   % Definitions to produce \{ and \} commands for indices,
569   % and @{ and @} for the aux file.
570   \catcode`\{ = \other \catcode`\} = \other
571   \catcode`\[ = 1 \catcode`\] = 2
572   \catcode`\! = 0 \catcode`\\ = \other
573   !gdef!lbracecmd[\{]%
574   !gdef!rbracecmd[\}]%
575   !gdef!lbraceatcmd[@{]%
576   !gdef!rbraceatcmd[@}]%
577 !endgroup
578
579 % @comma{} to avoid , parsing problems.
580 \let\comma = ,
581
582 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
583 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
584 \let\, = \c
585 \let\dotaccent = \.
586 \def\ringaccent#1{{\accent23 #1}}
587 \let\tieaccent = \t
588 \let\ubaraccent = \b
589 \let\udotaccent = \d
590
591 % Other special characters: @questiondown @exclamdown @ordf @ordm
592 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
593 \def\questiondown{?`}
594 \def\exclamdown{!`}
595 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
596 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
597
598 % Dotless i and dotless j, used for accents.
599 \def\imacro{i}
600 \def\jmacro{j}
601 \def\dotless#1{%
602   \def\temp{#1}%
603   \ifx\temp\imacro \ptexi
604   \else\ifx\temp\jmacro \j
605   \else \errmessage{@dotless can be used only with i or j}%
606   \fi\fi
607 }
608
609 % The \TeX{} logo, as in plain, but resetting the spacing so that a
610 % period following counts as ending a sentence.  (Idea found in latex.)
611 %
612 \edef\TeX{\TeX \spacefactor=1000 }
613
614 % @LaTeX{} logo.  Not quite the same results as the definition in
615 % latex.ltx, since we use a different font for the raised A; it's most
616 % convenient for us to use an explicitly smaller font, rather than using
617 % the \scriptstyle font (since we don't reset \scriptstyle and
618 % \scriptscriptstyle).
619 %
620 \def\LaTeX{%
621   L\kern-.36em
622   {\setbox0=\hbox{T}%
623    \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
624   \kern-.15em
625   \TeX
626 }
627
628 % Be sure we're in horizontal mode when doing a tie, since we make space
629 % equivalent to this in @example-like environments. Otherwise, a space
630 % at the beginning of a line will start with \penalty -- and
631 % since \penalty is valid in vertical mode, we'd end up putting the
632 % penalty on the vertical list instead of in the new paragraph.
633 {\catcode`@ = 11
634  % Avoid using \@M directly, because that causes trouble
635  % if the definition is written into an index file.
636  \global\let\tiepenalty = \@M
637  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
638 }
639
640 % @: forces normal size whitespace following.
641 \def\:{\spacefactor=1000 }
642
643 % @* forces a line break.
644 \def\*{\hfil\break\hbox{}\ignorespaces}
645
646 % @/ allows a line break.
647 \let\/=\allowbreak
648
649 % @. is an end-of-sentence period.
650 \def\.{.\spacefactor=3000 }
651
652 % @! is an end-of-sentence bang.
653 \def\!{!\spacefactor=3000 }
654
655 % @? is an end-of-sentence query.
656 \def\?{?\spacefactor=3000 }
657
658 % @w prevents a word break.  Without the \leavevmode, @w at the
659 % beginning of a paragraph, when TeX is still in vertical mode, would
660 % produce a whole line of output instead of starting the paragraph.
661 \def\w#1{\leavevmode\hbox{#1}}
662
663 % @group ... @end group forces ... to be all on one page, by enclosing
664 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
665 % to keep its height that of a normal line.  According to the rules for
666 % \topskip (p.114 of the TeXbook), the glue inserted is
667 % max (\topskip - \ht (first item), 0).  If that height is large,
668 % therefore, no glue is inserted, and the space between the headline and
669 % the text is small, which looks bad.
670 %
671 % Another complication is that the group might be very large.  This can
672 % cause the glue on the previous page to be unduly stretched, because it
673 % does not have much material.  In this case, it's better to add an
674 % explicit \vfill so that the extra space is at the bottom.  The
675 % threshold for doing this is if the group is more than \vfilllimit
676 % percent of a page (\vfilllimit can be changed inside of @tex).
677 %
678 \newbox\groupbox
679 \def\vfilllimit{0.7}
680 %
681 \envdef\group{%
682   \ifnum\catcode`\^^M=\active \else
683     \errhelp = \groupinvalidhelp
684     \errmessage{@group invalid in context where filling is enabled}%
685   \fi
686   \startsavinginserts
687   %
688   \setbox\groupbox = \vtop\bgroup
689     % Do @comment since we are called inside an environment such as
690     % @example, where each end-of-line in the input causes an
691     % end-of-line in the output.  We don't want the end-of-line after
692     % the `@group' to put extra space in the output.  Since @group
693     % should appear on a line by itself (according to the Texinfo
694     % manual), we don't worry about eating any user text.
695     \comment
696 }
697 %
698 % The \vtop produces a box with normal height and large depth; thus, TeX puts
699 % \baselineskip glue before it, and (when the next line of text is done)
700 % \lineskip glue after it.  Thus, space below is not quite equal to space
701 % above.  But it's pretty close.
702 \def\Egroup{%
703     % To get correct interline space between the last line of the group
704     % and the first line afterwards, we have to propagate \prevdepth.
705     \endgraf % Not \par, as it may have been set to \lisppar.
706     \global\dimen1 = \prevdepth
707   \egroup           % End the \vtop.
708   % \dimen0 is the vertical size of the group's box.
709   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
710   % \dimen2 is how much space is left on the page (more or less).
711   \dimen2 = \pageheight   \advance\dimen2 by -\pagetotal
712   % if the group doesn't fit on the current page, and it's a big big
713   % group, force a page break.
714   \ifdim \dimen0 > \dimen2
715     \ifdim \pagetotal < \vfilllimit\pageheight
716       \page
717     \fi
718   \fi
719   \box\groupbox
720   \prevdepth = \dimen1
721   \checkinserts
722 }
723 %
724 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
725 % message, so this ends up printing `@group can only ...'.
726 %
727 \newhelp\groupinvalidhelp{%
728 group can only be used in environments such as @example,^^J%
729 where each line of input produces a line of output.}
730
731 % @need space-in-mils
732 % forces a page break if there is not space-in-mils remaining.
733
734 \newdimen\mil  \mil=0.001in
735
736 % Old definition--didn't work.
737 %\parseargdef\need{\par %
738 %% This method tries to make TeX break the page naturally
739 %% if the depth of the box does not fit.
740 %{\baselineskip=0pt%
741 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
742 %\prevdepth=-1000pt
743 %}}
744
745 \parseargdef\need{%
746   % Ensure vertical mode, so we don't make a big box in the middle of a
747   % paragraph.
748   \par
749   %
750   % If the @need value is less than one line space, it's useless.
751   \dimen0 = #1\mil
752   \dimen2 = \ht\strutbox
753   \advance\dimen2 by \dp\strutbox
754   \ifdim\dimen0 > \dimen2
755     %
756     % Do a \strut just to make the height of this box be normal, so the
757     % normal leading is inserted relative to the preceding line.
758     % And a page break here is fine.
759     \vtop to #1\mil{\strut\vfil}%
760     %
761     % TeX does not even consider page breaks if a penalty added to the
762     % main vertical list is 10000 or more.  But in order to see if the
763     % empty box we just added fits on the page, we must make it consider
764     % page breaks.  On the other hand, we don't want to actually break the
765     % page after the empty box.  So we use a penalty of 9999.
766     %
767     % There is an extremely small chance that TeX will actually break the
768     % page at this \penalty, if there are no other feasible breakpoints in
769     % sight.  (If the user is using lots of big @group commands, which
770     % almost-but-not-quite fill up a page, TeX will have a hard time doing
771     % good page breaking, for example.)  However, I could not construct an
772     % example where a page broke at this \penalty; if it happens in a real
773     % document, then we can reconsider our strategy.
774     \penalty9999
775     %
776     % Back up by the size of the box, whether we did a page break or not.
777     \kern -#1\mil
778     %
779     % Do not allow a page break right after this kern.
780     \nobreak
781   \fi
782 }
783
784 % @br   forces paragraph break (and is undocumented).
785
786 \let\br = \par
787
788 % @page forces the start of a new page.
789 %
790 \def\page{\par\vfill\supereject}
791
792 % @exdent text....
793 % outputs text on separate line in roman font, starting at standard page margin
794
795 % This records the amount of indent in the innermost environment.
796 % That's how much \exdent should take out.
797 \newskip\exdentamount
798
799 % This defn is used inside fill environments such as @defun.
800 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
801
802 % This defn is used inside nofill environments such as @example.
803 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
804   \leftline{\hskip\leftskip{\rm#1}}}}
805
806 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
807 % paragraph.  For more general purposes, use the \margin insertion
808 % class.  WHICH is `l' or `r'.
809 %
810 \newskip\inmarginspacing \inmarginspacing=1cm
811 \def\strutdepth{\dp\strutbox}
812 %
813 \def\doinmargin#1#2{\strut\vadjust{%
814   \nobreak
815   \kern-\strutdepth
816   \vtop to \strutdepth{%
817     \baselineskip=\strutdepth
818     \vss
819     % if you have multiple lines of stuff to put here, you'll need to
820     % make the vbox yourself of the appropriate size.
821     \ifx#1l%
822       \llap{\ignorespaces #2\hskip\inmarginspacing}%
823     \else
824       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
825     \fi
826     \null
827   }%
828 }}
829 \def\inleftmargin{\doinmargin l}
830 \def\inrightmargin{\doinmargin r}
831 %
832 % @inmargin{TEXT [, RIGHT-TEXT]}
833 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
834 % else use TEXT for both).
835 %
836 \def\inmargin#1{\parseinmargin #1,,\finish}
837 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
838   \setbox0 = \hbox{\ignorespaces #2}%
839   \ifdim\wd0 > 0pt
840     \def\lefttext{#1}%  have both texts
841     \def\righttext{#2}%
842   \else
843     \def\lefttext{#1}%  have only one text
844     \def\righttext{#1}%
845   \fi
846   %
847   \ifodd\pageno
848     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
849   \else
850     \def\temp{\inleftmargin\lefttext}%
851   \fi
852   \temp
853 }
854
855 % @include file    insert text of that file as input.
856 %
857 \def\include{\parseargusing\filenamecatcodes\includezzz}
858 \def\includezzz#1{%
859   \pushthisfilestack
860   \def\thisfile{#1}%
861   {%
862     \makevalueexpandable
863     \def\temp{\input #1 }%
864     \expandafter
865   }\temp
866   \popthisfilestack
867 }
868 \def\filenamecatcodes{%
869   \catcode`\\=\other
870   \catcode`~=\other
871   \catcode`^=\other
872   \catcode`_=\other
873   \catcode`|=\other
874   \catcode`<=\other
875   \catcode`>=\other
876   \catcode`+=\other
877   \catcode`-=\other
878 }
879
880 \def\pushthisfilestack{%
881   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
882 }
883 \def\pushthisfilestackX{%
884   \expandafter\pushthisfilestackY\thisfile\StackTerm
885 }
886 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
887   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
888 }
889
890 \def\popthisfilestack{\errthisfilestackempty}
891 \def\errthisfilestackempty{\errmessage{Internal error:
892   the stack of filenames is empty.}}
893
894 \def\thisfile{}
895
896 % @center line
897 % outputs that line, centered.
898 %
899 \parseargdef\center{%
900   \ifhmode
901     \let\next\centerH
902   \else
903     \let\next\centerV
904   \fi
905   \next{\hfil \ignorespaces#1\unskip \hfil}%
906 }
907 \def\centerH#1{%
908   {%
909     \hfil\break
910     \advance\hsize by -\leftskip
911     \advance\hsize by -\rightskip
912     \line{#1}%
913     \break
914   }%
915 }
916 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
917
918 % @sp n   outputs n lines of vertical space
919
920 \parseargdef\sp{\vskip #1\baselineskip}
921
922 % @comment ...line which is ignored...
923 % @c is the same as @comment
924 % @ignore ... @end ignore  is another way to write a comment
925
926 \def\comment{\begingroup \catcode`\^^M=\other%
927 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
928 \commentxxx}
929 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
930
931 \let\c=\comment
932
933 % @paragraphindent NCHARS
934 % We'll use ems for NCHARS, close enough.
935 % NCHARS can also be the word `asis' or `none'.
936 % We cannot feasibly implement @paragraphindent asis, though.
937 %
938 \def\asisword{asis} % no translation, these are keywords
939 \def\noneword{none}
940 %
941 \parseargdef\paragraphindent{%
942   \def\temp{#1}%
943   \ifx\temp\asisword
944   \else
945     \ifx\temp\noneword
946       \defaultparindent = 0pt
947     \else
948       \defaultparindent = #1em
949     \fi
950   \fi
951   \parindent = \defaultparindent
952 }
953
954 % @exampleindent NCHARS
955 % We'll use ems for NCHARS like @paragraphindent.
956 % It seems @exampleindent asis isn't necessary, but
957 % I preserve it to make it similar to @paragraphindent.
958 \parseargdef\exampleindent{%
959   \def\temp{#1}%
960   \ifx\temp\asisword
961   \else
962     \ifx\temp\noneword
963       \lispnarrowing = 0pt
964     \else
965       \lispnarrowing = #1em
966     \fi
967   \fi
968 }
969
970 % @firstparagraphindent WORD
971 % If WORD is `none', then suppress indentation of the first paragraph
972 % after a section heading.  If WORD is `insert', then do indent at such
973 % paragraphs.
974 %
975 % The paragraph indentation is suppressed or not by calling
976 % \suppressfirstparagraphindent, which the sectioning commands do.
977 % We switch the definition of this back and forth according to WORD.
978 % By default, we suppress indentation.
979 %
980 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
981 \def\insertword{insert}
982 %
983 \parseargdef\firstparagraphindent{%
984   \def\temp{#1}%
985   \ifx\temp\noneword
986     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
987   \else\ifx\temp\insertword
988     \let\suppressfirstparagraphindent = \relax
989   \else
990     \errhelp = \EMsimple
991     \errmessage{Unknown @firstparagraphindent option `\temp'}%
992   \fi\fi
993 }
994
995 % Here is how we actually suppress indentation.  Redefine \everypar to
996 % \kern backwards by \parindent, and then reset itself to empty.
997 %
998 % We also make \indent itself not actually do anything until the next
999 % paragraph.
1000 %
1001 \gdef\dosuppressfirstparagraphindent{%
1002   \gdef\indent{%
1003     \restorefirstparagraphindent
1004     \indent
1005   }%
1006   \gdef\noindent{%
1007     \restorefirstparagraphindent
1008     \noindent
1009   }%
1010   \global\everypar = {%
1011     \kern -\parindent
1012     \restorefirstparagraphindent
1013   }%
1014 }
1015
1016 \gdef\restorefirstparagraphindent{%
1017   \global \let \indent = \ptexindent
1018   \global \let \noindent = \ptexnoindent
1019   \global \everypar = {}%
1020 }
1021
1022
1023 % @asis just yields its argument.  Used with @table, for example.
1024 %
1025 \def\asis#1{#1}
1026
1027 % @math outputs its argument in math mode.
1028 %
1029 % One complication: _ usually means subscripts, but it could also mean
1030 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
1031 % _ active, and distinguish by seeing if the current family is \slfam,
1032 % which is what @var uses.
1033 {
1034   \catcode\underChar = \active
1035   \gdef\mathunderscore{%
1036     \catcode\underChar=\active
1037     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1038   }
1039 }
1040 % Another complication: we want \\ (and @\) to output a \ character.
1041 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1042 % this is not advertised and we don't care.  Texinfo does not
1043 % otherwise define @\.
1044 %
1045 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1046 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1047 %
1048 \def\math{%
1049   \tex
1050   \mathunderscore
1051   \let\\ = \mathbackslash
1052   \mathactive
1053   $\finishmath
1054 }
1055 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1056
1057 % Some active characters (such as <) are spaced differently in math.
1058 % We have to reset their definitions in case the @math was an argument
1059 % to a command which sets the catcodes (such as @item or @section).
1060 %
1061 {
1062   \catcode`^ = \active
1063   \catcode`< = \active
1064   \catcode`> = \active
1065   \catcode`+ = \active
1066   \gdef\mathactive{%
1067     \let^ = \ptexhat
1068     \let< = \ptexless
1069     \let> = \ptexgtr
1070     \let+ = \ptexplus
1071   }
1072 }
1073
1074 % @bullet and @minus need the same treatment as @math, just above.
1075 \def\bullet{$\ptexbullet$}
1076 \def\minus{$-$}
1077
1078 % @dots{} outputs an ellipsis using the current font.
1079 % We do .5em per period so that it has the same spacing in a typewriter
1080 % font as three actual period characters.
1081 %
1082 \def\dots{%
1083   \leavevmode
1084   \hbox to 1.5em{%
1085     \hskip 0pt plus 0.25fil
1086     .\hfil.\hfil.%
1087     \hskip 0pt plus 0.5fil
1088   }%
1089 }
1090
1091 % @enddots{} is an end-of-sentence ellipsis.
1092 %
1093 \def\enddots{%
1094   \dots
1095   \spacefactor=3000
1096 }
1097
1098 % @comma{} is so commas can be inserted into text without messing up
1099 % Texinfo's parsing.
1100 %
1101 \let\comma = ,
1102
1103 % @refill is a no-op.
1104 \let\refill=\relax
1105
1106 % If working on a large document in chapters, it is convenient to
1107 % be able to disable indexing, cross-referencing, and contents, for test runs.
1108 % This is done with @novalidate (before @setfilename).
1109 %
1110 \newif\iflinks \linkstrue % by default we want the aux files.
1111 \let\novalidate = \linksfalse
1112
1113 % @setfilename is done at the beginning of every texinfo file.
1114 % So open here the files we need to have open while reading the input.
1115 % This makes it possible to make a .fmt file for texinfo.
1116 \def\setfilename{%
1117    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1118    \iflinks
1119      \tryauxfile
1120      % Open the new aux file.  TeX will close it automatically at exit.
1121      \immediate\openout\auxfile=\jobname.aux
1122    \fi % \openindices needs to do some work in any case.
1123    \openindices
1124    \let\setfilename=\comment % Ignore extra @setfilename cmds.
1125    %
1126    % If texinfo.cnf is present on the system, read it.
1127    % Useful for site-wide @afourpaper, etc.
1128    \openin 1 texinfo.cnf
1129    \ifeof 1 \else \input texinfo.cnf \fi
1130    \closein 1
1131    %
1132    \comment % Ignore the actual filename.
1133 }
1134
1135 % Called from \setfilename.
1136 %
1137 \def\openindices{%
1138   \newindex{cp}%
1139   \newcodeindex{fn}%
1140   \newcodeindex{vr}%
1141   \newcodeindex{tp}%
1142   \newcodeindex{ky}%
1143   \newcodeindex{pg}%
1144 }
1145
1146 % @bye.
1147 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1148
1149
1150 \message{pdf,}
1151 % adobe `portable' document format
1152 \newcount\tempnum
1153 \newcount\lnkcount
1154 \newtoks\filename
1155 \newcount\filenamelength
1156 \newcount\pgn
1157 \newtoks\toksA
1158 \newtoks\toksB
1159 \newtoks\toksC
1160 \newtoks\toksD
1161 \newbox\boxA
1162 \newcount\countA
1163 \newif\ifpdf
1164 \newif\ifpdfmakepagedest
1165
1166 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1167 % can be set).  So we test for \relax and 0 as well as \undefined,
1168 % borrowed from ifpdf.sty.
1169 \ifx\pdfoutput\undefined
1170 \else
1171   \ifx\pdfoutput\relax
1172   \else
1173     \ifcase\pdfoutput
1174     \else
1175       \pdftrue
1176     \fi
1177   \fi
1178 \fi
1179 %
1180 \ifpdf
1181   \input pdfcolor
1182   \pdfcatalog{/PageMode /UseOutlines}%
1183   \def\dopdfimage#1#2#3{%
1184     \def\imagewidth{#2}%
1185     \def\imageheight{#3}%
1186     % without \immediate, pdftex seg faults when the same image is
1187     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1188     \ifnum\pdftexversion < 14
1189       \immediate\pdfimage
1190     \else
1191       \immediate\pdfximage
1192     \fi
1193       \ifx\empty\imagewidth\else width \imagewidth \fi
1194       \ifx\empty\imageheight\else height \imageheight \fi
1195       \ifnum\pdftexversion<13
1196          #1.pdf%
1197        \else
1198          {#1.pdf}%
1199        \fi
1200     \ifnum\pdftexversion < 14 \else
1201       \pdfrefximage \pdflastximage
1202     \fi}
1203   \def\pdfmkdest#1{{%
1204     % We have to set dummies so commands such as @code in a section title
1205     % aren't expanded.
1206     \atdummies
1207     \normalturnoffactive
1208     \pdfdest name{#1} xyz%
1209   }}
1210   \def\pdfmkpgn#1{#1}
1211   \let\linkcolor = \Blue  % was Cyan, but that seems light?
1212   \def\endlink{\Black\pdfendlink}
1213   % Adding outlines to PDF; macros for calculating structure of outlines
1214   % come from Petr Olsak
1215   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1216     \else \csname#1\endcsname \fi}
1217   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1218     \advance\tempnum by 1
1219     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1220   %
1221   % #1 is the section text.  #2 is the pdf expression for the number
1222   % of subentries (or empty, for subsubsections).  #3 is the node
1223   % text, which might be empty if this toc entry had no
1224   % corresponding node.  #4 is the page number.
1225   %
1226   \def\dopdfoutline#1#2#3#4{%
1227     % Generate a link to the node text if that exists; else, use the
1228     % page number.  We could generate a destination for the section
1229     % text in the case where a section has no node, but it doesn't
1230     % seem worthwhile, since most documents are normally structured.
1231     \def\pdfoutlinedest{#3}%
1232     \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1233     %
1234     \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1235   }
1236   %
1237   \def\pdfmakeoutlines{%
1238     \begingroup
1239       % Thanh's hack / proper braces in bookmarks
1240       \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1241       \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1242       %
1243       % Read toc silently, to get counts of subentries for \pdfoutline.
1244       \def\numchapentry##1##2##3##4{%
1245         \def\thischapnum{##2}%
1246         \def\thissecnum{0}%
1247         \def\thissubsecnum{0}%
1248       }%
1249       \def\numsecentry##1##2##3##4{%
1250         \advancenumber{chap\thischapnum}%
1251         \def\thissecnum{##2}%
1252         \def\thissubsecnum{0}%
1253       }%
1254       \def\numsubsecentry##1##2##3##4{%
1255         \advancenumber{sec\thissecnum}%
1256         \def\thissubsecnum{##2}%
1257       }%
1258       \def\numsubsubsecentry##1##2##3##4{%
1259         \advancenumber{subsec\thissubsecnum}%
1260       }%
1261       \def\thischapnum{0}%
1262       \def\thissecnum{0}%
1263       \def\thissubsecnum{0}%
1264       %
1265       % use \def rather than \let here because we redefine \chapentry et
1266       % al. a second time, below.
1267       \def\appentry{\numchapentry}%
1268       \def\appsecentry{\numsecentry}%
1269       \def\appsubsecentry{\numsubsecentry}%
1270       \def\appsubsubsecentry{\numsubsubsecentry}%
1271       \def\unnchapentry{\numchapentry}%
1272       \def\unnsecentry{\numsecentry}%
1273       \def\unnsubsecentry{\numsubsecentry}%
1274       \def\unnsubsubsecentry{\numsubsubsecentry}%
1275       \input \jobname.toc
1276       %
1277       % Read toc second time, this time actually producing the outlines.
1278       % The `-' means take the \expnumber as the absolute number of
1279       % subentries, which we calculated on our first read of the .toc above.
1280       %
1281       % We use the node names as the destinations.
1282       \def\numchapentry##1##2##3##4{%
1283         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1284       \def\numsecentry##1##2##3##4{%
1285         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1286       \def\numsubsecentry##1##2##3##4{%
1287         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1288       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1289         \dopdfoutline{##1}{}{##3}{##4}}%
1290       %
1291       % PDF outlines are displayed using system fonts, instead of
1292       % document fonts.  Therefore we cannot use special characters,
1293       % since the encoding is unknown.  For example, the eogonek from
1294       % Latin 2 (0xea) gets translated to a | character.  Info from
1295       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1296       %
1297       % xx to do this right, we have to translate 8-bit characters to
1298       % their "best" equivalent, based on the @documentencoding.  Right
1299       % now, I guess we'll just let the pdf reader have its way.
1300       \indexnofonts
1301       \turnoffactive
1302       \input \jobname.toc
1303     \endgroup
1304   }
1305   %
1306   \def\makelinks #1,{%
1307     \def\params{#1}\def\E{END}%
1308     \ifx\params\E
1309       \let\nextmakelinks=\relax
1310     \else
1311       \let\nextmakelinks=\makelinks
1312       \ifnum\lnkcount>0,\fi
1313       \picknum{#1}%
1314       \startlink attr{/Border [0 0 0]}
1315         goto name{\pdfmkpgn{\the\pgn}}%
1316       \linkcolor #1%
1317       \advance\lnkcount by 1%
1318       \endlink
1319     \fi
1320     \nextmakelinks
1321   }
1322   \def\picknum#1{\expandafter\pn#1}
1323   \def\pn#1{%
1324     \def\p{#1}%
1325     \ifx\p\lbrace
1326       \let\nextpn=\ppn
1327     \else
1328       \let\nextpn=\ppnn
1329       \def\first{#1}
1330     \fi
1331     \nextpn
1332   }
1333   \def\ppn#1{\pgn=#1\gobble}
1334   \def\ppnn{\pgn=\first}
1335   \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1336   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1337     \ifx\PP\D\let\nextsp\relax
1338     \else\let\nextsp\skipspaces
1339       \ifx\p\space\else\addtokens{\filename}{\PP}%
1340         \advance\filenamelength by 1
1341       \fi
1342     \fi
1343     \nextsp}
1344   \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1345   \ifnum\pdftexversion < 14
1346     \let \startlink \pdfannotlink
1347   \else
1348     \let \startlink \pdfstartlink
1349   \fi
1350   \def\pdfurl#1{%
1351     \begingroup
1352       \normalturnoffactive\def\@{@}%
1353       \makevalueexpandable
1354       \leavevmode\Red
1355       \startlink attr{/Border [0 0 0]}%
1356         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1357     \endgroup}
1358   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1359   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1360   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1361   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1362   \def\maketoks{%
1363     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1364     \ifx\first0\adn0
1365     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1366     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1367     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1368     \else
1369       \ifnum0=\countA\else\makelink\fi
1370       \ifx\first.\let\next=\done\else
1371         \let\next=\maketoks
1372         \addtokens{\toksB}{\the\toksD}
1373         \ifx\first,\addtokens{\toksB}{\space}\fi
1374       \fi
1375     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1376     \next}
1377   \def\makelink{\addtokens{\toksB}%
1378     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1379   \def\pdflink#1{%
1380     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1381     \linkcolor #1\endlink}
1382   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1383 \else
1384   \let\pdfmkdest = \gobble
1385   \let\pdfurl = \gobble
1386   \let\endlink = \relax
1387   \let\linkcolor = \relax
1388   \let\pdfmakeoutlines = \relax
1389 \fi  % \ifx\pdfoutput
1390
1391
1392 \message{fonts,}
1393
1394 % Change the current font style to #1, remembering it in \curfontstyle.
1395 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1396 % italics, not bold italics.
1397 %
1398 \def\setfontstyle#1{%
1399   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1400   \csname ten#1\endcsname  % change the current font
1401 }
1402
1403 % Select #1 fonts with the current style.
1404 %
1405 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1406
1407 \def\rm{\fam=0 \setfontstyle{rm}}
1408 \def\it{\fam=\itfam \setfontstyle{it}}
1409 \def\sl{\fam=\slfam \setfontstyle{sl}}
1410 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1411 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1412
1413 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1414 % So we set up a \sf.
1415 \newfam\sffam
1416 \def\sf{\fam=\sffam \setfontstyle{sf}}
1417 \let\li = \sf % Sometimes we call it \li, not \sf.
1418
1419 % We don't need math for this font style.
1420 \def\ttsl{\setfontstyle{ttsl}}
1421
1422 % Default leading.
1423 \newdimen\textleading  \textleading = 13.2pt
1424
1425 % Set the baselineskip to #1, and the lineskip and strut size
1426 % correspondingly.  There is no deep meaning behind these magic numbers
1427 % used as factors; they just match (closely enough) what Knuth defined.
1428 %
1429 \def\lineskipfactor{.08333}
1430 \def\strutheightpercent{.70833}
1431 \def\strutdepthpercent {.29167}
1432 %
1433 \def\setleading#1{%
1434   \normalbaselineskip = #1\relax
1435   \normallineskip = \lineskipfactor\normalbaselineskip
1436   \normalbaselines
1437   \setbox\strutbox =\hbox{%
1438     \vrule width0pt height\strutheightpercent\baselineskip
1439                     depth \strutdepthpercent \baselineskip
1440   }%
1441 }
1442
1443 % Set the font macro #1 to the font named #2, adding on the
1444 % specified font prefix (normally `cm').
1445 % #3 is the font's design size, #4 is a scale factor
1446 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1447
1448 % Use cm as the default font prefix.
1449 % To specify the font prefix, you must define \fontprefix
1450 % before you read in texinfo.tex.
1451 \ifx\fontprefix\undefined
1452 \def\fontprefix{cm}
1453 \fi
1454 % Support font families that don't use the same naming scheme as CM.
1455 \def\rmshape{r}
1456 \def\rmbshape{bx}               %where the normal face is bold
1457 \def\bfshape{b}
1458 \def\bxshape{bx}
1459 \def\ttshape{tt}
1460 \def\ttbshape{tt}
1461 \def\ttslshape{sltt}
1462 \def\itshape{ti}
1463 \def\itbshape{bxti}
1464 \def\slshape{sl}
1465 \def\slbshape{bxsl}
1466 \def\sfshape{ss}
1467 \def\sfbshape{ss}
1468 \def\scshape{csc}
1469 \def\scbshape{csc}
1470
1471 % Text fonts (11.2pt, magstep1).
1472 \def\textnominalsize{11pt}
1473 \edef\mainmagstep{\magstephalf}
1474 \setfont\textrm\rmshape{10}{\mainmagstep}
1475 \setfont\texttt\ttshape{10}{\mainmagstep}
1476 \setfont\textbf\bfshape{10}{\mainmagstep}
1477 \setfont\textit\itshape{10}{\mainmagstep}
1478 \setfont\textsl\slshape{10}{\mainmagstep}
1479 \setfont\textsf\sfshape{10}{\mainmagstep}
1480 \setfont\textsc\scshape{10}{\mainmagstep}
1481 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1482 \font\texti=cmmi10 scaled \mainmagstep
1483 \font\textsy=cmsy10 scaled \mainmagstep
1484
1485 % A few fonts for @defun names and args.
1486 \setfont\defbf\bfshape{10}{\magstep1}
1487 \setfont\deftt\ttshape{10}{\magstep1}
1488 \setfont\defttsl\ttslshape{10}{\magstep1}
1489 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1490
1491 % Fonts for indices, footnotes, small examples (9pt).
1492 \def\smallnominalsize{9pt}
1493 \setfont\smallrm\rmshape{9}{1000}
1494 \setfont\smalltt\ttshape{9}{1000}
1495 \setfont\smallbf\bfshape{10}{900}
1496 \setfont\smallit\itshape{9}{1000}
1497 \setfont\smallsl\slshape{9}{1000}
1498 \setfont\smallsf\sfshape{9}{1000}
1499 \setfont\smallsc\scshape{10}{900}
1500 \setfont\smallttsl\ttslshape{10}{900}
1501 \font\smalli=cmmi9
1502 \font\smallsy=cmsy9
1503
1504 % Fonts for small examples (8pt).
1505 \def\smallernominalsize{8pt}
1506 \setfont\smallerrm\rmshape{8}{1000}
1507 \setfont\smallertt\ttshape{8}{1000}
1508 \setfont\smallerbf\bfshape{10}{800}
1509 \setfont\smallerit\itshape{8}{1000}
1510 \setfont\smallersl\slshape{8}{1000}
1511 \setfont\smallersf\sfshape{8}{1000}
1512 \setfont\smallersc\scshape{10}{800}
1513 \setfont\smallerttsl\ttslshape{10}{800}
1514 \font\smalleri=cmmi8
1515 \font\smallersy=cmsy8
1516
1517 % Fonts for title page (20.4pt):
1518 \def\titlenominalsize{20pt}
1519 \setfont\titlerm\rmbshape{12}{\magstep3}
1520 \setfont\titleit\itbshape{10}{\magstep4}
1521 \setfont\titlesl\slbshape{10}{\magstep4}
1522 \setfont\titlett\ttbshape{12}{\magstep3}
1523 \setfont\titlettsl\ttslshape{10}{\magstep4}
1524 \setfont\titlesf\sfbshape{17}{\magstep1}
1525 \let\titlebf=\titlerm
1526 \setfont\titlesc\scbshape{10}{\magstep4}
1527 \font\titlei=cmmi12 scaled \magstep3
1528 \font\titlesy=cmsy10 scaled \magstep4
1529 \def\authorrm{\secrm}
1530 \def\authortt{\sectt}
1531
1532 % Chapter (and unnumbered) fonts (17.28pt).
1533 \def\chapnominalsize{17pt}
1534 \setfont\chaprm\rmbshape{12}{\magstep2}
1535 \setfont\chapit\itbshape{10}{\magstep3}
1536 \setfont\chapsl\slbshape{10}{\magstep3}
1537 \setfont\chaptt\ttbshape{12}{\magstep2}
1538 \setfont\chapttsl\ttslshape{10}{\magstep3}
1539 \setfont\chapsf\sfbshape{17}{1000}
1540 \let\chapbf=\chaprm
1541 \setfont\chapsc\scbshape{10}{\magstep3}
1542 \font\chapi=cmmi12 scaled \magstep2
1543 \font\chapsy=cmsy10 scaled \magstep3
1544
1545 % Section fonts (14.4pt).
1546 \def\secnominalsize{14pt}
1547 \setfont\secrm\rmbshape{12}{\magstep1}
1548 \setfont\secit\itbshape{10}{\magstep2}
1549 \setfont\secsl\slbshape{10}{\magstep2}
1550 \setfont\sectt\ttbshape{12}{\magstep1}
1551 \setfont\secttsl\ttslshape{10}{\magstep2}
1552 \setfont\secsf\sfbshape{12}{\magstep1}
1553 \let\secbf\secrm
1554 \setfont\secsc\scbshape{10}{\magstep2}
1555 \font\seci=cmmi12 scaled \magstep1
1556 \font\secsy=cmsy10 scaled \magstep2
1557
1558 % Subsection fonts (13.15pt).
1559 \def\ssecnominalsize{13pt}
1560 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1561 \setfont\ssecit\itbshape{10}{1315}
1562 \setfont\ssecsl\slbshape{10}{1315}
1563 \setfont\ssectt\ttbshape{12}{\magstephalf}
1564 \setfont\ssecttsl\ttslshape{10}{1315}
1565 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1566 \let\ssecbf\ssecrm
1567 \setfont\ssecsc\scbshape{10}{1315}
1568 \font\sseci=cmmi12 scaled \magstephalf
1569 \font\ssecsy=cmsy10 scaled 1315
1570
1571 % Reduced fonts for @acro in text (10pt).
1572 \def\reducednominalsize{10pt}
1573 \setfont\reducedrm\rmshape{10}{1000}
1574 \setfont\reducedtt\ttshape{10}{1000}
1575 \setfont\reducedbf\bfshape{10}{1000}
1576 \setfont\reducedit\itshape{10}{1000}
1577 \setfont\reducedsl\slshape{10}{1000}
1578 \setfont\reducedsf\sfshape{10}{1000}
1579 \setfont\reducedsc\scshape{10}{1000}
1580 \setfont\reducedttsl\ttslshape{10}{1000}
1581 \font\reducedi=cmmi10
1582 \font\reducedsy=cmsy10
1583
1584 % In order for the font changes to affect most math symbols and letters,
1585 % we have to define the \textfont of the standard families.  Since
1586 % texinfo doesn't allow for producing subscripts and superscripts except
1587 % in the main text, we don't bother to reset \scriptfont and
1588 % \scriptscriptfont (which would also require loading a lot more fonts).
1589 %
1590 \def\resetmathfonts{%
1591   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1592   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1593   \textfont\ttfam=\tentt \textfont\sffam=\tensf
1594 }
1595
1596 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1597 % of just \STYLE.  We do this because \STYLE needs to also set the
1598 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
1599 % \tenSTYLE to set the current font.
1600 %
1601 % Each font-changing command also sets the names \lsize (one size lower)
1602 % and \lllsize (three sizes lower).  These relative commands are used in
1603 % the LaTeX logo and acronyms.
1604 %
1605 % This all needs generalizing, badly.
1606 %
1607 \def\textfonts{%
1608   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1609   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1610   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1611   \let\tenttsl=\textttsl
1612   \def\curfontsize{text}%
1613   \def\lsize{reduced}\def\lllsize{smaller}%
1614   \resetmathfonts \setleading{\textleading}}
1615 \def\titlefonts{%
1616   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1617   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1618   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1619   \let\tenttsl=\titlettsl
1620   \def\curfontsize{title}%
1621   \def\lsize{chap}\def\lllsize{subsec}%
1622   \resetmathfonts \setleading{25pt}}
1623 \def\titlefont#1{{\titlefonts\rm #1}}
1624 \def\chapfonts{%
1625   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1626   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1627   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1628   \let\tenttsl=\chapttsl
1629   \def\curfontsize{chap}%
1630   \def\lsize{sec}\def\lllsize{text}%
1631   \resetmathfonts \setleading{19pt}}
1632 \def\secfonts{%
1633   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1634   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1635   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1636   \let\tenttsl=\secttsl
1637   \def\curfontsize{sec}%
1638   \def\lsize{subsec}\def\lllsize{reduced}%
1639   \resetmathfonts \setleading{16pt}}
1640 \def\subsecfonts{%
1641   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1642   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1643   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1644   \let\tenttsl=\ssecttsl
1645   \def\curfontsize{ssec}%
1646   \def\lsize{text}\def\lllsize{small}%
1647   \resetmathfonts \setleading{15pt}}
1648 \let\subsubsecfonts = \subsecfonts
1649 \def\reducedfonts{%
1650   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1651   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1652   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1653   \let\tenttsl=\reducedttsl
1654   \def\curfontsize{reduced}%
1655   \def\lsize{small}\def\lllsize{smaller}%
1656   \resetmathfonts \setleading{10.5pt}}
1657 \def\smallfonts{%
1658   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1659   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1660   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1661   \let\tenttsl=\smallttsl
1662   \def\curfontsize{small}%
1663   \def\lsize{smaller}\def\lllsize{smaller}%
1664   \resetmathfonts \setleading{10.5pt}}
1665 \def\smallerfonts{%
1666   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1667   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1668   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1669   \let\tenttsl=\smallerttsl
1670   \def\curfontsize{smaller}%
1671   \def\lsize{smaller}\def\lllsize{smaller}%
1672   \resetmathfonts \setleading{9.5pt}}
1673
1674 % Set the fonts to use with the @small... environments.
1675 \let\smallexamplefonts = \smallfonts
1676
1677 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
1678 % can fit this many characters:
1679 %   8.5x11=86   smallbook=72  a4=90  a5=69
1680 % If we use \scriptfonts (8pt), then we can fit this many characters:
1681 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
1682 % For me, subjectively, the few extra characters that fit aren't worth
1683 % the additional smallness of 8pt.  So I'm making the default 9pt.
1684 %
1685 % By the way, for comparison, here's what fits with @example (10pt):
1686 %   8.5x11=71  smallbook=60  a4=75  a5=58
1687 %
1688 % I wish the USA used A4 paper.
1689 % --karl, 24jan03.
1690
1691
1692 % Set up the default fonts, so we can use them for creating boxes.
1693 %
1694 \textfonts \rm
1695
1696 % Define these so they can be easily changed for other fonts.
1697 \def\angleleft{$\langle$}
1698 \def\angleright{$\rangle$}
1699
1700 % Count depth in font-changes, for error checks
1701 \newcount\fontdepth \fontdepth=0
1702
1703 % Fonts for short table of contents.
1704 \setfont\shortcontrm\rmshape{12}{1000}
1705 \setfont\shortcontbf\bfshape{10}{\magstep1}  % no cmb12
1706 \setfont\shortcontsl\slshape{12}{1000}
1707 \setfont\shortconttt\ttshape{12}{1000}
1708
1709 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1710 %% serif) and @ii for TeX italic
1711
1712 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1713 % unless the following character is such as not to need one.
1714 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1715                     \ptexslash\fi\fi\fi}
1716 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1717 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1718
1719 % like \smartslanted except unconditionally uses \ttsl.
1720 % @var is set to this for defun arguments.
1721 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1722
1723 % like \smartslanted except unconditionally use \sl.  We never want
1724 % ttsl for book titles, do we?
1725 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1726
1727 \let\i=\smartitalic
1728 \let\slanted=\smartslanted
1729 \let\var=\smartslanted
1730 \let\dfn=\smartslanted
1731 \let\emph=\smartitalic
1732
1733 % @b, explicit bold.
1734 \def\b#1{{\bf #1}}
1735 \let\strong=\b
1736
1737 % @sansserif, explicit sans.
1738 \def\sansserif#1{{\sf #1}}
1739
1740 % We can't just use \exhyphenpenalty, because that only has effect at
1741 % the end of a paragraph.  Restore normal hyphenation at the end of the
1742 % group within which \nohyphenation is presumably called.
1743 %
1744 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
1745 \def\restorehyphenation{\hyphenchar\font = `- }
1746
1747 % Set sfcode to normal for the chars that usually have another value.
1748 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1749 % sometimes \x has an active definition that messes things up.
1750 %
1751 \catcode`@=11
1752   \def\frenchspacing{%
1753     \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1754     \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1755   }
1756 \catcode`@=\other
1757
1758 \def\t#1{%
1759   {\tt \rawbackslash \frenchspacing #1}%
1760   \null
1761 }
1762 \def\samp#1{`\tclose{#1}'\null}
1763 \setfont\keyrm\rmshape{8}{1000}
1764 \font\keysy=cmsy9
1765 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1766   \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1767     \vbox{\hrule\kern-0.4pt
1768      \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1769     \kern-0.4pt\hrule}%
1770   \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1771 % The old definition, with no lozenge:
1772 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1773 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1774
1775 % @file, @option are the same as @samp.
1776 \let\file=\samp
1777 \let\option=\samp
1778
1779 % @code is a modification of @t,
1780 % which makes spaces the same size as normal in the surrounding text.
1781 \def\tclose#1{%
1782   {%
1783     % Change normal interword space to be same as for the current font.
1784     \spaceskip = \fontdimen2\font
1785     %
1786     % Switch to typewriter.
1787     \tt
1788     %
1789     % But `\ ' produces the large typewriter interword space.
1790     \def\ {{\spaceskip = 0pt{} }}%
1791     %
1792     % Turn off hyphenation.
1793     \nohyphenation
1794     %
1795     \rawbackslash
1796     \frenchspacing
1797     #1%
1798   }%
1799   \null
1800 }
1801
1802 % We *must* turn on hyphenation at `-' and `_' in @code.
1803 % Otherwise, it is too hard to avoid overfull hboxes
1804 % in the Emacs manual, the Library manual, etc.
1805
1806 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1807 % both hyphenation at - and hyphenation within words.
1808 % We must therefore turn them both off (\tclose does that)
1809 % and arrange explicitly to hyphenate at a dash.
1810 %  -- rms.
1811 {
1812   \catcode`\-=\active
1813   \catcode`\_=\active
1814   %
1815   \global\def\code{\begingroup
1816     \catcode`\-=\active \let-\codedash
1817     \catcode`\_=\active \let_\codeunder
1818     \codex
1819   }
1820 }
1821
1822 \def\realdash{-}
1823 \def\codedash{-\discretionary{}{}{}}
1824 \def\codeunder{%
1825   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
1826   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1827   % will therefore expand the active definition of _, which is us
1828   % (inside @code that is), therefore an endless loop.
1829   \ifusingtt{\ifmmode
1830                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1831              \else\normalunderscore \fi
1832              \discretionary{}{}{}}%
1833             {\_}%
1834 }
1835 \def\codex #1{\tclose{#1}\endgroup}
1836
1837 % @kbd is like @code, except that if the argument is just one @key command,
1838 % then @kbd has no effect.
1839
1840 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1841 %   `example' (@kbd uses ttsl only inside of @example and friends),
1842 %   or `code' (@kbd uses normal tty font always).
1843 \parseargdef\kbdinputstyle{%
1844   \def\arg{#1}%
1845   \ifx\arg\worddistinct
1846     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1847   \else\ifx\arg\wordexample
1848     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1849   \else\ifx\arg\wordcode
1850     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1851   \else
1852     \errhelp = \EMsimple
1853     \errmessage{Unknown @kbdinputstyle option `\arg'}%
1854   \fi\fi\fi
1855 }
1856 \def\worddistinct{distinct}
1857 \def\wordexample{example}
1858 \def\wordcode{code}
1859
1860 % Default is `distinct.'
1861 \kbdinputstyle distinct
1862
1863 \def\xkey{\key}
1864 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1865 \ifx\one\xkey\ifx\threex\three \key{#2}%
1866 \else{\tclose{\kbdfont\look}}\fi
1867 \else{\tclose{\kbdfont\look}}\fi}
1868
1869 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1870 \let\indicateurl=\code
1871 \let\env=\code
1872 \let\command=\code
1873
1874 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1875 % second argument specifying the text to display and an optional third
1876 % arg as text to display instead of (rather than in addition to) the url
1877 % itself.  First (mandatory) arg is the url.  Perhaps eventually put in
1878 % a hypertex \special here.
1879 %
1880 \def\uref#1{\douref #1,,,\finish}
1881 \def\douref#1,#2,#3,#4\finish{\begingroup
1882   \unsepspaces
1883   \pdfurl{#1}%
1884   \setbox0 = \hbox{\ignorespaces #3}%
1885   \ifdim\wd0 > 0pt
1886     \unhbox0 % third arg given, show only that
1887   \else
1888     \setbox0 = \hbox{\ignorespaces #2}%
1889     \ifdim\wd0 > 0pt
1890       \ifpdf
1891         \unhbox0             % PDF: 2nd arg given, show only it
1892       \else
1893         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1894       \fi
1895     \else
1896       \code{#1}% only url given, so show it
1897     \fi
1898   \fi
1899   \endlink
1900 \endgroup}
1901
1902 % @url synonym for @uref, since that's how everyone uses it.
1903 %
1904 \let\url=\uref
1905
1906 % rms does not like angle brackets --karl, 17may97.
1907 % So now @email is just like @uref, unless we are pdf.
1908 %
1909 %\def\email#1{\angleleft{\tt #1}\angleright}
1910 \ifpdf
1911   \def\email#1{\doemail#1,,\finish}
1912   \def\doemail#1,#2,#3\finish{\begingroup
1913     \unsepspaces
1914     \pdfurl{mailto:#1}%
1915     \setbox0 = \hbox{\ignorespaces #2}%
1916     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1917     \endlink
1918   \endgroup}
1919 \else
1920   \let\email=\uref
1921 \fi
1922
1923 % Check if we are currently using a typewriter font.  Since all the
1924 % Computer Modern typewriter fonts have zero interword stretch (and
1925 % shrink), and it is reasonable to expect all typewriter fonts to have
1926 % this property, we can check that font parameter.
1927 %
1928 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1929
1930 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
1931 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1932 %
1933 \def\dmn#1{\thinspace #1}
1934
1935 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1936
1937 % @l was never documented to mean ``switch to the Lisp font'',
1938 % and it is not used as such in any manual I can find.  We need it for
1939 % Polish suppressed-l.  --karl, 22sep96.
1940 %\def\l#1{{\li #1}\null}
1941
1942 % Explicit font changes: @r, @sc, undocumented @ii.
1943 \def\r#1{{\rm #1}}              % roman font
1944 \def\sc#1{{\smallcaps#1}}       % smallcaps font
1945 \def\ii#1{{\it #1}}             % italic font
1946
1947 % @acronym for "FBI", "NATO", and the like.
1948 % We print this one point size smaller, since it's intended for
1949 % all-uppercase.
1950
1951 \def\acronym#1{\doacronym #1,,\finish}
1952 \def\doacronym#1,#2,#3\finish{%
1953   {\selectfonts\lsize #1}%
1954   \def\temp{#2}%
1955   \ifx\temp\empty \else
1956     \space ({\unsepspaces \ignorespaces \temp \unskip})%
1957   \fi
1958 }
1959
1960 % @abbr for "Comput. J." and the like.
1961 % No font change, but don't do end-of-sentence spacing.
1962
1963 \def\abbr#1{\doabbr #1,,\finish}
1964 \def\doabbr#1,#2,#3\finish{%
1965   {\frenchspacing #1}%
1966   \def\temp{#2}%
1967   \ifx\temp\empty \else
1968     \space ({\unsepspaces \ignorespaces \temp \unskip})%
1969   \fi
1970 }
1971
1972 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
1973 %
1974 \def\pounds{{\it\$}}
1975
1976 % @euro{} comes from a separate font, depending on the current style.
1977 % We use the free feym* fonts from the eurosym package by Henrik
1978 % Theiling, which support regular, slanted, bold and bold slanted (and
1979 % "outlined" (blackboard board, sort of) versions, which we don't need).
1980 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
1981
1982 % Although only regular is the truly official Euro symbol, we ignore
1983 % that.  The Euro is designed to be slightly taller than the regular
1984 % font height.
1985
1986 % feymr - regular
1987 % feymo - slanted
1988 % feybr - bold
1989 % feybo - bold slanted
1990
1991 % There is no good (free) typewriter version, to my knowledge.
1992 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
1993 % Hmm.
1994
1995 % Also doesn't work in math.  Do we need to do math with euro symbols?
1996 % Hope not.
1997
1998
1999 \def\euro{{\eurofont e}}
2000 \def\eurofont{%
2001   % We set the font at each command, rather than predefining it in
2002   % \textfonts and the other font-switching commands, so that
2003   % installations which never need the symbol don't have to have the
2004   % font installed.
2005   % 
2006   % There is only one designed size (nominal 10pt), so we always scale
2007   % that to the current nominal size.
2008   % 
2009   % By the way, simply using "at 1em" works for cmr10 and the like, but
2010   % does not work for cmbx10 and other extended/shrunken fonts.
2011   % 
2012   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2013   %
2014   \ifx\curfontstyle\bfstylename 
2015     % bold:
2016     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2017   \else 
2018     % regular:
2019     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2020   \fi
2021   \thiseurofont
2022 }
2023
2024 % @registeredsymbol - R in a circle.  The font for the R should really
2025 % be smaller yet, but lllsize is the best we can do for now.
2026 % Adapted from the plain.tex definition of \copyright.
2027 %
2028 \def\registeredsymbol{%
2029   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2030                \hfil\crcr\Orb}}%
2031     }$%
2032 }
2033
2034 % Laurent Siebenmann reports \Orb undefined with:
2035 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
2036 % so we'll define it if necessary.
2037
2038 \ifx\Orb\undefined
2039 \def\Orb{\mathhexbox20D}
2040 \fi
2041
2042
2043 \message{page headings,}
2044
2045 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2046 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2047
2048 % First the title page.  Must do @settitle before @titlepage.
2049 \newif\ifseenauthor
2050 \newif\iffinishedtitlepage
2051
2052 % Do an implicit @contents or @shortcontents after @end titlepage if the
2053 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2054 %
2055 \newif\ifsetcontentsaftertitlepage
2056  \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2057 \newif\ifsetshortcontentsaftertitlepage
2058  \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2059
2060 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2061         \endgroup\page\hbox{}\page}
2062
2063 \envdef\titlepage{%
2064   % Open one extra group, as we want to close it in the middle of \Etitlepage.
2065   \begingroup
2066     \parindent=0pt \textfonts
2067     % Leave some space at the very top of the page.
2068     \vglue\titlepagetopglue
2069     % No rule at page bottom unless we print one at the top with @title.
2070     \finishedtitlepagetrue
2071     %
2072     % Most title ``pages'' are actually two pages long, with space
2073     % at the top of the second.  We don't want the ragged left on the second.
2074     \let\oldpage = \page
2075     \def\page{%
2076       \iffinishedtitlepage\else
2077          \finishtitlepage
2078       \fi
2079       \let\page = \oldpage
2080       \page
2081       \null
2082     }%
2083 }
2084
2085 \def\Etitlepage{%
2086     \iffinishedtitlepage\else
2087         \finishtitlepage
2088     \fi
2089     % It is important to do the page break before ending the group,
2090     % because the headline and footline are only empty inside the group.
2091     % If we use the new definition of \page, we always get a blank page
2092     % after the title page, which we certainly don't want.
2093     \oldpage
2094   \endgroup
2095   %
2096   % Need this before the \...aftertitlepage checks so that if they are
2097   % in effect the toc pages will come out with page numbers.
2098   \HEADINGSon
2099   %
2100   % If they want short, they certainly want long too.
2101   \ifsetshortcontentsaftertitlepage
2102     \shortcontents
2103     \contents
2104     \global\let\shortcontents = \relax
2105     \global\let\contents = \relax
2106   \fi
2107   %
2108   \ifsetcontentsaftertitlepage
2109     \contents
2110     \global\let\contents = \relax
2111     \global\let\shortcontents = \relax
2112   \fi
2113 }
2114
2115 \def\finishtitlepage{%
2116   \vskip4pt \hrule height 2pt width \hsize
2117   \vskip\titlepagebottomglue
2118   \finishedtitlepagetrue
2119 }
2120
2121 %%% Macros to be used within @titlepage:
2122
2123 \let\subtitlerm=\tenrm
2124 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2125
2126 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2127                 \let\tt=\authortt}
2128
2129 \parseargdef\title{%
2130   \checkenv\titlepage
2131   \leftline{\titlefonts\rm #1}
2132   % print a rule at the page bottom also.
2133   \finishedtitlepagefalse
2134   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2135 }
2136
2137 \parseargdef\subtitle{%
2138   \checkenv\titlepage
2139   {\subtitlefont \rightline{#1}}%
2140 }
2141
2142 % @author should come last, but may come many times.
2143 % It can also be used inside @quotation.
2144 %
2145 \parseargdef\author{%
2146   \def\temp{\quotation}%
2147   \ifx\thisenv\temp
2148     \def\quotationauthor{#1}% printed in \Equotation.
2149   \else
2150     \checkenv\titlepage
2151     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2152     {\authorfont \leftline{#1}}%
2153   \fi
2154 }
2155
2156
2157 %%% Set up page headings and footings.
2158
2159 \let\thispage=\folio
2160
2161 \newtoks\evenheadline    % headline on even pages
2162 \newtoks\oddheadline     % headline on odd pages
2163 \newtoks\evenfootline    % footline on even pages
2164 \newtoks\oddfootline     % footline on odd pages
2165
2166 % Now make TeX use those variables
2167 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2168                             \else \the\evenheadline \fi}}
2169 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2170                             \else \the\evenfootline \fi}\HEADINGShook}
2171 \let\HEADINGShook=\relax
2172
2173 % Commands to set those variables.
2174 % For example, this is what  @headings on  does
2175 % @evenheading @thistitle|@thispage|@thischapter
2176 % @oddheading @thischapter|@thispage|@thistitle
2177 % @evenfooting @thisfile||
2178 % @oddfooting ||@thisfile
2179
2180
2181 \def\evenheading{\parsearg\evenheadingxxx}
2182 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2183 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2184 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2185
2186 \def\oddheading{\parsearg\oddheadingxxx}
2187 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2188 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2189 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2190
2191 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2192
2193 \def\evenfooting{\parsearg\evenfootingxxx}
2194 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2195 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2196 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2197
2198 \def\oddfooting{\parsearg\oddfootingxxx}
2199 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2200 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2201   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2202   %
2203   % Leave some space for the footline.  Hopefully ok to assume
2204   % @evenfooting will not be used by itself.
2205   \global\advance\pageheight by -\baselineskip
2206   \global\advance\vsize by -\baselineskip
2207 }
2208
2209 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2210
2211
2212 % @headings double      turns headings on for double-sided printing.
2213 % @headings single      turns headings on for single-sided printing.
2214 % @headings off         turns them off.
2215 % @headings on          same as @headings double, retained for compatibility.
2216 % @headings after       turns on double-sided headings after this page.
2217 % @headings doubleafter turns on double-sided headings after this page.
2218 % @headings singleafter turns on single-sided headings after this page.
2219 % By default, they are off at the start of a document,
2220 % and turned `on' after @end titlepage.
2221
2222 \def\headings #1 {\csname HEADINGS#1\endcsname}
2223
2224 \def\HEADINGSoff{%
2225 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2226 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2227 \HEADINGSoff
2228 % When we turn headings on, set the page number to 1.
2229 % For double-sided printing, put current file name in lower left corner,
2230 % chapter name on inside top of right hand pages, document
2231 % title on inside top of left hand pages, and page numbers on outside top
2232 % edge of all pages.
2233 \def\HEADINGSdouble{%
2234 \global\pageno=1
2235 \global\evenfootline={\hfil}
2236 \global\oddfootline={\hfil}
2237 \global\evenheadline={\line{\folio\hfil\thistitle}}
2238 \global\oddheadline={\line{\thischapter\hfil\folio}}
2239 \global\let\contentsalignmacro = \chapoddpage
2240 }
2241 \let\contentsalignmacro = \chappager
2242
2243 % For single-sided printing, chapter title goes across top left of page,
2244 % page number on top right.
2245 \def\HEADINGSsingle{%
2246 \global\pageno=1
2247 \global\evenfootline={\hfil}
2248 \global\oddfootline={\hfil}
2249 \global\evenheadline={\line{\thischapter\hfil\folio}}
2250 \global\oddheadline={\line{\thischapter\hfil\folio}}
2251 \global\let\contentsalignmacro = \chappager
2252 }
2253 \def\HEADINGSon{\HEADINGSdouble}
2254
2255 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2256 \let\HEADINGSdoubleafter=\HEADINGSafter
2257 \def\HEADINGSdoublex{%
2258 \global\evenfootline={\hfil}
2259 \global\oddfootline={\hfil}
2260 \global\evenheadline={\line{\folio\hfil\thistitle}}
2261 \global\oddheadline={\line{\thischapter\hfil\folio}}
2262 \global\let\contentsalignmacro = \chapoddpage
2263 }
2264
2265 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2266 \def\HEADINGSsinglex{%
2267 \global\evenfootline={\hfil}
2268 \global\oddfootline={\hfil}
2269 \global\evenheadline={\line{\thischapter\hfil\folio}}
2270 \global\oddheadline={\line{\thischapter\hfil\folio}}
2271 \global\let\contentsalignmacro = \chappager
2272 }
2273
2274 % Subroutines used in generating headings
2275 % This produces Day Month Year style of output.
2276 % Only define if not already defined, in case a txi-??.tex file has set
2277 % up a different format (e.g., txi-cs.tex does this).
2278 \ifx\today\undefined
2279 \def\today{%
2280   \number\day\space
2281   \ifcase\month
2282   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2283   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2284   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2285   \fi
2286   \space\number\year}
2287 \fi
2288
2289 % @settitle line...  specifies the title of the document, for headings.
2290 % It generates no output of its own.
2291 \def\thistitle{\putwordNoTitle}
2292 \def\settitle{\parsearg{\gdef\thistitle}}
2293
2294
2295 \message{tables,}
2296 % Tables -- @table, @ftable, @vtable, @item(x).
2297
2298 % default indentation of table text
2299 \newdimen\tableindent \tableindent=.8in
2300 % default indentation of @itemize and @enumerate text
2301 \newdimen\itemindent  \itemindent=.3in
2302 % margin between end of table item and start of table text.
2303 \newdimen\itemmargin  \itemmargin=.1in
2304
2305 % used internally for \itemindent minus \itemmargin
2306 \newdimen\itemmax
2307
2308 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2309 % these defs.
2310 % They also define \itemindex
2311 % to index the item name in whatever manner is desired (perhaps none).
2312
2313 \newif\ifitemxneedsnegativevskip
2314
2315 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2316
2317 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2318 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2319
2320 \def\itemzzz #1{\begingroup %
2321   \advance\hsize by -\rightskip
2322   \advance\hsize by -\tableindent
2323   \setbox0=\hbox{\itemindicate{#1}}%
2324   \itemindex{#1}%
2325   \nobreak % This prevents a break before @itemx.
2326   %
2327   % If the item text does not fit in the space we have, put it on a line
2328   % by itself, and do not allow a page break either before or after that
2329   % line.  We do not start a paragraph here because then if the next
2330   % command is, e.g., @kindex, the whatsit would get put into the
2331   % horizontal list on a line by itself, resulting in extra blank space.
2332   \ifdim \wd0>\itemmax
2333     %
2334     % Make this a paragraph so we get the \parskip glue and wrapping,
2335     % but leave it ragged-right.
2336     \begingroup
2337       \advance\leftskip by-\tableindent
2338       \advance\hsize by\tableindent
2339       \advance\rightskip by0pt plus1fil
2340       \leavevmode\unhbox0\par
2341     \endgroup
2342     %
2343     % We're going to be starting a paragraph, but we don't want the
2344     % \parskip glue -- logically it's part of the @item we just started.
2345     \nobreak \vskip-\parskip
2346     %
2347     % Stop a page break at the \parskip glue coming up.  However, if
2348     % what follows is an environment such as @example, there will be no
2349     % \parskip glue; then the negative vskip we just inserted would
2350     % cause the example and the item to crash together.  So we use this
2351     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2352     % \parskip glue after all.  Section titles are handled this way also.
2353     % 
2354     \penalty 10001
2355     \endgroup
2356     \itemxneedsnegativevskipfalse
2357   \else
2358     % The item text fits into the space.  Start a paragraph, so that the
2359     % following text (if any) will end up on the same line.
2360     \noindent
2361     % Do this with kerns and \unhbox so that if there is a footnote in
2362     % the item text, it can migrate to the main vertical list and
2363     % eventually be printed.
2364     \nobreak\kern-\tableindent
2365     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2366     \unhbox0
2367     \nobreak\kern\dimen0
2368     \endgroup
2369     \itemxneedsnegativevskiptrue
2370   \fi
2371 }
2372
2373 \def\item{\errmessage{@item while not in a list environment}}
2374 \def\itemx{\errmessage{@itemx while not in a list environment}}
2375
2376 % @table, @ftable, @vtable.
2377 \envdef\table{%
2378   \let\itemindex\gobble
2379   \tablecheck{table}%
2380 }
2381 \envdef\ftable{%
2382   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2383   \tablecheck{ftable}%
2384 }
2385 \envdef\vtable{%
2386   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2387   \tablecheck{vtable}%
2388 }
2389 \def\tablecheck#1{%
2390   \ifnum \the\catcode`\^^M=\active
2391     \endgroup
2392     \errmessage{This command won't work in this context; perhaps the problem is
2393       that we are \inenvironment\thisenv}%
2394     \def\next{\doignore{#1}}%
2395   \else
2396     \let\next\tablex
2397   \fi
2398   \next
2399 }
2400 \def\tablex#1{%
2401   \def\itemindicate{#1}%
2402   \parsearg\tabley
2403 }
2404 \def\tabley#1{%
2405   {%
2406     \makevalueexpandable
2407     \edef\temp{\noexpand\tablez #1\space\space\space}%
2408     \expandafter
2409   }\temp \endtablez
2410 }
2411 \def\tablez #1 #2 #3 #4\endtablez{%
2412   \aboveenvbreak
2413   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2414   \ifnum 0#2>0 \tableindent=#2\mil \fi
2415   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2416   \itemmax=\tableindent
2417   \advance \itemmax by -\itemmargin
2418   \advance \leftskip by \tableindent
2419   \exdentamount=\tableindent
2420   \parindent = 0pt
2421   \parskip = \smallskipamount
2422   \ifdim \parskip=0pt \parskip=2pt \fi
2423   \let\item = \internalBitem
2424   \let\itemx = \internalBitemx
2425 }
2426 \def\Etable{\endgraf\afterenvbreak}
2427 \let\Eftable\Etable
2428 \let\Evtable\Etable
2429 \let\Eitemize\Etable
2430 \let\Eenumerate\Etable
2431
2432 % This is the counter used by @enumerate, which is really @itemize
2433
2434 \newcount \itemno
2435
2436 \envdef\itemize{\parsearg\doitemize}
2437
2438 \def\doitemize#1{%
2439   \aboveenvbreak
2440   \itemmax=\itemindent
2441   \advance\itemmax by -\itemmargin
2442   \advance\leftskip by \itemindent
2443   \exdentamount=\itemindent
2444   \parindent=0pt
2445   \parskip=\smallskipamount
2446   \ifdim\parskip=0pt \parskip=2pt \fi
2447   \def\itemcontents{#1}%
2448   % @itemize with no arg is equivalent to @itemize @bullet.
2449   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2450   \let\item=\itemizeitem
2451 }
2452
2453 % Definition of @item while inside @itemize and @enumerate.
2454 %
2455 \def\itemizeitem{%
2456   \advance\itemno by 1  % for enumerations
2457   {\let\par=\endgraf \smallbreak}% reasonable place to break
2458   {%
2459    % If the document has an @itemize directly after a section title, a
2460    % \nobreak will be last on the list, and \sectionheading will have
2461    % done a \vskip-\parskip.  In that case, we don't want to zero
2462    % parskip, or the item text will crash with the heading.  On the
2463    % other hand, when there is normal text preceding the item (as there
2464    % usually is), we do want to zero parskip, or there would be too much
2465    % space.  In that case, we won't have a \nobreak before.  At least
2466    % that's the theory.
2467    \ifnum\lastpenalty<10000 \parskip=0in \fi
2468    \noindent
2469    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2470    \vadjust{\penalty 1200}}% not good to break after first line of item.
2471   \flushcr
2472 }
2473
2474 % \splitoff TOKENS\endmark defines \first to be the first token in
2475 % TOKENS, and \rest to be the remainder.
2476 %
2477 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2478
2479 % Allow an optional argument of an uppercase letter, lowercase letter,
2480 % or number, to specify the first label in the enumerated list.  No
2481 % argument is the same as `1'.
2482 %
2483 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
2484 \def\enumeratey #1 #2\endenumeratey{%
2485   % If we were given no argument, pretend we were given `1'.
2486   \def\thearg{#1}%
2487   \ifx\thearg\empty \def\thearg{1}\fi
2488   %
2489   % Detect if the argument is a single token.  If so, it might be a
2490   % letter.  Otherwise, the only valid thing it can be is a number.
2491   % (We will always have one token, because of the test we just made.
2492   % This is a good thing, since \splitoff doesn't work given nothing at
2493   % all -- the first parameter is undelimited.)
2494   \expandafter\splitoff\thearg\endmark
2495   \ifx\rest\empty
2496     % Only one token in the argument.  It could still be anything.
2497     % A ``lowercase letter'' is one whose \lccode is nonzero.
2498     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2499     %   not equal to itself.
2500     % Otherwise, we assume it's a number.
2501     %
2502     % We need the \relax at the end of the \ifnum lines to stop TeX from
2503     % continuing to look for a <number>.
2504     %
2505     \ifnum\lccode\expandafter`\thearg=0\relax
2506       \numericenumerate % a number (we hope)
2507     \else
2508       % It's a letter.
2509       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2510         \lowercaseenumerate % lowercase letter
2511       \else
2512         \uppercaseenumerate % uppercase letter
2513       \fi
2514     \fi
2515   \else
2516     % Multiple tokens in the argument.  We hope it's a number.
2517     \numericenumerate
2518   \fi
2519 }
2520
2521 % An @enumerate whose labels are integers.  The starting integer is
2522 % given in \thearg.
2523 %
2524 \def\numericenumerate{%
2525   \itemno = \thearg
2526   \startenumeration{\the\itemno}%
2527 }
2528
2529 % The starting (lowercase) letter is in \thearg.
2530 \def\lowercaseenumerate{%
2531   \itemno = \expandafter`\thearg
2532   \startenumeration{%
2533     % Be sure we're not beyond the end of the alphabet.
2534     \ifnum\itemno=0
2535       \errmessage{No more lowercase letters in @enumerate; get a bigger
2536                   alphabet}%
2537     \fi
2538     \char\lccode\itemno
2539   }%
2540 }
2541
2542 % The starting (uppercase) letter is in \thearg.
2543 \def\uppercaseenumerate{%
2544   \itemno = \expandafter`\thearg
2545   \startenumeration{%
2546     % Be sure we're not beyond the end of the alphabet.
2547     \ifnum\itemno=0
2548       \errmessage{No more uppercase letters in @enumerate; get a bigger
2549                   alphabet}
2550     \fi
2551     \char\uccode\itemno
2552   }%
2553 }
2554
2555 % Call \doitemize, adding a period to the first argument and supplying the
2556 % common last two arguments.  Also subtract one from the initial value in
2557 % \itemno, since @item increments \itemno.
2558 %
2559 \def\startenumeration#1{%
2560   \advance\itemno by -1
2561   \doitemize{#1.}\flushcr
2562 }
2563
2564 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2565 % to @enumerate.
2566 %
2567 \def\alphaenumerate{\enumerate{a}}
2568 \def\capsenumerate{\enumerate{A}}
2569 \def\Ealphaenumerate{\Eenumerate}
2570 \def\Ecapsenumerate{\Eenumerate}
2571
2572
2573 % @multitable macros
2574 % Amy Hendrickson, 8/18/94, 3/6/96
2575 %
2576 % @multitable ... @end multitable will make as many columns as desired.
2577 % Contents of each column will wrap at width given in preamble.  Width
2578 % can be specified either with sample text given in a template line,
2579 % or in percent of \hsize, the current width of text on page.
2580
2581 % Table can continue over pages but will only break between lines.
2582
2583 % To make preamble:
2584 %
2585 % Either define widths of columns in terms of percent of \hsize:
2586 %   @multitable @columnfractions .25 .3 .45
2587 %   @item ...
2588 %
2589 %   Numbers following @columnfractions are the percent of the total
2590 %   current hsize to be used for each column. You may use as many
2591 %   columns as desired.
2592
2593
2594 % Or use a template:
2595 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2596 %   @item ...
2597 %   using the widest term desired in each column.
2598
2599 % Each new table line starts with @item, each subsequent new column
2600 % starts with @tab. Empty columns may be produced by supplying @tab's
2601 % with nothing between them for as many times as empty columns are needed,
2602 % ie, @tab@tab@tab will produce two empty columns.
2603
2604 % @item, @tab do not need to be on their own lines, but it will not hurt
2605 % if they are.
2606
2607 % Sample multitable:
2608
2609 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2610 %   @item first col stuff @tab second col stuff @tab third col
2611 %   @item
2612 %   first col stuff
2613 %   @tab
2614 %   second col stuff
2615 %   @tab
2616 %   third col
2617 %   @item first col stuff @tab second col stuff
2618 %   @tab Many paragraphs of text may be used in any column.
2619 %
2620 %         They will wrap at the width determined by the template.
2621 %   @item@tab@tab This will be in third column.
2622 %   @end multitable
2623
2624 % Default dimensions may be reset by user.
2625 % @multitableparskip is vertical space between paragraphs in table.
2626 % @multitableparindent is paragraph indent in table.
2627 % @multitablecolmargin is horizontal space to be left between columns.
2628 % @multitablelinespace is space to leave between table items, baseline
2629 %                                                            to baseline.
2630 %   0pt means it depends on current normal line spacing.
2631 %
2632 \newskip\multitableparskip
2633 \newskip\multitableparindent
2634 \newdimen\multitablecolspace
2635 \newskip\multitablelinespace
2636 \multitableparskip=0pt
2637 \multitableparindent=6pt
2638 \multitablecolspace=12pt
2639 \multitablelinespace=0pt
2640
2641 % Macros used to set up halign preamble:
2642 %
2643 \let\endsetuptable\relax
2644 \def\xendsetuptable{\endsetuptable}
2645 \let\columnfractions\relax
2646 \def\xcolumnfractions{\columnfractions}
2647 \newif\ifsetpercent
2648
2649 % #1 is the @columnfraction, usually a decimal number like .5, but might
2650 % be just 1.  We just use it, whatever it is.
2651 %
2652 \def\pickupwholefraction#1 {%
2653   \global\advance\colcount by 1
2654   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2655   \setuptable
2656 }
2657
2658 \newcount\colcount
2659 \def\setuptable#1{%
2660   \def\firstarg{#1}%
2661   \ifx\firstarg\xendsetuptable
2662     \let\go = \relax
2663   \else
2664     \ifx\firstarg\xcolumnfractions
2665       \global\setpercenttrue
2666     \else
2667       \ifsetpercent
2668          \let\go\pickupwholefraction
2669       \else
2670          \global\advance\colcount by 1
2671          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2672                    % separator; typically that is always in the input, anyway.
2673          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2674       \fi
2675     \fi
2676     \ifx\go\pickupwholefraction
2677       % Put the argument back for the \pickupwholefraction call, so
2678       % we'll always have a period there to be parsed.
2679       \def\go{\pickupwholefraction#1}%
2680     \else
2681       \let\go = \setuptable
2682     \fi%
2683   \fi
2684   \go
2685 }
2686
2687 % multitable-only commands.
2688 %
2689 % @headitem starts a heading row, which we typeset in bold.
2690 % Assignments have to be global since we are inside the implicit group
2691 % of an alignment entry.  Note that \everycr resets \everytab.
2692 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2693 %
2694 % A \tab used to include \hskip1sp.  But then the space in a template
2695 % line is not enough.  That is bad.  So let's go back to just `&' until
2696 % we encounter the problem it was intended to solve again.
2697 %                                       --karl, nathan@acm.org, 20apr99.
2698 \def\tab{\checkenv\multitable &\the\everytab}%
2699
2700 % @multitable ... @end multitable definitions:
2701 %
2702 \newtoks\everytab  % insert after every tab.
2703 %
2704 \envdef\multitable{%
2705   \vskip\parskip
2706   \startsavinginserts
2707   %
2708   % @item within a multitable starts a normal row.
2709   % We use \def instead of \let so that if one of the multitable entries
2710   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2711   % \endtemplate) expanding \doitemize.
2712   \def\item{\crcr}%
2713   %
2714   \tolerance=9500
2715   \hbadness=9500
2716   \setmultitablespacing
2717   \parskip=\multitableparskip
2718   \parindent=\multitableparindent
2719   \overfullrule=0pt
2720   \global\colcount=0
2721   %
2722   \everycr = {%
2723     \noalign{%
2724       \global\everytab={}%
2725       \global\colcount=0 % Reset the column counter.
2726       % Check for saved footnotes, etc.
2727       \checkinserts
2728       % Keeps underfull box messages off when table breaks over pages.
2729       %\filbreak
2730         % Maybe so, but it also creates really weird page breaks when the
2731         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
2732         % problem manifests itself, so it can be fixed for real --karl.
2733     }%
2734   }%
2735   %
2736   \parsearg\domultitable
2737 }
2738 \def\domultitable#1{%
2739   % To parse everything between @multitable and @item:
2740   \setuptable#1 \endsetuptable
2741   %
2742   % This preamble sets up a generic column definition, which will
2743   % be used as many times as user calls for columns.
2744   % \vtop will set a single line and will also let text wrap and
2745   % continue for many paragraphs if desired.
2746   \halign\bgroup &%
2747     \global\advance\colcount by 1
2748     \multistrut
2749     \vtop{%
2750       % Use the current \colcount to find the correct column width:
2751       \hsize=\expandafter\csname col\the\colcount\endcsname
2752       %
2753       % In order to keep entries from bumping into each other
2754       % we will add a \leftskip of \multitablecolspace to all columns after
2755       % the first one.
2756       %
2757       % If a template has been used, we will add \multitablecolspace
2758       % to the width of each template entry.
2759       %
2760       % If the user has set preamble in terms of percent of \hsize we will
2761       % use that dimension as the width of the column, and the \leftskip
2762       % will keep entries from bumping into each other.  Table will start at
2763       % left margin and final column will justify at right margin.
2764       %
2765       % Make sure we don't inherit \rightskip from the outer environment.
2766       \rightskip=0pt
2767       \ifnum\colcount=1
2768         % The first column will be indented with the surrounding text.
2769         \advance\hsize by\leftskip
2770       \else
2771         \ifsetpercent \else
2772           % If user has not set preamble in terms of percent of \hsize
2773           % we will advance \hsize by \multitablecolspace.
2774           \advance\hsize by \multitablecolspace
2775         \fi
2776        % In either case we will make \leftskip=\multitablecolspace:
2777       \leftskip=\multitablecolspace
2778       \fi
2779       % Ignoring space at the beginning and end avoids an occasional spurious
2780       % blank line, when TeX decides to break the line at the space before the
2781       % box from the multistrut, so the strut ends up on a line by itself.
2782       % For example:
2783       % @multitable @columnfractions .11 .89
2784       % @item @code{#}
2785       % @tab Legal holiday which is valid in major parts of the whole country.
2786       % Is automatically provided with highlighting sequences respectively
2787       % marking characters.
2788       \noindent\ignorespaces##\unskip\multistrut
2789     }\cr
2790 }
2791 \def\Emultitable{%
2792   \crcr
2793   \egroup % end the \halign
2794   \global\setpercentfalse
2795 }
2796
2797 \def\setmultitablespacing{%
2798   \def\multistrut{\strut}% just use the standard line spacing
2799   %
2800   % Compute \multitablelinespace (if not defined by user) for use in
2801   % \multitableparskip calculation.  We used define \multistrut based on
2802   % this, but (ironically) that caused the spacing to be off.
2803   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2804 \ifdim\multitablelinespace=0pt
2805 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2806 \global\advance\multitablelinespace by-\ht0
2807 \fi
2808 %% Test to see if parskip is larger than space between lines of
2809 %% table. If not, do nothing.
2810 %%        If so, set to same dimension as multitablelinespace.
2811 \ifdim\multitableparskip>\multitablelinespace
2812 \global\multitableparskip=\multitablelinespace
2813 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2814                                       %% than skip between lines in the table.
2815 \fi%
2816 \ifdim\multitableparskip=0pt
2817 \global\multitableparskip=\multitablelinespace
2818 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2819                                       %% than skip between lines in the table.
2820 \fi}
2821
2822
2823 \message{conditionals,}
2824
2825 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2826 % @ifnotxml always succeed.  They currently do nothing; we don't
2827 % attempt to check whether the conditionals are properly nested.  But we
2828 % have to remember that they are conditionals, so that @end doesn't
2829 % attempt to close an environment group.
2830 %
2831 \def\makecond#1{%
2832   \expandafter\let\csname #1\endcsname = \relax
2833   \expandafter\let\csname iscond.#1\endcsname = 1
2834 }
2835 \makecond{iftex}
2836 \makecond{ifnotdocbook}
2837 \makecond{ifnothtml}
2838 \makecond{ifnotinfo}
2839 \makecond{ifnotplaintext}
2840 \makecond{ifnotxml}
2841
2842 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2843 %
2844 \def\direntry{\doignore{direntry}}
2845 \def\documentdescription{\doignore{documentdescription}}
2846 \def\docbook{\doignore{docbook}}
2847 \def\html{\doignore{html}}
2848 \def\ifdocbook{\doignore{ifdocbook}}
2849 \def\ifhtml{\doignore{ifhtml}}
2850 \def\ifinfo{\doignore{ifinfo}}
2851 \def\ifnottex{\doignore{ifnottex}}
2852 \def\ifplaintext{\doignore{ifplaintext}}
2853 \def\ifxml{\doignore{ifxml}}
2854 \def\ignore{\doignore{ignore}}
2855 \def\menu{\doignore{menu}}
2856 \def\xml{\doignore{xml}}
2857
2858 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2859 %
2860 % A count to remember the depth of nesting.
2861 \newcount\doignorecount
2862
2863 \def\doignore#1{\begingroup
2864   % Scan in ``verbatim'' mode:
2865   \catcode`\@ = \other
2866   \catcode`\{ = \other
2867   \catcode`\} = \other
2868   %
2869   % Make sure that spaces turn into tokens that match what \doignoretext wants.
2870   \spaceisspace
2871   %
2872   % Count number of #1's that we've seen.
2873   \doignorecount = 0
2874   %
2875   % Swallow text until we reach the matching `@end #1'.
2876   \dodoignore{#1}%
2877 }
2878
2879 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2880   \obeylines %
2881   %
2882   \gdef\dodoignore#1{%
2883     % #1 contains the command name as a string, e.g., `ifinfo'.
2884     %
2885     % Define a command to find the next `@end #1', which must be on a line
2886     % by itself.
2887     \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2888     % And this command to find another #1 command, at the beginning of a
2889     % line.  (Otherwise, we would consider a line `@c @ifset', for
2890     % example, to count as an @ifset for nesting.)
2891     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2892     %
2893     % And now expand that command.
2894     \obeylines %
2895     \doignoretext ^^M%
2896   }%
2897 }
2898
2899 \def\doignoreyyy#1{%
2900   \def\temp{#1}%
2901   \ifx\temp\empty                       % Nothing found.
2902     \let\next\doignoretextzzz
2903   \else                                 % Found a nested condition, ...
2904     \advance\doignorecount by 1
2905     \let\next\doignoretextyyy           % ..., look for another.
2906     % If we're here, #1 ends with ^^M\ifinfo (for example).
2907   \fi
2908   \next #1% the token \_STOP_ is present just after this macro.
2909 }
2910
2911 % We have to swallow the remaining "\_STOP_".
2912 %
2913 \def\doignoretextzzz#1{%
2914   \ifnum\doignorecount = 0      % We have just found the outermost @end.
2915     \let\next\enddoignore
2916   \else                         % Still inside a nested condition.
2917     \advance\doignorecount by -1
2918     \let\next\doignoretext      % Look for the next @end.
2919   \fi
2920   \next
2921 }
2922
2923 % Finish off ignored text.
2924 \def\enddoignore{\endgroup\ignorespaces}
2925
2926
2927 % @set VAR sets the variable VAR to an empty value.
2928 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2929 %
2930 % Since we want to separate VAR from REST-OF-LINE (which might be
2931 % empty), we can't just use \parsearg; we have to insert a space of our
2932 % own to delimit the rest of the line, and then take it out again if we
2933 % didn't need it.
2934 % We rely on the fact that \parsearg sets \catcode`\ =10.
2935 %
2936 \parseargdef\set{\setyyy#1 \endsetyyy}
2937 \def\setyyy#1 #2\endsetyyy{%
2938   {%
2939     \makevalueexpandable
2940     \def\temp{#2}%
2941     \edef\next{\gdef\makecsname{SET#1}}%
2942     \ifx\temp\empty
2943       \next{}%
2944     \else
2945       \setzzz#2\endsetzzz
2946     \fi
2947   }%
2948 }
2949 % Remove the trailing space \setxxx inserted.
2950 \def\setzzz#1 \endsetzzz{\next{#1}}
2951
2952 % @clear VAR clears (i.e., unsets) the variable VAR.
2953 %
2954 \parseargdef\clear{%
2955   {%
2956     \makevalueexpandable
2957     \global\expandafter\let\csname SET#1\endcsname=\relax
2958   }%
2959 }
2960
2961 % @value{foo} gets the text saved in variable foo.
2962 \def\value{\begingroup\makevalueexpandable\valuexxx}
2963 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2964 {
2965   \catcode`\- = \active \catcode`\_ = \active
2966   %
2967   \gdef\makevalueexpandable{%
2968     \let\value = \expandablevalue
2969     % We don't want these characters active, ...
2970     \catcode`\-=\other \catcode`\_=\other
2971     % ..., but we might end up with active ones in the argument if
2972     % we're called from @code, as @code{@value{foo-bar_}}, though.
2973     % So \let them to their normal equivalents.
2974     \let-\realdash \let_\normalunderscore
2975   }
2976 }
2977
2978 % We have this subroutine so that we can handle at least some @value's
2979 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2980 % The command has to be fully expandable (if the variable is set), since
2981 % the result winds up in the index file.  This means that if the
2982 % variable's value contains other Texinfo commands, it's almost certain
2983 % it will fail (although perhaps we could fix that with sufficient work
2984 % to do a one-level expansion on the result, instead of complete).
2985 %
2986 \def\expandablevalue#1{%
2987   \expandafter\ifx\csname SET#1\endcsname\relax
2988     {[No value for ``#1'']}%
2989     \message{Variable `#1', used in @value, is not set.}%
2990   \else
2991     \csname SET#1\endcsname
2992   \fi
2993 }
2994
2995 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2996 % with @set.
2997 %
2998 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2999 %
3000 \makecond{ifset}
3001 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3002 \def\doifset#1#2{%
3003   {%
3004     \makevalueexpandable
3005     \let\next=\empty
3006     \expandafter\ifx\csname SET#2\endcsname\relax
3007       #1% If not set, redefine \next.
3008     \fi
3009     \expandafter
3010   }\next
3011 }
3012 \def\ifsetfail{\doignore{ifset}}
3013
3014 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3015 % defined with @set, or has been undefined with @clear.
3016 %
3017 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3018 % above code: if the variable is not set, do nothing, if it is set,
3019 % then redefine \next to \ifclearfail.
3020 %
3021 \makecond{ifclear}
3022 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3023 \def\ifclearfail{\doignore{ifclear}}
3024
3025 % @dircategory CATEGORY  -- specify a category of the dir file
3026 % which this file should belong to.  Ignore this in TeX.
3027 \let\dircategory=\comment
3028
3029 % @defininfoenclose.
3030 \let\definfoenclose=\comment
3031
3032
3033 \message{indexing,}
3034 % Index generation facilities
3035
3036 % Define \newwrite to be identical to plain tex's \newwrite
3037 % except not \outer, so it can be used within macros and \if's.
3038 \edef\newwrite{\makecsname{ptexnewwrite}}
3039
3040 % \newindex {foo} defines an index named foo.
3041 % It automatically defines \fooindex such that
3042 % \fooindex ...rest of line... puts an entry in the index foo.
3043 % It also defines \fooindfile to be the number of the output channel for
3044 % the file that accumulates this index.  The file's extension is foo.
3045 % The name of an index should be no more than 2 characters long
3046 % for the sake of vms.
3047 %
3048 \def\newindex#1{%
3049   \iflinks
3050     \expandafter\newwrite \csname#1indfile\endcsname
3051     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3052   \fi
3053   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
3054     \noexpand\doindex{#1}}
3055 }
3056
3057 % @defindex foo  ==  \newindex{foo}
3058 %
3059 \def\defindex{\parsearg\newindex}
3060
3061 % Define @defcodeindex, like @defindex except put all entries in @code.
3062 %
3063 \def\defcodeindex{\parsearg\newcodeindex}
3064 %
3065 \def\newcodeindex#1{%
3066   \iflinks
3067     \expandafter\newwrite \csname#1indfile\endcsname
3068     \openout \csname#1indfile\endcsname \jobname.#1
3069   \fi
3070   \expandafter\xdef\csname#1index\endcsname{%
3071     \noexpand\docodeindex{#1}}%
3072 }
3073
3074
3075 % @synindex foo bar    makes index foo feed into index bar.
3076 % Do this instead of @defindex foo if you don't want it as a separate index.
3077 %
3078 % @syncodeindex foo bar   similar, but put all entries made for index foo
3079 % inside @code.
3080 %
3081 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3082 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3083
3084 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3085 % #3 the target index (bar).
3086 \def\dosynindex#1#2#3{%
3087   % Only do \closeout if we haven't already done it, else we'll end up
3088   % closing the target index.
3089   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3090     % The \closeout helps reduce unnecessary open files; the limit on the
3091     % Acorn RISC OS is a mere 16 files.
3092     \expandafter\closeout\csname#2indfile\endcsname
3093     \expandafter\let\csname\donesynindex#2\endcsname = 1
3094   \fi
3095   % redefine \fooindfile:
3096   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3097   \expandafter\let\csname#2indfile\endcsname=\temp
3098   % redefine \fooindex:
3099   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3100 }
3101
3102 % Define \doindex, the driver for all \fooindex macros.
3103 % Argument #1 is generated by the calling \fooindex macro,
3104 %  and it is "foo", the name of the index.
3105
3106 % \doindex just uses \parsearg; it calls \doind for the actual work.
3107 % This is because \doind is more useful to call from other macros.
3108
3109 % There is also \dosubind {index}{topic}{subtopic}
3110 % which makes an entry in a two-level index such as the operation index.
3111
3112 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3113 \def\singleindexer #1{\doind{\indexname}{#1}}
3114
3115 % like the previous two, but they put @code around the argument.
3116 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3117 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3118
3119 % Take care of Texinfo commands that can appear in an index entry.
3120 % Since there are some commands we want to expand, and others we don't,
3121 % we have to laboriously prevent expansion for those that we don't.
3122 %
3123 \def\indexdummies{%
3124   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3125   \def\ {\realbackslash\space }%
3126   % Need these in case \tex is in effect and \{ is a \delimiter again.
3127   % But can't use \lbracecmd and \rbracecmd because texindex assumes
3128   % braces and backslashes are used only as delimiters.
3129   \let\{ = \mylbrace
3130   \let\} = \myrbrace
3131   %
3132   % \definedummyword defines \#1 as \realbackslash #1\space, thus
3133   % effectively preventing its expansion.  This is used only for control
3134   % words, not control letters, because the \space would be incorrect
3135   % for control characters, but is needed to separate the control word
3136   % from whatever follows.
3137   %
3138   % For control letters, we have \definedummyletter, which omits the
3139   % space.
3140   %
3141   % These can be used both for control words that take an argument and
3142   % those that do not.  If it is followed by {arg} in the input, then
3143   % that will dutifully get written to the index (or wherever).
3144   %
3145   \def\definedummyword##1{%
3146     \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3147   }%
3148   \def\definedummyletter##1{%
3149     \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3150   }%
3151   \let\definedummyaccent\definedummyletter
3152   %
3153   % Do the redefinitions.
3154   \commondummies
3155 }
3156
3157 % For the aux file, @ is the escape character.  So we want to redefine
3158 % everything using @ instead of \realbackslash.  When everything uses
3159 % @, this will be simpler.
3160 %
3161 \def\atdummies{%
3162   \def\@{@@}%
3163   \def\ {@ }%
3164   \let\{ = \lbraceatcmd
3165   \let\} = \rbraceatcmd
3166   %
3167   % (See comments in \indexdummies.)
3168   \def\definedummyword##1{%
3169     \expandafter\def\csname ##1\endcsname{@##1\space}%
3170   }%
3171   \def\definedummyletter##1{%
3172     \expandafter\def\csname ##1\endcsname{@##1}%
3173   }%
3174   \let\definedummyaccent\definedummyletter
3175   %
3176   % Do the redefinitions.
3177   \commondummies
3178 }
3179
3180 % Called from \indexdummies and \atdummies.  \definedummyword and
3181 % \definedummyletter must be defined first.
3182 %
3183 \def\commondummies{%
3184   %
3185   \normalturnoffactive
3186   %
3187   \commondummiesnofonts
3188   %
3189   \definedummyletter{_}%
3190   %
3191   % Non-English letters.
3192   \definedummyword{AA}%
3193   \definedummyword{AE}%
3194   \definedummyword{L}%
3195   \definedummyword{OE}%
3196   \definedummyword{O}%
3197   \definedummyword{aa}%
3198   \definedummyword{ae}%
3199   \definedummyword{l}%
3200   \definedummyword{oe}%
3201   \definedummyword{o}%
3202   \definedummyword{ss}%
3203   \definedummyword{exclamdown}%
3204   \definedummyword{questiondown}%
3205   \definedummyword{ordf}%
3206   \definedummyword{ordm}%
3207   %
3208   % Although these internal commands shouldn't show up, sometimes they do.
3209   \definedummyword{bf}%
3210   \definedummyword{gtr}%
3211   \definedummyword{hat}%
3212   \definedummyword{less}%
3213   \definedummyword{sf}%
3214   \definedummyword{sl}%
3215   \definedummyword{tclose}%
3216   \definedummyword{tt}%
3217   %
3218   \definedummyword{LaTeX}%
3219   \definedummyword{TeX}%
3220   %
3221   % Assorted special characters.
3222   \definedummyword{bullet}%
3223   \definedummyword{comma}%
3224   \definedummyword{copyright}%
3225   \definedummyword{registeredsymbol}%
3226   \definedummyword{dots}%
3227   \definedummyword{enddots}%
3228   \definedummyword{equiv}%
3229   \definedummyword{error}%
3230   \definedummyword{euro}%
3231   \definedummyword{expansion}%
3232   \definedummyword{minus}%
3233   \definedummyword{pounds}%
3234   \definedummyword{point}%
3235   \definedummyword{print}%
3236   \definedummyword{result}%
3237   %
3238   % Handle some cases of @value -- where it does not contain any
3239   % (non-fully-expandable) commands.
3240   \makevalueexpandable
3241   %
3242   % Normal spaces, not active ones.
3243   \unsepspaces
3244   %
3245   % No macro expansion.
3246   \turnoffmacros
3247 }
3248
3249 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3250 %
3251 % Better have this without active chars.
3252 {
3253   \catcode`\~=\other
3254   \gdef\commondummiesnofonts{%
3255     % Control letters and accents.
3256     \definedummyletter{!}%
3257     \definedummyaccent{"}%
3258     \definedummyaccent{'}%
3259     \definedummyletter{*}%
3260     \definedummyaccent{,}%
3261     \definedummyletter{.}%
3262     \definedummyletter{/}%
3263     \definedummyletter{:}%
3264     \definedummyaccent{=}%
3265     \definedummyletter{?}%
3266     \definedummyaccent{^}%
3267     \definedummyaccent{`}%
3268     \definedummyaccent{~}%
3269     \definedummyword{u}%
3270     \definedummyword{v}%
3271     \definedummyword{H}%
3272     \definedummyword{dotaccent}%
3273     \definedummyword{ringaccent}%
3274     \definedummyword{tieaccent}%
3275     \definedummyword{ubaraccent}%
3276     \definedummyword{udotaccent}%
3277     \definedummyword{dotless}%
3278     %
3279     % Texinfo font commands.
3280     \definedummyword{b}%
3281     \definedummyword{i}%
3282     \definedummyword{r}%
3283     \definedummyword{sc}%
3284     \definedummyword{t}%
3285     %
3286     % Commands that take arguments.
3287     \definedummyword{acronym}%
3288     \definedummyword{cite}%
3289     \definedummyword{code}%
3290     \definedummyword{command}%
3291     \definedummyword{dfn}%
3292     \definedummyword{emph}%
3293     \definedummyword{env}%
3294     \definedummyword{file}%
3295     \definedummyword{kbd}%
3296     \definedummyword{key}%
3297     \definedummyword{math}%
3298     \definedummyword{option}%
3299     \definedummyword{samp}%
3300     \definedummyword{strong}%
3301     \definedummyword{tie}%
3302     \definedummyword{uref}%
3303     \definedummyword{url}%
3304     \definedummyword{var}%
3305     \definedummyword{verb}%
3306     \definedummyword{w}%
3307   }
3308 }
3309
3310 % \indexnofonts is used when outputting the strings to sort the index
3311 % by, and when constructing control sequence names.  It eliminates all
3312 % control sequences and just writes whatever the best ASCII sort string
3313 % would be for a given command (usually its argument).
3314 %
3315 \def\indexnofonts{%
3316   % Accent commands should become @asis.
3317   \def\definedummyaccent##1{%
3318     \expandafter\let\csname ##1\endcsname\asis
3319   }%
3320   % We can just ignore other control letters.
3321   \def\definedummyletter##1{%
3322     \expandafter\def\csname ##1\endcsname{}%
3323   }%
3324   % Hopefully, all control words can become @asis.
3325   \let\definedummyword\definedummyaccent
3326   %
3327   \commondummiesnofonts
3328   %
3329   % Don't no-op \tt, since it isn't a user-level command
3330   % and is used in the definitions of the active chars like <, >, |, etc.
3331   % Likewise with the other plain tex font commands.
3332   %\let\tt=\asis
3333   %
3334   \def\ { }%
3335   \def\@{@}%
3336   % how to handle braces?
3337   \def\_{\normalunderscore}%
3338   %
3339   % Non-English letters.
3340   \def\AA{AA}%
3341   \def\AE{AE}%
3342   \def\L{L}%
3343   \def\OE{OE}%
3344   \def\O{O}%
3345   \def\aa{aa}%
3346   \def\ae{ae}%
3347   \def\l{l}%
3348   \def\oe{oe}%
3349   \def\o{o}%
3350   \def\ss{ss}%
3351   \def\exclamdown{!}%
3352   \def\questiondown{?}%
3353   \def\ordf{a}%
3354   \def\ordm{o}%
3355   %
3356   \def\LaTeX{LaTeX}%
3357   \def\TeX{TeX}%
3358   %
3359   % Assorted special characters.
3360   % (The following {} will end up in the sort string, but that's ok.)
3361   \def\bullet{bullet}%
3362   \def\comma{,}%
3363   \def\copyright{copyright}%
3364   \def\registeredsymbol{R}%
3365   \def\dots{...}%
3366   \def\enddots{...}%
3367   \def\equiv{==}%
3368   \def\error{error}%
3369   \def\euro{euro}%
3370   \def\expansion{==>}%
3371   \def\minus{-}%
3372   \def\pounds{pounds}%
3373   \def\point{.}%
3374   \def\print{-|}%
3375   \def\result{=>}%
3376   %
3377   % Don't write macro names.
3378   \emptyusermacros
3379 }
3380
3381 \let\indexbackslash=0  %overridden during \printindex.
3382 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3383
3384 % Most index entries go through here, but \dosubind is the general case.
3385 % #1 is the index name, #2 is the entry text.
3386 \def\doind#1#2{\dosubind{#1}{#2}{}}
3387
3388 % Workhorse for all \fooindexes.
3389 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3390 % empty if called from \doind, as we usually are (the main exception
3391 % is with most defuns, which call us directly).
3392 %
3393 \def\dosubind#1#2#3{%
3394   \iflinks
3395   {%
3396     % Store the main index entry text (including the third arg).
3397     \toks0 = {#2}%
3398     % If third arg is present, precede it with a space.
3399     \def\thirdarg{#3}%
3400     \ifx\thirdarg\empty \else
3401       \toks0 = \expandafter{\the\toks0 \space #3}%
3402     \fi
3403     %
3404     \edef\writeto{\csname#1indfile\endcsname}%
3405     %
3406     \ifvmode
3407       \dosubindsanitize
3408     \else
3409       \dosubindwrite
3410     \fi
3411   }%
3412   \fi
3413 }
3414
3415 % Write the entry in \toks0 to the index file:
3416 %
3417 \def\dosubindwrite{%
3418   % Put the index entry in the margin if desired.
3419   \ifx\SETmarginindex\relax\else
3420     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3421   \fi
3422   %
3423   % Remember, we are within a group.
3424   \indexdummies % Must do this here, since \bf, etc expand at this stage
3425   \escapechar=`\\
3426   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3427       % so it will be output as is; and it will print as backslash.
3428   %
3429   % Process the index entry with all font commands turned off, to
3430   % get the string to sort by.
3431   {\indexnofonts
3432    \edef\temp{\the\toks0}% need full expansion
3433    \xdef\indexsorttmp{\temp}%
3434   }%
3435   %
3436   % Set up the complete index entry, with both the sort key and
3437   % the original text, including any font commands.  We write
3438   % three arguments to \entry to the .?? file (four in the
3439   % subentry case), texindex reduces to two when writing the .??s
3440   % sorted result.
3441   \edef\temp{%
3442     \write\writeto{%
3443       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3444   }%
3445   \temp
3446 }
3447
3448 % Take care of unwanted page breaks:
3449 %
3450 % If a skip is the last thing on the list now, preserve it
3451 % by backing up by \lastskip, doing the \write, then inserting
3452 % the skip again.  Otherwise, the whatsit generated by the
3453 % \write will make \lastskip zero.  The result is that sequences
3454 % like this:
3455 % @end defun
3456 % @tindex whatever
3457 % @defun ...
3458 % will have extra space inserted, because the \medbreak in the
3459 % start of the @defun won't see the skip inserted by the @end of
3460 % the previous defun.
3461 %
3462 % But don't do any of this if we're not in vertical mode.  We
3463 % don't want to do a \vskip and prematurely end a paragraph.
3464 %
3465 % Avoid page breaks due to these extra skips, too.
3466 %
3467 % But wait, there is a catch there:
3468 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
3469 % sufficient for this purpose, as it ignores stretch and shrink parts
3470 % of the skip.  The only way seems to be to check the textual
3471 % representation of the skip.
3472 %
3473 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3474 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3475 %
3476 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3477 %
3478 % ..., ready, GO:
3479 %
3480 \def\dosubindsanitize{%
3481   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3482   \skip0 = \lastskip
3483   \edef\lastskipmacro{\the\lastskip}%
3484   \count255 = \lastpenalty
3485   %
3486   % If \lastskip is nonzero, that means the last item was a
3487   % skip.  And since a skip is discardable, that means this
3488   % -\skip0 glue we're inserting is preceded by a
3489   % non-discardable item, therefore it is not a potential
3490   % breakpoint, therefore no \nobreak needed.
3491   \ifx\lastskipmacro\zeroskipmacro