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