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