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-11-08.11}
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\*{\unskip\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
2277\let\markupsetuplqcode \markupsetcodequoteleft
2278\let\markupsetuprqcode \markupsetcodequoteright
2279%
2280\let\markupsetuplqexample \markupsetcodequoteleft
2281\let\markupsetuprqexample \markupsetcodequoteright
2282%
2283\let\markupsetuplqkbd     \markupsetcodequoteleft
2284\let\markupsetuprqkbd     \markupsetcodequoteright
2285%
2286\let\markupsetuplqsamp \markupsetcodequoteleft
2287\let\markupsetuprqsamp \markupsetcodequoteright
2288%
2289\let\markupsetuplqverb \markupsetcodequoteleft
2290\let\markupsetuprqverb \markupsetcodequoteright
2291%
2292\let\markupsetuplqverbatim \markupsetcodequoteleft
2293\let\markupsetuprqverbatim \markupsetcodequoteright
2294
2295% Allow an option to not use regular directed right quote/apostrophe
2296% (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2297% The undirected quote is ugly, so don't make it the default, but it
2298% works for pasting with more pdf viewers (at least evince), the
2299% lilypond developers report.  xpdf does work with the regular 0x27.
2300%
2301\def\codequoteright{%
2302  \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2303    \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2304      '%
2305    \else \char'15 \fi
2306  \else \char'15 \fi
2307}
2308%
2309% and a similar option for the left quote char vs. a grave accent.
2310% Modern fonts display ASCII 0x60 as a grave accent, so some people like
2311% the code environments to do likewise.
2312%
2313\def\codequoteleft{%
2314  \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2315    \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2316      % [Knuth] pp. 380,381,391
2317      % \relax disables Spanish ligatures ?` and !` of \tt font.
2318      \relax`%
2319    \else \char'22 \fi
2320  \else \char'22 \fi
2321}
2322
2323% Commands to set the quote options.
2324% 
2325\parseargdef\codequoteundirected{%
2326  \def\temp{#1}%
2327  \ifx\temp\onword
2328    \expandafter\let\csname SETtxicodequoteundirected\endcsname
2329      = t%
2330  \else\ifx\temp\offword
2331    \expandafter\let\csname SETtxicodequoteundirected\endcsname
2332      = \relax
2333  \else
2334    \errhelp = \EMsimple
2335    \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2336  \fi\fi
2337}
2338%
2339\parseargdef\codequotebacktick{%
2340  \def\temp{#1}%
2341  \ifx\temp\onword
2342    \expandafter\let\csname SETtxicodequotebacktick\endcsname
2343      = t%
2344  \else\ifx\temp\offword
2345    \expandafter\let\csname SETtxicodequotebacktick\endcsname
2346      = \relax
2347  \else
2348    \errhelp = \EMsimple
2349    \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2350  \fi\fi
2351}
2352
2353% [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2354\def\noligaturesquoteleft{\relax\lq}
2355
2356% Count depth in font-changes, for error checks
2357\newcount\fontdepth \fontdepth=0
2358
2359% Font commands.
2360
2361% #1 is the font command (\sl or \it), #2 is the text to slant.
2362% If we are in a monospaced environment, however, 1) always use \ttsl,
2363% and 2) do not add an italic correction.
2364\def\dosmartslant#1#2{%
2365  \ifusingtt 
2366    {{\ttsl #2}\let\next=\relax}%
2367    {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2368  \next
2369}
2370\def\smartslanted{\dosmartslant\sl}
2371\def\smartitalic{\dosmartslant\it}
2372
2373% Output an italic correction unless \next (presumed to be the following
2374% character) is such as not to need one.
2375\def\smartitaliccorrection{%
2376  \ifx\next,%
2377  \else\ifx\next-%
2378  \else\ifx\next.%
2379  \else\ptexslash
2380  \fi\fi\fi
2381  \aftersmartic
2382}
2383
2384% Unconditional use \ttsl, and no ic.  @var is set to this for defuns.
2385\def\ttslanted#1{{\ttsl #1}}
2386
2387% @cite is like \smartslanted except unconditionally use \sl.  We never want
2388% ttsl for book titles, do we?
2389\def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2390
2391\def\aftersmartic{}
2392\def\var#1{%
2393  \let\saveaftersmartic = \aftersmartic
2394  \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2395  \smartslanted{#1}%
2396}
2397
2398\let\i=\smartitalic
2399\let\slanted=\smartslanted
2400\let\dfn=\smartslanted
2401\let\emph=\smartitalic
2402
2403% Explicit font changes: @r, @sc, undocumented @ii.
2404\def\r#1{{\rm #1}}              % roman font
2405\def\sc#1{{\smallcaps#1}}       % smallcaps font
2406\def\ii#1{{\it #1}}             % italic font
2407
2408% @b, explicit bold.  Also @strong.
2409\def\b#1{{\bf #1}}
2410\let\strong=\b
2411
2412% @sansserif, explicit sans.
2413\def\sansserif#1{{\sf #1}}
2414
2415% We can't just use \exhyphenpenalty, because that only has effect at
2416% the end of a paragraph.  Restore normal hyphenation at the end of the
2417% group within which \nohyphenation is presumably called.
2418%
2419\def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
2420\def\restorehyphenation{\hyphenchar\font = `- }
2421
2422% Set sfcode to normal for the chars that usually have another value.
2423% Can't use plain's \frenchspacing because it uses the `\x notation, and
2424% sometimes \x has an active definition that messes things up.
2425%
2426\catcode`@=11
2427  \def\plainfrenchspacing{%
2428    \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2429    \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2430    \def\endofsentencespacefactor{1000}% for @. and friends
2431  }
2432  \def\plainnonfrenchspacing{%
2433    \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2434    \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2435    \def\endofsentencespacefactor{3000}% for @. and friends
2436  }
2437\catcode`@=\other
2438\def\endofsentencespacefactor{3000}% default
2439
2440% @t, explicit typewriter.
2441\def\t#1{%
2442  {\tt \rawbackslash \plainfrenchspacing #1}%
2443  \null
2444}
2445
2446% @samp.
2447\def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2448
2449% @indicateurl is \samp, that is, with quotes.
2450\let\indicateurl=\samp
2451
2452% @code (and similar) prints in typewriter, but with spaces the same
2453% size as normal in the surrounding text, without hyphenation, etc.
2454% This is a subroutine for that.
2455\def\tclose#1{%
2456  {%
2457    % Change normal interword space to be same as for the current font.
2458    \spaceskip = \fontdimen2\font
2459    %
2460    % Switch to typewriter.
2461    \tt
2462    %
2463    % But `\ ' produces the large typewriter interword space.
2464    \def\ {{\spaceskip = 0pt{} }}%
2465    %
2466    % Turn off hyphenation.
2467    \nohyphenation
2468    %
2469    \rawbackslash
2470    \plainfrenchspacing
2471    #1%
2472  }%
2473  \null % reset spacefactor to 1000
2474}
2475
2476% We *must* turn on hyphenation at `-' and `_' in @code.
2477% Otherwise, it is too hard to avoid overfull hboxes
2478% in the Emacs manual, the Library manual, etc.
2479%
2480% Unfortunately, TeX uses one parameter (\hyphenchar) to control
2481% both hyphenation at - and hyphenation within words.
2482% We must therefore turn them both off (\tclose does that)
2483% and arrange explicitly to hyphenate at a dash.
2484%  -- rms.
2485{
2486  \catcode`\-=\active \catcode`\_=\active
2487  \catcode`\'=\active \catcode`\`=\active
2488  \global\let'=\rq \global\let`=\lq  % default definitions
2489  %
2490  \global\def\code{\begingroup
2491    \setupmarkupstyle{code}%
2492    % The following should really be moved into \setupmarkupstyle handlers.
2493    \catcode\dashChar=\active  \catcode\underChar=\active
2494    \ifallowcodebreaks
2495     \let-\codedash
2496     \let_\codeunder
2497    \else
2498     \let-\realdash
2499     \let_\realunder
2500    \fi
2501    \codex
2502  }
2503}
2504
2505\def\codex #1{\tclose{#1}\endgroup}
2506
2507\def\realdash{-}
2508\def\codedash{-\discretionary{}{}{}}
2509\def\codeunder{%
2510  % this is all so @math{@code{var_name}+1} can work.  In math mode, _
2511  % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2512  % will therefore expand the active definition of _, which is us
2513  % (inside @code that is), therefore an endless loop.
2514  \ifusingtt{\ifmmode
2515               \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2516             \else\normalunderscore \fi
2517             \discretionary{}{}{}}%
2518            {\_}%
2519}
2520
2521% An additional complication: the above will allow breaks after, e.g.,
2522% each of the four underscores in __typeof__.  This is undesirable in
2523% some manuals, especially if they don't have long identifiers in
2524% general.  @allowcodebreaks provides a way to control this.
2525%
2526\newif\ifallowcodebreaks  \allowcodebreakstrue
2527
2528\def\keywordtrue{true}
2529\def\keywordfalse{false}
2530
2531\parseargdef\allowcodebreaks{%
2532  \def\txiarg{#1}%
2533  \ifx\txiarg\keywordtrue
2534    \allowcodebreakstrue
2535  \else\ifx\txiarg\keywordfalse
2536    \allowcodebreaksfalse
2537  \else
2538    \errhelp = \EMsimple
2539    \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2540  \fi\fi
2541}
2542
2543% For @command, @env, @file, @option quotes seem unnecessary,
2544% so use \code rather than \samp.
2545\let\command=\code
2546\let\env=\code
2547\let\file=\code
2548\let\option=\code
2549
2550% @uref (abbreviation for `urlref') takes an optional (comma-separated)
2551% second argument specifying the text to display and an optional third
2552% arg as text to display instead of (rather than in addition to) the url
2553% itself.  First (mandatory) arg is the url.
2554% (This \urefnobreak definition isn't used now, leaving it for a while
2555% for comparison.)
2556\def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2557\def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2558  \unsepspaces
2559  \pdfurl{#1}%
2560  \setbox0 = \hbox{\ignorespaces #3}%
2561  \ifdim\wd0 > 0pt
2562    \unhbox0 % third arg given, show only that
2563  \else
2564    \setbox0 = \hbox{\ignorespaces #2}%
2565    \ifdim\wd0 > 0pt
2566      \ifpdf
2567        \unhbox0             % PDF: 2nd arg given, show only it
2568      \else
2569        \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2570      \fi
2571    \else
2572      \code{#1}% only url given, so show it
2573    \fi
2574  \fi
2575  \endlink
2576\endgroup}
2577
2578% This \urefbreak definition is the active one.
2579\def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2580\let\uref=\urefbreak
2581\def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2582\def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2583  \unsepspaces
2584  \pdfurl{#1}%
2585  \setbox0 = \hbox{\ignorespaces #3}%
2586  \ifdim\wd0 > 0pt
2587    \unhbox0 % third arg given, show only that
2588  \else
2589    \setbox0 = \hbox{\ignorespaces #2}%
2590    \ifdim\wd0 > 0pt
2591      \ifpdf
2592        \unhbox0             % PDF: 2nd arg given, show only it
2593      \else
2594        \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2595      \fi
2596    \else
2597      \urefcode{#1}% only url given, so show it
2598    \fi
2599  \fi
2600  \endlink
2601\endgroup}
2602
2603% Allow line breaks around only a few characters (only).
2604\def\urefcatcodes{%
2605  \catcode\ampChar=\active   \catcode\dotChar=\active
2606  \catcode\hashChar=\active  \catcode\questChar=\active
2607  \catcode\slashChar=\active
2608}
2609{
2610  \urefcatcodes
2611  %
2612  \global\def\urefcode{\begingroup
2613    \setupmarkupstyle{code}%
2614    \urefcatcodes
2615    \let&\urefcodeamp
2616    \let.\urefcodedot
2617    \let#\urefcodehash
2618    \let?\urefcodequest
2619    \let/\urefcodeslash
2620    \codex
2621  }
2622  %
2623  % By default, they are just regular characters.
2624  \global\def&{\normalamp}
2625  \global\def.{\normaldot}
2626  \global\def#{\normalhash}
2627  \global\def?{\normalquest}
2628  \global\def/{\normalslash}
2629}
2630
2631% we put a little stretch before and after the breakable chars, to help
2632% line breaking of long url's.  The unequal skips make look better in
2633% cmtt at least, especially for dots.
2634\def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2635\def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2636%
2637\def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2638\def\urefcodedot{\urefprestretch .\urefpoststretch}
2639\def\urefcodehash{\urefprestretch \#\urefpoststretch}
2640\def\urefcodequest{\urefprestretch ?\urefpoststretch}
2641\def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2642{
2643  \catcode`\/=\active
2644  \global\def\urefcodeslashfinish{%
2645    \urefprestretch \slashChar
2646    % Allow line break only after the final / in a sequence of
2647    % slashes, to avoid line break between the slashes in http://.
2648    \ifx\next/\else \urefpoststretch \fi
2649  }
2650}
2651
2652% One more complication: by default we'll break after the special
2653% characters, but some people like to break before the special chars, so
2654% allow that.  Also allow no breaking at all, for manual control.
2655% 
2656\parseargdef\urefbreakstyle{%
2657  \def\txiarg{#1}%
2658  \ifx\txiarg\wordnone
2659    \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2660  \else\ifx\txiarg\wordbefore
2661    \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2662  \else\ifx\txiarg\wordafter
2663    \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2664  \else
2665    \errhelp = \EMsimple
2666    \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2667  \fi\fi\fi
2668}
2669\def\wordafter{after}
2670\def\wordbefore{before}
2671\def\wordnone{none}
2672
2673\urefbreakstyle after
2674
2675% @url synonym for @uref, since that's how everyone uses it.
2676%
2677\let\url=\uref
2678
2679% rms does not like angle brackets --karl, 17may97.
2680% So now @email is just like @uref, unless we are pdf.
2681%
2682%\def\email#1{\angleleft{\tt #1}\angleright}
2683\ifpdf
2684  \def\email#1{\doemail#1,,\finish}
2685  \def\doemail#1,#2,#3\finish{\begingroup
2686    \unsepspaces
2687    \pdfurl{mailto:#1}%
2688    \setbox0 = \hbox{\ignorespaces #2}%
2689    \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2690    \endlink
2691  \endgroup}
2692\else
2693  \let\email=\uref
2694\fi
2695
2696% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2697%   `example' (@kbd uses ttsl only inside of @example and friends),
2698%   or `code' (@kbd uses normal tty font always).
2699\parseargdef\kbdinputstyle{%
2700  \def\txiarg{#1}%
2701  \ifx\txiarg\worddistinct
2702    \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2703  \else\ifx\txiarg\wordexample
2704    \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2705  \else\ifx\txiarg\wordcode
2706    \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2707  \else
2708    \errhelp = \EMsimple
2709    \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2710  \fi\fi\fi
2711}
2712\def\worddistinct{distinct}
2713\def\wordexample{example}
2714\def\wordcode{code}
2715
2716% Default is `distinct'.
2717\kbdinputstyle distinct
2718
2719% @kbd is like @code, except that if the argument is just one @key command,
2720% then @kbd has no effect.
2721\def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2722
2723\def\xkey{\key}
2724\def\kbdsub#1#2#3\par{%
2725  \def\one{#1}\def\three{#3}\def\threex{??}%
2726  \ifx\one\xkey\ifx\threex\three \key{#2}%
2727  \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2728  \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2729}
2730
2731% definition of @key that produces a lozenge.  Doesn't adjust to text size.
2732%\setfont\keyrm\rmshape{8}{1000}{OT1}
2733%\font\keysy=cmsy9
2734%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2735%  \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2736%    \vbox{\hrule\kern-0.4pt
2737%     \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2738%    \kern-0.4pt\hrule}%
2739%  \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2740
2741% definition of @key with no lozenge.  If the current font is already
2742% monospace, don't change it; that way, we respect @kbdinputstyle.  But
2743% if it isn't monospace, then use \tt.
2744%
2745\def\key#1{{\setupmarkupstyle{key}%
2746  \nohyphenation
2747  \ifmonospace\else\tt\fi
2748  #1}\null}
2749
2750% @clicksequence{File @click{} Open ...}
2751\def\clicksequence#1{\begingroup #1\endgroup}
2752
2753% @clickstyle @arrow   (by default)
2754\parseargdef\clickstyle{\def\click{#1}}
2755\def\click{\arrow}
2756
2757% Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
2758% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2759%
2760\def\dmn#1{\thinspace #1}
2761
2762% @l was never documented to mean ``switch to the Lisp font'',
2763% and it is not used as such in any manual I can find.  We need it for
2764% Polish suppressed-l.  --karl, 22sep96.
2765%\def\l#1{{\li #1}\null}
2766
2767% @acronym for "FBI", "NATO", and the like.
2768% We print this one point size smaller, since it's intended for
2769% all-uppercase.
2770%
2771\def\acronym#1{\doacronym #1,,\finish}
2772\def\doacronym#1,#2,#3\finish{%
2773  {\selectfonts\lsize #1}%
2774  \def\temp{#2}%
2775  \ifx\temp\empty \else
2776    \space ({\unsepspaces \ignorespaces \temp \unskip})%
2777  \fi
2778  \null % reset \spacefactor=1000
2779}
2780
2781% @abbr for "Comput. J." and the like.
2782% No font change, but don't do end-of-sentence spacing.
2783%
2784\def\abbr#1{\doabbr #1,,\finish}
2785\def\doabbr#1,#2,#3\finish{%
2786  {\plainfrenchspacing #1}%
2787  \def\temp{#2}%
2788  \ifx\temp\empty \else
2789    \space ({\unsepspaces \ignorespaces \temp \unskip})%
2790  \fi
2791  \null % reset \spacefactor=1000
2792}
2793
2794% @asis just yields its argument.  Used with @table, for example.
2795%
2796\def\asis#1{#1}
2797
2798% @math outputs its argument in math mode.
2799%
2800% One complication: _ usually means subscripts, but it could also mean
2801% an actual _ character, as in @math{@var{some_variable} + 1}.  So make
2802% _ active, and distinguish by seeing if the current family is \slfam,
2803% which is what @var uses.
2804{
2805  \catcode`\_ = \active
2806  \gdef\mathunderscore{%
2807    \catcode`\_=\active
2808    \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2809  }
2810}
2811% Another complication: we want \\ (and @\) to output a math (or tt) \.
2812% FYI, plain.tex uses \\ as a temporary control sequence (for no
2813% particular reason), but this is not advertised and we don't care.
2814%
2815% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2816\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2817%
2818\def\math{%
2819  \tex
2820  \mathunderscore
2821  \let\\ = \mathbackslash
2822  \mathactive
2823  % make the texinfo accent commands work in math mode
2824  \let\"=\ddot
2825  \let\'=\acute
2826  \let\==\bar
2827  \let\^=\hat
2828  \let\`=\grave
2829  \let\u=\breve
2830  \let\v=\check
2831  \let\~=\tilde
2832  \let\dotaccent=\dot
2833  $\finishmath
2834}
2835\def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
2836
2837% Some active characters (such as <) are spaced differently in math.
2838% We have to reset their definitions in case the @math was an argument
2839% to a command which sets the catcodes (such as @item or @section).
2840%
2841{
2842  \catcode`^ = \active
2843  \catcode`< = \active
2844  \catcode`> = \active
2845  \catcode`+ = \active
2846  \catcode`' = \active
2847  \gdef\mathactive{%
2848    \let^ = \ptexhat
2849    \let< = \ptexless
2850    \let> = \ptexgtr
2851    \let+ = \ptexplus
2852    \let' = \ptexquoteright
2853  }
2854}
2855
2856% ctrl is no longer a Texinfo command, but leave this definition for fun.
2857\def\ctrl #1{{\tt \rawbackslash \hat}#1}
2858
2859% @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2860% Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2861% except specified as a normal braced arg, so no newlines to worry about.
2862% 
2863\def\outfmtnametex{tex}
2864%
2865\long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2866\long\def\doinlinefmt#1,#2,\finish{%
2867  \def\inlinefmtname{#1}%
2868  \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2869}
2870% For raw, must switch into @tex before parsing the argument, to avoid
2871% setting catcodes prematurely.  Doing it this way means that, for
2872% example, @inlineraw{html, foo{bar} gets a parse error instead of being
2873% ignored.  But this isn't important because if people want a literal
2874% *right* brace they would have to use a command anyway, so they may as
2875% well use a command to get a left brace too.  We could re-use the
2876% delimiter character idea from \verb, but it seems like overkill.
2877% 
2878\long\def\inlineraw{\tex \doinlineraw}
2879\long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2880\def\doinlinerawtwo#1,#2,\finish{%
2881  \def\inlinerawname{#1}%
2882  \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2883  \endgroup % close group opened by \tex.
2884}
2885
2886
2887\message{glyphs,}
2888% and logos.
2889
2890% @@ prints an @, as does @atchar{}.
2891\def\@{\char64 }
2892\let\atchar=\@
2893
2894% @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2895% Unless we're in typewriter, use \ecfont because the CM text fonts do
2896% not have braces, and we don't want to switch into math.
2897\def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2898\def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2899\let\{=\mylbrace \let\lbracechar=\{
2900\let\}=\myrbrace \let\rbracechar=\}
2901\begingroup
2902  % Definitions to produce \{ and \} commands for indices,
2903  % and @{ and @} for the aux/toc files.
2904  \catcode`\{ = \other \catcode`\} = \other
2905  \catcode`\[ = 1 \catcode`\] = 2
2906  \catcode`\! = 0 \catcode`\\ = \other
2907  !gdef!lbracecmd[\{]%
2908  !gdef!rbracecmd[\}]%
2909  !gdef!lbraceatcmd[@{]%
2910  !gdef!rbraceatcmd[@}]%
2911!endgroup
2912
2913% @comma{} to avoid , parsing problems.
2914\let\comma = ,
2915
2916% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2917% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2918\let\, = \ptexc
2919\let\dotaccent = \ptexdot
2920\def\ringaccent#1{{\accent23 #1}}
2921\let\tieaccent = \ptext
2922\let\ubaraccent = \ptexb
2923\let\udotaccent = \d
2924
2925% Other special characters: @questiondown @exclamdown @ordf @ordm
2926% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2927\def\questiondown{?`}
2928\def\exclamdown{!`}
2929\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2930\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2931
2932% Dotless i and dotless j, used for accents.
2933\def\imacro{i}
2934\def\jmacro{j}
2935\def\dotless#1{%
2936  \def\temp{#1}%
2937  \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2938  \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2939  \else \errmessage{@dotless can be used only with i or j}%
2940  \fi\fi
2941}
2942
2943% The \TeX{} logo, as in plain, but resetting the spacing so that a
2944% period following counts as ending a sentence.  (Idea found in latex.)
2945%
2946\edef\TeX{\TeX \spacefactor=1000 }
2947
2948% @LaTeX{} logo.  Not quite the same results as the definition in
2949% latex.ltx, since we use a different font for the raised A; it's most
2950% convenient for us to use an explicitly smaller font, rather than using
2951% the \scriptstyle font (since we don't reset \scriptstyle and
2952% \scriptscriptstyle).
2953%
2954\def\LaTeX{%
2955  L\kern-.36em
2956  {\setbox0=\hbox{T}%
2957   \vbox to \ht0{\hbox{%
2958     \ifx\textnominalsize\xwordpt
2959       % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2960       % Revert to plain's \scriptsize, which is 7pt.
2961       \count255=\the\fam $\fam\count255 \scriptstyle A$%
2962     \else
2963       % For 11pt, we can use our lllsize.
2964       \selectfonts\lllsize A%
2965     \fi
2966     }%
2967     \vss
2968  }}%
2969  \kern-.15em
2970  \TeX
2971}
2972
2973% Some math mode symbols.
2974\def\bullet{$\ptexbullet$}
2975\def\geq{\ifmmode \ge\else $\ge$\fi}
2976\def\leq{\ifmmode \le\else $\le$\fi}
2977\def\minus{\ifmmode -\else $-$\fi}
2978
2979% @dots{} outputs an ellipsis using the current font.
2980% We do .5em per period so that it has the same spacing in the cm
2981% typewriter fonts as three actual period characters; on the other hand,
2982% in other typewriter fonts three periods are wider than 1.5em.  So do
2983% whichever is larger.
2984%
2985\def\dots{%
2986  \leavevmode
2987  \setbox0=\hbox{...}% get width of three periods
2988  \ifdim\wd0 > 1.5em
2989    \dimen0 = \wd0
2990  \else
2991    \dimen0 = 1.5em
2992  \fi
2993  \hbox to \dimen0{%
2994    \hskip 0pt plus.25fil
2995    .\hskip 0pt plus1fil
2996    .\hskip 0pt plus1fil
2997    .\hskip 0pt plus.5fil
2998  }%
2999}
3000
3001% @enddots{} is an end-of-sentence ellipsis.
3002%
3003\def\enddots{%
3004  \dots
3005  \spacefactor=\endofsentencespacefactor
3006}
3007
3008% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3009%
3010% Since these characters are used in examples, they should be an even number of
3011% \tt widths. Each \tt character is 1en, so two makes it 1em.
3012%
3013\def\point{$\star$}
3014\def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3015\def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3016\def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3017\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3018\def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3019
3020% The @error{} command.
3021% Adapted from the TeXbook's \boxit.
3022%
3023\newbox\errorbox
3024%
3025{\tentt \global\dimen0 = 3em}% Width of the box.
3026\dimen2 = .55pt % Thickness of rules
3027% The text. (`r' is open on the right, `e' somewhat less so on the left.)
3028\setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3029%
3030\setbox\errorbox=\hbox to \dimen0{\hfil
3031   \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3032   \advance\hsize by -2\dimen2 % Rules.
3033   \vbox{%
3034      \hrule height\dimen2
3035      \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
3036         \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3037         \kern3pt\vrule width\dimen2}% Space to right.
3038      \hrule height\dimen2}
3039    \hfil}
3040%
3041\def\error{\leavevmode\lower.7ex\copy\errorbox}
3042
3043% @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3044%
3045\def\pounds{{\it\$}}
3046
3047% @euro{} comes from a separate font, depending on the current style.
3048% We use the free feym* fonts from the eurosym package by Henrik
3049% Theiling, which support regular, slanted, bold and bold slanted (and
3050% "outlined" (blackboard board, sort of) versions, which we don't need).
3051% It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3052%
3053% Although only regular is the truly official Euro symbol, we ignore
3054% that.  The Euro is designed to be slightly taller than the regular
3055% font height.
3056%
3057% feymr - regular
3058% feymo - slanted
3059% feybr - bold
3060% feybo - bold slanted
3061%
3062% There is no good (free) typewriter version, to my knowledge.
3063% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3064% Hmm.
3065%
3066% Also doesn't work in math.  Do we need to do math with euro symbols?
3067% Hope not.
3068%
3069%
3070\def\euro{{\eurofont e}}
3071\def\eurofont{%
3072  % We set the font at each command, rather than predefining it in
3073  % \textfonts and the other font-switching commands, so that
3074  % installations which never need the symbol don't have to have the
3075  % font installed.
3076  %
3077  % There is only one designed size (nominal 10pt), so we always scale
3078  % that to the current nominal size.
3079  %
3080  % By the way, simply using "at 1em" works for cmr10 and the like, but
3081  % does not work for cmbx10 and other extended/shrunken fonts.
3082  %
3083  \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3084  %
3085  \ifx\curfontstyle\bfstylename
3086    % bold:
3087    \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3088  \else
3089    % regular:
3090    \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3091  \fi
3092  \thiseurofont
3093}
3094
3095% Glyphs from the EC fonts.  We don't use \let for the aliases, because
3096% sometimes we redefine the original macro, and the alias should reflect
3097% the redefinition.
3098%
3099% Use LaTeX names for the Icelandic letters.
3100\def\DH{{\ecfont \char"D0}} % Eth
3101\def\dh{{\ecfont \char"F0}} % eth
3102\def\TH{{\ecfont \char"DE}} % Thorn
3103\def\th{{\ecfont \char"FE}} % thorn
3104%
3105\def\guillemetleft{{\ecfont \char"13}}
3106\def\guillemotleft{\guillemetleft}
3107\def\guillemetright{{\ecfont \char"14}}
3108\def\guillemotright{\guillemetright}
3109\def\guilsinglleft{{\ecfont \char"0E}}
3110\def\guilsinglright{{\ecfont \char"0F}}
3111\def\quotedblbase{{\ecfont \char"12}}
3112\def\quotesinglbase{{\ecfont \char"0D}}
3113%
3114% This positioning is not perfect (see the ogonek LaTeX package), but
3115% we have the precomposed glyphs for the most common cases.  We put the
3116% tests to use those glyphs in the single \ogonek macro so we have fewer
3117% dummy definitions to worry about for index entries, etc.
3118%
3119% ogonek is also used with other letters in Lithuanian (IOU), but using
3120% the precomposed glyphs for those is not so easy since they aren't in
3121% the same EC font.
3122\def\ogonek#1{{%
3123  \def\temp{#1}%
3124  \ifx\temp\macrocharA\Aogonek
3125  \else\ifx\temp\macrochara\aogonek
3126  \else\ifx\temp\macrocharE\Eogonek
3127  \else\ifx\temp\macrochare\eogonek
3128  \else
3129    \ecfont \setbox0=\hbox{#1}%
3130    \ifdim\ht0=1ex\accent"0C #1%
3131    \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3132    \fi
3133  \fi\fi\fi\fi
3134  }%
3135}
3136\def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3137\def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3138\def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3139\def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3140%
3141% Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3142\def\ecfont{%
3143  % We can't distinguish serif/sans and italic/slanted, but this
3144  % is used for crude hacks anyway (like adding French and German
3145  % quotes to documents typeset with CM, where we lose kerning), so
3146  % hopefully nobody will notice/care.
3147  \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3148  \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3149  \ifmonospace
3150    % typewriter:
3151    \font\thisecfont = ectt\ecsize \space at \nominalsize
3152  \else
3153    \ifx\curfontstyle\bfstylename
3154      % bold:
3155      \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3156    \else
3157      % regular:
3158      \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3159    \fi
3160  \fi
3161  \thisecfont
3162}
3163
3164% @registeredsymbol - R in a circle.  The font for the R should really
3165% be smaller yet, but lllsize is the best we can do for now.
3166% Adapted from the plain.tex definition of \copyright.
3167%
3168\def\registeredsymbol{%
3169  $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3170               \hfil\crcr\Orb}}%
3171    }$%
3172}
3173
3174% @textdegree - the normal degrees sign.
3175%
3176\def\textdegree{$^\circ$}
3177
3178% Laurent Siebenmann reports \Orb undefined with:
3179%  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
3180% so we'll define it if necessary.
3181%
3182\ifx\Orb\thisisundefined
3183\def\Orb{\mathhexbox20D}
3184\fi
3185
3186% Quotes.
3187\chardef\quotedblleft="5C
3188\chardef\quotedblright=`\"
3189\chardef\quoteleft=`\`
3190\chardef\quoteright=`\'
3191
3192
3193\message{page headings,}
3194
3195\newskip\titlepagetopglue \titlepagetopglue = 1.5in
3196\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3197
3198% First the title page.  Must do @settitle before @titlepage.
3199\newif\ifseenauthor
3200\newif\iffinishedtitlepage
3201
3202% Do an implicit @contents or @shortcontents after @end titlepage if the
3203% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3204%
3205\newif\ifsetcontentsaftertitlepage
3206 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3207\newif\ifsetshortcontentsaftertitlepage
3208 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3209
3210\parseargdef\shorttitlepage{%
3211  \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3212  \endgroup\page\hbox{}\page}
3213
3214\envdef\titlepage{%
3215  % Open one extra group, as we want to close it in the middle of \Etitlepage.
3216  \begingroup
3217    \parindent=0pt \textfonts
3218    % Leave some space at the very top of the page.
3219    \vglue\titlepagetopglue
3220    % No rule at page bottom unless we print one at the top with @title.
3221    \finishedtitlepagetrue
3222    %
3223    % Most title ``pages'' are actually two pages long, with space
3224    % at the top of the second.  We don't want the ragged left on the second.
3225    \let\oldpage = \page
3226    \def\page{%
3227      \iffinishedtitlepage\else
3228	 \finishtitlepage
3229      \fi
3230      \let\page = \oldpage
3231      \page
3232      \null
3233    }%
3234}
3235
3236\def\Etitlepage{%
3237    \iffinishedtitlepage\else
3238	\finishtitlepage
3239    \fi
3240    % It is important to do the page break before ending the group,
3241    % because the headline and footline are only empty inside the group.
3242    % If we use the new definition of \page, we always get a blank page
3243    % after the title page, which we certainly don't want.
3244    \oldpage
3245  \endgroup
3246  %
3247  % Need this before the \...aftertitlepage checks so that if they are
3248  % in effect the toc pages will come out with page numbers.
3249  \HEADINGSon
3250  %
3251  % If they want short, they certainly want long too.
3252  \ifsetshortcontentsaftertitlepage
3253    \shortcontents
3254    \contents
3255    \global\let\shortcontents = \relax
3256    \global\let\contents = \relax
3257  \fi
3258  %
3259  \ifsetcontentsaftertitlepage
3260    \contents
3261    \global\let\contents = \relax
3262    \global\let\shortcontents = \relax
3263  \fi
3264}
3265
3266\def\finishtitlepage{%
3267  \vskip4pt \hrule height 2pt width \hsize
3268  \vskip\titlepagebottomglue
3269  \finishedtitlepagetrue
3270}
3271
3272% Settings used for typesetting titles: no hyphenation, no indentation,
3273% don't worry much about spacing, ragged right.  This should be used
3274% inside a \vbox, and fonts need to be set appropriately first.  Because
3275% it is always used for titles, nothing else, we call \rmisbold.  \par
3276% should be specified before the end of the \vbox, since a vbox is a group.
3277% 
3278\def\raggedtitlesettings{%
3279  \rmisbold
3280  \hyphenpenalty=10000
3281  \parindent=0pt
3282  \tolerance=5000
3283  \ptexraggedright
3284}
3285
3286% Macros to be used within @titlepage:
3287
3288\let\subtitlerm=\tenrm
3289\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3290
3291\parseargdef\title{%
3292  \checkenv\titlepage
3293  \vbox{\titlefonts \raggedtitlesettings #1\par}%
3294  % print a rule at the page bottom also.
3295  \finishedtitlepagefalse
3296  \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3297}
3298
3299\parseargdef\subtitle{%
3300  \checkenv\titlepage
3301  {\subtitlefont \rightline{#1}}%
3302}
3303
3304% @author should come last, but may come many times.
3305% It can also be used inside @quotation.
3306%
3307\parseargdef\author{%
3308  \def\temp{\quotation}%
3309  \ifx\thisenv\temp
3310    \def\quotationauthor{#1}% printed in \Equotation.
3311  \else
3312    \checkenv\titlepage
3313    \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3314    {\secfonts\rmisbold \leftline{#1}}%
3315  \fi
3316}
3317
3318
3319% Set up page headings and footings.
3320
3321\let\thispage=\folio
3322
3323\newtoks\evenheadline    % headline on even pages
3324\newtoks\oddheadline     % headline on odd pages
3325\newtoks\evenfootline    % footline on even pages
3326\newtoks\oddfootline     % footline on odd pages
3327
3328% Now make TeX use those variables
3329\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3330                            \else \the\evenheadline \fi}}
3331\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3332                            \else \the\evenfootline \fi}\HEADINGShook}
3333\let\HEADINGShook=\relax
3334
3335% Commands to set those variables.
3336% For example, this is what  @headings on  does
3337% @evenheading @thistitle|@thispage|@thischapter
3338% @oddheading @thischapter|@thispage|@thistitle
3339% @evenfooting @thisfile||
3340% @oddfooting ||@thisfile
3341
3342
3343\def\evenheading{\parsearg\evenheadingxxx}
3344\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3345\def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3346\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3347
3348\def\oddheading{\parsearg\oddheadingxxx}
3349\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3350\def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3351\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3352
3353\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3354
3355\def\evenfooting{\parsearg\evenfootingxxx}
3356\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3357\def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3358\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3359
3360\def\oddfooting{\parsearg\oddfootingxxx}
3361\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3362\def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3363  \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3364  %
3365  % Leave some space for the footline.  Hopefully ok to assume
3366  % @evenfooting will not be used by itself.
3367  \global\advance\pageheight by -12pt
3368  \global\advance\vsize by -12pt
3369}
3370
3371\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3372
3373% @evenheadingmarks top     \thischapter <- chapter at the top of a page
3374% @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
3375%
3376% The same set of arguments for:
3377%
3378% @oddheadingmarks
3379% @evenfootingmarks
3380% @oddfootingmarks
3381% @everyheadingmarks
3382% @everyfootingmarks
3383
3384\def\evenheadingmarks{\headingmarks{even}{heading}}
3385\def\oddheadingmarks{\headingmarks{odd}{heading}}
3386\def\evenfootingmarks{\headingmarks{even}{footing}}
3387\def\oddfootingmarks{\headingmarks{odd}{footing}}
3388\def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3389                          \headingmarks{odd}{heading}{#1} }
3390\def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3391                          \headingmarks{odd}{footing}{#1} }
3392% #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3393\def\headingmarks#1#2#3 {%
3394  \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3395  \global\expandafter\let\csname get#1#2marks\endcsname \temp
3396}
3397
3398\everyheadingmarks bottom
3399\everyfootingmarks bottom
3400
3401% @headings double      turns headings on for double-sided printing.
3402% @headings single      turns headings on for single-sided printing.
3403% @headings off         turns them off.
3404% @headings on          same as @headings double, retained for compatibility.
3405% @headings after       turns on double-sided headings after this page.
3406% @headings doubleafter turns on double-sided headings after this page.
3407% @headings singleafter turns on single-sided headings after this page.
3408% By default, they are off at the start of a document,
3409% and turned `on' after @end titlepage.
3410
3411\def\headings #1 {\csname HEADINGS#1\endcsname}
3412
3413\def\headingsoff{% non-global headings elimination
3414  \evenheadline={\hfil}\evenfootline={\hfil}%
3415   \oddheadline={\hfil}\oddfootline={\hfil}%
3416}
3417
3418\def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3419\HEADINGSoff  % it's the default
3420
3421% When we turn headings on, set the page number to 1.
3422% For double-sided printing, put current file name in lower left corner,
3423% chapter name on inside top of right hand pages, document
3424% title on inside top of left hand pages, and page numbers on outside top
3425% edge of all pages.
3426\def\HEADINGSdouble{%
3427\global\pageno=1
3428\global\evenfootline={\hfil}
3429\global\oddfootline={\hfil}
3430\global\evenheadline={\line{\folio\hfil\thistitle}}
3431\global\oddheadline={\line{\thischapter\hfil\folio}}
3432\global\let\contentsalignmacro = \chapoddpage
3433}
3434\let\contentsalignmacro = \chappager
3435
3436% For single-sided printing, chapter title goes across top left of page,
3437% page number on top right.
3438\def\HEADINGSsingle{%
3439\global\pageno=1
3440\global\evenfootline={\hfil}
3441\global\oddfootline={\hfil}
3442\global\evenheadline={\line{\thischapter\hfil\folio}}
3443\global\oddheadline={\line{\thischapter\hfil\folio}}
3444\global\let\contentsalignmacro = \chappager
3445}
3446\def\HEADINGSon{\HEADINGSdouble}
3447
3448\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3449\let\HEADINGSdoubleafter=\HEADINGSafter
3450\def\HEADINGSdoublex{%
3451\global\evenfootline={\hfil}
3452\global\oddfootline={\hfil}
3453\global\evenheadline={\line{\folio\hfil\thistitle}}
3454\global\oddheadline={\line{\thischapter\hfil\folio}}
3455\global\let\contentsalignmacro = \chapoddpage
3456}
3457
3458\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3459\def\HEADINGSsinglex{%
3460\global\evenfootline={\hfil}
3461\global\oddfootline={\hfil}
3462\global\evenheadline={\line{\thischapter\hfil\folio}}
3463\global\oddheadline={\line{\thischapter\hfil\folio}}
3464\global\let\contentsalignmacro = \chappager
3465}
3466
3467% Subroutines used in generating headings
3468% This produces Day Month Year style of output.
3469% Only define if not already defined, in case a txi-??.tex file has set
3470% up a different format (e.g., txi-cs.tex does this).
3471\ifx\today\thisisundefined
3472\def\today{%
3473  \number\day\space
3474  \ifcase\month
3475  \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3476  \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3477  \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3478  \fi
3479  \space\number\year}
3480\fi
3481
3482% @settitle line...  specifies the title of the document, for headings.
3483% It generates no output of its own.
3484\def\thistitle{\putwordNoTitle}
3485\def\settitle{\parsearg{\gdef\thistitle}}
3486
3487
3488\message{tables,}
3489% Tables -- @table, @ftable, @vtable, @item(x).
3490
3491% default indentation of table text
3492\newdimen\tableindent \tableindent=.8in
3493% default indentation of @itemize and @enumerate text
3494\newdimen\itemindent  \itemindent=.3in
3495% margin between end of table item and start of table text.
3496\newdimen\itemmargin  \itemmargin=.1in
3497
3498% used internally for \itemindent minus \itemmargin
3499\newdimen\itemmax
3500
3501% Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3502% these defs.
3503% They also define \itemindex
3504% to index the item name in whatever manner is desired (perhaps none).
3505
3506\newif\ifitemxneedsnegativevskip
3507
3508\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3509
3510\def\internalBitem{\smallbreak \parsearg\itemzzz}
3511\def\internalBitemx{\itemxpar \parsearg\itemzzz}
3512
3513\def\itemzzz #1{\begingroup %
3514  \advance\hsize by -\rightskip
3515  \advance\hsize by -\tableindent
3516  \setbox0=\hbox{\itemindicate{#1}}%
3517  \itemindex{#1}%
3518  \nobreak % This prevents a break before @itemx.
3519  %
3520  % If the item text does not fit in the space we have, put it on a line
3521  % by itself, and do not allow a page break either before or after that
3522  % line.  We do not start a paragraph here because then if the next
3523  % command is, e.g., @kindex, the whatsit would get put into the
3524  % horizontal list on a line by itself, resulting in extra blank space.
3525  \ifdim \wd0>\itemmax
3526    %
3527    % Make this a paragraph so we get the \parskip glue and wrapping,
3528    % but leave it ragged-right.
3529    \begingroup
3530      \advance\leftskip by-\tableindent
3531      \advance\hsize by\tableindent
3532      \advance\rightskip by0pt plus1fil\relax
3533      \leavevmode\unhbox0\par
3534    \endgroup
3535    %
3536    % We're going to be starting a paragraph, but we don't want the
3537    % \parskip glue -- logically it's part of the @item we just started.
3538    \nobreak \vskip-\parskip
3539    %
3540    % Stop a page break at the \parskip glue coming up.  However, if
3541    % what follows is an environment such as @example, there will be no
3542    % \parskip glue; then the negative vskip we just inserted would
3543    % cause the example and the item to crash together.  So we use this
3544    % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3545    % \parskip glue after all.  Section titles are handled this way also.
3546    %
3547    \penalty 10001
3548    \endgroup
3549    \itemxneedsnegativevskipfalse
3550  \else
3551    % The item text fits into the space.  Start a paragraph, so that the
3552    % following text (if any) will end up on the same line.
3553    \noindent
3554    % Do this with kerns and \unhbox so that if there is a footnote in
3555    % the item text, it can migrate to the main vertical list and
3556    % eventually be printed.
3557    \nobreak\kern-\tableindent
3558    \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3559    \unhbox0
3560    \nobreak\kern\dimen0
3561    \endgroup
3562    \itemxneedsnegativevskiptrue
3563  \fi
3564}
3565
3566\def\item{\errmessage{@item while not in a list environment}}
3567\def\itemx{\errmessage{@itemx while not in a list environment}}
3568
3569% @table, @ftable, @vtable.
3570\envdef\table{%
3571  \let\itemindex\gobble
3572  \tablecheck{table}%
3573}
3574\envdef\ftable{%
3575  \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3576  \tablecheck{ftable}%
3577}
3578\envdef\vtable{%
3579  \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3580  \tablecheck{vtable}%
3581}
3582\def\tablecheck#1{%
3583  \ifnum \the\catcode`\^^M=\active
3584    \endgroup
3585    \errmessage{This command won't work in this context; perhaps the problem is
3586      that we are \inenvironment\thisenv}%
3587    \def\next{\doignore{#1}}%
3588  \else
3589    \let\next\tablex
3590  \fi
3591  \next
3592}
3593\def\tablex#1{%
3594  \def\itemindicate{#1}%
3595  \parsearg\tabley
3596}
3597\def\tabley#1{%
3598  {%
3599    \makevalueexpandable
3600    \edef\temp{\noexpand\tablez #1\space\space\space}%
3601    \expandafter
3602  }\temp \endtablez
3603}
3604\def\tablez #1 #2 #3 #4\endtablez{%
3605  \aboveenvbreak
3606  \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3607  \ifnum 0#2>0 \tableindent=#2\mil \fi
3608  \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3609  \itemmax=\tableindent
3610  \advance \itemmax by -\itemmargin
3611  \advance \leftskip by \tableindent
3612  \exdentamount=\tableindent
3613  \parindent = 0pt
3614  \parskip = \smallskipamount
3615  \ifdim \parskip=0pt \parskip=2pt \fi
3616  \let\item = \internalBitem
3617  \let\itemx = \internalBitemx
3618}
3619\def\Etable{\endgraf\afterenvbreak}
3620\let\Eftable\Etable
3621\let\Evtable\Etable
3622\let\Eitemize\Etable
3623\let\Eenumerate\Etable
3624
3625% This is the counter used by @enumerate, which is really @itemize
3626
3627\newcount \itemno
3628
3629\envdef\itemize{\parsearg\doitemize}
3630
3631\def\doitemize#1{%
3632  \aboveenvbreak
3633  \itemmax=\itemindent
3634  \advance\itemmax by -\itemmargin
3635  \advance\leftskip by \itemindent
3636  \exdentamount=\itemindent
3637  \parindent=0pt
3638  \parskip=\smallskipamount
3639  \ifdim\parskip=0pt \parskip=2pt \fi
3640  %
3641  % Try typesetting the item mark that if the document erroneously says
3642  % something like @itemize @samp (intending @table), there's an error
3643  % right away at the @itemize.  It's not the best error message in the
3644  % world, but it's better than leaving it to the @item.  This means if
3645  % the user wants an empty mark, they have to say @w{} not just @w.
3646  \def\itemcontents{#1}%
3647  \setbox0 = \hbox{\itemcontents}%
3648  %
3649  % @itemize with no arg is equivalent to @itemize @bullet.
3650  \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3651  %
3652  \let\item=\itemizeitem
3653}
3654
3655% Definition of @item while inside @itemize and @enumerate.
3656%
3657\def\itemizeitem{%
3658  \advance\itemno by 1  % for enumerations
3659  {\let\par=\endgraf \smallbreak}% reasonable place to break
3660  {%
3661   % If the document has an @itemize directly after a section title, a
3662   % \nobreak will be last on the list, and \sectionheading will have
3663   % done a \vskip-\parskip.  In that case, we don't want to zero
3664   % parskip, or the item text will crash with the heading.  On the
3665   % other hand, when there is normal text preceding the item (as there
3666   % usually is), we do want to zero parskip, or there would be too much
3667   % space.  In that case, we won't have a \nobreak before.  At least
3668   % that's the theory.
3669   \ifnum\lastpenalty<10000 \parskip=0in \fi
3670   \noindent
3671   \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3672   %
3673   \vadjust{\penalty 1200}}% not good to break after first line of item.
3674  \flushcr
3675}
3676
3677% \splitoff TOKENS\endmark defines \first to be the first token in
3678% TOKENS, and \rest to be the remainder.
3679%
3680\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3681
3682% Allow an optional argument of an uppercase letter, lowercase letter,
3683% or number, to specify the first label in the enumerated list.  No
3684% argument is the same as `1'.
3685%
3686\envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
3687\def\enumeratey #1 #2\endenumeratey{%
3688  % If we were given no argument, pretend we were given `1'.
3689  \def\thearg{#1}%
3690  \ifx\thearg\empty \def\thearg{1}\fi
3691  %
3692  % Detect if the argument is a single token.  If so, it might be a
3693  % letter.  Otherwise, the only valid thing it can be is a number.
3694  % (We will always have one token, because of the test we just made.
3695  % This is a good thing, since \splitoff doesn't work given nothing at
3696  % all -- the first parameter is undelimited.)
3697  \expandafter\splitoff\thearg\endmark
3698  \ifx\rest\empty
3699    % Only one token in the argument.  It could still be anything.
3700    % A ``lowercase letter'' is one whose \lccode is nonzero.
3701    % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3702    %   not equal to itself.
3703    % Otherwise, we assume it's a number.
3704    %
3705    % We need the \relax at the end of the \ifnum lines to stop TeX from
3706    % continuing to look for a <number>.
3707    %
3708    \ifnum\lccode\expandafter`\thearg=0\relax
3709      \numericenumerate % a number (we hope)
3710    \else
3711      % It's a letter.
3712      \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3713        \lowercaseenumerate % lowercase letter
3714      \else
3715        \uppercaseenumerate % uppercase letter
3716      \fi
3717    \fi
3718  \else
3719    % Multiple tokens in the argument.  We hope it's a number.
3720    \numericenumerate
3721  \fi
3722}
3723
3724% An @enumerate whose labels are integers.  The starting integer is
3725% given in \thearg.
3726%
3727\def\numericenumerate{%
3728  \itemno = \thearg
3729  \startenumeration{\the\itemno}%
3730}
3731
3732% The starting (lowercase) letter is in \thearg.
3733\def\lowercaseenumerate{%
3734  \itemno = \expandafter`\thearg
3735  \startenumeration{%
3736    % Be sure we're not beyond the end of the alphabet.
3737    \ifnum\itemno=0
3738      \errmessage{No more lowercase letters in @enumerate; get a bigger
3739                  alphabet}%
3740    \fi
3741    \char\lccode\itemno
3742  }%
3743}
3744
3745% The starting (uppercase) letter is in \thearg.
3746\def\uppercaseenumerate{%
3747  \itemno = \expandafter`\thearg
3748  \startenumeration{%
3749    % Be sure we're not beyond the end of the alphabet.
3750    \ifnum\itemno=0
3751      \errmessage{No more uppercase letters in @enumerate; get a bigger
3752                  alphabet}
3753    \fi
3754    \char\uccode\itemno
3755  }%
3756}
3757
3758% Call \doitemize, adding a period to the first argument and supplying the
3759% common last two arguments.  Also subtract one from the initial value in
3760% \itemno, since @item increments \itemno.
3761%
3762\def\startenumeration#1{%
3763  \advance\itemno by -1
3764  \doitemize{#1.}\flushcr
3765}
3766
3767% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3768% to @enumerate.
3769%
3770\def\alphaenumerate{\enumerate{a}}
3771\def\capsenumerate{\enumerate{A}}
3772\def\Ealphaenumerate{\Eenumerate}
3773\def\Ecapsenumerate{\Eenumerate}
3774
3775
3776% @multitable macros
3777% Amy Hendrickson, 8/18/94, 3/6/96
3778%
3779% @multitable ... @end multitable will make as many columns as desired.
3780% Contents of each column will wrap at width given in preamble.  Width
3781% can be specified either with sample text given in a template line,
3782% or in percent of \hsize, the current width of text on page.
3783
3784% Table can continue over pages but will only break between lines.
3785
3786% To make preamble:
3787%
3788% Either define widths of columns in terms of percent of \hsize:
3789%   @multitable @columnfractions .25 .3 .45
3790%   @item ...
3791%
3792%   Numbers following @columnfractions are the percent of the total
3793%   current hsize to be used for each column. You may use as many
3794%   columns as desired.
3795
3796
3797% Or use a template:
3798%   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3799%   @item ...
3800%   using the widest term desired in each column.
3801
3802% Each new table line starts with @item, each subsequent new column
3803% starts with @tab. Empty columns may be produced by supplying @tab's
3804% with nothing between them for as many times as empty columns are needed,
3805% ie, @tab@tab@tab will produce two empty columns.
3806
3807% @item, @tab do not need to be on their own lines, but it will not hurt
3808% if they are.
3809
3810% Sample multitable:
3811
3812%   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3813%   @item first col stuff @tab second col stuff @tab third col
3814%   @item
3815%   first col stuff
3816%   @tab
3817%   second col stuff
3818%   @tab
3819%   third col
3820%   @item first col stuff @tab second col stuff
3821%   @tab Many paragraphs of text may be used in any column.
3822%
3823%         They will wrap at the width determined by the template.
3824%   @item@tab@tab This will be in third column.
3825%   @end multitable
3826
3827% Default dimensions may be reset by user.
3828% @multitableparskip is vertical space between paragraphs in table.
3829% @multitableparindent is paragraph indent in table.
3830% @multitablecolmargin is horizontal space to be left between columns.
3831% @multitablelinespace is space to leave between table items, baseline
3832%                                                            to baseline.
3833%   0pt means it depends on current normal line spacing.
3834%
3835\newskip\multitableparskip
3836\newskip\multitableparindent
3837\newdimen\multitablecolspace
3838\newskip\multitablelinespace
3839\multitableparskip=0pt
3840\multitableparindent=6pt
3841\multitablecolspace=12pt
3842\multitablelinespace=0pt
3843
3844% Macros used to set up halign preamble:
3845%
3846\let\endsetuptable\relax
3847\def\xendsetuptable{\endsetuptable}
3848\let\columnfractions\relax
3849\def\xcolumnfractions{\columnfractions}
3850\newif\ifsetpercent
3851
3852% #1 is the @columnfraction, usually a decimal number like .5, but might
3853% be just 1.  We just use it, whatever it is.
3854%
3855\def\pickupwholefraction#1 {%
3856  \global\advance\colcount by 1
3857  \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3858  \setuptable
3859}
3860
3861\newcount\colcount
3862\def\setuptable#1{%
3863  \def\firstarg{#1}%
3864  \ifx\firstarg\xendsetuptable
3865    \let\go = \relax
3866  \else
3867    \ifx\firstarg\xcolumnfractions
3868      \global\setpercenttrue
3869    \else
3870      \ifsetpercent
3871         \let\go\pickupwholefraction
3872      \else
3873         \global\advance\colcount by 1
3874         \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3875                   % separator; typically that is always in the input, anyway.
3876         \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3877      \fi
3878    \fi
3879    \ifx\go\pickupwholefraction
3880      % Put the argument back for the \pickupwholefraction call, so
3881      % we'll always have a period there to be parsed.
3882      \def\go{\pickupwholefraction#1}%
3883    \else
3884      \let\go = \setuptable
3885    \fi%
3886  \fi
3887  \go
3888}
3889
3890% multitable-only commands.
3891%
3892% @headitem starts a heading row, which we typeset in bold.
3893% Assignments have to be global since we are inside the implicit group
3894% of an alignment entry.  \everycr resets \everytab so we don't have to
3895% undo it ourselves.
3896\def\headitemfont{\b}% for people to use in the template row; not changeable
3897\def\headitem{%
3898  \checkenv\multitable
3899  \crcr
3900  \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3901  \the\everytab % for the first item
3902}%
3903%
3904% A \tab used to include \hskip1sp.  But then the space in a template
3905% line is not enough.  That is bad.  So let's go back to just `&' until
3906% we again encounter the problem the 1sp was intended to solve.
3907%					--karl, nathan@acm.org, 20apr99.
3908\def\tab{\checkenv\multitable &\the\everytab}%
3909
3910% @multitable ... @end multitable definitions:
3911%
3912\newtoks\everytab  % insert after every tab.
3913%
3914\envdef\multitable{%
3915  \vskip\parskip
3916  \startsavinginserts
3917  %
3918  % @item within a multitable starts a normal row.
3919  % We use \def instead of \let so that if one of the multitable entries
3920  % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3921  % \endtemplate) expanding \doitemize.
3922  \def\item{\crcr}%
3923  %
3924  \tolerance=9500
3925  \hbadness=9500
3926  \setmultitablespacing
3927  \parskip=\multitableparskip
3928  \parindent=\multitableparindent
3929  \overfullrule=0pt
3930  \global\colcount=0
3931  %
3932  \everycr = {%
3933    \noalign{%
3934      \global\everytab={}%
3935      \global\colcount=0 % Reset the column counter.
3936      % Check for saved footnotes, etc.
3937      \checkinserts
3938      % Keeps underfull box messages off when table breaks over pages.
3939      %\filbreak
3940	% Maybe so, but it also creates really weird page breaks when the
3941	% table breaks over pages. Wouldn't \vfil be better?  Wait until the
3942	% problem manifests itself, so it can be fixed for real --karl.
3943    }%
3944  }%
3945  %
3946  \parsearg\domultitable
3947}
3948\def\domultitable#1{%
3949  % To parse everything between @multitable and @item:
3950  \setuptable#1 \endsetuptable
3951  %
3952  % This preamble sets up a generic column definition, which will
3953  % be used as many times as user calls for columns.
3954  % \vtop will set a single line and will also let text wrap and
3955  % continue for many paragraphs if desired.
3956  \halign\bgroup &%
3957    \global\advance\colcount by 1
3958    \multistrut
3959    \vtop{%
3960      % Use the current \colcount to find the correct column width:
3961      \hsize=\expandafter\csname col\the\colcount\endcsname
3962      %
3963      % In order to keep entries from bumping into each other
3964      % we will add a \leftskip of \multitablecolspace to all columns after
3965      % the first one.
3966      %
3967      % If a template has been used, we will add \multitablecolspace
3968      % to the width of each template entry.
3969      %
3970      % If the user has set preamble in terms of percent of \hsize we will
3971      % use that dimension as the width of the column, and the \leftskip
3972      % will keep entries from bumping into each other.  Table will start at
3973      % left margin and final column will justify at right margin.
3974      %
3975      % Make sure we don't inherit \rightskip from the outer environment.
3976      \rightskip=0pt
3977      \ifnum\colcount=1
3978	% The first column will be indented with the surrounding text.
3979	\advance\hsize by\leftskip
3980      \else
3981	\ifsetpercent \else
3982	  % If user has not set preamble in terms of percent of \hsize
3983	  % we will advance \hsize by \multitablecolspace.
3984	  \advance\hsize by \multitablecolspace
3985	\fi
3986       % In either case we will make \leftskip=\multitablecolspace:
3987      \leftskip=\multitablecolspace
3988      \fi
3989      % Ignoring space at the beginning and end avoids an occasional spurious
3990      % blank line, when TeX decides to break the line at the space before the
3991      % box from the multistrut, so the strut ends up on a line by itself.
3992      % For example:
3993      % @multitable @columnfractions .11 .89
3994      % @item @code{#}
3995      % @tab Legal holiday which is valid in major parts of the whole country.
3996      % Is automatically provided with highlighting sequences respectively
3997      % marking characters.
3998      \noindent\ignorespaces##\unskip\multistrut
3999    }\cr
4000}
4001\def\Emultitable{%
4002  \crcr
4003  \egroup % end the \halign
4004  \global\setpercentfalse
4005}
4006
4007\def\setmultitablespacing{%
4008  \def\multistrut{\strut}% just use the standard line spacing
4009  %
4010  % Compute \multitablelinespace (if not defined by user) for use in
4011  % \multitableparskip calculation.  We used define \multistrut based on
4012  % this, but (ironically) that caused the spacing to be off.
4013  % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4014\ifdim\multitablelinespace=0pt
4015\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4016\global\advance\multitablelinespace by-\ht0
4017\fi
4018% Test to see if parskip is larger than space between lines of
4019% table. If not, do nothing.
4020%        If so, set to same dimension as multitablelinespace.
4021\ifdim\multitableparskip>\multitablelinespace
4022\global\multitableparskip=\multitablelinespace
4023\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4024                                      % than skip between lines in the table.
4025\fi%
4026\ifdim\multitableparskip=0pt
4027\global\multitableparskip=\multitablelinespace
4028\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4029                                      % than skip between lines in the table.
4030\fi}
4031
4032
4033\message{conditionals,}
4034
4035% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4036% @ifnotxml always succeed.  They currently do nothing; we don't
4037% attempt to check whether the conditionals are properly nested.  But we
4038% have to remember that they are conditionals, so that @end doesn't
4039% attempt to close an environment group.
4040%
4041\def\makecond#1{%
4042  \expandafter\let\csname #1\endcsname = \relax
4043  \expandafter\let\csname iscond.#1\endcsname = 1
4044}
4045\makecond{iftex}
4046\makecond{ifnotdocbook}
4047\makecond{ifnothtml}
4048\makecond{ifnotinfo}
4049\makecond{ifnotplaintext}
4050\makecond{ifnotxml}
4051
4052% Ignore @ignore, @ifhtml, @ifinfo, and the like.
4053%
4054\def\direntry{\doignore{direntry}}
4055\def\documentdescription{\doignore{documentdescription}}
4056\def\docbook{\doignore{docbook}}
4057\def\html{\doignore{html}}
4058\def\ifdocbook{\doignore{ifdocbook}}
4059\def\ifhtml{\doignore{ifhtml}}
4060\def\ifinfo{\doignore{ifinfo}}
4061\def\ifnottex{\doignore{ifnottex}}
4062\def\ifplaintext{\doignore{ifplaintext}}
4063\def\ifxml{\doignore{ifxml}}
4064\def\ignore{\doignore{ignore}}
4065\def\menu{\doignore{menu}}
4066\def\xml{\doignore{xml}}
4067
4068% Ignore text until a line `@end #1', keeping track of nested conditionals.
4069%
4070% A count to remember the depth of nesting.
4071\newcount\doignorecount
4072
4073\def\doignore#1{\begingroup
4074  % Scan in ``verbatim'' mode:
4075  \obeylines
4076  \catcode`\@ = \other
4077  \catcode`\{ = \other
4078  \catcode`\} = \other
4079  %
4080  % Make sure that spaces turn into tokens that match what \doignoretext wants.
4081  \spaceisspace
4082  %
4083  % Count number of #1's that we've seen.
4084  \doignorecount = 0
4085  %
4086  % Swallow text until we reach the matching `@end #1'.
4087  \dodoignore{#1}%
4088}
4089
4090{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4091  \obeylines %
4092  %
4093  \gdef\dodoignore#1{%
4094    % #1 contains the command name as a string, e.g., `ifinfo'.
4095    %
4096    % Define a command to find the next `@end #1'.
4097    \long\def\doignoretext##1^^M@end #1{%
4098      \doignoretextyyy##1^^M@#1\_STOP_}%
4099    %
4100    % And this command to find another #1 command, at the beginning of a
4101    % line.  (Otherwise, we would consider a line `@c @ifset', for
4102    % example, to count as an @ifset for nesting.)
4103    \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4104    %
4105    % And now expand that command.
4106    \doignoretext ^^M%
4107  }%
4108}
4109
4110\def\doignoreyyy#1{%
4111  \def\temp{#1}%
4112  \ifx\temp\empty			% Nothing found.
4113    \let\next\doignoretextzzz
4114  \else					% Found a nested condition, ...
4115    \advance\doignorecount by 1
4116    \let\next\doignoretextyyy		% ..., look for another.
4117    % If we're here, #1 ends with ^^M\ifinfo (for example).
4118  \fi
4119  \next #1% the token \_STOP_ is present just after this macro.
4120}
4121
4122% We have to swallow the remaining "\_STOP_".
4123%
4124\def\doignoretextzzz#1{%
4125  \ifnum\doignorecount = 0	% We have just found the outermost @end.
4126    \let\next\enddoignore
4127  \else				% Still inside a nested condition.
4128    \advance\doignorecount by -1
4129    \let\next\doignoretext      % Look for the next @end.
4130  \fi
4131  \next
4132}
4133
4134% Finish off ignored text.
4135{ \obeylines%
4136  % Ignore anything after the last `@end #1'; this matters in verbatim
4137  % environments, where otherwise the newline after an ignored conditional
4138  % would result in a blank line in the output.
4139  \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4140}
4141
4142
4143% @set VAR sets the variable VAR to an empty value.
4144% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4145%
4146% Since we want to separate VAR from REST-OF-LINE (which might be
4147% empty), we can't just use \parsearg; we have to insert a space of our
4148% own to delimit the rest of the line, and then take it out again if we
4149% didn't need it.
4150% We rely on the fact that \parsearg sets \catcode`\ =10.
4151%
4152\parseargdef\set{\setyyy#1 \endsetyyy}
4153\def\setyyy#1 #2\endsetyyy{%
4154  {%
4155    \makevalueexpandable
4156    \def\temp{#2}%
4157    \edef\next{\gdef\makecsname{SET#1}}%
4158    \ifx\temp\empty
4159      \next{}%
4160    \else
4161      \setzzz#2\endsetzzz
4162    \fi
4163  }%
4164}
4165% Remove the trailing space \setxxx inserted.
4166\def\setzzz#1 \endsetzzz{\next{#1}}
4167
4168% @clear VAR clears (i.e., unsets) the variable VAR.
4169%
4170\parseargdef\clear{%
4171  {%
4172    \makevalueexpandable
4173    \global\expandafter\let\csname SET#1\endcsname=\relax
4174  }%
4175}
4176
4177% @value{foo} gets the text saved in variable foo.
4178\def\value{\begingroup\makevalueexpandable\valuexxx}
4179\def\valuexxx#1{\expandablevalue{#1}\endgroup}
4180{
4181  \catcode`\- = \active \catcode`\_ = \active
4182  %
4183  \gdef\makevalueexpandable{%
4184    \let\value = \expandablevalue
4185    % We don't want these characters active, ...
4186    \catcode`\-=\other \catcode`\_=\other
4187    % ..., but we might end up with active ones in the argument if
4188    % we're called from @code, as @code{@value{foo-bar_}}, though.
4189    % So \let them to their normal equivalents.
4190    \let-\realdash \let_\normalunderscore
4191  }
4192}
4193
4194% We have this subroutine so that we can handle at least some @value's
4195% properly in indexes (we call \makevalueexpandable in \indexdummies).
4196% The command has to be fully expandable (if the variable is set), since
4197% the result winds up in the index file.  This means that if the
4198% variable's value contains other Texinfo commands, it's almost certain
4199% it will fail (although perhaps we could fix that with sufficient work
4200% to do a one-level expansion on the result, instead of complete).
4201%
4202\def\expandablevalue#1{%
4203  \expandafter\ifx\csname SET#1\endcsname\relax
4204    {[No value for ``#1'']}%
4205    \message{Variable `#1', used in @value, is not set.}%
4206  \else
4207    \csname SET#1\endcsname
4208  \fi
4209}
4210
4211% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4212% with @set.
4213%
4214% To get special treatment of `@end ifset,' call \makeond and the redefine.
4215%
4216\makecond{ifset}
4217\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4218\def\doifset#1#2{%
4219  {%
4220    \makevalueexpandable
4221    \let\next=\empty
4222    \expandafter\ifx\csname SET#2\endcsname\relax
4223      #1% If not set, redefine \next.
4224    \fi
4225    \expandafter
4226  }\next
4227}
4228\def\ifsetfail{\doignore{ifset}}
4229
4230% @ifclear VAR ... @end executes the `...' iff VAR has never been
4231% defined with @set, or has been undefined with @clear.
4232%
4233% The `\else' inside the `\doifset' parameter is a trick to reuse the
4234% above code: if the variable is not set, do nothing, if it is set,
4235% then redefine \next to \ifclearfail.
4236%
4237\makecond{ifclear}
4238\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4239\def\ifclearfail{\doignore{ifclear}}
4240
4241% @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4242% without the @) is in fact defined.  We can only feasibly check at the
4243% TeX level, so something like `mathcode' is going to considered
4244% defined even though it is not a Texinfo command.
4245% 
4246\makecond{ifcommanddefined}
4247\def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4248%
4249\def\doifcmddefined#1#2{{%
4250    \makevalueexpandable
4251    \let\next=\empty
4252    \expandafter\ifx\csname #2\endcsname\relax
4253      #1% If not defined, \let\next as above.
4254    \fi
4255    \expandafter
4256  }\next
4257}
4258\def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4259
4260% @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4261\makecond{ifcommandnotdefined}
4262\def\ifcommandnotdefined{%
4263  \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4264\def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4265
4266% Set the `txicommandconditionals' variable, so documents have a way to
4267% test if the @ifcommand...defined conditionals are available.
4268\set txicommandconditionals
4269
4270% @dircategory CATEGORY  -- specify a category of the dir file
4271% which this file should belong to.  Ignore this in TeX.
4272\let\dircategory=\comment
4273
4274% @defininfoenclose.
4275\let\definfoenclose=\comment
4276
4277
4278\message{indexing,}
4279% Index generation facilities
4280
4281% Define \newwrite to be identical to plain tex's \newwrite
4282% except not \outer, so it can be used within macros and \if's.
4283\edef\newwrite{\makecsname{ptexnewwrite}}
4284
4285% \newindex {foo} defines an index named foo.
4286% It automatically defines \fooindex such that
4287% \fooindex ...rest of line... puts an entry in the index foo.
4288% It also defines \fooindfile to be the number of the output channel for
4289% the file that accumulates this index.  The file's extension is foo.
4290% The name of an index should be no more than 2 characters long
4291% for the sake of vms.
4292%
4293\def\newindex#1{%
4294  \iflinks
4295    \expandafter\newwrite \csname#1indfile\endcsname
4296    \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4297  \fi
4298  \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
4299    \noexpand\doindex{#1}}
4300}
4301
4302% @defindex foo  ==  \newindex{foo}
4303%
4304\def\defindex{\parsearg\newindex}
4305
4306% Define @defcodeindex, like @defindex except put all entries in @code.
4307%
4308\def\defcodeindex{\parsearg\newcodeindex}
4309%
4310\def\newcodeindex#1{%
4311  \iflinks
4312    \expandafter\newwrite \csname#1indfile\endcsname
4313    \openout \csname#1indfile\endcsname \jobname.#1
4314  \fi
4315  \expandafter\xdef\csname#1index\endcsname{%
4316    \noexpand\docodeindex{#1}}%
4317}
4318
4319
4320% @synindex foo bar    makes index foo feed into index bar.
4321% Do this instead of @defindex foo if you don't want it as a separate index.
4322%
4323% @syncodeindex foo bar   similar, but put all entries made for index foo
4324% inside @code.
4325%
4326\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4327\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4328
4329% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4330% #3 the target index (bar).
4331\def\dosynindex#1#2#3{%
4332  % Only do \closeout if we haven't already done it, else we'll end up
4333  % closing the target index.
4334  \expandafter \ifx\csname donesynindex#2\endcsname \relax
4335    % The \closeout helps reduce unnecessary open files; the limit on the
4336    % Acorn RISC OS is a mere 16 files.
4337    \expandafter\closeout\csname#2indfile\endcsname
4338    \expandafter\let\csname donesynindex#2\endcsname = 1
4339  \fi
4340  % redefine \fooindfile:
4341  \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4342  \expandafter\let\csname#2indfile\endcsname=\temp
4343  % redefine \fooindex:
4344  \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4345}
4346
4347% Define \doindex, the driver for all \fooindex macros.
4348% Argument #1 is generated by the calling \fooindex macro,
4349%  and it is "foo", the name of the index.
4350
4351% \doindex just uses \parsearg; it calls \doind for the actual work.
4352% This is because \doind is more useful to call from other macros.
4353
4354% There is also \dosubind {index}{topic}{subtopic}
4355% which makes an entry in a two-level index such as the operation index.
4356
4357\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4358\def\singleindexer #1{\doind{\indexname}{#1}}
4359
4360% like the previous two, but they put @code around the argument.
4361\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4362\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4363
4364% Take care of Texinfo commands that can appear in an index entry.
4365% Since there are some commands we want to expand, and others we don't,
4366% we have to laboriously prevent expansion for those that we don't.
4367%
4368\def\indexdummies{%
4369  \escapechar = `\\     % use backslash in output files.
4370  \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4371  \def\ {\realbackslash\space }%
4372  %
4373  % Need these unexpandable (because we define \tt as a dummy)
4374  % definitions when @{ or @} appear in index entry text.  Also, more
4375  % complicated, when \tex is in effect and \{ is a \delimiter again.
4376  % We can't use \lbracecmd and \rbracecmd because texindex assumes
4377  % braces and backslashes are used only as delimiters.  Perhaps we
4378  % should define @lbrace and @rbrace commands a la @comma.
4379  \def\{{{\tt\char123}}%
4380  \def\}{{\tt\char125}}%
4381  %
4382  % I don't entirely understand this, but when an index entry is
4383  % generated from a macro call, the \endinput which \scanmacro inserts
4384  % causes processing to be prematurely terminated.  This is,
4385  % apparently, because \indexsorttmp is fully expanded, and \endinput
4386  % is an expandable command.  The redefinition below makes \endinput
4387  % disappear altogether for that purpose -- although logging shows that
4388  % processing continues to some further point.  On the other hand, it
4389  % seems \endinput does not hurt in the printed index arg, since that
4390  % is still getting written without apparent harm.
4391  %
4392  % Sample source (mac-idx3.tex, reported by Graham Percival to
4393  % help-texinfo, 22may06):
4394  % @macro funindex {WORD}
4395  % @findex xyz
4396  % @end macro
4397  % ...
4398  % @funindex commtest
4399  %
4400  % The above is not enough to reproduce the bug, but it gives the flavor.
4401  %
4402  % Sample whatsit resulting:
4403  % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4404  %
4405  % So:
4406  \let\endinput = \empty
4407  %
4408  % Do the redefinitions.
4409  \commondummies
4410}
4411
4412% For the aux and toc files, @ is the escape character.  So we want to
4413% redefine everything using @ as the escape character (instead of
4414% \realbackslash, still used for index files).  When everything uses @,
4415% this will be simpler.
4416%
4417\def\atdummies{%
4418  \def\@{@@}%
4419  \def\ {@ }%
4420  \let\{ = \lbraceatcmd
4421  \let\} = \rbraceatcmd
4422  %
4423  % Do the redefinitions.
4424  \commondummies
4425  \otherbackslash
4426}
4427
4428% Called from \indexdummies and \atdummies.
4429%
4430\def\commondummies{%
4431  %
4432  % \definedummyword defines \#1 as \string\#1\space, thus effectively
4433  % preventing its expansion.  This is used only for control words,
4434  % not control letters, because the \space would be incorrect for
4435  % control characters, but is needed to separate the control word
4436  % from whatever follows.
4437  %
4438  % For control letters, we have \definedummyletter, which omits the
4439  % space.
4440  %
4441  % These can be used both for control words that take an argument and
4442  % those that do not.  If it is followed by {arg} in the input, then
4443  % that will dutifully get written to the index (or wherever).
4444  %
4445  \def\definedummyword  ##1{\def##1{\string##1\space}}%
4446  \def\definedummyletter##1{\def##1{\string##1}}%
4447  \let\definedummyaccent\definedummyletter
4448  %
4449  \commondummiesnofonts
4450  %
4451  \definedummyletter\_%
4452  \definedummyletter\-%
4453  %
4454  % Non-English letters.
4455  \definedummyword\AA
4456  \definedummyword\AE
4457  \definedummyword\DH
4458  \definedummyword\L
4459  \definedummyword\O
4460  \definedummyword\OE
4461  \definedummyword\TH
4462  \definedummyword\aa
4463  \definedummyword\ae
4464  \definedummyword\dh
4465  \definedummyword\exclamdown
4466  \definedummyword\l
4467  \definedummyword\o
4468  \definedummyword\oe
4469  \definedummyword\ordf
4470  \definedummyword\ordm
4471  \definedummyword\questiondown
4472  \definedummyword\ss
4473  \definedummyword\th
4474  %
4475  % Although these internal commands shouldn't show up, sometimes they do.
4476  \definedummyword\bf
4477  \definedummyword\gtr
4478  \definedummyword\hat
4479  \definedummyword\less
4480  \definedummyword\sf
4481  \definedummyword\sl
4482  \definedummyword\tclose
4483  \definedummyword\tt
4484  %
4485  \definedummyword\LaTeX
4486  \definedummyword\TeX
4487  %
4488  % Assorted special characters.
4489  \definedummyword\arrow
4490  \definedummyword\bullet
4491  \definedummyword\comma
4492  \definedummyword\copyright
4493  \definedummyword\registeredsymbol
4494  \definedummyword\dots
4495  \definedummyword\enddots
4496  \definedummyword\entrybreak
4497  \definedummyword\equiv
4498  \definedummyword\error
4499  \definedummyword\euro
4500  \definedummyword\expansion
4501  \definedummyword\geq
4502  \definedummyword\guillemetleft
4503  \definedummyword\guillemetright
4504  \definedummyword\guilsinglleft
4505  \definedummyword\guilsinglright
4506  \definedummyword\lbracechar
4507  \definedummyword\leq
4508  \definedummyword\minus
4509  \definedummyword\ogonek
4510  \definedummyword\pounds
4511  \definedummyword\point
4512  \definedummyword\print
4513  \definedummyword\quotedblbase
4514  \definedummyword\quotedblleft
4515  \definedummyword\quotedblright
4516  \definedummyword\quoteleft
4517  \definedummyword\quoteright
4518  \definedummyword\quotesinglbase
4519  \definedummyword\rbracechar
4520  \definedummyword\result
4521  \definedummyword\textdegree
4522  %
4523  % We want to disable all macros so that they are not expanded by \write.
4524  \macrolist
4525  %
4526  \normalturnoffactive
4527  %
4528  % Handle some cases of @value -- where it does not contain any
4529  % (non-fully-expandable) commands.
4530  \makevalueexpandable
4531}
4532
4533% \commondummiesnofonts: common to \commondummies and \indexnofonts.
4534%
4535\def\commondummiesnofonts{%
4536  % Control letters and accents.
4537  \definedummyletter\!%
4538  \definedummyaccent\"%
4539  \definedummyaccent\'%
4540  \definedummyletter\*%
4541  \definedummyaccent\,%
4542  \definedummyletter\.%
4543  \definedummyletter\/%
4544  \definedummyletter\:%
4545  \definedummyaccent\=%
4546  \definedummyletter\?%
4547  \definedummyaccent\^%
4548  \definedummyaccent\`%
4549  \definedummyaccent\~%
4550  \definedummyword\u
4551  \definedummyword\v
4552  \definedummyword\H
4553  \definedummyword\dotaccent
4554  \definedummyword\ogonek
4555  \definedummyword\ringaccent
4556  \definedummyword\tieaccent
4557  \definedummyword\ubaraccent
4558  \definedummyword\udotaccent
4559  \definedummyword\dotless
4560  %
4561  % Texinfo font commands.
4562  \definedummyword\b
4563  \definedummyword\i
4564  \definedummyword\r
4565  \definedummyword\sansserif
4566  \definedummyword\sc
4567  \definedummyword\slanted
4568  \definedummyword\t
4569  %
4570  % Commands that take arguments.
4571  \definedummyword\abbr
4572  \definedummyword\acronym
4573  \definedummyword\anchor
4574  \definedummyword\cite
4575  \definedummyword\code
4576  \definedummyword\command
4577  \definedummyword\dfn
4578  \definedummyword\dmn
4579  \definedummyword\email
4580  \definedummyword\emph
4581  \definedummyword\env
4582  \definedummyword\file
4583  \definedummyword\image
4584  \definedummyword\indicateurl
4585  \definedummyword\inforef
4586  \definedummyword\kbd
4587  \definedummyword\key
4588  \definedummyword\math
4589  \definedummyword\option
4590  \definedummyword\pxref
4591  \definedummyword\ref
4592  \definedummyword\samp
4593  \definedummyword\strong
4594  \definedummyword\tie
4595  \definedummyword\uref
4596  \definedummyword\url
4597  \definedummyword\var
4598  \definedummyword\verb
4599  \definedummyword\w
4600  \definedummyword\xref
4601}
4602
4603% \indexnofonts is used when outputting the strings to sort the index
4604% by, and when constructing control sequence names.  It eliminates all
4605% control sequences and just writes whatever the best ASCII sort string
4606% would be for a given command (usually its argument).
4607%
4608\def\indexnofonts{%
4609  % Accent commands should become @asis.
4610  \def\definedummyaccent##1{\let##1\asis}%
4611  % We can just ignore other control letters.
4612  \def\definedummyletter##1{\let##1\empty}%
4613  % All control words become @asis by default; overrides below.
4614  \let\definedummyword\definedummyaccent
4615  %
4616  \commondummiesnofonts
4617  %
4618  % Don't no-op \tt, since it isn't a user-level command
4619  % and is used in the definitions of the active chars like <, >, |, etc.
4620  % Likewise with the other plain tex font commands.
4621  %\let\tt=\asis
4622  %
4623  \def\ { }%
4624  \def\@{@}%
4625  \def\_{\normalunderscore}%
4626  \def\-{}% @- shouldn't affect sorting
4627  %
4628  % Unfortunately, texindex is not prepared to handle braces in the
4629  % content at all.  So for index sorting, we map @{ and @} to strings
4630  % starting with |, since that ASCII character is between ASCII { and }.
4631  \def\{{|a}%
4632  \def\lbracechar{|a}%
4633  %
4634  \def\}{|b}%
4635  \def\rbracechar{|b}%
4636  %
4637  % Non-English letters.
4638  \def\AA{AA}%
4639  \def\AE{AE}%
4640  \def\DH{DZZ}%
4641  \def\L{L}%
4642  \def\OE{OE}%
4643  \def\O{O}%
4644  \def\TH{ZZZ}%
4645  \def\aa{aa}%
4646  \def\ae{ae}%
4647  \def\dh{dzz}%
4648  \def\exclamdown{!}%
4649  \def\l{l}%
4650  \def\oe{oe}%
4651  \def\ordf{a}%
4652  \def\ordm{o}%
4653  \def\o{o}%
4654  \def\questiondown{?}%
4655  \def\ss{ss}%
4656  \def\th{zzz}%
4657  %
4658  \def\LaTeX{LaTeX}%
4659  \def\TeX{TeX}%
4660  %
4661  % Assorted special characters.
4662  % (The following {} will end up in the sort string, but that's ok.)
4663  \def\arrow{->}%
4664  \def\bullet{bullet}%
4665  \def\comma{,}%
4666  \def\copyright{copyright}%
4667  \def\dots{...}%
4668  \def\enddots{...}%
4669  \def\equiv{==}%
4670  \def\error{error}%
4671  \def\euro{euro}%
4672  \def\expansion{==>}%
4673  \def\geq{>=}%
4674  \def\guillemetleft{<<}%
4675  \def\guillemetright{>>}%
4676  \def\guilsinglleft{<}%
4677  \def\guilsinglright{>}%
4678  \def\leq{<=}%
4679  \def\minus{-}%
4680  \def\point{.}%
4681  \def\pounds{pounds}%
4682  \def\print{-|}%
4683  \def\quotedblbase{"}%
4684  \def\quotedblleft{"}%
4685  \def\quotedblright{"}%
4686  \def\quoteleft{`}%
4687  \def\quoteright{'}%
4688  \def\quotesinglbase{,}%
4689  \def\registeredsymbol{R}%
4690  \def\result{=>}%
4691  \def\textdegree{o}%
4692  %
4693  \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4694  \else \indexlquoteignore \fi
4695  %
4696  % We need to get rid of all macros, leaving only the arguments (if present).
4697  % Of course this is not nearly correct, but it is the best we can do for now.
4698  % makeinfo does not expand macros in the argument to @deffn, which ends up
4699  % writing an index entry, and texindex isn't prepared for an index sort entry
4700  % that starts with \.
4701  %
4702  % Since macro invocations are followed by braces, we can just redefine them
4703  % to take a single TeX argument.  The case of a macro invocation that
4704  % goes to end-of-line is not handled.
4705  %
4706  \macrolist
4707}
4708
4709% Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4710% ignore left quotes in the sort term.
4711{\catcode`\`=\active
4712 \gdef\indexlquoteignore{\let`=\empty}}
4713
4714\let\indexbackslash=0  %overridden during \printindex.
4715\let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4716
4717% Most index entries go through here, but \dosubind is the general case.
4718% #1 is the index name, #2 is the entry text.
4719\def\doind#1#2{\dosubind{#1}{#2}{}}
4720
4721% Workhorse for all \fooindexes.
4722% #1 is name of index, #2 is stuff to put there, #3 is subentry --
4723% empty if called from \doind, as we usually are (the main exception
4724% is with most defuns, which call us directly).
4725%
4726\def\dosubind#1#2#3{%
4727  \iflinks
4728  {%
4729    % Store the main index entry text (including the third arg).
4730    \toks0 = {#2}%
4731    % If third arg is present, precede it with a space.
4732    \def\thirdarg{#3}%
4733    \ifx\thirdarg\empty \else
4734      \toks0 = \expandafter{\the\toks0 \space #3}%
4735    \fi
4736    %
4737    \edef\writeto{\csname#1indfile\endcsname}%
4738    %
4739    \safewhatsit\dosubindwrite
4740  }%
4741  \fi
4742}
4743
4744% Write the entry in \toks0 to the index file:
4745%
4746\def\dosubindwrite{%
4747  % Put the index entry in the margin if desired.
4748  \ifx\SETmarginindex\relax\else
4749    \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4750  \fi
4751  %
4752  % Remember, we are within a group.
4753  \indexdummies % Must do this here, since \bf, etc expand at this stage
4754  \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4755      % so it will be output as is; and it will print as backslash.
4756  %
4757  % Process the index entry with all font commands turned off, to
4758  % get the string to sort by.
4759  {\indexnofonts
4760   \edef\temp{\the\toks0}% need full expansion
4761   \xdef\indexsorttmp{\temp}%
4762  }%
4763  %
4764  % Set up the complete index entry, with both the sort key and
4765  % the original text, including any font commands.  We write
4766  % three arguments to \entry to the .?? file (four in the
4767  % subentry case), texindex reduces to two when writing the .??s
4768  % sorted result.
4769  \edef\temp{%
4770    \write\writeto{%
4771      \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4772  }%
4773  \temp
4774}
4775
4776% Take care of unwanted page breaks/skips around a whatsit:
4777%
4778% If a skip is the last thing on the list now, preserve it
4779% by backing up by \lastskip, doing the \write, then inserting
4780% the skip again.  Otherwise, the whatsit generated by the
4781% \write or \pdfdest will make \lastskip zero.  The result is that
4782% sequences like this:
4783% @end defun
4784% @tindex whatever
4785% @defun ...
4786% will have extra space inserted, because the \medbreak in the
4787% start of the @defun won't see the skip inserted by the @end of
4788% the previous defun.
4789%
4790% But don't do any of this if we're not in vertical mode.  We
4791% don't want to do a \vskip and prematurely end a paragraph.
4792%
4793% Avoid page breaks due to these extra skips, too.
4794%
4795% But wait, there is a catch there:
4796% We'll have to check whether \lastskip is zero skip.  \ifdim is not
4797% sufficient for this purpose, as it ignores stretch and shrink parts
4798% of the skip.  The only way seems to be to check the textual
4799% representation of the skip.
4800%
4801% The following is almost like \def\zeroskipmacro{0.0pt} except that
4802% the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4803%
4804\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4805%
4806\newskip\whatsitskip
4807\newcount\whatsitpenalty
4808%
4809% ..., ready, GO:
4810%
4811\def\safewhatsit#1{\ifhmode
4812  #1%
4813 \else
4814  % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4815  \whatsitskip = \lastskip
4816  \edef\lastskipmacro{\the\lastskip}%
4817  \whatsitpenalty = \lastpenalty
4818  %
4819  % If \lastskip is nonzero, that means the last item was a
4820  % skip.  And since a skip is discardable, that means this
4821  % -\whatsitskip glue we're inserting is preceded by a
4822  % non-discardable item, therefore it is not a potential
4823  % breakpoint, therefore no \nobreak needed.
4824  \ifx\lastskipmacro\zeroskipmacro
4825  \else
4826    \vskip-\whatsitskip
4827  \fi
4828  %
4829  #1%
4830  %
4831  \ifx\lastskipmacro\zeroskipmacro
4832    % If \lastskip was zero, perhaps the last item was a penalty, and
4833    % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
4834    % to re-insert the same penalty (values >10000 are used for various
4835    % signals); since we just inserted a non-discardable item, any
4836    % following glue (such as a \parskip) would be a breakpoint.  For example:
4837    %   @deffn deffn-whatever
4838    %   @vindex index-whatever
4839    %   Description.
4840    % would allow a break between the index-whatever whatsit
4841    % and the "Description." paragraph.
4842    \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4843  \else
4844    % On the other hand, if we had a nonzero \lastskip,
4845    % this make-up glue would be preceded by a non-discardable item
4846    % (the whatsit from the \write), so we must insert a \nobreak.
4847    \nobreak\vskip\whatsitskip
4848  \fi
4849\fi}
4850
4851% The index entry written in the file actually looks like
4852%  \entry {sortstring}{page}{topic}
4853% or
4854%  \entry {sortstring}{page}{topic}{subtopic}
4855% The texindex program reads in these files and writes files
4856% containing these kinds of lines:
4857%  \initial {c}
4858%     before the first topic whose initial is c
4859%  \entry {topic}{pagelist}
4860%     for a topic that is used without subtopics
4861%  \primary {topic}
4862%     for the beginning of a topic that is used with subtopics
4863%  \secondary {subtopic}{pagelist}
4864%     for each subtopic.
4865
4866% Define the user-accessible indexing commands
4867% @findex, @vindex, @kindex, @cindex.
4868
4869\def\findex {\fnindex}
4870\def\kindex {\kyindex}
4871\def\cindex {\cpindex}
4872\def\vindex {\vrindex}
4873\def\tindex {\tpindex}
4874\def\pindex {\pgindex}
4875
4876\def\cindexsub {\begingroup\obeylines\cindexsub}
4877{\obeylines %
4878\gdef\cindexsub "#1" #2^^M{\endgroup %
4879\dosubind{cp}{#2}{#1}}}
4880
4881% Define the macros used in formatting output of the sorted index material.
4882
4883% @printindex causes a particular index (the ??s file) to get printed.
4884% It does not print any chapter heading (usually an @unnumbered).
4885%
4886\parseargdef\printindex{\begingroup
4887  \dobreak \chapheadingskip{10000}%
4888  %
4889  \smallfonts \rm
4890  \tolerance = 9500
4891  \plainfrenchspacing
4892  \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4893  %
4894  % See if the index file exists and is nonempty.
4895  % Change catcode of @ here so that if the index file contains
4896  % \initial {@}
4897  % as its first line, TeX doesn't complain about mismatched braces
4898  % (because it thinks @} is a control sequence).
4899  \catcode`\@ = 11
4900  \openin 1 \jobname.#1s
4901  \ifeof 1
4902    % \enddoublecolumns gets confused if there is no text in the index,
4903    % and it loses the chapter title and the aux file entries for the
4904    % index.  The easiest way to prevent this problem is to make sure
4905    % there is some text.
4906    \putwordIndexNonexistent
4907  \else
4908    %
4909    % If the index file exists but is empty, then \openin leaves \ifeof
4910    % false.  We have to make TeX try to read something from the file, so
4911    % it can discover if there is anything in it.
4912    \read 1 to \temp
4913    \ifeof 1
4914      \putwordIndexIsEmpty
4915    \else
4916      % Index files are almost Texinfo source, but we use \ as the escape
4917      % character.  It would be better to use @, but that's too big a change
4918      % to make right now.
4919      \def\indexbackslash{\backslashcurfont}%
4920      \catcode`\\ = 0
4921      \escapechar = `\\
4922      \begindoublecolumns
4923      \input \jobname.#1s
4924      \enddoublecolumns
4925    \fi
4926  \fi
4927  \closein 1
4928\endgroup}
4929
4930% These macros are used by the sorted index file itself.
4931% Change them to control the appearance of the index.
4932
4933\def\initial#1{{%
4934  % Some minor font changes for the special characters.
4935  \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4936  %
4937  % Remove any glue we may have, we'll be inserting our own.
4938  \removelastskip
4939  %
4940  % We like breaks before the index initials, so insert a bonus.
4941  \nobreak
4942  \vskip 0pt plus 3\baselineskip
4943  \penalty 0
4944  \vskip 0pt plus -3\baselineskip
4945  %
4946  % Typeset the initial.  Making this add up to a whole number of
4947  % baselineskips increases the chance of the dots lining up from column
4948  % to column.  It still won't often be perfect, because of the stretch
4949  % we need before each entry, but it's better.
4950  %
4951  % No shrink because it confuses \balancecolumns.
4952  \vskip 1.67\baselineskip plus .5\baselineskip
4953  \leftline{\secbf #1}%
4954  % Do our best not to break after the initial.
4955  \nobreak
4956  \vskip .33\baselineskip plus .1\baselineskip
4957}}
4958
4959% \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4960% then page number (#2) flushed to the right margin.  It is used for index
4961% and table of contents entries.  The paragraph is indented by \leftskip.
4962%
4963% A straightforward implementation would start like this:
4964%	\def\entry#1#2{...
4965% But this freezes the catcodes in the argument, and can cause problems to
4966% @code, which sets - active.  This problem was fixed by a kludge---
4967% ``-'' was active throughout whole index, but this isn't really right.
4968% The right solution is to prevent \entry from swallowing the whole text.
4969%                                 --kasal, 21nov03
4970\def\entry{%
4971  \begingroup
4972    %
4973    % Start a new paragraph if necessary, so our assignments below can't
4974    % affect previous text.
4975    \par
4976    %
4977    % Do not fill out the last line with white space.
4978    \parfillskip = 0in
4979    %
4980    % No extra space above this paragraph.
4981    \parskip = 0in
4982    %
4983    % Do not prefer a separate line ending with a hyphen to fewer lines.
4984    \finalhyphendemerits = 0
4985    %
4986    % \hangindent is only relevant when the entry text and page number
4987    % don't both fit on one line.  In that case, bob suggests starting the
4988    % dots pretty far over on the line.  Unfortunately, a large
4989    % indentation looks wrong when the entry text itself is broken across
4990    % lines.  So we use a small indentation and put up with long leaders.
4991    %
4992    % \hangafter is reset to 1 (which is the value we want) at the start
4993    % of each paragraph, so we need not do anything with that.
4994    \hangindent = 2em
4995    %
4996    % When the entry text needs to be broken, just fill out the first line
4997    % with blank space.
4998    \rightskip = 0pt plus1fil
4999    %
5000    % A bit of stretch before each entry for the benefit of balancing
5001    % columns.
5002    \vskip 0pt plus1pt
5003    %
5004    % When reading the text of entry, convert explicit line breaks
5005    % from @* into spaces.  The user might give these in long section
5006    % titles, for instance.
5007    \def\*{\unskip\space\ignorespaces}%
5008    \def\entrybreak{\hfil\break}%
5009    %
5010    % Swallow the left brace of the text (first parameter):
5011    \afterassignment\doentry
5012    \let\temp =
5013}
5014\def\entrybreak{\unskip\space\ignorespaces}%
5015\def\doentry{%
5016    \bgroup % Instead of the swallowed brace.
5017      \noindent
5018      \aftergroup\finishentry
5019      % And now comes the text of the entry.
5020}
5021\def\finishentry#1{%
5022    % #1 is the page number.
5023    %
5024    % The following is kludged to not output a line of dots in the index if
5025    % there are no page numbers.  The next person who breaks this will be
5026    % cursed by a Unix daemon.
5027    \setbox\boxA = \hbox{#1}%
5028    \ifdim\wd\boxA = 0pt
5029      \ %
5030    \else
5031      %
5032      % If we must, put the page number on a line of its own, and fill out
5033      % this line with blank space.  (The \hfil is overwhelmed with the
5034      % fill leaders glue in \indexdotfill if the page number does fit.)
5035      \hfil\penalty50
5036      \null\nobreak\indexdotfill % Have leaders before the page number.
5037      %
5038      % The `\ ' here is removed by the implicit \unskip that TeX does as
5039      % part of (the primitive) \par.  Without it, a spurious underfull
5040      % \hbox ensues.
5041      \ifpdf
5042	\pdfgettoks#1.%
5043	\ \the\toksA
5044      \else
5045	\ #1%
5046      \fi
5047    \fi
5048    \par
5049  \endgroup
5050}
5051
5052% Like plain.tex's \dotfill, except uses up at least 1 em.
5053\def\indexdotfill{\cleaders
5054  \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5055
5056\def\primary #1{\line{#1\hfil}}
5057
5058\newskip\secondaryindent \secondaryindent=0.5cm
5059\def\secondary#1#2{{%
5060  \parfillskip=0in
5061  \parskip=0in
5062  \hangindent=1in
5063  \hangafter=1
5064  \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5065  \ifpdf
5066    \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5067  \else
5068    #2
5069  \fi
5070  \par
5071}}
5072
5073% Define two-column mode, which we use to typeset indexes.
5074% Adapted from the TeXbook, page 416, which is to say,
5075% the manmac.tex format used to print the TeXbook itself.
5076\catcode`\@=11
5077
5078\newbox\partialpage
5079\newdimen\doublecolumnhsize
5080
5081\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5082  % Grab any single-column material above us.
5083  \output = {%
5084    %
5085    % Here is a possibility not foreseen in manmac: if we accumulate a
5086    % whole lot of material, we might end up calling this \output
5087    % routine twice in a row (see the doublecol-lose test, which is
5088    % essentially a couple of indexes with @setchapternewpage off).  In
5089    % that case we just ship out what is in \partialpage with the normal
5090    % output routine.  Generally, \partialpage will be empty when this
5091    % runs and this will be a no-op.  See the indexspread.tex test case.
5092    \ifvoid\partialpage \else
5093      \onepageout{\pagecontents\partialpage}%
5094    \fi
5095    %
5096    \global\setbox\partialpage = \vbox{%
5097      % Unvbox the main output page.
5098      \unvbox\PAGE
5099      \kern-\topskip \kern\baselineskip
5100    }%
5101  }%
5102  \eject % run that output routine to set \partialpage
5103  %
5104  % Use the double-column output routine for subsequent pages.
5105  \output = {\doublecolumnout}%
5106  %
5107  % Change the page size parameters.  We could do this once outside this
5108  % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5109  % format, but then we repeat the same computation.  Repeating a couple
5110  % of assignments once per index is clearly meaningless for the
5111  % execution time, so we may as well do it in one place.
5112  %
5113  % First we halve the line length, less a little for the gutter between
5114  % the columns.  We compute the gutter based on the line length, so it
5115  % changes automatically with the paper format.  The magic constant
5116  % below is chosen so that the gutter has the same value (well, +-<1pt)
5117  % as it did when we hard-coded it.
5118  %
5119  % We put the result in a separate register, \doublecolumhsize, so we
5120  % can restore it in \pagesofar, after \hsize itself has (potentially)
5121  % been clobbered.
5122  %
5123  \doublecolumnhsize = \hsize
5124    \advance\doublecolumnhsize by -.04154\hsize
5125    \divide\doublecolumnhsize by 2
5126  \hsize = \doublecolumnhsize
5127  %
5128  % Double the \vsize as well.  (We don't need a separate register here,
5129  % since nobody clobbers \vsize.)
5130  \vsize = 2\vsize
5131}
5132
5133% The double-column output routine for all double-column pages except
5134% the last.
5135%
5136\def\doublecolumnout{%
5137  \splittopskip=\topskip \splitmaxdepth=\maxdepth
5138  % Get the available space for the double columns -- the normal
5139  % (undoubled) page height minus any material left over from the
5140  % previous page.
5141  \dimen@ = \vsize
5142  \divide\dimen@ by 2
5143  \advance\dimen@ by -\ht\partialpage
5144  %
5145  % box0 will be the left-hand column, box2 the right.
5146  \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5147  \onepageout\pagesofar
5148  \unvbox255
5149  \penalty\outputpenalty
5150}
5151%
5152% Re-output the contents of the output page -- any previous material,
5153% followed by the two boxes we just split, in box0 and box2.
5154\def\pagesofar{%
5155  \unvbox\partialpage
5156  %
5157  \hsize = \doublecolumnhsize
5158  \wd0=\hsize \wd2=\hsize
5159  \hbox to\pagewidth{\box0\hfil\box2}%
5160}
5161%
5162% All done with double columns.
5163\def\enddoublecolumns{%
5164  % The following penalty ensures that the page builder is exercised
5165  % _before_ we change the output routine.  This is necessary in the
5166  % following situation:
5167  %
5168  % The last section of the index consists only of a single entry.
5169  % Before this section, \pagetotal is less than \pagegoal, so no
5170  % break occurs before the last section starts.  However, the last
5171  % section, consisting of \initial and the single \entry, does not
5172  % fit on the page and has to be broken off.  Without the following
5173  % penalty the page builder will not be exercised until \eject
5174  % below, and by that time we'll already have changed the output
5175  % routine to the \balancecolumns version, so the next-to-last
5176  % double-column page will be processed with \balancecolumns, which
5177  % is wrong:  The two columns will go to the main vertical list, with
5178  % the broken-off section in the recent contributions.  As soon as
5179  % the output routine finishes, TeX starts reconsidering the page
5180  % break.  The two columns and the broken-off section both fit on the
5181  % page, because the two columns now take up only half of the page
5182  % goal.  When TeX sees \eject from below which follows the final
5183  % section, it invokes the new output routine that we've set after
5184  % \balancecolumns below; \onepageout will try to fit the two columns
5185  % and the final section into the vbox of \pageheight (see
5186  % \pagebody), causing an overfull box.
5187  %
5188  % Note that glue won't work here, because glue does not exercise the
5189  % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5190  \penalty0
5191  %
5192  \output = {%
5193    % Split the last of the double-column material.  Leave it on the
5194    % current page, no automatic page break.
5195    \balancecolumns
5196    %
5197    % If we end up splitting too much material for the current page,
5198    % though, there will be another page break right after this \output
5199    % invocation ends.  Having called \balancecolumns once, we do not
5200    % want to call it again.  Therefore, reset \output to its normal
5201    % definition right away.  (We hope \balancecolumns will never be
5202    % called on to balance too much material, but if it is, this makes
5203    % the output somewhat more palatable.)
5204    \global\output = {\onepageout{\pagecontents\PAGE}}%
5205  }%
5206  \eject
5207  \endgroup % started in \begindoublecolumns
5208  %
5209  % \pagegoal was set to the doubled \vsize above, since we restarted
5210  % the current page.  We're now back to normal single-column
5211  % typesetting, so reset \pagegoal to the normal \vsize (after the
5212  % \endgroup where \vsize got restored).
5213  \pagegoal = \vsize
5214}
5215%
5216% Called at the end of the double column material.
5217\def\balancecolumns{%
5218  \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5219  \dimen@ = \ht0
5220  \advance\dimen@ by \topskip
5221  \advance\dimen@ by-\baselineskip
5222  \divide\dimen@ by 2 % target to split to
5223  %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5224  \splittopskip = \topskip
5225  % Loop until we get a decent breakpoint.
5226  {%
5227    \vbadness = 10000
5228    \loop
5229      \global\setbox3 = \copy0
5230      \global\setbox1 = \vsplit3 to \dimen@
5231    \ifdim\ht3>\dimen@
5232      \global\advance\dimen@ by 1pt
5233    \repeat
5234  }%
5235  %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5236  \setbox0=\vbox to\dimen@{\unvbox1}%
5237  \setbox2=\vbox to\dimen@{\unvbox3}%
5238  %
5239  \pagesofar
5240}
5241\catcode`\@ = \other
5242
5243
5244\message{sectioning,}
5245% Chapters, sections, etc.
5246
5247% Let's start with @part.
5248\outer\parseargdef\part{\partzzz{#1}}
5249\def\partzzz#1{%
5250  \chapoddpage
5251  \null
5252  \vskip.3\vsize  % move it down on the page a bit
5253  \begingroup
5254    \noindent \titlefonts\rmisbold #1\par % the text
5255    \let\lastnode=\empty      % no node to associate with
5256    \writetocentry{part}{#1}{}% but put it in the toc
5257    \headingsoff              % no headline or footline on the part page
5258    \chapoddpage
5259  \endgroup
5260}
5261
5262% \unnumberedno is an oxymoron.  But we count the unnumbered
5263% sections so that we can refer to them unambiguously in the pdf
5264% outlines by their "section number".  We avoid collisions with chapter
5265% numbers by starting them at 10000.  (If a document ever has 10000
5266% chapters, we're in trouble anyway, I'm sure.)
5267\newcount\unnumberedno \unnumberedno = 10000
5268\newcount\chapno
5269\newcount\secno        \secno=0
5270\newcount\subsecno     \subsecno=0
5271\newcount\subsubsecno  \subsubsecno=0
5272
5273% This counter is funny since it counts through charcodes of letters A, B, ...
5274\newcount\appendixno  \appendixno = `\@
5275%
5276% \def\appendixletter{\char\the\appendixno}
5277% We do the following ugly conditional instead of the above simple
5278% construct for the sake of pdftex, which needs the actual
5279% letter in the expansion, not just typeset.
5280%
5281\def\appendixletter{%
5282  \ifnum\appendixno=`A A%
5283  \else\ifnum\appendixno=`B B%
5284  \else\ifnum\appendixno=`C C%
5285  \else\ifnum\appendixno=`D D%
5286  \else\ifnum\appendixno=`E E%
5287  \else\ifnum\appendixno=`F F%
5288  \else\ifnum\appendixno=`G G%
5289  \else\ifnum\appendixno=`H H%
5290  \else\ifnum\appendixno=`I I%
5291  \else\ifnum\appendixno=`J J%
5292  \else\ifnum\appendixno=`K K%
5293  \else\ifnum\appendixno=`L L%
5294  \else\ifnum\appendixno=`M M%
5295  \else\ifnum\appendixno=`N N%
5296  \else\ifnum\appendixno=`O O%
5297  \else\ifnum\appendixno=`P P%
5298  \else\ifnum\appendixno=`Q Q%
5299  \else\ifnum\appendixno=`R R%
5300  \else\ifnum\appendixno=`S S%
5301  \else\ifnum\appendixno=`T T%
5302  \else\ifnum\appendixno=`U U%
5303  \else\ifnum\appendixno=`V V%
5304  \else\ifnum\appendixno=`W W%
5305  \else\ifnum\appendixno=`X X%
5306  \else\ifnum\appendixno=`Y Y%
5307  \else\ifnum\appendixno=`Z Z%
5308  % The \the is necessary, despite appearances, because \appendixletter is
5309  % expanded while writing the .toc file.  \char\appendixno is not
5310  % expandable, thus it is written literally, thus all appendixes come out
5311  % with the same letter (or @) in the toc without it.
5312  \else\char\the\appendixno
5313  \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5314  \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5315
5316% Each @chapter defines these (using marks) as the number+name, number
5317% and name of the chapter.  Page headings and footings can use
5318% these.  @section does likewise.
5319\def\thischapter{}
5320\def\thischapternum{}
5321\def\thischaptername{}
5322\def\thissection{}
5323\def\thissectionnum{}
5324\def\thissectionname{}
5325
5326\newcount\absseclevel % used to calculate proper heading level
5327\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5328
5329% @raisesections: treat @section as chapter, @subsection as section, etc.
5330\def\raisesections{\global\advance\secbase by -1}
5331\let\up=\raisesections % original BFox name
5332
5333% @lowersections: treat @chapter as section, @section as subsection, etc.
5334\def\lowersections{\global\advance\secbase by 1}
5335\let\down=\lowersections % original BFox name
5336
5337% we only have subsub.
5338\chardef\maxseclevel = 3
5339%
5340% A numbered section within an unnumbered changes to unnumbered too.
5341% To achieve this, remember the "biggest" unnum. sec. we are currently in:
5342\chardef\unnlevel = \maxseclevel
5343%
5344% Trace whether the current chapter is an appendix or not:
5345% \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5346\def\chapheadtype{N}
5347
5348% Choose a heading macro
5349% #1 is heading type
5350% #2 is heading level
5351% #3 is text for heading
5352\def\genhead#1#2#3{%
5353  % Compute the abs. sec. level:
5354  \absseclevel=#2
5355  \advance\absseclevel by \secbase
5356  % Make sure \absseclevel doesn't fall outside the range:
5357  \ifnum \absseclevel < 0
5358    \absseclevel = 0
5359  \else
5360    \ifnum \absseclevel > 3
5361      \absseclevel = 3
5362    \fi
5363  \fi
5364  % The heading type:
5365  \def\headtype{#1}%
5366  \if \headtype U%
5367    \ifnum \absseclevel < \unnlevel
5368      \chardef\unnlevel = \absseclevel
5369    \fi
5370  \else
5371    % Check for appendix sections:
5372    \ifnum \absseclevel = 0
5373      \edef\chapheadtype{\headtype}%
5374    \else
5375      \if \headtype A\if \chapheadtype N%
5376	\errmessage{@appendix... within a non-appendix chapter}%
5377      \fi\fi
5378    \fi
5379    % Check for numbered within unnumbered:
5380    \ifnum \absseclevel > \unnlevel
5381      \def\headtype{U}%
5382    \else
5383      \chardef\unnlevel = 3
5384    \fi
5385  \fi
5386  % Now print the heading:
5387  \if \headtype U%
5388    \ifcase\absseclevel
5389	\unnumberedzzz{#3}%
5390    \or \unnumberedseczzz{#3}%
5391    \or \unnumberedsubseczzz{#3}%
5392    \or \unnumberedsubsubseczzz{#3}%
5393    \fi
5394  \else
5395    \if \headtype A%
5396      \ifcase\absseclevel
5397	  \appendixzzz{#3}%
5398      \or \appendixsectionzzz{#3}%
5399      \or \appendixsubseczzz{#3}%
5400      \or \appendixsubsubseczzz{#3}%
5401      \fi
5402    \else
5403      \ifcase\absseclevel
5404	  \chapterzzz{#3}%
5405      \or \seczzz{#3}%
5406      \or \numberedsubseczzz{#3}%
5407      \or \numberedsubsubseczzz{#3}%
5408      \fi
5409    \fi
5410  \fi
5411  \suppressfirstparagraphindent
5412}
5413
5414% an interface:
5415\def\numhead{\genhead N}
5416\def\apphead{\genhead A}
5417\def\unnmhead{\genhead U}
5418
5419% @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
5420% all lower-level sectioning counters to zero.
5421%
5422% Also set \chaplevelprefix, which we prepend to @float sequence numbers
5423% (e.g., figures), q.v.  By default (before any chapter), that is empty.
5424\let\chaplevelprefix = \empty
5425%
5426\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5427\def\chapterzzz#1{%
5428  % section resetting is \global in case the chapter is in a group, such
5429  % as an @include file.
5430  \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5431    \global\advance\chapno by 1
5432  %
5433  % Used for \float.
5434  \gdef\chaplevelprefix{\the\chapno.}%
5435  \resetallfloatnos
5436  %
5437  % \putwordChapter can contain complex things in translations.
5438  \toks0=\expandafter{\putwordChapter}%
5439  \message{\the\toks0 \space \the\chapno}%
5440  %
5441  % Write the actual heading.
5442  \chapmacro{#1}{Ynumbered}{\the\chapno}%
5443  %
5444  % So @section and the like are numbered underneath this chapter.
5445  \global\let\section = \numberedsec
5446  \global\let\subsection = \numberedsubsec
5447  \global\let\subsubsection = \numberedsubsubsec
5448}
5449
5450\outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5451%
5452\def\appendixzzz#1{%
5453  \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5454    \global\advance\appendixno by 1
5455  \gdef\chaplevelprefix{\appendixletter.}%
5456  \resetallfloatnos
5457  %
5458  % \putwordAppendix can contain complex things in translations.
5459  \toks0=\expandafter{\putwordAppendix}%
5460  \message{\the\toks0 \space \appendixletter}%
5461  %
5462  \chapmacro{#1}{Yappendix}{\appendixletter}%
5463  %
5464  \global\let\section = \appendixsec
5465  \global\let\subsection = \appendixsubsec
5466  \global\let\subsubsection = \appendixsubsubsec
5467}
5468
5469% normally unnmhead0 calls unnumberedzzz:
5470\outer\parseargdef\unnumbered{\unnmhead0{#1}}
5471\def\unnumberedzzz#1{%
5472  \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5473    \global\advance\unnumberedno by 1
5474  %
5475  % Since an unnumbered has no number, no prefix for figures.
5476  \global\let\chaplevelprefix = \empty
5477  \resetallfloatnos
5478  %
5479  % This used to be simply \message{#1}, but TeX fully expands the
5480  % argument to \message.  Therefore, if #1 contained @-commands, TeX
5481  % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
5482  % expanded @cite (which turns out to cause errors because \cite is meant
5483  % to be executed, not expanded).
5484  %
5485  % Anyway, we don't want the fully-expanded definition of @cite to appear
5486  % as a result of the \message, we just want `@cite' itself.  We use
5487  % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5488  % simply yielding the contents of <toks register>.  (We also do this for
5489  % the toc entries.)
5490  \toks0 = {#1}%
5491  \message{(\the\toks0)}%
5492  %
5493  \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5494  %
5495  \global\let\section = \unnumberedsec
5496  \global\let\subsection = \unnumberedsubsec
5497  \global\let\subsubsection = \unnumberedsubsubsec
5498}
5499
5500% @centerchap is like @unnumbered, but the heading is centered.
5501\outer\parseargdef\centerchap{%
5502  % Well, we could do the following in a group, but that would break
5503  % an assumption that \chapmacro is called at the outermost level.
5504  % Thus we are safer this way:		--kasal, 24feb04
5505  \let\centerparametersmaybe = \centerparameters
5506  \unnmhead0{#1}%
5507  \let\centerparametersmaybe = \relax
5508}
5509
5510% @top is like @unnumbered.
5511\let\top\unnumbered
5512
5513% Sections.
5514% 
5515\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5516\def\seczzz#1{%
5517  \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5518  \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5519}
5520
5521% normally calls appendixsectionzzz:
5522\outer\parseargdef\appendixsection{\apphead1{#1}}
5523\def\appendixsectionzzz#1{%
5524  \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5525  \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5526}
5527\let\appendixsec\appendixsection
5528
5529% normally calls unnumberedseczzz:
5530\outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5531\def\unnumberedseczzz#1{%
5532  \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5533  \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5534}
5535
5536% Subsections.
5537% 
5538% normally calls numberedsubseczzz:
5539\outer\parseargdef\numberedsubsec{\numhead2{#1}}
5540\def\numberedsubseczzz#1{%
5541  \global\subsubsecno=0  \global\advance\subsecno by 1
5542  \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5543}
5544
5545% normally calls appendixsubseczzz:
5546\outer\parseargdef\appendixsubsec{\apphead2{#1}}
5547\def\appendixsubseczzz#1{%
5548  \global\subsubsecno=0  \global\advance\subsecno by 1
5549  \sectionheading{#1}{subsec}{Yappendix}%
5550                 {\appendixletter.\the\secno.\the\subsecno}%
5551}
5552
5553% normally calls unnumberedsubseczzz:
5554\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5555\def\unnumberedsubseczzz#1{%
5556  \global\subsubsecno=0  \global\advance\subsecno by 1
5557  \sectionheading{#1}{subsec}{Ynothing}%
5558                 {\the\unnumberedno.\the\secno.\the\subsecno}%
5559}
5560
5561% Subsubsections.
5562% 
5563% normally numberedsubsubseczzz:
5564\outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5565\def\numberedsubsubseczzz#1{%
5566  \global\advance\subsubsecno by 1
5567  \sectionheading{#1}{subsubsec}{Ynumbered}%
5568                 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5569}
5570
5571% normally appendixsubsubseczzz:
5572\outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5573\def\appendixsubsubseczzz#1{%
5574  \global\advance\subsubsecno by 1
5575  \sectionheading{#1}{subsubsec}{Yappendix}%
5576                 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5577}
5578
5579% normally unnumberedsubsubseczzz:
5580\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5581\def\unnumberedsubsubseczzz#1{%
5582  \global\advance\subsubsecno by 1
5583  \sectionheading{#1}{subsubsec}{Ynothing}%
5584                 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5585}
5586
5587% These macros control what the section commands do, according
5588% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5589% Define them by default for a numbered chapter.
5590\let\section = \numberedsec
5591\let\subsection = \numberedsubsec
5592\let\subsubsection = \numberedsubsubsec
5593
5594% Define @majorheading, @heading and @subheading
5595
5596\def\majorheading{%
5597  {\advance\chapheadingskip by 10pt \chapbreak }%
5598  \parsearg\chapheadingzzz
5599}
5600
5601\def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5602\def\chapheadingzzz#1{%
5603  \vbox{\chapfonts \raggedtitlesettings #1\par}%
5604  \nobreak\bigskip \nobreak
5605  \suppressfirstparagraphindent
5606}
5607
5608% @heading, @subheading, @subsubheading.
5609\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5610  \suppressfirstparagraphindent}
5611\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5612  \suppressfirstparagraphindent}
5613\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5614  \suppressfirstparagraphindent}
5615
5616% These macros generate a chapter, section, etc. heading only
5617% (including whitespace, linebreaking, etc. around it),
5618% given all the information in convenient, parsed form.
5619
5620% Args are the skip and penalty (usually negative)
5621\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5622
5623% Parameter controlling skip before chapter headings (if needed)
5624\newskip\chapheadingskip
5625
5626% Define plain chapter starts, and page on/off switching for it.
5627\def\chapbreak{\dobreak \chapheadingskip {-4000}}
5628\def\chappager{\par\vfill\supereject}
5629% Because \domark is called before \chapoddpage, the filler page will
5630% get the headings for the next chapter, which is wrong.  But we don't
5631% care -- we just disable all headings on the filler page.
5632\def\chapoddpage{%
5633  \chappager
5634  \ifodd\pageno \else
5635    \begingroup
5636      \headingsoff
5637      \null
5638      \chappager
5639    \endgroup
5640  \fi
5641}
5642
5643\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5644
5645\def\CHAPPAGoff{%
5646\global\let\contentsalignmacro = \chappager
5647\global\let\pchapsepmacro=\chapbreak
5648\global\let\pagealignmacro=\chappager}
5649
5650\def\CHAPPAGon{%
5651\global\let\contentsalignmacro = \chappager
5652\global\let\pchapsepmacro=\chappager
5653\global\let\pagealignmacro=\chappager
5654\global\def\HEADINGSon{\HEADINGSsingle}}
5655
5656\def\CHAPPAGodd{%
5657\global\let\contentsalignmacro = \chapoddpage
5658\global\let\pchapsepmacro=\chapoddpage
5659\global\let\pagealignmacro=\chapoddpage
5660\global\def\HEADINGSon{\HEADINGSdouble}}
5661
5662\CHAPPAGon
5663
5664% Chapter opening.
5665%
5666% #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5667% Yappendix, Yomitfromtoc), #3 the chapter number.
5668%
5669% To test against our argument.
5670\def\Ynothingkeyword{Ynothing}
5671\def\Yomitfromtockeyword{Yomitfromtoc}
5672\def\Yappendixkeyword{Yappendix}
5673%
5674\def\chapmacro#1#2#3{%
5675  % Insert the first mark before the heading break (see notes for \domark).
5676  \let\prevchapterdefs=\lastchapterdefs
5677  \let\prevsectiondefs=\lastsectiondefs
5678  \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5679                        \gdef\thissection{}}%
5680  %
5681  \def\temptype{#2}%
5682  \ifx\temptype\Ynothingkeyword
5683    \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5684                          \gdef\thischapter{\thischaptername}}%
5685  \else\ifx\temptype\Yomitfromtockeyword
5686    \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5687                          \gdef\thischapter{}}%
5688  \else\ifx\temptype\Yappendixkeyword
5689    \toks0={#1}%
5690    \xdef\lastchapterdefs{%
5691      \gdef\noexpand\thischaptername{\the\toks0}%
5692      \gdef\noexpand\thischapternum{\appendixletter}%
5693      % \noexpand\putwordAppendix avoids expanding indigestible
5694      % commands in some of the translations.
5695      \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5696                                 \noexpand\thischapternum:
5697                                 \noexpand\thischaptername}%
5698    }%
5699  \else
5700    \toks0={#1}%
5701    \xdef\lastchapterdefs{%
5702      \gdef\noexpand\thischaptername{\the\toks0}%
5703      \gdef\noexpand\thischapternum{\the\chapno}%
5704      % \noexpand\putwordChapter avoids expanding indigestible
5705      % commands in some of the translations.
5706      \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5707                                 \noexpand\thischapternum:
5708                                 \noexpand\thischaptername}%
5709    }%
5710  \fi\fi\fi
5711  %
5712  % Output the mark.  Pass it through \safewhatsit, to take care of
5713  % the preceding space.
5714  \safewhatsit\domark
5715  %
5716  % Insert the chapter heading break.
5717  \pchapsepmacro
5718  %
5719  % Now the second mark, after the heading break.  No break points
5720  % between here and the heading.
5721  \let\prevchapterdefs=\lastchapterdefs
5722  \let\prevsectiondefs=\lastsectiondefs
5723  \domark
5724  %
5725  {%
5726    \chapfonts \rmisbold
5727    %
5728    % Have to define \lastsection before calling \donoderef, because the
5729    % xref code eventually uses it.  On the other hand, it has to be called
5730    % after \pchapsepmacro, or the headline will change too soon.
5731    \gdef\lastsection{#1}%
5732    %
5733    % Only insert the separating space if we have a chapter/appendix
5734    % number, and don't print the unnumbered ``number''.
5735    \ifx\temptype\Ynothingkeyword
5736      \setbox0 = \hbox{}%
5737      \def\toctype{unnchap}%
5738    \else\ifx\temptype\Yomitfromtockeyword
5739      \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5740      \def\toctype{omit}%
5741    \else\ifx\temptype\Yappendixkeyword
5742      \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5743      \def\toctype{app}%
5744    \else
5745      \setbox0 = \hbox{#3\enspace}%
5746      \def\toctype{numchap}%
5747    \fi\fi\fi
5748    %
5749    % Write the toc entry for this chapter.  Must come before the
5750    % \donoderef, because we include the current node name in the toc
5751    % entry, and \donoderef resets it to empty.
5752    \writetocentry{\toctype}{#1}{#3}%
5753    %
5754    % For pdftex, we have to write out the node definition (aka, make
5755    % the pdfdest) after any page break, but before the actual text has
5756    % been typeset.  If the destination for the pdf outline is after the
5757    % text, then jumping from the outline may wind up with the text not
5758    % being visible, for instance under high magnification.
5759    \donoderef{#2}%
5760    %
5761    % Typeset the actual heading.
5762    \nobreak % Avoid page breaks at the interline glue.
5763    \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5764          \unhbox0 #1\par}%
5765  }%
5766  \nobreak\bigskip % no page break after a chapter title
5767  \nobreak
5768}
5769
5770% @centerchap -- centered and unnumbered.
5771\let\centerparametersmaybe = \relax
5772\def\centerparameters{%
5773  \advance\rightskip by 3\rightskip
5774  \leftskip = \rightskip
5775  \parfillskip = 0pt
5776}
5777
5778
5779% I don't think this chapter style is supported any more, so I'm not
5780% updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
5781%
5782\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5783%
5784\def\unnchfopen #1{%
5785  \chapoddpage
5786  \vbox{\chapfonts \raggedtitlesettings #1\par}%
5787  \nobreak\bigskip\nobreak
5788}
5789\def\chfopen #1#2{\chapoddpage {\chapfonts
5790\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5791\par\penalty 5000 %
5792}
5793\def\centerchfopen #1{%
5794  \chapoddpage
5795  \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5796  \nobreak\bigskip \nobreak
5797}
5798\def\CHAPFopen{%
5799  \global\let\chapmacro=\chfopen
5800  \global\let\centerchapmacro=\centerchfopen}
5801
5802
5803% Section titles.  These macros combine the section number parts and
5804% call the generic \sectionheading to do the printing.
5805%
5806\newskip\secheadingskip
5807\def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5808
5809% Subsection titles.
5810\newskip\subsecheadingskip
5811\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5812
5813% Subsubsection titles.
5814\def\subsubsecheadingskip{\subsecheadingskip}
5815\def\subsubsecheadingbreak{\subsecheadingbreak}
5816
5817
5818% Print any size, any type, section title.
5819%
5820% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5821% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5822% section number.
5823%
5824\def\seckeyword{sec}
5825%
5826\def\sectionheading#1#2#3#4{%
5827  {%
5828    \checkenv{}% should not be in an environment.
5829    %
5830    % Switch to the right set of fonts.
5831    \csname #2fonts\endcsname \rmisbold
5832    %
5833    \def\sectionlevel{#2}%
5834    \def\temptype{#3}%
5835    %
5836    % Insert first mark before the heading break (see notes for \domark).
5837    \let\prevsectiondefs=\lastsectiondefs
5838    \ifx\temptype\Ynothingkeyword
5839      \ifx\sectionlevel\seckeyword
5840        \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5841                              \gdef\thissection{\thissectionname}}%
5842      \fi
5843    \else\ifx\temptype\Yomitfromtockeyword
5844      % Don't redefine \thissection.
5845    \else\ifx\temptype\Yappendixkeyword
5846      \ifx\sectionlevel\seckeyword
5847        \toks0={#1}%
5848        \xdef\lastsectiondefs{%
5849          \gdef\noexpand\thissectionname{\the\toks0}%
5850          \gdef\noexpand\thissectionnum{#4}%
5851          % \noexpand\putwordSection avoids expanding indigestible
5852          % commands in some of the translations.
5853          \gdef\noexpand\thissection{\noexpand\putwordSection{}
5854                                     \noexpand\thissectionnum:
5855                                     \noexpand\thissectionname}%
5856        }%
5857      \fi
5858    \else
5859      \ifx\sectionlevel\seckeyword
5860        \toks0={#1}%
5861        \xdef\lastsectiondefs{%
5862          \gdef\noexpand\thissectionname{\the\toks0}%
5863          \gdef\noexpand\thissectionnum{#4}%
5864          % \noexpand\putwordSection avoids expanding indigestible
5865          % commands in some of the translations.
5866          \gdef\noexpand\thissection{\noexpand\putwordSection{}
5867                                     \noexpand\thissectionnum:
5868                                     \noexpand\thissectionname}%
5869        }%
5870      \fi
5871    \fi\fi\fi
5872    %
5873    % Go into vertical mode.  Usually we'll already be there, but we
5874    % don't want the following whatsit to end up in a preceding paragraph
5875    % if the document didn't happen to have a blank line.
5876    \par
5877    %
5878    % Output the mark.  Pass it through \safewhatsit, to take care of
5879    % the preceding space.
5880    \safewhatsit\domark
5881    %
5882    % Insert space above the heading.
5883    \csname #2headingbreak\endcsname
5884    %
5885    % Now the second mark, after the heading break.  No break points
5886    % between here and the heading.
5887    \let\prevsectiondefs=\lastsectiondefs
5888    \domark
5889    %
5890    % Only insert the space after the number if we have a section number.
5891    \ifx\temptype\Ynothingkeyword
5892      \setbox0 = \hbox{}%
5893      \def\toctype{unn}%
5894      \gdef\lastsection{#1}%
5895    \else\ifx\temptype\Yomitfromtockeyword
5896      % for @headings -- no section number, don't include in toc,
5897      % and don't redefine \lastsection.
5898      \setbox0 = \hbox{}%
5899      \def\toctype{omit}%
5900      \let\sectionlevel=\empty
5901    \else\ifx\temptype\Yappendixkeyword
5902      \setbox0 = \hbox{#4\enspace}%
5903      \def\toctype{app}%
5904      \gdef\lastsection{#1}%
5905    \else
5906      \setbox0 = \hbox{#4\enspace}%
5907      \def\toctype{num}%
5908      \gdef\lastsection{#1}%
5909    \fi\fi\fi
5910    %
5911    % Write the toc entry (before \donoderef).  See comments in \chapmacro.
5912    \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5913    %
5914    % Write the node reference (= pdf destination for pdftex).
5915    % Again, see comments in \chapmacro.
5916    \donoderef{#3}%
5917    %
5918    % Interline glue will be inserted when the vbox is completed.
5919    % That glue will be a valid breakpoint for the page, since it'll be
5920    % preceded by a whatsit (usually from the \donoderef, or from the
5921    % \writetocentry if there was no node).  We don't want to allow that
5922    % break, since then the whatsits could end up on page n while the
5923    % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
5924    \nobreak
5925    %
5926    % Output the actual section heading.
5927    \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5928          \hangindent=\wd0  % zero if no section number
5929          \unhbox0 #1}%
5930  }%
5931  % Add extra space after the heading -- half of whatever came above it.
5932  % Don't allow stretch, though.
5933  \kern .5 \csname #2headingskip\endcsname
5934  %
5935  % Do not let the kern be a potential breakpoint, as it would be if it
5936  % was followed by glue.
5937  \nobreak
5938  %
5939  % We'll almost certainly start a paragraph next, so don't let that
5940  % glue accumulate.  (Not a breakpoint because it's preceded by a
5941  % discardable item.)  However, when a paragraph is not started next
5942  % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5943  % or the negative glue will cause weirdly wrong output, typically
5944  % obscuring the section heading with something else.
5945  \vskip-\parskip
5946  %
5947  % This is so the last item on the main vertical list is a known
5948  % \penalty > 10000, so \startdefun, etc., can recognize the situation
5949  % and do the needful.
5950  \penalty 10001
5951}
5952
5953
5954\message{toc,}
5955% Table of contents.
5956\newwrite\tocfile
5957
5958% Write an entry to the toc file, opening it if necessary.
5959% Called from @chapter, etc.
5960%
5961% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5962% We append the current node name (if any) and page number as additional
5963% arguments for the \{chap,sec,...}entry macros which will eventually
5964% read this.  The node name is used in the pdf outlines as the
5965% destination to jump to.
5966%
5967% We open the .toc file for writing here instead of at @setfilename (or
5968% any other fixed time) so that @contents can be anywhere in the document.
5969% But if #1 is `omit', then we don't do anything.  This is used for the
5970% table of contents chapter openings themselves.
5971%
5972\newif\iftocfileopened
5973\def\omitkeyword{omit}%
5974%
5975\def\writetocentry#1#2#3{%
5976  \edef\writetoctype{#1}%
5977  \ifx\writetoctype\omitkeyword \else
5978    \iftocfileopened\else
5979      \immediate\openout\tocfile = \jobname.toc
5980      \global\tocfileopenedtrue
5981    \fi
5982    %
5983    \iflinks
5984      {\atdummies
5985       \edef\temp{%
5986         \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5987       \temp
5988      }%
5989    \fi
5990  \fi
5991  %
5992  % Tell \shipout to create a pdf destination on each page, if we're
5993  % writing pdf.  These are used in the table of contents.  We can't
5994  % just write one on every page because the title pages are numbered
5995  % 1 and 2 (the page numbers aren't printed), and so are the first
5996  % two pages of the document.  Thus, we'd have two destinations named
5997  % `1', and two named `2'.
5998  \ifpdf \global\pdfmakepagedesttrue \fi
5999}
6000
6001
6002% These characters do not print properly in the Computer Modern roman
6003% fonts, so we must take special care.  This is more or less redundant
6004% with the Texinfo input format setup at the end of this file.
6005%
6006\def\activecatcodes{%
6007  \catcode`\"=\active
6008  \catcode`\$=\active
6009  \catcode`\<=\active
6010  \catcode`\>=\active
6011  \catcode`\\=\active
6012  \catcode`\^=\active
6013  \catcode`\_=\active
6014  \catcode`\|=\active
6015  \catcode`\~=\active
6016}
6017
6018
6019% Read the toc file, which is essentially Texinfo input.
6020\def\readtocfile{%
6021  \setupdatafile
6022  \activecatcodes
6023  \input \tocreadfilename
6024}
6025
6026\newskip\contentsrightmargin \contentsrightmargin=1in
6027\newcount\savepageno
6028\newcount\lastnegativepageno \lastnegativepageno = -1
6029
6030% Prepare to read what we've written to \tocfile.
6031%
6032\def\startcontents#1{%
6033  % If @setchapternewpage on, and @headings double, the contents should
6034  % start on an odd page, unlike chapters.  Thus, we maintain
6035  % \contentsalignmacro in parallel with \pagealignmacro.
6036  % From: Torbjorn Granlund <tege@matematik.su.se>
6037  \contentsalignmacro
6038  \immediate\closeout\tocfile
6039  %
6040  % Don't need to put `Contents' or `Short Contents' in the headline.
6041  % It is abundantly clear what they are.
6042  \chapmacro{#1}{Yomitfromtoc}{}%
6043  %
6044  \savepageno = \pageno
6045  \begingroup                  % Set up to handle contents files properly.
6046    \raggedbottom              % Worry more about breakpoints than the bottom.
6047    \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6048    %
6049    % Roman numerals for page numbers.
6050    \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6051}
6052
6053% redefined for the two-volume lispref.  We always output on
6054% \jobname.toc even if this is redefined.
6055%
6056\def\tocreadfilename{\jobname.toc}
6057
6058% Normal (long) toc.
6059%
6060\def\contents{%
6061  \startcontents{\putwordTOC}%
6062    \openin 1 \tocreadfilename\space
6063    \ifeof 1 \else
6064      \readtocfile
6065    \fi
6066    \vfill \eject
6067    \contentsalignmacro % in case @setchapternewpage odd is in effect
6068    \ifeof 1 \else
6069      \pdfmakeoutlines
6070    \fi
6071    \closein 1
6072  \endgroup
6073  \lastnegativepageno = \pageno
6074  \global\pageno = \savepageno
6075}
6076
6077% And just the chapters.
6078\def\summarycontents{%
6079  \startcontents{\putwordShortTOC}%
6080    %
6081    \let\partentry = \shortpartentry
6082    \let\numchapentry = \shortchapentry
6083    \let\appentry = \shortchapentry
6084    \let\unnchapentry = \shortunnchapentry
6085    % We want a true roman here for the page numbers.
6086    \secfonts
6087    \let\rm=\shortcontrm \let\bf=\shortcontbf
6088    \let\sl=\shortcontsl \let\tt=\shortconttt
6089    \rm
6090    \hyphenpenalty = 10000
6091    \advance\baselineskip by 1pt % Open it up a little.
6092    \def\numsecentry##1##2##3##4{}
6093    \let\appsecentry = \numsecentry
6094    \let\unnsecentry = \numsecentry
6095    \let\numsubsecentry = \numsecentry
6096    \let\appsubsecentry = \numsecentry
6097    \let\unnsubsecentry = \numsecentry
6098    \let\numsubsubsecentry = \numsecentry
6099    \let\appsubsubsecentry = \numsecentry
6100    \let\unnsubsubsecentry = \numsecentry
6101    \openin 1 \tocreadfilename\space
6102    \ifeof 1 \else
6103      \readtocfile
6104    \fi
6105    \closein 1
6106    \vfill \eject
6107    \contentsalignmacro % in case @setchapternewpage odd is in effect
6108  \endgroup
6109  \lastnegativepageno = \pageno
6110  \global\pageno = \savepageno
6111}
6112\let\shortcontents = \summarycontents
6113
6114% Typeset the label for a chapter or appendix for the short contents.
6115% The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6116%
6117\def\shortchaplabel#1{%
6118  % This space should be enough, since a single number is .5em, and the
6119  % widest letter (M) is 1em, at least in the Computer Modern fonts.
6120  % But use \hss just in case.
6121  % (This space doesn't include the extra space that gets added after
6122  % the label; that gets put in by \shortchapentry above.)
6123  %
6124  % We'd like to right-justify chapter numbers, but that looks strange
6125  % with appendix letters.  And right-justifying numbers and
6126  % left-justifying letters looks strange when there is less than 10
6127  % chapters.  Have to read the whole toc once to know how many chapters
6128  % there are before deciding ...
6129  \hbox to 1em{#1\hss}%
6130}
6131
6132% These macros generate individual entries in the table of contents.
6133% The first argument is the chapter or section name.
6134% The last argument is the page number.
6135% The arguments in between are the chapter number, section number, ...
6136
6137% Parts, in the main contents.  Replace the part number, which doesn't
6138% exist, with an empty box.  Let's hope all the numbers have the same width.
6139% Also ignore the page number, which is conventionally not printed.
6140\def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6141\def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6142%
6143% Parts, in the short toc.
6144\def\shortpartentry#1#2#3#4{%
6145  \penalty-300
6146  \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6147  \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6148}
6149
6150% Chapters, in the main contents.
6151\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6152%
6153% Chapters, in the short toc.
6154% See comments in \dochapentry re vbox and related settings.
6155\def\shortchapentry#1#2#3#4{%
6156  \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6157}
6158
6159% Appendices, in the main contents.
6160% Need the word Appendix, and a fixed-size box.
6161%
6162\def\appendixbox#1{%
6163  % We use M since it's probably the widest letter.
6164  \setbox0 = \hbox{\putwordAppendix{} M}%
6165  \hbox to \wd0{\putwordAppendix{} #1\hss}}
6166%
6167\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6168
6169% Unnumbered chapters.
6170\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6171\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6172
6173% Sections.
6174\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6175\let\appsecentry=\numsecentry
6176\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6177
6178% Subsections.
6179\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6180\let\appsubsecentry=\numsubsecentry
6181\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6182
6183% And subsubsections.
6184\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6185\let\appsubsubsecentry=\numsubsubsecentry
6186\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6187
6188% This parameter controls the indentation of the various levels.
6189% Same as \defaultparindent.
6190\newdimen\tocindent \tocindent = 15pt
6191
6192% Now for the actual typesetting. In all these, #1 is the text and #2 is the
6193% page number.
6194%
6195% If the toc has to be broken over pages, we want it to be at chapters
6196% if at all possible; hence the \penalty.
6197\def\dochapentry#1#2{%
6198   \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6199   \begingroup
6200     \chapentryfonts
6201     \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6202   \endgroup
6203   \nobreak\vskip .25\baselineskip plus.1\baselineskip
6204}
6205
6206\def\dosecentry#1#2{\begingroup
6207  \secentryfonts \leftskip=\tocindent
6208  \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6209\endgroup}
6210
6211\def\dosubsecentry#1#2{\begingroup
6212  \subsecentryfonts \leftskip=2\tocindent
6213  \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6214\endgroup}
6215
6216\def\dosubsubsecentry#1#2{\begingroup
6217  \subsubsecentryfonts \leftskip=3\tocindent
6218  \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6219\endgroup}
6220
6221% We use the same \entry macro as for the index entries.
6222\let\tocentry = \entry
6223
6224% Space between chapter (or whatever) number and the title.
6225\def\labelspace{\hskip1em \relax}
6226
6227\def\dopageno#1{{\rm #1}}
6228\def\doshortpageno#1{{\rm #1}}
6229
6230\def\chapentryfonts{\secfonts \rm}
6231\def\secentryfonts{\textfonts}
6232\def\subsecentryfonts{\textfonts}
6233\def\subsubsecentryfonts{\textfonts}
6234
6235
6236\message{environments,}
6237% @foo ... @end foo.
6238
6239% @tex ... @end tex    escapes into raw TeX temporarily.
6240% One exception: @ is still an escape character, so that @end tex works.
6241% But \@ or @@ will get a plain @ character.
6242
6243\envdef\tex{%
6244  \setupmarkupstyle{tex}%
6245  \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6246  \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6247  \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6248  \catcode `\%=14
6249  \catcode `\+=\other
6250  \catcode `\"=\other
6251  \catcode `\|=\other
6252  \catcode `\<=\other
6253  \catcode `\>=\other
6254  \catcode`\`=\other
6255  \catcode`\'=\other
6256  \escapechar=`\\
6257  %
6258  % ' is active in math mode (mathcode"8000).  So reset it, and all our
6259  % other math active characters (just in case), to plain's definitions.
6260  \mathactive
6261  %
6262  \let\b=\ptexb
6263  \let\bullet=\ptexbullet
6264  \let\c=\ptexc
6265  \let\,=\ptexcomma
6266  \let\.=\ptexdot
6267  \let\dots=\ptexdots
6268  \let\equiv=\ptexequiv
6269  \let\!=\ptexexclam
6270  \let\i=\ptexi
6271  \let\indent=\ptexindent
6272  \let\noindent=\ptexnoindent
6273  \let\{=\ptexlbrace
6274  \let\+=\tabalign
6275  \let\}=\ptexrbrace
6276  \let\/=\ptexslash
6277  \let\*=\ptexstar
6278  \let\t=\ptext
6279  \expandafter \let\csname top\endcsname=\ptextop  % outer
6280  \let\frenchspacing=\plainfrenchspacing
6281  %
6282  \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6283  \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6284  \def\@{@}%
6285}
6286% There is no need to define \Etex.
6287
6288% Define @lisp ... @end lisp.
6289% @lisp environment forms a group so it can rebind things,
6290% including the definition of @end lisp (which normally is erroneous).
6291
6292% Amount to narrow the margins by for @lisp.
6293\newskip\lispnarrowing \lispnarrowing=0.4in
6294
6295% This is the definition that ^^M gets inside @lisp, @example, and other
6296% such environments.  \null is better than a space, since it doesn't
6297% have any width.
6298\def\lisppar{\null\endgraf}
6299
6300% This space is always present above and below environments.
6301\newskip\envskipamount \envskipamount = 0pt
6302
6303% Make spacing and below environment symmetrical.  We use \parskip here
6304% to help in doing that, since in @example-like environments \parskip
6305% is reset to zero; thus the \afterenvbreak inserts no space -- but the
6306% start of the next paragraph will insert \parskip.
6307%
6308\def\aboveenvbreak{{%
6309  % =10000 instead of <10000 because of a special case in \itemzzz and
6310  % \sectionheading, q.v.
6311  \ifnum \lastpenalty=10000 \else
6312    \advance\envskipamount by \parskip
6313    \endgraf
6314    \ifdim\lastskip<\envskipamount
6315      \removelastskip
6316      % it's not a good place to break if the last penalty was \nobreak
6317      % or better ...
6318      \ifnum\lastpenalty<10000 \penalty-50 \fi
6319      \vskip\envskipamount
6320    \fi
6321  \fi
6322}}
6323
6324\let\afterenvbreak = \aboveenvbreak
6325
6326% \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
6327% also clear it, so that its embedded environments do the narrowing again.
6328\let\nonarrowing=\relax
6329
6330% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6331% environment contents.
6332\font\circle=lcircle10
6333\newdimen\circthick
6334\newdimen\cartouter\newdimen\cartinner
6335\newskip\normbskip\newskip\normpskip\newskip\normlskip
6336\circthick=\fontdimen8\circle
6337%
6338\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6339\def\ctr{{\hskip 6pt\circle\char'010}}
6340\def\cbl{{\circle\char'012\hskip -6pt}}
6341\def\cbr{{\hskip 6pt\circle\char'011}}
6342\def\carttop{\hbox to \cartouter{\hskip\lskip
6343        \ctl\leaders\hrule height\circthick\hfil\ctr
6344        \hskip\rskip}}
6345\def\cartbot{\hbox to \cartouter{\hskip\lskip
6346        \cbl\leaders\hrule height\circthick\hfil\cbr
6347        \hskip\rskip}}
6348%
6349\newskip\lskip\newskip\rskip
6350
6351\envdef\cartouche{%
6352  \ifhmode\par\fi  % can't be in the midst of a paragraph.
6353  \startsavinginserts
6354  \lskip=\leftskip \rskip=\rightskip
6355  \leftskip=0pt\rightskip=0pt % we want these *outside*.
6356  \cartinner=\hsize \advance\cartinner by-\lskip
6357  \advance\cartinner by-\rskip
6358  \cartouter=\hsize
6359  \advance\cartouter by 18.4pt	% allow for 3pt kerns on either
6360				% side, and for 6pt waste from
6361				% each corner char, and rule thickness
6362  \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6363  % Flag to tell @lisp, etc., not to narrow margin.
6364  \let\nonarrowing = t%
6365  %
6366  % If this cartouche directly follows a sectioning command, we need the
6367  % \parskip glue (backspaced over by default) or the cartouche can
6368  % collide with the section heading.
6369  \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6370  %
6371  \vbox\bgroup
6372      \baselineskip=0pt\parskip=0pt\lineskip=0pt
6373      \carttop
6374      \hbox\bgroup
6375	  \hskip\lskip
6376	  \vrule\kern3pt
6377	  \vbox\bgroup
6378	      \kern3pt
6379	      \hsize=\cartinner
6380	      \baselineskip=\normbskip
6381	      \lineskip=\normlskip
6382	      \parskip=\normpskip
6383	      \vskip -\parskip
6384	      \comment % For explanation, see the end of def\group.
6385}
6386\def\Ecartouche{%
6387              \ifhmode\par\fi
6388	      \kern3pt
6389	  \egroup
6390	  \kern3pt\vrule
6391	  \hskip\rskip
6392      \egroup
6393      \cartbot
6394  \egroup
6395  \checkinserts
6396}
6397
6398
6399% This macro is called at the beginning of all the @example variants,
6400% inside a group.
6401\newdimen\nonfillparindent
6402\def\nonfillstart{%
6403  \aboveenvbreak
6404  \hfuzz = 12pt % Don't be fussy
6405  \sepspaces % Make spaces be word-separators rather than space tokens.
6406  \let\par = \lisppar % don't ignore blank lines
6407  \obeylines % each line of input is a line of output
6408  \parskip = 0pt
6409  % Turn off paragraph indentation but redefine \indent to emulate
6410  % the normal \indent.
6411  \nonfillparindent=\parindent
6412  \parindent = 0pt
6413  \let\indent\nonfillindent
6414  %
6415  \emergencystretch = 0pt % don't try to avoid overfull boxes
6416  \ifx\nonarrowing\relax
6417    \advance \leftskip by \lispnarrowing
6418    \exdentamount=\lispnarrowing
6419  \else
6420    \let\nonarrowing = \relax
6421  \fi
6422  \let\exdent=\nofillexdent
6423}
6424
6425\begingroup
6426\obeyspaces
6427% We want to swallow spaces (but not other tokens) after the fake
6428% @indent in our nonfill-environments, where spaces are normally
6429% active and set to @tie, resulting in them not being ignored after
6430% @indent.
6431\gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6432\gdef\nonfillindentcheck{%
6433\ifx\temp %
6434\expandafter\nonfillindentgobble%
6435\else%
6436\leavevmode\nonfillindentbox%
6437\fi%
6438}%
6439\endgroup
6440\def\nonfillindentgobble#1{\nonfillindent}
6441\def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6442
6443% If you want all examples etc. small: @set dispenvsize small.
6444% If you want even small examples the full size: @set dispenvsize nosmall.
6445% This affects the following displayed environments:
6446%    @example, @display, @format, @lisp
6447%
6448\def\smallword{small}
6449\def\nosmallword{nosmall}
6450\let\SETdispenvsize\relax
6451\def\setnormaldispenv{%
6452  \ifx\SETdispenvsize\smallword
6453    % end paragraph for sake of leading, in case document has no blank
6454    % line.  This is redundant with what happens in \aboveenvbreak, but
6455    % we need to do it before changing the fonts, and it's inconvenient
6456    % to change the fonts afterward.
6457    \ifnum \lastpenalty=10000 \else \endgraf \fi
6458    \smallexamplefonts \rm
6459  \fi
6460}
6461\def\setsmalldispenv{%
6462  \ifx\SETdispenvsize\nosmallword
6463  \else
6464    \ifnum \lastpenalty=10000 \else \endgraf \fi
6465    \smallexamplefonts \rm
6466  \fi
6467}
6468
6469% We often define two environments, @foo and @smallfoo.
6470% Let's do it in one command.  #1 is the env name, #2 the definition.
6471\def\makedispenvdef#1#2{%
6472  \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6473  \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6474  \expandafter\let\csname E#1\endcsname \afterenvbreak
6475  \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6476}
6477
6478% Define two environment synonyms (#1 and #2) for an environment.
6479\def\maketwodispenvdef#1#2#3{%
6480  \makedispenvdef{#1}{#3}%
6481  \makedispenvdef{#2}{#3}%
6482}
6483%
6484% @lisp: indented, narrowed, typewriter font;
6485% @example: same as @lisp.
6486%
6487% @smallexample and @smalllisp: use smaller fonts.
6488% Originally contributed by Pavel@xerox.
6489%
6490\maketwodispenvdef{lisp}{example}{%
6491  \nonfillstart
6492  \tt\setupmarkupstyle{example}%
6493  \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6494  \gobble % eat return
6495}
6496% @display/@smalldisplay: same as @lisp except keep current font.
6497%
6498\makedispenvdef{display}{%
6499  \nonfillstart
6500  \gobble
6501}
6502
6503% @format/@smallformat: same as @display except don't narrow margins.
6504%
6505\makedispenvdef{format}{%
6506  \let\nonarrowing = t%
6507  \nonfillstart
6508  \gobble
6509}
6510
6511% @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6512\envdef\flushleft{%
6513  \let\nonarrowing = t%
6514  \nonfillstart
6515  \gobble
6516}
6517\let\Eflushleft = \afterenvbreak
6518
6519% @flushright.
6520%
6521\envdef\flushright{%
6522  \let\nonarrowing = t%
6523  \nonfillstart
6524  \advance\leftskip by 0pt plus 1fill\relax
6525  \gobble
6526}
6527\let\Eflushright = \afterenvbreak
6528
6529
6530% @raggedright does more-or-less normal line breaking but no right
6531% justification.  From plain.tex.
6532\envdef\raggedright{%
6533  \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6534}
6535\let\Eraggedright\par
6536
6537\envdef\raggedleft{%
6538  \parindent=0pt \leftskip0pt plus2em
6539  \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6540  \hbadness=10000 % Last line will usually be underfull, so turn off
6541                  % badness reporting.
6542}
6543\let\Eraggedleft\par
6544
6545\envdef\raggedcenter{%
6546  \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6547  \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6548  \hbadness=10000 % Last line will usually be underfull, so turn off
6549                  % badness reporting.
6550}
6551\let\Eraggedcenter\par
6552
6553
6554% @quotation does normal linebreaking (hence we can't use \nonfillstart)
6555% and narrows the margins.  We keep \parskip nonzero in general, since
6556% we're doing normal filling.  So, when using \aboveenvbreak and
6557% \afterenvbreak, temporarily make \parskip 0.
6558%
6559\makedispenvdef{quotation}{\quotationstart}
6560%
6561\def\quotationstart{%
6562  \indentedblockstart % same as \indentedblock, but increase right margin too.
6563  \ifx\nonarrowing\relax
6564    \advance\rightskip by \lispnarrowing
6565  \fi
6566  \parsearg\quotationlabel
6567}
6568
6569% We have retained a nonzero parskip for the environment, since we're
6570% doing normal filling.
6571%
6572\def\Equotation{%
6573  \par
6574  \ifx\quotationauthor\thisisundefined\else
6575    % indent a bit.
6576    \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6577  \fi
6578  {\parskip=0pt \afterenvbreak}%
6579}
6580\def\Esmallquotation{\Equotation}
6581
6582% If we're given an argument, typeset it in bold with a colon after.
6583\def\quotationlabel#1{%
6584  \def\temp{#1}%
6585  \ifx\temp\empty \else
6586    {\bf #1: }%
6587  \fi
6588}
6589
6590% @indentedblock is like @quotation, but indents only on the left and
6591% has no optional argument.
6592% 
6593\makedispenvdef{indentedblock}{\indentedblockstart}
6594%
6595\def\indentedblockstart{%
6596  {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6597  \parindent=0pt
6598  %
6599  % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6600  \ifx\nonarrowing\relax
6601    \advance\leftskip by \lispnarrowing
6602    \exdentamount = \lispnarrowing
6603  \else
6604    \let\nonarrowing = \relax
6605  \fi
6606}
6607
6608% Keep a nonzero parskip for the environment, since we're doing normal filling.
6609%
6610\def\Eindentedblock{%
6611  \par
6612  {\parskip=0pt \afterenvbreak}%
6613}
6614\def\Esmallindentedblock{\Eindentedblock}
6615
6616
6617% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6618% If we want to allow any <char> as delimiter,
6619% we need the curly braces so that makeinfo sees the @verb command, eg:
6620% `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
6621%
6622% [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
6623%
6624% [Knuth] p.344; only we need to do the other characters Texinfo sets
6625% active too.  Otherwise, they get lost as the first character on a
6626% verbatim line.
6627\def\dospecials{%
6628  \do\ \do\\\do\{\do\}\do\$\do\&%
6629  \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6630  \do\<\do\>\do\|\do\@\do+\do\"%
6631  % Don't do the quotes -- if we do, @set txicodequoteundirected and
6632  % @set txicodequotebacktick will not have effect on @verb and
6633  % @verbatim, and ?` and !` ligatures won't get disabled.
6634  %\do\`\do\'%
6635}
6636%
6637% [Knuth] p. 380
6638\def\uncatcodespecials{%
6639  \def\do##1{\catcode`##1=\other}\dospecials}
6640%
6641% Setup for the @verb command.
6642%
6643% Eight spaces for a tab
6644\begingroup
6645  \catcode`\^^I=\active
6646  \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6647\endgroup
6648%
6649\def\setupverb{%
6650  \tt  % easiest (and conventionally used) font for verbatim
6651  \def\par{\leavevmode\endgraf}%
6652  \setupmarkupstyle{verb}%
6653  \tabeightspaces
6654  % Respect line breaks,
6655  % print special symbols as themselves, and
6656  % make each space count
6657  % must do in this order:
6658  \obeylines \uncatcodespecials \sepspaces
6659}
6660
6661% Setup for the @verbatim environment
6662%
6663% Real tab expansion.
6664\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6665%
6666% We typeset each line of the verbatim in an \hbox, so we can handle
6667% tabs.  The \global is in case the verbatim line starts with an accent,
6668% or some other command that starts with a begin-group.  Otherwise, the
6669% entire \verbbox would disappear at the corresponding end-group, before
6670% it is typeset.  Meanwhile, we can't have nested verbatim commands
6671% (can we?), so the \global won't be overwriting itself.
6672\newbox\verbbox
6673\def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6674%
6675\begingroup
6676  \catcode`\^^I=\active
6677  \gdef\tabexpand{%
6678    \catcode`\^^I=\active
6679    \def^^I{\leavevmode\egroup
6680      \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6681      \divide\dimen\verbbox by\tabw
6682      \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6683      \advance\dimen\verbbox by\tabw  % advance to next multiple of \tabw
6684      \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6685    }%
6686  }
6687\endgroup
6688
6689% start the verbatim environment.
6690\def\setupverbatim{%
6691  \let\nonarrowing = t%
6692  \nonfillstart
6693  \tt % easiest (and conventionally used) font for verbatim
6694  % The \leavevmode here is for blank lines.  Otherwise, we would
6695  % never \starttabox and the \egroup would end verbatim mode.
6696  \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6697  \tabexpand
6698  \setupmarkupstyle{verbatim}%
6699  % Respect line breaks,
6700  % print special symbols as themselves, and
6701  % make each space count.
6702  % Must do in this order:
6703  \obeylines \uncatcodespecials \sepspaces
6704  \everypar{\starttabbox}%
6705}
6706
6707% Do the @verb magic: verbatim text is quoted by unique
6708% delimiter characters.  Before first delimiter expect a
6709% right brace, after last delimiter expect closing brace:
6710%
6711%    \def\doverb'{'<char>#1<char>'}'{#1}
6712%
6713% [Knuth] p. 382; only eat outer {}
6714\begingroup
6715  \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6716  \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6717\endgroup
6718%
6719\def\verb{\begingroup\setupverb\doverb}
6720%
6721%
6722% Do the @verbatim magic: define the macro \doverbatim so that
6723% the (first) argument ends when '@end verbatim' is reached, ie:
6724%
6725%     \def\doverbatim#1@end verbatim{#1}
6726%
6727% For Texinfo it's a lot easier than for LaTeX,
6728% because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6729% we need not redefine '\', '{' and '}'.
6730%
6731% Inspired by LaTeX's verbatim command set [latex.ltx]
6732%
6733\begingroup
6734  \catcode`\ =\active
6735  \obeylines %
6736  % ignore everything up to the first ^^M, that's the newline at the end
6737  % of the @verbatim input line itself.  Otherwise we get an extra blank
6738  % line in the output.
6739  \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6740  % We really want {...\end verbatim} in the body of the macro, but
6741  % without the active space; thus we have to use \xdef and \gobble.
6742\endgroup
6743%
6744\envdef\verbatim{%
6745    \setupverbatim\doverbatim
6746}
6747\let\Everbatim = \afterenvbreak
6748
6749
6750% @verbatiminclude FILE - insert text of file in verbatim environment.
6751%
6752\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6753%
6754\def\doverbatiminclude#1{%
6755  {%
6756    \makevalueexpandable
6757    \setupverbatim
6758    \indexnofonts       % Allow `@@' and other weird things in file names.
6759    \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6760    \input #1
6761    \afterenvbreak
6762  }%
6763}
6764
6765% @copying ... @end copying.
6766% Save the text away for @insertcopying later.
6767%
6768% We save the uninterpreted tokens, rather than creating a box.
6769% Saving the text in a box would be much easier, but then all the
6770% typesetting commands (@smallbook, font changes, etc.) have to be done
6771% beforehand -- and a) we want @copying to be done first in the source
6772% file; b) letting users define the frontmatter in as flexible order as
6773% possible is very desirable.
6774%
6775\def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6776\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6777%
6778\def\insertcopying{%
6779  \begingroup
6780    \parindent = 0pt  % paragraph indentation looks wrong on title page
6781    \scanexp\copyingtext
6782  \endgroup
6783}
6784
6785
6786\message{defuns,}
6787% @defun etc.
6788
6789\newskip\defbodyindent \defbodyindent=.4in
6790\newskip\defargsindent \defargsindent=50pt
6791\newskip\deflastargmargin \deflastargmargin=18pt
6792\newcount\defunpenalty
6793
6794% Start the processing of @deffn:
6795\def\startdefun{%
6796  \ifnum\lastpenalty<10000
6797    \medbreak
6798    \defunpenalty=10003 % Will keep this @deffn together with the
6799                        % following @def command, see below.
6800  \else
6801    % If there are two @def commands in a row, we'll have a \nobreak,
6802    % which is there to keep the function description together with its
6803    % header.  But if there's nothing but headers, we need to allow a
6804    % break somewhere.  Check specifically for penalty 10002, inserted
6805    % by \printdefunline, instead of 10000, since the sectioning
6806    % commands also insert a nobreak penalty, and we don't want to allow
6807    % a break between a section heading and a defun.
6808    %
6809    % As a further refinement, we avoid "club" headers by signalling
6810    % with penalty of 10003 after the very first @deffn in the
6811    % sequence (see above), and penalty of 10002 after any following
6812    % @def command.
6813    \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6814    %
6815    % Similarly, after a section heading, do not allow a break.
6816    % But do insert the glue.
6817    \medskip  % preceded by discardable penalty, so not a breakpoint
6818  \fi
6819  %
6820  \parindent=0in
6821  \advance\leftskip by \defbodyindent
6822  \exdentamount=\defbodyindent
6823}
6824
6825\def\dodefunx#1{%
6826  % First, check whether we are in the right environment:
6827  \checkenv#1%
6828  %
6829  % As above, allow line break if we have multiple x headers in a row.
6830  % It's not a great place, though.
6831  \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6832  %
6833  % And now, it's time to reuse the body of the original defun:
6834  \expandafter\gobbledefun#1%
6835}
6836\def\gobbledefun#1\startdefun{}
6837
6838% \printdefunline \deffnheader{text}
6839%
6840\def\printdefunline#1#2{%
6841  \begingroup
6842    % call \deffnheader:
6843    #1#2 \endheader
6844    % common ending:
6845    \interlinepenalty = 10000
6846    \advance\rightskip by 0pt plus 1fil\relax
6847    \endgraf
6848    \nobreak\vskip -\parskip
6849    \penalty\defunpenalty  % signal to \startdefun and \dodefunx
6850    % Some of the @defun-type tags do not enable magic parentheses,
6851    % rendering the following check redundant.  But we don't optimize.
6852    \checkparencounts
6853  \endgroup
6854}
6855
6856\def\Edefun{\endgraf\medbreak}
6857
6858% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6859% the only thing remaining is to define \deffnheader.
6860%
6861\def\makedefun#1{%
6862  \expandafter\let\csname E#1\endcsname = \Edefun
6863  \edef\temp{\noexpand\domakedefun
6864    \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6865  \temp
6866}
6867
6868% \domakedefun \deffn \deffnx \deffnheader
6869%
6870% Define \deffn and \deffnx, without parameters.
6871% \deffnheader has to be defined explicitly.
6872%
6873\def\domakedefun#1#2#3{%
6874  \envdef#1{%
6875    \startdefun
6876    \doingtypefnfalse    % distinguish typed functions from all else
6877    \parseargusing\activeparens{\printdefunline#3}%
6878  }%
6879  \def#2{\dodefunx#1}%
6880  \def#3%
6881}
6882
6883\newif\ifdoingtypefn       % doing typed function?
6884\newif\ifrettypeownline    % typeset return type on its own line?
6885
6886% @deftypefnnewline on|off says whether the return type of typed functions
6887% are printed on their own line.  This affects @deftypefn, @deftypefun,
6888% @deftypeop, and @deftypemethod.
6889% 
6890\parseargdef\deftypefnnewline{%
6891  \def\temp{#1}%
6892  \ifx\temp\onword
6893    \expandafter\let\csname SETtxideftypefnnl\endcsname
6894      = \empty
6895  \else\ifx\temp\offword
6896    \expandafter\let\csname SETtxideftypefnnl\endcsname
6897      = \relax
6898  \else
6899    \errhelp = \EMsimple
6900    \errmessage{Unknown @txideftypefnnl value `\temp',
6901                must be on|off}%
6902  \fi\fi
6903}
6904
6905% Untyped functions:
6906
6907% @deffn category name args
6908\makedefun{deffn}{\deffngeneral{}}
6909
6910% @deffn category class name args
6911\makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6912
6913% \defopon {category on}class name args
6914\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6915
6916% \deffngeneral {subind}category name args
6917%
6918\def\deffngeneral#1#2 #3 #4\endheader{%
6919  % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6920  \dosubind{fn}{\code{#3}}{#1}%
6921  \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6922}
6923
6924% Typed functions:
6925
6926% @deftypefn category type name args
6927\makedefun{deftypefn}{\deftypefngeneral{}}
6928
6929% @deftypeop category class type name args
6930\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6931
6932% \deftypeopon {category on}class type name args
6933\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6934
6935% \deftypefngeneral {subind}category type name args
6936%
6937\def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6938  \dosubind{fn}{\code{#4}}{#1}%
6939  \doingtypefntrue
6940  \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6941}
6942
6943% Typed variables:
6944
6945% @deftypevr category type var args
6946\makedefun{deftypevr}{\deftypecvgeneral{}}
6947
6948% @deftypecv category class type var args
6949\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6950
6951% \deftypecvof {category of}class type var args
6952\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6953
6954% \deftypecvgeneral {subind}category type var args
6955%
6956\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6957  \dosubind{vr}{\code{#4}}{#1}%
6958  \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6959}
6960
6961% Untyped variables:
6962
6963% @defvr category var args
6964\makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6965
6966% @defcv category class var args
6967\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6968
6969% \defcvof {category of}class var args
6970\def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6971
6972% Types:
6973
6974% @deftp category name args
6975\makedefun{deftp}#1 #2 #3\endheader{%
6976  \doind{tp}{\code{#2}}%
6977  \defname{#1}{}{#2}\defunargs{#3\unskip}%
6978}
6979
6980% Remaining @defun-like shortcuts:
6981\makedefun{defun}{\deffnheader{\putwordDeffunc} }
6982\makedefun{defmac}{\deffnheader{\putwordDefmac} }
6983\makedefun{defspec}{\deffnheader{\putwordDefspec} }
6984\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6985\makedefun{defvar}{\defvrheader{\putwordDefvar} }
6986\makedefun{defopt}{\defvrheader{\putwordDefopt} }
6987\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6988\makedefun{defmethod}{\defopon\putwordMethodon}
6989\makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6990\makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6991\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6992
6993% \defname, which formats the name of the @def (not the args).
6994% #1 is the category, such as "Function".
6995% #2 is the return type, if any.
6996% #3 is the function name.
6997%
6998% We are followed by (but not passed) the arguments, if any.
6999%
7000\def\defname#1#2#3{%
7001  \par
7002  % Get the values of \leftskip and \rightskip as they were outside the @def...
7003  \advance\leftskip by -\defbodyindent
7004  %
7005  % Determine if we are typesetting the return type of a typed function
7006  % on a line by itself.
7007  \rettypeownlinefalse
7008  \ifdoingtypefn  % doing a typed function specifically?
7009    % then check user option for putting return type on its own line:
7010    \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7011      \rettypeownlinetrue
7012    \fi
7013  \fi
7014  %
7015  % How we'll format the category name.  Putting it in brackets helps
7016  % distinguish it from the body text that may end up on the next line
7017  % just below it.
7018  \def\temp{#1}%
7019  \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7020  %
7021  % Figure out line sizes for the paragraph shape.  We'll always have at
7022  % least two.
7023  \tempnum = 2
7024  %
7025  % The first line needs space for \box0; but if \rightskip is nonzero,
7026  % we need only space for the part of \box0 which exceeds it:
7027  \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
7028  %
7029  % If doing a return type on its own line, we'll have another line.
7030  \ifrettypeownline
7031    \advance\tempnum by 1
7032    \def\maybeshapeline{0in \hsize}%
7033  \else
7034    \def\maybeshapeline{}%
7035  \fi
7036  %
7037  % The continuations:
7038  \dimen2=\hsize  \advance\dimen2 by -\defargsindent
7039  %
7040  % The final paragraph shape:
7041  \parshape \tempnum  0in \dimen0  \maybeshapeline  \defargsindent \dimen2
7042  %
7043  % Put the category name at the right margin.
7044  \noindent
7045  \hbox to 0pt{%
7046    \hfil\box0 \kern-\hsize
7047    % \hsize has to be shortened this way:
7048    \kern\leftskip
7049    % Intentionally do not respect \rightskip, since we need the space.
7050  }%
7051  %
7052  % Allow all lines to be underfull without complaint:
7053  \tolerance=10000 \hbadness=10000
7054  \exdentamount=\defbodyindent
7055  {%
7056    % defun fonts. We use typewriter by default (used to be bold) because:
7057    % . we're printing identifiers, they should be in tt in principle.
7058    % . in languages with many accents, such as Czech or French, it's
7059    %   common to leave accents off identifiers.  The result looks ok in
7060    %   tt, but exceedingly strange in rm.
7061    % . we don't want -- and --- to be treated as ligatures.
7062    % . this still does not fix the ?` and !` ligatures, but so far no
7063    %   one has made identifiers using them :).
7064    \df \tt
7065    \def\temp{#2}% text of the return type
7066    \ifx\temp\empty\else
7067      \tclose{\temp}% typeset the return type
7068      \ifrettypeownline
7069        % put return type on its own line; prohibit line break following:
7070        \hfil\vadjust{\nobreak}\break  
7071      \else
7072        \space  % type on same line, so just followed by a space
7073      \fi
7074    \fi           % no return type
7075    #3% output function name
7076  }%
7077  {\rm\enskip}% hskip 0.5 em of \tenrm
7078  %
7079  \boldbrax
7080  % arguments will be output next, if any.
7081}
7082
7083% Print arguments in slanted roman (not ttsl), inconsistently with using
7084% tt for the name.  This is because literal text is sometimes needed in
7085% the argument list (groff manual), and ttsl and tt are not very
7086% distinguishable.  Prevent hyphenation at `-' chars.
7087%
7088\def\defunargs#1{%
7089  % use sl by default (not ttsl),
7090  % tt for the names.
7091  \df \sl \hyphenchar\font=0
7092  %
7093  % On the other hand, if an argument has two dashes (for instance), we
7094  % want a way to get ttsl.  We used to recommend @var for that, so
7095  % leave the code in, but it's strange for @var to lead to typewriter.
7096  % Nowadays we recommend @code, since the difference between a ttsl hyphen
7097  % and a tt hyphen is pretty tiny.  @code also disables ?` !`.
7098  \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7099  #1%
7100  \sl\hyphenchar\font=45
7101}
7102
7103% We want ()&[] to print specially on the defun line.
7104%
7105\def\activeparens{%
7106  \catcode`\(=\active \catcode`\)=\active
7107  \catcode`\[=\active \catcode`\]=\active
7108  \catcode`\&=\active
7109}
7110
7111% Make control sequences which act like normal parenthesis chars.
7112\let\lparen = ( \let\rparen = )
7113
7114% Be sure that we always have a definition for `(', etc.  For example,
7115% if the fn name has parens in it, \boldbrax will not be in effect yet,
7116% so TeX would otherwise complain about undefined control sequence.
7117{
7118  \activeparens
7119  \global\let(=\lparen \global\let)=\rparen
7120  \global\let[=\lbrack \global\let]=\rbrack
7121  \global\let& = \&
7122
7123  \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7124  \gdef\magicamp{\let&=\amprm}
7125}
7126
7127\newcount\parencount
7128
7129% If we encounter &foo, then turn on ()-hacking afterwards
7130\newif\ifampseen
7131\def\amprm#1 {\ampseentrue{\bf\&#1 }}
7132
7133\def\parenfont{%
7134  \ifampseen
7135    % At the first level, print parens in roman,
7136    % otherwise use the default font.
7137    \ifnum \parencount=1 \rm \fi
7138  \else
7139    % The \sf parens (in \boldbrax) actually are a little bolder than
7140    % the contained text.  This is especially needed for [ and ] .
7141    \sf
7142  \fi
7143}
7144\def\infirstlevel#1{%
7145  \ifampseen
7146    \ifnum\parencount=1
7147      #1%
7148    \fi
7149  \fi
7150}
7151\def\bfafterword#1 {#1 \bf}
7152
7153\def\opnr{%
7154  \global\advance\parencount by 1
7155  {\parenfont(}%
7156  \infirstlevel \bfafterword
7157}
7158\def\clnr{%
7159  {\parenfont)}%
7160  \infirstlevel \sl
7161  \global\advance\parencount by -1
7162}
7163
7164\newcount\brackcount
7165\def\lbrb{%
7166  \global\advance\brackcount by 1
7167  {\bf[}%
7168}
7169\def\rbrb{%
7170  {\bf]}%
7171  \global\advance\brackcount by -1
7172}
7173
7174\def\checkparencounts{%
7175  \ifnum\parencount=0 \else \badparencount \fi
7176  \ifnum\brackcount=0 \else \badbrackcount \fi
7177}
7178% these should not use \errmessage; the glibc manual, at least, actually
7179% has such constructs (when documenting function pointers).
7180\def\badparencount{%
7181  \message{Warning: unbalanced parentheses in @def...}%
7182  \global\parencount=0
7183}
7184\def\badbrackcount{%
7185  \message{Warning: unbalanced square brackets in @def...}%
7186  \global\brackcount=0
7187}
7188
7189
7190\message{macros,}
7191% @macro.
7192
7193% To do this right we need a feature of e-TeX, \scantokens,
7194% which we arrange to emulate with a temporary file in ordinary TeX.
7195\ifx\eTeXversion\thisisundefined
7196  \newwrite\macscribble
7197  \def\scantokens#1{%
7198    \toks0={#1}%
7199    \immediate\openout\macscribble=\jobname.tmp
7200    \immediate\write\macscribble{\the\toks0}%
7201    \immediate\closeout\macscribble
7202    \input \jobname.tmp
7203  }
7204\fi
7205
7206\def\scanmacro#1{\begingroup
7207  \newlinechar`\^^M
7208  \let\xeatspaces\eatspaces
7209  %
7210  % Undo catcode changes of \startcontents and \doprintindex
7211  % When called from @insertcopying or (short)caption, we need active
7212  % backslash to get it printed correctly.  Previously, we had
7213  % \catcode`\\=\other instead.  We'll see whether a problem appears
7214  % with macro expansion.				--kasal, 19aug04
7215  \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7216  %
7217  % ... and for \example:
7218  \spaceisspace
7219  %
7220  % The \empty here causes a following catcode 5 newline to be eaten as
7221  % part of reading whitespace after a control sequence.  It does not
7222  % eat a catcode 13 newline.  There's no good way to handle the two
7223  % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7224  % would then have different behavior).  See the Macro Details node in
7225  % the manual for the workaround we recommend for macros and
7226  % line-oriented commands.
7227  % 
7228  \scantokens{#1\empty}%
7229\endgroup}
7230
7231\def\scanexp#1{%
7232  \edef\temp{\noexpand\scanmacro{#1}}%
7233  \temp
7234}
7235
7236\newcount\paramno   % Count of parameters
7237\newtoks\macname    % Macro name
7238\newif\ifrecursive  % Is it recursive?
7239
7240% List of all defined macros in the form
7241%    \definedummyword\macro1\definedummyword\macro2...
7242% Currently is also contains all @aliases; the list can be split
7243% if there is a need.
7244\def\macrolist{}
7245
7246% Add the macro to \macrolist
7247\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7248\def\addtomacrolistxxx#1{%
7249     \toks0 = \expandafter{\macrolist\definedummyword#1}%
7250     \xdef\macrolist{\the\toks0}%
7251}
7252
7253% Utility routines.
7254% This does \let #1 = #2, with \csnames; that is,
7255%   \let \csname#1\endcsname = \csname#2\endcsname
7256% (except of course we have to play expansion games).
7257%
7258\def\cslet#1#2{%
7259  \expandafter\let
7260  \csname#1\expandafter\endcsname
7261  \csname#2\endcsname
7262}
7263
7264% Trim leading and trailing spaces off a string.
7265% Concepts from aro-bend problem 15 (see CTAN).
7266{\catcode`\@=11
7267\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7268\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7269\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7270\def\unbrace#1{#1}
7271\unbrace{\gdef\trim@@@ #1 } #2@{#1}
7272}
7273
7274% Trim a single trailing ^^M off a string.
7275{\catcode`\^^M=\other \catcode`\Q=3%
7276\gdef\eatcr #1{\eatcra #1Q^^MQ}%
7277\gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7278\gdef\eatcrb#1Q#2Q{#1}%
7279}
7280
7281% Macro bodies are absorbed as an argument in a context where
7282% all characters are catcode 10, 11 or 12, except \ which is active
7283% (as in normal texinfo). It is necessary to change the definition of \
7284% to recognize macro arguments; this is the job of \mbodybackslash.
7285%
7286% Non-ASCII encodings make 8-bit characters active, so un-activate
7287% them to avoid their expansion.  Must do this non-globally, to
7288% confine the change to the current group.
7289%
7290% It's necessary to have hard CRs when the macro is executed. This is
7291% done by making ^^M (\endlinechar) catcode 12 when reading the macro
7292% body, and then making it the \newlinechar in \scanmacro.
7293%
7294\def\scanctxt{% used as subroutine
7295  \catcode`\"=\other
7296  \catcode`\+=\other
7297  \catcode`\<=\other
7298  \catcode`\>=\other
7299  \catcode`\@=\other
7300  \catcode`\^=\other
7301  \catcode`\_=\other
7302  \catcode`\|=\other
7303  \catcode`\~=\other
7304  \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7305}
7306
7307\def\scanargctxt{% used for copying and captions, not macros.
7308  \scanctxt
7309  \catcode`\\=\other
7310  \catcode`\^^M=\other
7311}
7312
7313\def\macrobodyctxt{% used for @macro definitions
7314  \scanctxt
7315  \catcode`\{=\other
7316  \catcode`\}=\other
7317  \catcode`\^^M=\other
7318  \usembodybackslash
7319}
7320
7321\def\macroargctxt{% used when scanning invocations
7322  \scanctxt
7323  \catcode`\\=0
7324}
7325% why catcode 0 for \ in the above?  To recognize \\ \{ \} as "escapes"
7326% for the single characters \ { }.  Thus, we end up with the "commands"
7327% that would be written @\ @{ @} in a Texinfo document.
7328% 
7329% We already have @{ and @}.  For @\, we define it here, and only for
7330% this purpose, to produce a typewriter backslash (so, the @\ that we
7331% define for @math can't be used with @macro calls):
7332%
7333\def\\{\normalbackslash}%
7334% 
7335% We would like to do this for \, too, since that is what makeinfo does.
7336% But it is not possible, because Texinfo already has a command @, for a
7337% cedilla accent.  Documents must use @comma{} instead.
7338%
7339% \anythingelse will almost certainly be an error of some kind.
7340
7341
7342% \mbodybackslash is the definition of \ in @macro bodies.
7343% It maps \foo\ => \csname macarg.foo\endcsname => #N
7344% where N is the macro parameter number.
7345% We define \csname macarg.\endcsname to be \realbackslash, so
7346% \\ in macro replacement text gets you a backslash.
7347%
7348{\catcode`@=0 @catcode`@\=@active
7349 @gdef@usembodybackslash{@let\=@mbodybackslash}
7350 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7351}
7352\expandafter\def\csname macarg.\endcsname{\realbackslash}
7353
7354\def\margbackslash#1{\char`\#1 }
7355
7356\def\macro{\recursivefalse\parsearg\macroxxx}
7357\def\rmacro{\recursivetrue\parsearg\macroxxx}
7358
7359\def\macroxxx#1{%
7360  \getargs{#1}% now \macname is the macname and \argl the arglist
7361  \ifx\argl\empty       % no arguments
7362     \paramno=0\relax
7363  \else
7364     \expandafter\parsemargdef \argl;%
7365     \if\paramno>256\relax
7366       \ifx\eTeXversion\thisisundefined
7367         \errhelp = \EMsimple
7368         \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7369       \fi
7370     \fi
7371  \fi
7372  \if1\csname ismacro.\the\macname\endcsname
7373     \message{Warning: redefining \the\macname}%
7374  \else
7375     \expandafter\ifx\csname \the\macname\endcsname \relax
7376     \else \errmessage{Macro name \the\macname\space already defined}\fi
7377     \global\cslet{macsave.\the\macname}{\the\macname}%
7378     \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7379     \addtomacrolist{\the\macname}%
7380  \fi
7381  \begingroup \macrobodyctxt
7382  \ifrecursive \expandafter\parsermacbody
7383  \else \expandafter\parsemacbody
7384  \fi}
7385
7386\parseargdef\unmacro{%
7387  \if1\csname ismacro.#1\endcsname
7388    \global\cslet{#1}{macsave.#1}%
7389    \global\expandafter\let \csname ismacro.#1\endcsname=0%
7390    % Remove the macro name from \macrolist:
7391    \begingroup
7392      \expandafter\let\csname#1\endcsname \relax
7393      \let\definedummyword\unmacrodo
7394      \xdef\macrolist{\macrolist}%
7395    \endgroup
7396  \else
7397    \errmessage{Macro #1 not defined}%
7398  \fi
7399}
7400
7401% Called by \do from \dounmacro on each macro.  The idea is to omit any
7402% macro definitions that have been changed to \relax.
7403%
7404\def\unmacrodo#1{%
7405  \ifx #1\relax
7406    % remove this
7407  \else
7408    \noexpand\definedummyword \noexpand#1%
7409  \fi
7410}
7411
7412% This makes use of the obscure feature that if the last token of a
7413% <parameter list> is #, then the preceding argument is delimited by
7414% an opening brace, and that opening brace is not consumed.
7415\def\getargs#1{\getargsxxx#1{}}
7416\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7417\def\getmacname#1 #2\relax{\macname={#1}}
7418\def\getmacargs#1{\def\argl{#1}}
7419
7420% For macro processing make @ a letter so that we can make Texinfo private macro names.
7421\edef\texiatcatcode{\the\catcode`\@}
7422\catcode `@=11\relax
7423
7424% Parse the optional {params} list.  Set up \paramno and \paramlist
7425% so \defmacro knows what to do.  Define \macarg.BLAH for each BLAH
7426% in the params list to some hook where the argument si to be expanded.  If
7427% there are less than 10 arguments that hook is to be replaced by ##N where N
7428% is the position in that list, that is to say the macro arguments are to be
7429% defined `a la TeX in the macro body.  
7430%
7431% That gets used by \mbodybackslash (above).
7432%
7433% We need to get `macro parameter char #' into several definitions.
7434% The technique used is stolen from LaTeX: let \hash be something
7435% unexpandable, insert that wherever you need a #, and then redefine
7436% it to # just before using the token list produced.
7437%
7438% The same technique is used to protect \eatspaces till just before
7439% the macro is used.
7440%
7441% If there are 10 or more arguments, a different technique is used, where the
7442% hook remains in the body, and when macro is to be expanded the body is
7443% processed again to replace the arguments.
7444%
7445% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7446% argument N value and then \edef  the body (nothing else will expand because of
7447% the catcode regime underwhich the body was input).
7448%
7449% If you compile with TeX (not eTeX), and you have macros with 10 or more
7450% arguments, you need that no macro has more than 256 arguments, otherwise an
7451% error is produced.
7452\def\parsemargdef#1;{%
7453  \paramno=0\def\paramlist{}%
7454  \let\hash\relax
7455  \let\xeatspaces\relax
7456  \parsemargdefxxx#1,;,%
7457  % In case that there are 10 or more arguments we parse again the arguments
7458  % list to set new definitions for the \macarg.BLAH macros corresponding to
7459  % each BLAH argument. It was anyhow needed to parse already once this list
7460  % in order to count the arguments, and as macros with at most 9 arguments
7461  % are by far more frequent than macro with 10 or more arguments, defining
7462  % twice the \macarg.BLAH macros does not cost too much processing power.
7463  \ifnum\paramno<10\relax\else
7464    \paramno0\relax
7465    \parsemmanyargdef@@#1,;,% 10 or more arguments
7466  \fi
7467}
7468\def\parsemargdefxxx#1,{%
7469  \if#1;\let\next=\relax
7470  \else \let\next=\parsemargdefxxx
7471    \advance\paramno by 1
7472    \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7473        {\xeatspaces{\hash\the\paramno}}%
7474    \edef\paramlist{\paramlist\hash\the\paramno,}%
7475  \fi\next}
7476
7477\def\parsemmanyargdef@@#1,{%
7478  \if#1;\let\next=\relax
7479  \else 
7480    \let\next=\parsemmanyargdef@@
7481    \edef\tempb{\eatspaces{#1}}%
7482    \expandafter\def\expandafter\tempa
7483       \expandafter{\csname macarg.\tempb\endcsname}%
7484    % Note that we need some extra \noexpand\noexpand, this is because we
7485    % don't want \the  to be expanded in the \parsermacbody  as it uses an
7486    % \xdef .
7487    \expandafter\edef\tempa
7488      {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7489    \advance\paramno by 1\relax
7490  \fi\next}
7491
7492% These two commands read recursive and nonrecursive macro bodies.
7493% (They're different since rec and nonrec macros end differently.)
7494%
7495
7496\catcode `\@\texiatcatcode
7497\long\def\parsemacbody#1@end macro%
7498{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7499\long\def\parsermacbody#1@end rmacro%
7500{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7501\catcode `\@=11\relax
7502
7503\let\endargs@\relax
7504\let\nil@\relax
7505\def\nilm@{\nil@}%
7506\long\def\nillm@{\nil@}%
7507
7508% This macro is expanded during the Texinfo macro expansion, not during its
7509% definition.  It gets all the arguments values and assigns them to macros
7510% macarg.ARGNAME
7511%
7512% #1 is the macro name
7513% #2 is the list of argument names
7514% #3 is the list of argument values
7515\def\getargvals@#1#2#3{%
7516  \def\macargdeflist@{}%
7517  \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7518  \def\paramlist{#2,\nil@}%
7519  \def\macroname{#1}%
7520  \begingroup
7521  \macroargctxt
7522  \def\argvaluelist{#3,\nil@}%
7523  \def\@tempa{#3}%
7524  \ifx\@tempa\empty
7525    \setemptyargvalues@
7526  \else
7527    \getargvals@@
7528  \fi
7529}
7530
7531% 
7532\def\getargvals@@{%
7533  \ifx\paramlist\nilm@
7534      % Some sanity check needed here that \argvaluelist is also empty.
7535      \ifx\argvaluelist\nillm@
7536      \else
7537        \errhelp = \EMsimple
7538        \errmessage{Too many arguments in macro `\macroname'!}%
7539      \fi
7540      \let\next\macargexpandinbody@
7541  \else
7542    \ifx\argvaluelist\nillm@
7543       % No more arguments values passed to macro.  Set remaining named-arg
7544       % macros to empty.
7545       \let\next\setemptyargvalues@
7546    \else
7547      % pop current arg name into \@tempb
7548      \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7549      \expandafter\@tempa\expandafter{\paramlist}%
7550       % pop current argument value into \@tempc
7551      \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7552      \expandafter\@tempa\expandafter{\argvaluelist}%
7553       % Here \@tempb is the current arg name and \@tempc is the current arg value.
7554       % First place the new argument macro definition into \@tempd
7555       \expandafter\macname\expandafter{\@tempc}%
7556       \expandafter\let\csname macarg.\@tempb\endcsname\relax
7557       \expandafter\def\expandafter\@tempe\expandafter{%
7558         \csname macarg.\@tempb\endcsname}%
7559       \edef\@tempd{\long\def\@tempe{\the\macname}}%
7560       \push@\@tempd\macargdeflist@
7561       \let\next\getargvals@@
7562    \fi
7563  \fi
7564  \next
7565}
7566
7567\def\push@#1#2{%
7568  \expandafter\expandafter\expandafter\def
7569  \expandafter\expandafter\expandafter#2%
7570  \expandafter\expandafter\expandafter{%
7571  \expandafter#1#2}%
7572}
7573
7574% Replace arguments by their values in the macro body, and place the result
7575% in macro \@tempa
7576\def\macvalstoargs@{%
7577  %  To do this we use the property that token registers that are \the'ed
7578  % within an \edef  expand only once. So we are going to place all argument
7579  % values into respective token registers.
7580  %
7581  % First we save the token context, and initialize argument numbering.
7582  \begingroup
7583    \paramno0\relax
7584    % Then, for each argument number #N, we place the corresponding argument
7585    % value into a new token list register \toks#N
7586    \expandafter\putargsintokens@\saveparamlist@,;,%
7587    % Then, we expand the body so that argument are replaced by their
7588    % values. The trick for values not to be expanded themselves is that they
7589    % are within tokens and that tokens expand only once in an \edef .
7590    \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7591    % Now we restore the token stack pointer to free the token list registers
7592    % which we have used, but we make sure that expanded body is saved after
7593    % group.
7594    \expandafter
7595  \endgroup
7596  \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7597  }
7598
7599\def\macargexpandinbody@{% 
7600  %% Define the named-macro outside of this group and then close this group. 
7601  \expandafter
7602  \endgroup
7603  \macargdeflist@
7604  % First the replace in body the macro arguments by their values, the result
7605  % is in \@tempa .
7606  \macvalstoargs@
7607  % Then we point at the \norecurse or \gobble (for recursive) macro value
7608  % with \@tempb .
7609  \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7610  % Depending on whether it is recursive or not, we need some tailing
7611  % \egroup .
7612  \ifx\@tempb\gobble
7613     \let\@tempc\relax
7614  \else
7615     \let\@tempc\egroup
7616  \fi
7617  % And now we do the real job:
7618  \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7619  \@tempd
7620}
7621
7622\def\putargsintokens@#1,{%
7623  \if#1;\let\next\relax
7624  \else
7625    \let\next\putargsintokens@
7626    % First we allocate the new token list register, and give it a temporary
7627    % alias \@tempb .
7628    \toksdef\@tempb\the\paramno
7629    % Then we place the argument value into that token list register.
7630    \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7631    \expandafter\@tempb\expandafter{\@tempa}%
7632    \advance\paramno by 1\relax
7633  \fi
7634  \next
7635}
7636
7637% Save the token stack pointer into macro #1
7638\def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7639% Restore the token stack pointer from number in macro #1
7640\def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7641% newtoks that can be used non \outer .
7642\def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7643
7644% Tailing missing arguments are set to empty
7645\def\setemptyargvalues@{%
7646  \ifx\paramlist\nilm@
7647    \let\next\macargexpandinbody@
7648  \else
7649    \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7650    \let\next\setemptyargvalues@
7651  \fi
7652  \next
7653}
7654
7655\def\setemptyargvaluesparser@#1,#2\endargs@{%
7656  \expandafter\def\expandafter\@tempa\expandafter{%
7657    \expandafter\def\csname macarg.#1\endcsname{}}%
7658  \push@\@tempa\macargdeflist@
7659  \def\paramlist{#2}%
7660}
7661
7662% #1 is the element target macro
7663% #2 is the list macro
7664% #3,#4\endargs@ is the list value
7665\def\pop@#1#2#3,#4\endargs@{%
7666   \def#1{#3}%
7667   \def#2{#4}%
7668}
7669\long\def\longpop@#1#2#3,#4\endargs@{%
7670   \long\def#1{#3}%
7671   \long\def#2{#4}%
7672}
7673
7674% This defines a Texinfo @macro. There are eight cases: recursive and
7675% nonrecursive macros of zero, one, up to nine, and many arguments.
7676% Much magic with \expandafter here.
7677% \xdef is used so that macro definitions will survive the file
7678% they're defined in; @include reads the file inside a group.
7679%
7680\def\defmacro{%
7681  \let\hash=##% convert placeholders to macro parameter chars
7682  \ifrecursive
7683    \ifcase\paramno
7684    % 0
7685      \expandafter\xdef\csname\the\macname\endcsname{%
7686        \noexpand\scanmacro{\temp}}%
7687    \or % 1
7688      \expandafter\xdef\csname\the\macname\endcsname{%
7689         \bgroup\noexpand\macroargctxt
7690         \noexpand\braceorline
7691         \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7692      \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7693         \egroup\noexpand\scanmacro{\temp}}%
7694    \else
7695      \ifnum\paramno<10\relax % at most 9
7696        \expandafter\xdef\csname\the\macname\endcsname{%
7697           \bgroup\noexpand\macroargctxt
7698           \noexpand\csname\the\macname xx\endcsname}%
7699        \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7700            \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7701        \expandafter\expandafter
7702        \expandafter\xdef
7703        \expandafter\expandafter
7704          \csname\the\macname xxx\endcsname
7705            \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7706      \else % 10 or more
7707        \expandafter\xdef\csname\the\macname\endcsname{%
7708          \noexpand\getargvals@{\the\macname}{\argl}%
7709        }%    
7710        \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7711        \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7712      \fi
7713    \fi
7714  \else
7715    \ifcase\paramno
7716    % 0
7717      \expandafter\xdef\csname\the\macname\endcsname{%
7718        \noexpand\norecurse{\the\macname}%
7719        \noexpand\scanmacro{\temp}\egroup}%
7720    \or % 1
7721      \expandafter\xdef\csname\the\macname\endcsname{%
7722         \bgroup\noexpand\macroargctxt
7723         \noexpand\braceorline
7724         \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7725      \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7726        \egroup
7727        \noexpand\norecurse{\the\macname}%
7728        \noexpand\scanmacro{\temp}\egroup}%
7729    \else % at most 9
7730      \ifnum\paramno<10\relax
7731        \expandafter\xdef\csname\the\macname\endcsname{%
7732           \bgroup\noexpand\macroargctxt
7733           \expandafter\noexpand\csname\the\macname xx\endcsname}%
7734        \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7735            \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7736        \expandafter\expandafter
7737        \expandafter\xdef
7738        \expandafter\expandafter
7739        \csname\the\macname xxx\endcsname
7740        \paramlist{%
7741            \egroup
7742            \noexpand\norecurse{\the\macname}%
7743            \noexpand\scanmacro{\temp}\egroup}%
7744      \else % 10 or more:
7745        \expandafter\xdef\csname\the\macname\endcsname{%
7746          \noexpand\getargvals@{\the\macname}{\argl}%
7747        }%
7748        \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7749        \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7750      \fi
7751    \fi
7752  \fi}
7753
7754\catcode `\@\texiatcatcode\relax
7755
7756\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7757
7758% \braceorline decides whether the next nonwhitespace character is a
7759% {.  If so it reads up to the closing }, if not, it reads the whole
7760% line.  Whatever was read is then fed to the next control sequence
7761% as an argument (by \parsebrace or \parsearg).
7762% 
7763\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7764\def\braceorlinexxx{%
7765  \ifx\nchar\bgroup\else
7766    \expandafter\parsearg
7767  \fi \macnamexxx}
7768
7769
7770% @alias.
7771% We need some trickery to remove the optional spaces around the equal
7772% sign.  Make them active and then expand them all to nothing.
7773%
7774\def\alias{\parseargusing\obeyspaces\aliasxxx}
7775\def\aliasxxx #1{\aliasyyy#1\relax}
7776\def\aliasyyy #1=#2\relax{%
7777  {%
7778    \expandafter\let\obeyedspace=\empty
7779    \addtomacrolist{#1}%
7780    \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7781  }%
7782  \next
7783}
7784
7785
7786\message{cross references,}
7787
7788\newwrite\auxfile
7789\newif\ifhavexrefs    % True if xref values are known.
7790\newif\ifwarnedxrefs  % True if we warned once that they aren't known.
7791
7792% @inforef is relatively simple.
7793\def\inforef #1{\inforefzzz #1,,,,**}
7794\def\inforefzzz #1,#2,#3,#4**{%
7795  \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7796  node \samp{\ignorespaces#1{}}}
7797
7798% @node's only job in TeX is to define \lastnode, which is used in
7799% cross-references.  The @node line might or might not have commas, and
7800% might or might not have spaces before the first comma, like:
7801% @node foo , bar , ...
7802% We don't want such trailing spaces in the node name.
7803%
7804\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7805%
7806% also remove a trailing comma, in case of something like this:
7807% @node Help-Cross,  ,  , Cross-refs
7808\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7809\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7810
7811\let\nwnode=\node
7812\let\lastnode=\empty
7813
7814% Write a cross-reference definition for the current node.  #1 is the
7815% type (Ynumbered, Yappendix, Ynothing).
7816%
7817\def\donoderef#1{%
7818  \ifx\lastnode\empty\else
7819    \setref{\lastnode}{#1}%
7820    \global\let\lastnode=\empty
7821  \fi
7822}
7823
7824% @anchor{NAME} -- define xref target at arbitrary point.
7825%
7826\newcount\savesfregister
7827%
7828\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7829\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7830\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7831
7832% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7833% anchor), which consists of three parts:
7834% 1) NAME-title - the current sectioning name taken from \lastsection,
7835%                 or the anchor name.
7836% 2) NAME-snt   - section number and type, passed as the SNT arg, or
7837%                 empty for anchors.
7838% 3) NAME-pg    - the page number.
7839%
7840% This is called from \donoderef, \anchor, and \dofloat.  In the case of
7841% floats, there is an additional part, which is not written here:
7842% 4) NAME-lof   - the text as it should appear in a @listoffloats.
7843%
7844\def\setref#1#2{%
7845  \pdfmkdest{#1}%
7846  \iflinks
7847    {%
7848      \atdummies  % preserve commands, but don't expand them
7849      \edef\writexrdef##1##2{%
7850	\write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7851	  ##1}{##2}}% these are parameters of \writexrdef
7852      }%
7853      \toks0 = \expandafter{\lastsection}%
7854      \immediate \writexrdef{title}{\the\toks0 }%
7855      \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7856      \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7857    }%
7858  \fi
7859}
7860
7861% @xrefautosectiontitle on|off says whether @section(ing) names are used
7862% automatically in xrefs, if the third arg is not explicitly specified.
7863% This was provided as a "secret" @set xref-automatic-section-title
7864% variable, now it's official.
7865% 
7866\parseargdef\xrefautomaticsectiontitle{%
7867  \def\temp{#1}%
7868  \ifx\temp\onword
7869    \expandafter\let\csname SETxref-automatic-section-title\endcsname
7870      = \empty
7871  \else\ifx\temp\offword
7872    \expandafter\let\csname SETxref-automatic-section-title\endcsname
7873      = \relax
7874  \else
7875    \errhelp = \EMsimple
7876    \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7877                must be on|off}%
7878  \fi\fi
7879}
7880
7881% 
7882% @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
7883% the node name, #2 the name of the Info cross-reference, #3 the printed
7884% node name, #4 the name of the Info file, #5 the name of the printed
7885% manual.  All but the node name can be omitted.
7886%
7887\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7888\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7889\def\ref#1{\xrefX[#1,,,,,,,]}
7890%
7891\newbox\toprefbox
7892\newbox\printedrefnamebox
7893\newbox\infofilenamebox
7894\newbox\printedmanualbox
7895%
7896\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7897  \unsepspaces
7898  %
7899  % Get args without leading/trailing spaces.
7900  \def\printedrefname{\ignorespaces #3}%
7901  \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7902  %
7903  \def\infofilename{\ignorespaces #4}%
7904  \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7905  %
7906  \def\printedmanual{\ignorespaces #5}%
7907  \setbox\printedmanualbox  = \hbox{\printedmanual\unskip}%
7908  %
7909  % If the printed reference name (arg #3) was not explicitly given in
7910  % the @xref, figure out what we want to use.
7911  \ifdim \wd\printedrefnamebox = 0pt
7912    % No printed node name was explicitly given.
7913    \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7914      % Not auto section-title: use node name inside the square brackets.
7915      \def\printedrefname{\ignorespaces #1}%
7916    \else
7917      % Auto section-title: use chapter/section title inside
7918      % the square brackets if we have it.
7919      \ifdim \wd\printedmanualbox > 0pt
7920        % It is in another manual, so we don't have it; use node name.
7921        \def\printedrefname{\ignorespaces #1}%
7922      \else
7923        \ifhavexrefs
7924          % We (should) know the real title if we have the xref values.
7925          \def\printedrefname{\refx{#1-title}{}}%
7926        \else
7927          % Otherwise just copy the Info node name.
7928          \def\printedrefname{\ignorespaces #1}%
7929        \fi%
7930      \fi
7931    \fi
7932  \fi
7933  %
7934  % Make link in pdf output.
7935  \ifpdf
7936    {\indexnofonts
7937     \turnoffactive
7938     \makevalueexpandable
7939     % This expands tokens, so do it after making catcode changes, so _
7940     % etc. don't get their TeX definitions.  This ignores all spaces in
7941     % #4, including (wrongly) those in the middle of the filename.
7942     \getfilename{#4}%
7943     %
7944     % This (wrongly) does not take account of leading or trailing
7945     % spaces in #1, which should be ignored.
7946     \edef\pdfxrefdest{#1}%
7947     \ifx\pdfxrefdest\empty
7948       \def\pdfxrefdest{Top}% no empty targets
7949     \else
7950       \txiescapepdf\pdfxrefdest  % escape PDF special chars
7951     \fi
7952     %
7953     \leavevmode
7954     \startlink attr{/Border [0 0 0]}%
7955     \ifnum\filenamelength>0
7956       goto file{\the\filename.pdf} name{\pdfxrefdest}%
7957     \else
7958       goto name{\pdfmkpgn{\pdfxrefdest}}%
7959     \fi
7960    }%
7961    \setcolor{\linkcolor}%
7962  \fi
7963  %
7964  % Float references are printed completely differently: "Figure 1.2"
7965  % instead of "[somenode], p.3".  We distinguish them by the
7966  % LABEL-title being set to a magic string.
7967  {%
7968    % Have to otherify everything special to allow the \csname to
7969    % include an _ in the xref name, etc.
7970    \indexnofonts
7971    \turnoffactive
7972    \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7973      \csname XR#1-title\endcsname
7974  }%
7975  \iffloat\Xthisreftitle
7976    % If the user specified the print name (third arg) to the ref,
7977    % print it instead of our usual "Figure 1.2".
7978    \ifdim\wd\printedrefnamebox = 0pt
7979      \refx{#1-snt}{}%
7980    \else
7981      \printedrefname
7982    \fi
7983    %
7984    % If the user also gave the printed manual name (fifth arg), append
7985    % "in MANUALNAME".
7986    \ifdim \wd\printedmanualbox > 0pt
7987      \space \putwordin{} \cite{\printedmanual}%
7988    \fi
7989  \else
7990    % node/anchor (non-float) references.
7991    % 
7992    % If we use \unhbox to print the node names, TeX does not insert
7993    % empty discretionaries after hyphens, which means that it will not
7994    % find a line break at a hyphen in a node names.  Since some manuals
7995    % are best written with fairly long node names, containing hyphens,
7996    % this is a loss.  Therefore, we give the text of the node name
7997    % again, so it is as if TeX is seeing it for the first time.
7998    % 
7999    \ifdim \wd\printedmanualbox > 0pt
8000      % Cross-manual reference with a printed manual name.
8001      % 
8002      \crossmanualxref{\cite{\printedmanual\unskip}}%
8003    %
8004    \else\ifdim \wd\infofilenamebox > 0pt
8005      % Cross-manual reference with only an info filename (arg 4), no
8006      % printed manual name (arg 5).  This is essentially the same as
8007      % the case above; we output the filename, since we have nothing else.
8008      % 
8009      \crossmanualxref{\code{\infofilename\unskip}}%
8010    %
8011    \else
8012      % Reference within this manual.
8013      %
8014      % _ (for example) has to be the character _ for the purposes of the
8015      % control sequence corresponding to the node, but it has to expand
8016      % into the usual \leavevmode...\vrule stuff for purposes of
8017      % printing. So we \turnoffactive for the \refx-snt, back on for the
8018      % printing, back off for the \refx-pg.
8019      {\turnoffactive
8020       % Only output a following space if the -snt ref is nonempty; for
8021       % @unnumbered and @anchor, it won't be.
8022       \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8023       \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8024      }%
8025      % output the `[mynode]' via the macro below so it can be overridden.
8026      \xrefprintnodename\printedrefname
8027      %
8028      % But we always want a comma and a space:
8029      ,\space
8030      %
8031      % output the `page 3'.
8032      \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8033    \fi\fi
8034  \fi
8035  \endlink
8036\endgroup}
8037
8038% Output a cross-manual xref to #1.  Used just above (twice).
8039% 
8040% Only include the text "Section ``foo'' in" if the foo is neither
8041% missing or Top.  Thus, @xref{,,,foo,The Foo Manual} outputs simply
8042% "see The Foo Manual", the idea being to refer to the whole manual.
8043% 
8044% But, this being TeX, we can't easily compare our node name against the
8045% string "Top" while ignoring the possible spaces before and after in
8046% the input.  By adding the arbitrary 7sp below, we make it much less
8047% likely that a real node name would have the same width as "Top" (e.g.,
8048% in a monospaced font).  Hopefully it will never happen in practice.
8049% 
8050% For the same basic reason, we retypeset the "Top" at every
8051% reference, since the current font is indeterminate.
8052% 
8053\def\crossmanualxref#1{%
8054  \setbox\toprefbox = \hbox{Top\kern7sp}%
8055  \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8056  \ifdim \wd2 > 7sp  % nonempty?
8057    \ifdim \wd2 = \wd\toprefbox \else  % same as Top?
8058      \putwordSection{} ``\printedrefname'' \putwordin{}\space
8059    \fi
8060  \fi
8061  #1%
8062}
8063
8064% This macro is called from \xrefX for the `[nodename]' part of xref
8065% output.  It's a separate macro only so it can be changed more easily,
8066% since square brackets don't work well in some documents.  Particularly
8067% one that Bob is working on :).
8068%
8069\def\xrefprintnodename#1{[#1]}
8070
8071% Things referred to by \setref.
8072%
8073\def\Ynothing{}
8074\def\Yomitfromtoc{}
8075\def\Ynumbered{%
8076  \ifnum\secno=0
8077    \putwordChapter@tie \the\chapno
8078  \else \ifnum\subsecno=0
8079    \putwordSection@tie \the\chapno.\the\secno
8080  \else \ifnum\subsubsecno=0
8081    \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8082  \else
8083    \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8084  \fi\fi\fi
8085}
8086\def\Yappendix{%
8087  \ifnum\secno=0
8088     \putwordAppendix@tie @char\the\appendixno{}%
8089  \else \ifnum\subsecno=0
8090     \putwordSection@tie @char\the\appendixno.\the\secno
8091  \else \ifnum\subsubsecno=0
8092    \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8093  \else
8094    \putwordSection@tie
8095      @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8096  \fi\fi\fi
8097}
8098
8099% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8100% If its value is nonempty, SUFFIX is output afterward.
8101%
8102\def\refx#1#2{%
8103  {%
8104    \indexnofonts
8105    \otherbackslash
8106    \expandafter\global\expandafter\let\expandafter\thisrefX
8107      \csname XR#1\endcsname
8108  }%
8109  \ifx\thisrefX\relax
8110    % If not defined, say something at least.
8111    \angleleft un\-de\-fined\angleright
8112    \iflinks
8113      \ifhavexrefs
8114        {\toks0 = {#1}% avoid expansion of possibly-complex value
8115         \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8116      \else
8117        \ifwarnedxrefs\else
8118          \global\warnedxrefstrue
8119          \message{Cross reference values unknown; you must run TeX again.}%
8120        \fi
8121      \fi
8122    \fi
8123  \else
8124    % It's defined, so just use it.
8125    \thisrefX
8126  \fi
8127  #2% Output the suffix in any case.
8128}
8129
8130% This is the macro invoked by entries in the aux file.  Usually it's
8131% just a \def (we prepend XR to the control sequence name to avoid
8132% collisions).  But if this is a float type, we have more work to do.
8133%
8134\def\xrdef#1#2{%
8135  {% The node name might contain 8-bit characters, which in our current
8136   % implementation are changed to commands like @'e.  Don't let these
8137   % mess up the control sequence name.
8138    \indexnofonts
8139    \turnoffactive
8140    \xdef\safexrefname{#1}%
8141  }%
8142  %
8143  \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8144  %
8145  % Was that xref control sequence that we just defined for a float?
8146  \expandafter\iffloat\csname XR\safexrefname\endcsname
8147    % it was a float, and we have the (safe) float type in \iffloattype.
8148    \expandafter\let\expandafter\floatlist
8149      \csname floatlist\iffloattype\endcsname
8150    %
8151    % Is this the first time we've seen this float type?
8152    \expandafter\ifx\floatlist\relax
8153      \toks0 = {\do}% yes, so just \do
8154    \else
8155      % had it before, so preserve previous elements in list.
8156      \toks0 = \expandafter{\floatlist\do}%
8157    \fi
8158    %
8159    % Remember this xref in the control sequence \floatlistFLOATTYPE,
8160    % for later use in \listoffloats.
8161    \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8162      {\safexrefname}}%
8163  \fi
8164}
8165
8166% Read the last existing aux file, if any.  No error if none exists.
8167%
8168\def\tryauxfile{%
8169  \openin 1 \jobname.aux
8170  \ifeof 1 \else
8171    \readdatafile{aux}%
8172    \global\havexrefstrue
8173  \fi
8174  \closein 1
8175}
8176
8177\def\setupdatafile{%
8178  \catcode`\^^@=\other
8179  \catcode`\^^A=\other
8180  \catcode`\^^B=\other
8181  \catcode`\^^C=\other
8182  \catcode`\^^D=\other
8183  \catcode`\^^E=\other
8184  \catcode`\^^F=\other
8185  \catcode`\^^G=\other
8186  \catcode`\^^H=\other
8187  \catcode`\^^K=\other
8188  \catcode`\^^L=\other
8189  \catcode`\^^N=\other
8190  \catcode`\^^P=\other
8191  \catcode`\^^Q=\other
8192  \catcode`\^^R=\other
8193  \catcode`\^^S=\other
8194  \catcode`\^^T=\other
8195  \catcode`\^^U=\other
8196  \catcode`\^^V=\other
8197  \catcode`\^^W=\other
8198  \catcode`\^^X=\other
8199  \catcode`\^^Z=\other
8200  \catcode`\^^[=\other
8201  \catcode`\^^\=\other
8202  \catcode`\^^]=\other
8203  \catcode`\^^^=\other
8204  \catcode`\^^_=\other
8205  % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8206  % in xref tags, i.e., node names.  But since ^^e4 notation isn't
8207  % supported in the main text, it doesn't seem desirable.  Furthermore,
8208  % that is not enough: for node names that actually contain a ^
8209  % character, we would end up writing a line like this: 'xrdef {'hat
8210  % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8211  % argument, and \hat is not an expandable control sequence.  It could
8212  % all be worked out, but why?  Either we support ^^ or we don't.
8213  %
8214  % The other change necessary for this was to define \auxhat:
8215  % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8216  % and then to call \auxhat in \setq.
8217  %
8218  \catcode`\^=\other
8219  %
8220  % Special characters.  Should be turned off anyway, but...
8221  \catcode`\~=\other
8222  \catcode`\[=\other
8223  \catcode`\]=\other
8224  \catcode`\"=\other
8225  \catcode`\_=\other
8226  \catcode`\|=\other
8227  \catcode`\<=\other
8228  \catcode`\>=\other
8229  \catcode`\$=\other
8230  \catcode`\#=\other
8231  \catcode`\&=\other
8232  \catcode`\%=\other
8233  \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8234  %
8235  % This is to support \ in node names and titles, since the \
8236  % characters end up in a \csname.  It's easier than
8237  % leaving it active and making its active definition an actual \
8238  % character.  What I don't understand is why it works in the *value*
8239  % of the xrdef.  Seems like it should be a catcode12 \, and that
8240  % should not typeset properly.  But it works, so I'm moving on for
8241  % now.  --karl, 15jan04.
8242  \catcode`\\=\other
8243  %
8244  % Make the characters 128-255 be printing characters.
8245  {%
8246    \count1=128
8247    \def\loop{%
8248      \catcode\count1=\other
8249      \advance\count1 by 1
8250      \ifnum \count1<256 \loop \fi
8251    }%
8252  }%
8253  %
8254  % @ is our escape character in .aux files, and we need braces.
8255  \catcode`\{=1
8256  \catcode`\}=2
8257  \catcode`\@=0
8258}
8259
8260\def\readdatafile#1{%
8261\begingroup
8262  \setupdatafile
8263  \input\jobname.#1
8264\endgroup}
8265
8266
8267\message{insertions,}
8268% including footnotes.
8269
8270\newcount \footnoteno
8271
8272% The trailing space in the following definition for supereject is
8273% vital for proper filling; pages come out unaligned when you do a
8274% pagealignmacro call if that space before the closing brace is
8275% removed. (Generally, numeric constants should always be followed by a
8276% space to prevent strange expansion errors.)
8277\def\supereject{\par\penalty -20000\footnoteno =0 }
8278
8279% @footnotestyle is meaningful for Info output only.
8280\let\footnotestyle=\comment
8281
8282{\catcode `\@=11
8283%
8284% Auto-number footnotes.  Otherwise like plain.
8285\gdef\footnote{%
8286  \let\indent=\ptexindent
8287  \let\noindent=\ptexnoindent
8288  \global\advance\footnoteno by \@ne
8289  \edef\thisfootno{$^{\the\footnoteno}$}%
8290  %
8291  % In case the footnote comes at the end of a sentence, preserve the
8292  % extra spacing after we do the footnote number.
8293  \let\@sf\empty
8294  \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8295  %
8296  % Remove inadvertent blank space before typesetting the footnote number.
8297  \unskip
8298  \thisfootno\@sf
8299  \dofootnote
8300}%
8301
8302% Don't bother with the trickery in plain.tex to not require the
8303% footnote text as a parameter.  Our footnotes don't need to be so general.
8304%
8305% Oh yes, they do; otherwise, @ifset (and anything else that uses
8306% \parseargline) fails inside footnotes because the tokens are fixed when
8307% the footnote is read.  --karl, 16nov96.
8308%
8309\gdef\dofootnote{%
8310  \insert\footins\bgroup
8311  % We want to typeset this text as a normal paragraph, even if the
8312  % footnote reference occurs in (for example) a display environment.
8313  % So reset some parameters.
8314  \hsize=\pagewidth
8315  \interlinepenalty\interfootnotelinepenalty
8316  \splittopskip\ht\strutbox % top baseline for broken footnotes
8317  \splitmaxdepth\dp\strutbox
8318  \floatingpenalty\@MM
8319  \leftskip\z@skip
8320  \rightskip\z@skip
8321  \spaceskip\z@skip
8322  \xspaceskip\z@skip
8323  \parindent\defaultparindent
8324  %
8325  \smallfonts \rm
8326  %
8327  % Because we use hanging indentation in footnotes, a @noindent appears
8328  % to exdent this text, so make it be a no-op.  makeinfo does not use
8329  % hanging indentation so @noindent can still be needed within footnote
8330  % text after an @example or the like (not that this is good style).
8331  \let\noindent = \relax
8332  %
8333  % Hang the footnote text off the number.  Use \everypar in case the
8334  % footnote extends for more than one paragraph.
8335  \everypar = {\hang}%
8336  \textindent{\thisfootno}%
8337  %
8338  % Don't crash into the line above the footnote text.  Since this
8339  % expands into a box, it must come within the paragraph, lest it
8340  % provide a place where TeX can split the footnote.
8341  \footstrut
8342  %
8343  % Invoke rest of plain TeX footnote routine.
8344  \futurelet\next\fo@t
8345}
8346}%end \catcode `\@=11
8347
8348% In case a @footnote appears in a vbox, save the footnote text and create
8349% the real \insert just after the vbox finished.  Otherwise, the insertion
8350% would be lost.
8351% Similarly, if a @footnote appears inside an alignment, save the footnote
8352% text to a box and make the \insert when a row of the table is finished.
8353% And the same can be done for other insert classes.  --kasal, 16nov03.
8354
8355% Replace the \insert primitive by a cheating macro.
8356% Deeper inside, just make sure that the saved insertions are not spilled
8357% out prematurely.
8358%
8359\def\startsavinginserts{%
8360  \ifx \insert\ptexinsert
8361    \let\insert\saveinsert
8362  \else
8363    \let\checkinserts\relax
8364  \fi
8365}
8366
8367% This \insert replacement works for both \insert\footins{foo} and
8368% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8369%
8370\def\saveinsert#1{%
8371  \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8372  \afterassignment\next
8373  % swallow the left brace
8374  \let\temp =
8375}
8376\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8377\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8378
8379\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8380
8381\def\placesaveins#1{%
8382  \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8383    {\box#1}%
8384}
8385
8386% eat @SAVE -- beware, all of them have catcode \other:
8387{
8388  \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
8389  \gdef\gobblesave @SAVE{}
8390}
8391
8392% initialization:
8393\def\newsaveins #1{%
8394  \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8395  \next
8396}
8397\def\newsaveinsX #1{%
8398  \csname newbox\endcsname #1%
8399  \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8400    \checksaveins #1}%
8401}
8402
8403% initialize:
8404\let\checkinserts\empty
8405\newsaveins\footins
8406\newsaveins\margin
8407
8408
8409% @image.  We use the macros from epsf.tex to support this.
8410% If epsf.tex is not installed and @image is used, we complain.
8411%
8412% Check for and read epsf.tex up front.  If we read it only at @image
8413% time, we might be inside a group, and then its definitions would get
8414% undone and the next image would fail.
8415\openin 1 = epsf.tex
8416\ifeof 1 \else
8417  % Do not bother showing banner with epsf.tex v2.7k (available in
8418  % doc/epsf.tex and on ctan).
8419  \def\epsfannounce{\toks0 = }%
8420  \input epsf.tex
8421\fi
8422\closein 1
8423%
8424% We will only complain once about lack of epsf.tex.
8425\newif\ifwarnednoepsf
8426\newhelp\noepsfhelp{epsf.tex must be installed for images to
8427  work.  It is also included in the Texinfo distribution, or you can get
8428  it from ftp://tug.org/tex/epsf.tex.}
8429%
8430\def\image#1{%
8431  \ifx\epsfbox\thisisundefined
8432    \ifwarnednoepsf \else
8433      \errhelp = \noepsfhelp
8434      \errmessage{epsf.tex not found, images will be ignored}%
8435      \global\warnednoepsftrue
8436    \fi
8437  \else
8438    \imagexxx #1,,,,,\finish
8439  \fi
8440}
8441%
8442% Arguments to @image:
8443% #1 is (mandatory) image filename; we tack on .eps extension.
8444% #2 is (optional) width, #3 is (optional) height.
8445% #4 is (ignored optional) html alt text.
8446% #5 is (ignored optional) extension.
8447% #6 is just the usual extra ignored arg for parsing stuff.
8448\newif\ifimagevmode
8449\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8450  \catcode`\^^M = 5     % in case we're inside an example
8451  \normalturnoffactive  % allow _ et al. in names
8452  % If the image is by itself, center it.
8453  \ifvmode
8454    \imagevmodetrue
8455  \else \ifx\centersub\centerV
8456    % for @center @image, we need a vbox so we can have our vertical space
8457    \imagevmodetrue
8458    \vbox\bgroup % vbox has better behavior than vtop herev
8459  \fi\fi
8460  %
8461  \ifimagevmode
8462    \nobreak\medskip
8463    % Usually we'll have text after the image which will insert
8464    % \parskip glue, so insert it here too to equalize the space
8465    % above and below.
8466    \nobreak\vskip\parskip
8467    \nobreak
8468  \fi
8469  %
8470  % Leave vertical mode so that indentation from an enclosing
8471  %  environment such as @quotation is respected.
8472  % However, if we're at the top level, we don't want the
8473  %  normal paragraph indentation.
8474  % On the other hand, if we are in the case of @center @image, we don't
8475  %  want to start a paragraph, which will create a hsize-width box and
8476  %  eradicate the centering.
8477  \ifx\centersub\centerV\else \noindent \fi
8478  %
8479  % Output the image.
8480  \ifpdf
8481    \dopdfimage{#1}{#2}{#3}%
8482  \else
8483    % \epsfbox itself resets \epsf?size at each figure.
8484    \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8485    \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8486    \epsfbox{#1.eps}%
8487  \fi
8488  %
8489  \ifimagevmode
8490    \medskip  % space after a standalone image
8491  \fi  
8492  \ifx\centersub\centerV \egroup \fi
8493\endgroup}
8494
8495
8496% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8497% etc.  We don't actually implement floating yet, we always include the
8498% float "here".  But it seemed the best name for the future.
8499%
8500\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8501
8502% There may be a space before second and/or third parameter; delete it.
8503\def\eatcommaspace#1, {#1,}
8504
8505% #1 is the optional FLOATTYPE, the text label for this float, typically
8506% "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
8507% this float will not be numbered and cannot be referred to.
8508%
8509% #2 is the optional xref label.  Also must be present for the float to
8510% be referable.
8511%
8512% #3 is the optional positioning argument; for now, it is ignored.  It
8513% will somehow specify the positions allowed to float to (here, top, bottom).
8514%
8515% We keep a separate counter for each FLOATTYPE, which we reset at each
8516% chapter-level command.
8517\let\resetallfloatnos=\empty
8518%
8519\def\dofloat#1,#2,#3,#4\finish{%
8520  \let\thiscaption=\empty
8521  \let\thisshortcaption=\empty
8522  %
8523  % don't lose footnotes inside @float.
8524  %
8525  % BEWARE: when the floats start float, we have to issue warning whenever an
8526  % insert appears inside a float which could possibly float. --kasal, 26may04
8527  %
8528  \startsavinginserts
8529  %
8530  % We can't be used inside a paragraph.
8531  \par
8532  %
8533  \vtop\bgroup
8534    \def\floattype{#1}%
8535    \def\floatlabel{#2}%
8536    \def\floatloc{#3}% we do nothing with this yet.
8537    %
8538    \ifx\floattype\empty
8539      \let\safefloattype=\empty
8540    \else
8541      {%
8542        % the floattype might have accents or other special characters,
8543        % but we need to use it in a control sequence name.
8544        \indexnofonts
8545        \turnoffactive
8546        \xdef\safefloattype{\floattype}%
8547      }%
8548    \fi
8549    %
8550    % If label is given but no type, we handle that as the empty type.
8551    \ifx\floatlabel\empty \else
8552      % We want each FLOATTYPE to be numbered separately (Figure 1,
8553      % Table 1, Figure 2, ...).  (And if no label, no number.)
8554      %
8555      \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8556      \global\advance\floatno by 1
8557      %
8558      {%
8559        % This magic value for \lastsection is output by \setref as the
8560        % XREFLABEL-title value.  \xrefX uses it to distinguish float
8561        % labels (which have a completely different output format) from
8562        % node and anchor labels.  And \xrdef uses it to construct the
8563        % lists of floats.
8564        %
8565        \edef\lastsection{\floatmagic=\safefloattype}%
8566        \setref{\floatlabel}{Yfloat}%
8567      }%
8568    \fi
8569    %
8570    % start with \parskip glue, I guess.
8571    \vskip\parskip
8572    %
8573    % Don't suppress indentation if a float happens to start a section.
8574    \restorefirstparagraphindent
8575}
8576
8577% we have these possibilities:
8578% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8579% @float Foo,lbl & no caption:    Foo 1.1
8580% @float Foo & @caption{Cap}:     Foo: Cap
8581% @float Foo & no caption:        Foo
8582% @float ,lbl & Caption{Cap}:     1.1: Cap
8583% @float ,lbl & no caption:       1.1
8584% @float & @caption{Cap}:         Cap
8585% @float & no caption:
8586%
8587\def\Efloat{%
8588    \let\floatident = \empty
8589    %
8590    % In all cases, if we have a float type, it comes first.
8591    \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8592    %
8593    % If we have an xref label, the number comes next.
8594    \ifx\floatlabel\empty \else
8595      \ifx\floattype\empty \else % if also had float type, need tie first.
8596        \appendtomacro\floatident{\tie}%
8597      \fi
8598      % the number.
8599      \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8600    \fi
8601    %
8602    % Start the printed caption with what we've constructed in
8603    % \floatident, but keep it separate; we need \floatident again.
8604    \let\captionline = \floatident
8605    %
8606    \ifx\thiscaption\empty \else
8607      \ifx\floatident\empty \else
8608	\appendtomacro\captionline{: }% had ident, so need a colon between
8609      \fi
8610      %
8611      % caption text.
8612      \appendtomacro\captionline{\scanexp\thiscaption}%
8613    \fi
8614    %
8615    % If we have anything to print, print it, with space before.
8616    % Eventually this needs to become an \insert.
8617    \ifx\captionline\empty \else
8618      \vskip.5\parskip
8619      \captionline
8620      %
8621      % Space below caption.
8622      \vskip\parskip
8623    \fi
8624    %
8625    % If have an xref label, write the list of floats info.  Do this
8626    % after the caption, to avoid chance of it being a breakpoint.
8627    \ifx\floatlabel\empty \else
8628      % Write the text that goes in the lof to the aux file as
8629      % \floatlabel-lof.  Besides \floatident, we include the short
8630      % caption if specified, else the full caption if specified, else nothing.
8631      {%
8632        \atdummies
8633        %
8634        % since we read the caption text in the macro world, where ^^M
8635        % is turned into a normal character, we have to scan it back, so
8636        % we don't write the literal three characters "^^M" into the aux file.
8637	\scanexp{%
8638	  \xdef\noexpand\gtemp{%
8639	    \ifx\thisshortcaption\empty
8640	      \thiscaption
8641	    \else
8642	      \thisshortcaption
8643	    \fi
8644	  }%
8645	}%
8646        \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8647	  \ifx\gtemp\empty \else : \gtemp \fi}}%
8648      }%
8649    \fi
8650  \egroup  % end of \vtop
8651  %
8652  % place the captured inserts
8653  %
8654  % BEWARE: when the floats start floating, we have to issue warning
8655  % whenever an insert appears inside a float which could possibly
8656  % float. --kasal, 26may04
8657  %
8658  \checkinserts
8659}
8660
8661% Append the tokens #2 to the definition of macro #1, not expanding either.
8662%
8663\def\appendtomacro#1#2{%
8664  \expandafter\def\expandafter#1\expandafter{#1#2}%
8665}
8666
8667% @caption, @shortcaption
8668%
8669\def\caption{\docaption\thiscaption}
8670\def\shortcaption{\docaption\thisshortcaption}
8671\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8672\def\defcaption#1#2{\egroup \def#1{#2}}
8673
8674% The parameter is the control sequence identifying the counter we are
8675% going to use.  Create it if it doesn't exist and assign it to \floatno.
8676\def\getfloatno#1{%
8677  \ifx#1\relax
8678      % Haven't seen this figure type before.
8679      \csname newcount\endcsname #1%
8680      %
8681      % Remember to reset this floatno at the next chap.
8682      \expandafter\gdef\expandafter\resetallfloatnos
8683        \expandafter{\resetallfloatnos #1=0 }%
8684  \fi
8685  \let\floatno#1%
8686}
8687
8688% \setref calls this to get the XREFLABEL-snt value.  We want an @xref
8689% to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
8690% first read the @float command.
8691%
8692\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8693
8694% Magic string used for the XREFLABEL-title value, so \xrefX can
8695% distinguish floats from other xref types.
8696\def\floatmagic{!!float!!}
8697
8698% #1 is the control sequence we are passed; we expand into a conditional
8699% which is true if #1 represents a float ref.  That is, the magic
8700% \lastsection value which we \setref above.
8701%
8702\def\iffloat#1{\expandafter\doiffloat#1==\finish}
8703%
8704% #1 is (maybe) the \floatmagic string.  If so, #2 will be the
8705% (safe) float type for this float.  We set \iffloattype to #2.
8706%
8707\def\doiffloat#1=#2=#3\finish{%
8708  \def\temp{#1}%
8709  \def\iffloattype{#2}%
8710  \ifx\temp\floatmagic
8711}
8712
8713% @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8714%
8715\parseargdef\listoffloats{%
8716  \def\floattype{#1}% floattype
8717  {%
8718    % the floattype might have accents or other special characters,
8719    % but we need to use it in a control sequence name.
8720    \indexnofonts
8721    \turnoffactive
8722    \xdef\safefloattype{\floattype}%
8723  }%
8724  %
8725  % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8726  \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8727    \ifhavexrefs
8728      % if the user said @listoffloats foo but never @float foo.
8729      \message{\linenumber No `\safefloattype' floats to list.}%
8730    \fi
8731  \else
8732    \begingroup
8733      \leftskip=\tocindent  % indent these entries like a toc
8734      \let\do=\listoffloatsdo
8735      \csname floatlist\safefloattype\endcsname
8736    \endgroup
8737  \fi
8738}
8739
8740% This is called on each entry in a list of floats.  We're passed the
8741% xref label, in the form LABEL-title, which is how we save it in the
8742% aux file.  We strip off the -title and look up \XRLABEL-lof, which
8743% has the text we're supposed to typeset here.
8744%
8745% Figures without xref labels will not be included in the list (since
8746% they won't appear in the aux file).
8747%
8748\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8749\def\listoffloatsdoentry#1-title\finish{{%
8750  % Can't fully expand XR#1-lof because it can contain anything.  Just
8751  % pass the control sequence.  On the other hand, XR#1-pg is just the
8752  % page number, and we want to fully expand that so we can get a link
8753  % in pdf output.
8754  \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8755  %
8756  % use the same \entry macro we use to generate the TOC and index.
8757  \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8758  \writeentry
8759}}
8760
8761
8762\message{localization,}
8763
8764% For single-language documents, @documentlanguage is usually given very
8765% early, just after @documentencoding.  Single argument is the language
8766% (de) or locale (de_DE) abbreviation.
8767%
8768{
8769  \catcode`\_ = \active
8770  \globaldefs=1
8771\parseargdef\documentlanguage{\begingroup
8772  \let_=\normalunderscore  % normal _ character for filenames
8773  \tex % read txi-??.tex file in plain TeX.
8774    % Read the file by the name they passed if it exists.
8775    \openin 1 txi-#1.tex
8776    \ifeof 1
8777      \documentlanguagetrywithoutunderscore{#1_\finish}%
8778    \else
8779      \globaldefs = 1  % everything in the txi-LL files needs to persist
8780      \input txi-#1.tex
8781    \fi
8782    \closein 1
8783  \endgroup % end raw TeX
8784\endgroup}
8785%
8786% If they passed de_DE, and txi-de_DE.tex doesn't exist,
8787% try txi-de.tex.
8788%
8789\gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8790  \openin 1 txi-#1.tex
8791  \ifeof 1
8792    \errhelp = \nolanghelp
8793    \errmessage{Cannot read language file txi-#1.tex}%
8794  \else
8795    \globaldefs = 1  % everything in the txi-LL files needs to persist
8796    \input txi-#1.tex
8797  \fi
8798  \closein 1
8799}
8800}% end of special _ catcode
8801%
8802\newhelp\nolanghelp{The given language definition file cannot be found or
8803is empty.  Maybe you need to install it?  Putting it in the current
8804directory should work if nowhere else does.}
8805
8806% This macro is called from txi-??.tex files; the first argument is the
8807% \language name to set (without the "\lang@" prefix), the second and
8808% third args are \{left,right}hyphenmin.
8809%
8810% The language names to pass are determined when the format is built.
8811% See the etex.log file created at that time, e.g.,
8812% /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8813%
8814% With TeX Live 2008, etex now includes hyphenation patterns for all
8815% available languages.  This means we can support hyphenation in
8816% Texinfo, at least to some extent.  (This still doesn't solve the
8817% accented characters problem.)
8818%
8819\catcode`@=11
8820\def\txisetlanguage#1#2#3{%
8821  % do not set the language if the name is undefined in the current TeX.
8822  \expandafter\ifx\csname lang@#1\endcsname \relax
8823    \message{no patterns for #1}%
8824  \else
8825    \global\language = \csname lang@#1\endcsname
8826  \fi
8827  % but there is no harm in adjusting the hyphenmin values regardless.
8828  \global\lefthyphenmin = #2\relax
8829  \global\righthyphenmin = #3\relax
8830}
8831
8832% Helpers for encodings.
8833% Set the catcode of characters 128 through 255 to the specified number.
8834%
8835\def\setnonasciicharscatcode#1{%
8836   \count255=128
8837   \loop\ifnum\count255<256
8838      \global\catcode\count255=#1\relax
8839      \advance\count255 by 1
8840   \repeat
8841}
8842
8843\def\setnonasciicharscatcodenonglobal#1{%
8844   \count255=128
8845   \loop\ifnum\count255<256
8846      \catcode\count255=#1\relax
8847      \advance\count255 by 1
8848   \repeat
8849}
8850
8851% @documentencoding sets the definition of non-ASCII characters
8852% according to the specified encoding.
8853%
8854\parseargdef\documentencoding{%
8855  % Encoding being declared for the document.
8856  \def\declaredencoding{\csname #1.enc\endcsname}%
8857  %
8858  % Supported encodings: names converted to tokens in order to be able
8859  % to compare them with \ifx.
8860  \def\ascii{\csname US-ASCII.enc\endcsname}%
8861  \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8862  \def\latone{\csname ISO-8859-1.enc\endcsname}%
8863  \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8864  \def\utfeight{\csname UTF-8.enc\endcsname}%
8865  %
8866  \ifx \declaredencoding \ascii
8867     \asciichardefs
8868  %
8869  \else \ifx \declaredencoding \lattwo
8870     \setnonasciicharscatcode\active
8871     \lattwochardefs
8872  %
8873  \else \ifx \declaredencoding \latone
8874     \setnonasciicharscatcode\active
8875     \latonechardefs
8876  %
8877  \else \ifx \declaredencoding \latnine
8878     \setnonasciicharscatcode\active
8879     \latninechardefs
8880  %
8881  \else \ifx \declaredencoding \utfeight
8882     \setnonasciicharscatcode\active
8883     \utfeightchardefs
8884  %
8885  \else
8886    \message{Unknown document encoding #1, ignoring.}%
8887  %
8888  \fi % utfeight
8889  \fi % latnine
8890  \fi % latone
8891  \fi % lattwo
8892  \fi % ascii
8893}
8894
8895% A message to be logged when using a character that isn't available
8896% the default font encoding (OT1).
8897%
8898\def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8899
8900% Take account of \c (plain) vs. \, (Texinfo) difference.
8901\def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8902
8903% First, make active non-ASCII characters in order for them to be
8904% correctly categorized when TeX reads the replacement text of
8905% macros containing the character definitions.
8906\setnonasciicharscatcode\active
8907%
8908% Latin1 (ISO-8859-1) character definitions.
8909\def\latonechardefs{%
8910  \gdef^^a0{\tie}
8911  \gdef^^a1{\exclamdown}
8912  \gdef^^a2{\missingcharmsg{CENT SIGN}}
8913  \gdef^^a3{{\pounds}}
8914  \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8915  \gdef^^a5{\missingcharmsg{YEN SIGN}}
8916  \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8917  \gdef^^a7{\S}
8918  \gdef^^a8{\"{}}
8919  \gdef^^a9{\copyright}
8920  \gdef^^aa{\ordf}
8921  \gdef^^ab{\guillemetleft}
8922  \gdef^^ac{$\lnot$}
8923  \gdef^^ad{\-}
8924  \gdef^^ae{\registeredsymbol}
8925  \gdef^^af{\={}}
8926  %
8927  \gdef^^b0{\textdegree}
8928  \gdef^^b1{$\pm$}
8929  \gdef^^b2{$^2$}
8930  \gdef^^b3{$^3$}
8931  \gdef^^b4{\'{}}
8932  \gdef^^b5{$\mu$}
8933  \gdef^^b6{\P}
8934  %
8935  \gdef^^b7{$^.$}
8936  \gdef^^b8{\cedilla\ }
8937  \gdef^^b9{$^1$}
8938  \gdef^^ba{\ordm}
8939  %
8940  \gdef^^bb{\guillemetright}
8941  \gdef^^bc{$1\over4$}
8942  \gdef^^bd{$1\over2$}
8943  \gdef^^be{$3\over4$}
8944  \gdef^^bf{\questiondown}
8945  %
8946  \gdef^^c0{\`A}
8947  \gdef^^c1{\'A}
8948  \gdef^^c2{\^A}
8949  \gdef^^c3{\~A}
8950  \gdef^^c4{\"A}
8951  \gdef^^c5{\ringaccent A}
8952  \gdef^^c6{\AE}
8953  \gdef^^c7{\cedilla C}
8954  \gdef^^c8{\`E}
8955  \gdef^^c9{\'E}
8956  \gdef^^ca{\^E}
8957  \gdef^^cb{\"E}
8958  \gdef^^cc{\`I}
8959  \gdef^^cd{\'I}
8960  \gdef^^ce{\^I}
8961  \gdef^^cf{\"I}
8962  %
8963  \gdef^^d0{\DH}
8964  \gdef^^d1{\~N}
8965  \gdef^^d2{\`O}
8966  \gdef^^d3{\'O}
8967  \gdef^^d4{\^O}
8968  \gdef^^d5{\~O}
8969  \gdef^^d6{\"O}
8970  \gdef^^d7{$\times$}
8971  \gdef^^d8{\O}
8972  \gdef^^d9{\`U}
8973  \gdef^^da{\'U}
8974  \gdef^^db{\^U}
8975  \gdef^^dc{\"U}
8976  \gdef^^dd{\'Y}
8977  \gdef^^de{\TH}
8978  \gdef^^df{\ss}
8979  %
8980  \gdef^^e0{\`a}
8981  \gdef^^e1{\'a}
8982  \gdef^^e2{\^a}
8983  \gdef^^e3{\~a}
8984  \gdef^^e4{\"a}
8985  \gdef^^e5{\ringaccent a}
8986  \gdef^^e6{\ae}
8987  \gdef^^e7{\cedilla c}
8988  \gdef^^e8{\`e}
8989  \gdef^^e9{\'e}
8990  \gdef^^ea{\^e}
8991  \gdef^^eb{\"e}
8992  \gdef^^ec{\`{\dotless i}}
8993  \gdef^^ed{\'{\dotless i}}
8994  \gdef^^ee{\^{\dotless i}}
8995  \gdef^^ef{\"{\dotless i}}
8996  %
8997  \gdef^^f0{\dh}
8998  \gdef^^f1{\~n}
8999  \gdef^^f2{\`o}
9000  \gdef^^f3{\'o}
9001  \gdef^^f4{\^o}
9002  \gdef^^f5{\~o}
9003  \gdef^^f6{\"o}
9004  \gdef^^f7{$\div$}
9005  \gdef^^f8{\o}
9006  \gdef^^f9{\`u}
9007  \gdef^^fa{\'u}
9008  \gdef^^fb{\^u}
9009  \gdef^^fc{\"u}
9010  \gdef^^fd{\'y}
9011  \gdef^^fe{\th}
9012  \gdef^^ff{\"y}
9013}
9014
9015% Latin9 (ISO-8859-15) encoding character definitions.
9016\def\latninechardefs{%
9017  % Encoding is almost identical to Latin1.
9018  \latonechardefs
9019  %
9020  \gdef^^a4{\euro}
9021  \gdef^^a6{\v S}
9022  \gdef^^a8{\v s}
9023  \gdef^^b4{\v Z}
9024  \gdef^^b8{\v z}
9025  \gdef^^bc{\OE}
9026  \gdef^^bd{\oe}
9027  \gdef^^be{\"Y}
9028}
9029
9030% Latin2 (ISO-8859-2) character definitions.
9031\def\lattwochardefs{%
9032  \gdef^^a0{\tie}
9033  \gdef^^a1{\ogonek{A}}
9034  \gdef^^a2{\u{}}
9035  \gdef^^a3{\L}
9036  \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9037  \gdef^^a5{\v L}
9038  \gdef^^a6{\'S}
9039  \gdef^^a7{\S}
9040  \gdef^^a8{\"{}}
9041  \gdef^^a9{\v S}
9042  \gdef^^aa{\cedilla S}
9043  \gdef^^ab{\v T}
9044  \gdef^^ac{\'Z}
9045  \gdef^^ad{\-}
9046  \gdef^^ae{\v Z}
9047  \gdef^^af{\dotaccent Z}
9048  %
9049  \gdef^^b0{\textdegree}
9050  \gdef^^b1{\ogonek{a}}
9051  \gdef^^b2{\ogonek{ }}
9052  \gdef^^b3{\l}
9053  \gdef^^b4{\'{}}
9054  \gdef^^b5{\v l}
9055  \gdef^^b6{\'s}
9056  \gdef^^b7{\v{}}
9057  \gdef^^b8{\cedilla\ }
9058  \gdef^^b9{\v s}
9059  \gdef^^ba{\cedilla s}
9060  \gdef^^bb{\v t}
9061  \gdef^^bc{\'z}
9062  \gdef^^bd{\H{}}
9063  \gdef^^be{\v z}
9064  \gdef^^bf{\dotaccent z}
9065  %
9066  \gdef^^c0{\'R}
9067  \gdef^^c1{\'A}
9068  \gdef^^c2{\^A}
9069  \gdef^^c3{\u A}
9070  \gdef^^c4{\"A}
9071  \gdef^^c5{\'L}
9072  \gdef^^c6{\'C}
9073  \gdef^^c7{\cedilla C}
9074  \gdef^^c8{\v C}
9075  \gdef^^c9{\'E}
9076  \gdef^^ca{\ogonek{E}}
9077  \gdef^^cb{\"E}
9078  \gdef^^cc{\v E}
9079  \gdef^^cd{\'I}
9080  \gdef^^ce{\^I}
9081  \gdef^^cf{\v D}
9082  %
9083  \gdef^^d0{\DH}
9084  \gdef^^d1{\'N}
9085  \gdef^^d2{\v N}
9086  \gdef^^d3{\'O}
9087  \gdef^^d4{\^O}
9088  \gdef^^d5{\H O}
9089  \gdef^^d6{\"O}
9090  \gdef^^d7{$\times$}
9091  \gdef^^d8{\v R}
9092  \gdef^^d9{\ringaccent U}
9093  \gdef^^da{\'U}
9094  \gdef^^db{\H U}
9095  \gdef^^dc{\"U}
9096  \gdef^^dd{\'Y}
9097  \gdef^^de{\cedilla T}
9098  \gdef^^df{\ss}
9099  %
9100  \gdef^^e0{\'r}
9101  \gdef^^e1{\'a}
9102  \gdef^^e2{\^a}
9103  \gdef^^e3{\u a}
9104  \gdef^^e4{\"a}
9105  \gdef^^e5{\'l}
9106  \gdef^^e6{\'c}
9107  \gdef^^e7{\cedilla c}
9108  \gdef^^e8{\v c}
9109  \gdef^^e9{\'e}
9110  \gdef^^ea{\ogonek{e}}
9111  \gdef^^eb{\"e}
9112  \gdef^^ec{\v e}
9113  \gdef^^ed{\'{\dotless{i}}}
9114  \gdef^^ee{\^{\dotless{i}}}
9115  \gdef^^ef{\v d}
9116  %
9117  \gdef^^f0{\dh}
9118  \gdef^^f1{\'n}
9119  \gdef^^f2{\v n}
9120  \gdef^^f3{\'o}
9121  \gdef^^f4{\^o}
9122  \gdef^^f5{\H o}
9123  \gdef^^f6{\"o}
9124  \gdef^^f7{$\div$}
9125  \gdef^^f8{\v r}
9126  \gdef^^f9{\ringaccent u}
9127  \gdef^^fa{\'u}
9128  \gdef^^fb{\H u}
9129  \gdef^^fc{\"u}
9130  \gdef^^fd{\'y}
9131  \gdef^^fe{\cedilla t}
9132  \gdef^^ff{\dotaccent{}}
9133}
9134
9135% UTF-8 character definitions.
9136%
9137% This code to support UTF-8 is based on LaTeX's utf8.def, with some
9138% changes for Texinfo conventions.  It is included here under the GPL by
9139% permission from Frank Mittelbach and the LaTeX team.
9140%
9141\newcount\countUTFx
9142\newcount\countUTFy
9143\newcount\countUTFz
9144
9145\gdef\UTFviiiTwoOctets#1#2{\expandafter
9146   \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9147%
9148\gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9149   \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9150%
9151\gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9152   \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9153
9154\gdef\UTFviiiDefined#1{%
9155  \ifx #1\relax
9156    \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9157  \else
9158    \expandafter #1%
9159  \fi
9160}
9161
9162\begingroup
9163  \catcode`\~13
9164  \catcode`\"12
9165
9166  \def\UTFviiiLoop{%
9167    \global\catcode\countUTFx\active
9168    \uccode`\~\countUTFx
9169    \uppercase\expandafter{\UTFviiiTmp}%
9170    \advance\countUTFx by 1
9171    \ifnum\countUTFx < \countUTFy
9172      \expandafter\UTFviiiLoop
9173    \fi}
9174
9175  \countUTFx = "C2
9176  \countUTFy = "E0
9177  \def\UTFviiiTmp{%
9178    \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9179  \UTFviiiLoop
9180
9181  \countUTFx = "E0
9182  \countUTFy = "F0
9183  \def\UTFviiiTmp{%
9184    \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9185  \UTFviiiLoop
9186
9187  \countUTFx = "F0
9188  \countUTFy = "F4
9189  \def\UTFviiiTmp{%
9190    \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9191  \UTFviiiLoop
9192\endgroup
9193
9194\begingroup
9195  \catcode`\"=12
9196  \catcode`\<=12
9197  \catcode`\.=12
9198  \catcode`\,=12
9199  \catcode`\;=12
9200  \catcode`\!=12
9201  \catcode`\~=13
9202
9203  \gdef\DeclareUnicodeCharacter#1#2{%
9204    \countUTFz = "#1\relax
9205    %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9206    \begingroup
9207      \parseXMLCharref
9208      \def\UTFviiiTwoOctets##1##2{%
9209        \csname u8:##1\string ##2\endcsname}%
9210      \def\UTFviiiThreeOctets##1##2##3{%
9211        \csname u8:##1\string ##2\string ##3\endcsname}%
9212      \def\UTFviiiFourOctets##1##2##3##4{%
9213        \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9214      \expandafter\expandafter\expandafter\expandafter
9215       \expandafter\expandafter\expandafter
9216       \gdef\UTFviiiTmp{#2}%
9217    \endgroup}
9218
9219  \gdef\parseXMLCharref{%
9220    \ifnum\countUTFz < "A0\relax
9221      \errhelp = \EMsimple
9222      \errmessage{Cannot define Unicode char value < 00A0}%
9223    \else\ifnum\countUTFz < "800\relax
9224      \parseUTFviiiA,%
9225      \parseUTFviiiB C\UTFviiiTwoOctets.,%
9226    \else\ifnum\countUTFz < "10000\relax
9227      \parseUTFviiiA;%
9228      \parseUTFviiiA,%
9229      \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9230    \else
9231      \parseUTFviiiA;%
9232      \parseUTFviiiA,%
9233      \parseUTFviiiA!%
9234      \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9235    \fi\fi\fi
9236  }
9237
9238  \gdef\parseUTFviiiA#1{%
9239    \countUTFx = \countUTFz
9240    \divide\countUTFz by 64
9241    \countUTFy = \countUTFz
9242    \multiply\countUTFz by 64
9243    \advance\countUTFx by -\countUTFz
9244    \advance\countUTFx by 128
9245    \uccode `#1\countUTFx
9246    \countUTFz = \countUTFy}
9247
9248  \gdef\parseUTFviiiB#1#2#3#4{%
9249    \advance\countUTFz by "#10\relax
9250    \uccode `#3\countUTFz
9251    \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9252\endgroup
9253
9254\def\utfeightchardefs{%
9255  \DeclareUnicodeCharacter{00A0}{\tie}
9256  \DeclareUnicodeCharacter{00A1}{\exclamdown}
9257  \DeclareUnicodeCharacter{00A3}{\pounds}
9258  \DeclareUnicodeCharacter{00A8}{\"{ }}
9259  \DeclareUnicodeCharacter{00A9}{\copyright}
9260  \DeclareUnicodeCharacter{00AA}{\ordf}
9261  \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9262  \DeclareUnicodeCharacter{00AD}{\-}
9263  \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9264  \DeclareUnicodeCharacter{00AF}{\={ }}
9265
9266  \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9267  \DeclareUnicodeCharacter{00B4}{\'{ }}
9268  \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9269  \DeclareUnicodeCharacter{00BA}{\ordm}
9270  \DeclareUnicodeCharacter{00BB}{\guillemetright}
9271  \DeclareUnicodeCharacter{00BF}{\questiondown}
9272
9273  \DeclareUnicodeCharacter{00C0}{\`A}
9274  \DeclareUnicodeCharacter{00C1}{\'A}
9275  \DeclareUnicodeCharacter{00C2}{\^A}
9276  \DeclareUnicodeCharacter{00C3}{\~A}
9277  \DeclareUnicodeCharacter{00C4}{\"A}
9278  \DeclareUnicodeCharacter{00C5}{\AA}
9279  \DeclareUnicodeCharacter{00C6}{\AE}
9280  \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9281  \DeclareUnicodeCharacter{00C8}{\`E}
9282  \DeclareUnicodeCharacter{00C9}{\'E}
9283  \DeclareUnicodeCharacter{00CA}{\^E}
9284  \DeclareUnicodeCharacter{00CB}{\"E}
9285  \DeclareUnicodeCharacter{00CC}{\`I}
9286  \DeclareUnicodeCharacter{00CD}{\'I}
9287  \DeclareUnicodeCharacter{00CE}{\^I}
9288  \DeclareUnicodeCharacter{00CF}{\"I}
9289
9290  \DeclareUnicodeCharacter{00D0}{\DH}
9291  \DeclareUnicodeCharacter{00D1}{\~N}
9292  \DeclareUnicodeCharacter{00D2}{\`O}
9293  \DeclareUnicodeCharacter{00D3}{\'O}
9294  \DeclareUnicodeCharacter{00D4}{\^O}
9295  \DeclareUnicodeCharacter{00D5}{\~O}
9296  \DeclareUnicodeCharacter{00D6}{\"O}
9297  \DeclareUnicodeCharacter{00D8}{\O}
9298  \DeclareUnicodeCharacter{00D9}{\`U}
9299  \DeclareUnicodeCharacter{00DA}{\'U}
9300  \DeclareUnicodeCharacter{00DB}{\^U}
9301  \DeclareUnicodeCharacter{00DC}{\"U}
9302  \DeclareUnicodeCharacter{00DD}{\'Y}
9303  \DeclareUnicodeCharacter{00DE}{\TH}
9304  \DeclareUnicodeCharacter{00DF}{\ss}
9305
9306  \DeclareUnicodeCharacter{00E0}{\`a}
9307  \DeclareUnicodeCharacter{00E1}{\'a}
9308  \DeclareUnicodeCharacter{00E2}{\^a}
9309  \DeclareUnicodeCharacter{00E3}{\~a}
9310  \DeclareUnicodeCharacter{00E4}{\"a}
9311  \DeclareUnicodeCharacter{00E5}{\aa}
9312  \DeclareUnicodeCharacter{00E6}{\ae}
9313  \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9314  \DeclareUnicodeCharacter{00E8}{\`e}
9315  \DeclareUnicodeCharacter{00E9}{\'e}
9316  \DeclareUnicodeCharacter{00EA}{\^e}
9317  \DeclareUnicodeCharacter{00EB}{\"e}
9318  \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9319  \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9320  \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9321  \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9322
9323  \DeclareUnicodeCharacter{00F0}{\dh}
9324  \DeclareUnicodeCharacter{00F1}{\~n}
9325  \DeclareUnicodeCharacter{00F2}{\`o}
9326  \DeclareUnicodeCharacter{00F3}{\'o}
9327  \DeclareUnicodeCharacter{00F4}{\^o}
9328  \DeclareUnicodeCharacter{00F5}{\~o}
9329  \DeclareUnicodeCharacter{00F6}{\"o}
9330  \DeclareUnicodeCharacter{00F8}{\o}
9331  \DeclareUnicodeCharacter{00F9}{\`u}
9332  \DeclareUnicodeCharacter{00FA}{\'u}
9333  \DeclareUnicodeCharacter{00FB}{\^u}
9334  \DeclareUnicodeCharacter{00FC}{\"u}
9335  \DeclareUnicodeCharacter{00FD}{\'y}
9336  \DeclareUnicodeCharacter{00FE}{\th}
9337  \DeclareUnicodeCharacter{00FF}{\"y}
9338
9339  \DeclareUnicodeCharacter{0100}{\=A}
9340  \DeclareUnicodeCharacter{0101}{\=a}
9341  \DeclareUnicodeCharacter{0102}{\u{A}}
9342  \DeclareUnicodeCharacter{0103}{\u{a}}
9343  \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9344  \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9345  \DeclareUnicodeCharacter{0106}{\'C}
9346  \DeclareUnicodeCharacter{0107}{\'c}
9347  \DeclareUnicodeCharacter{0108}{\^C}
9348  \DeclareUnicodeCharacter{0109}{\^c}
9349  \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9350  \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9351  \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9352  \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9353  \DeclareUnicodeCharacter{010C}{\v{C}}
9354  \DeclareUnicodeCharacter{010D}{\v{c}}
9355  \DeclareUnicodeCharacter{010E}{\v{D}}
9356
9357  \DeclareUnicodeCharacter{0112}{\=E}
9358  \DeclareUnicodeCharacter{0113}{\=e}
9359  \DeclareUnicodeCharacter{0114}{\u{E}}
9360  \DeclareUnicodeCharacter{0115}{\u{e}}
9361  \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9362  \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9363  \DeclareUnicodeCharacter{011A}{\v{E}}
9364  \DeclareUnicodeCharacter{011B}{\v{e}}
9365  \DeclareUnicodeCharacter{011C}{\^G}
9366  \DeclareUnicodeCharacter{011D}{\^g}
9367  \DeclareUnicodeCharacter{011E}{\u{G}}
9368  \DeclareUnicodeCharacter{011F}{\u{g}}
9369
9370  \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9371  \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9372  \DeclareUnicodeCharacter{0124}{\^H}
9373  \DeclareUnicodeCharacter{0125}{\^h}
9374  \DeclareUnicodeCharacter{0128}{\~I}
9375  \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9376  \DeclareUnicodeCharacter{012A}{\=I}
9377  \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9378  \DeclareUnicodeCharacter{012C}{\u{I}}
9379  \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9380
9381  \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9382  \DeclareUnicodeCharacter{0131}{\dotless{i}}
9383  \DeclareUnicodeCharacter{0132}{IJ}
9384  \DeclareUnicodeCharacter{0133}{ij}
9385  \DeclareUnicodeCharacter{0134}{\^J}
9386  \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9387  \DeclareUnicodeCharacter{0139}{\'L}
9388  \DeclareUnicodeCharacter{013A}{\'l}
9389
9390  \DeclareUnicodeCharacter{0141}{\L}
9391  \DeclareUnicodeCharacter{0142}{\l}
9392  \DeclareUnicodeCharacter{0143}{\'N}
9393  \DeclareUnicodeCharacter{0144}{\'n}
9394  \DeclareUnicodeCharacter{0147}{\v{N}}
9395  \DeclareUnicodeCharacter{0148}{\v{n}}
9396  \DeclareUnicodeCharacter{014C}{\=O}
9397  \DeclareUnicodeCharacter{014D}{\=o}
9398  \DeclareUnicodeCharacter{014E}{\u{O}}
9399  \DeclareUnicodeCharacter{014F}{\u{o}}
9400
9401  \DeclareUnicodeCharacter{0150}{\H{O}}
9402  \DeclareUnicodeCharacter{0151}{\H{o}}
9403  \DeclareUnicodeCharacter{0152}{\OE}
9404  \DeclareUnicodeCharacter{0153}{\oe}
9405  \DeclareUnicodeCharacter{0154}{\'R}
9406  \DeclareUnicodeCharacter{0155}{\'r}
9407  \DeclareUnicodeCharacter{0158}{\v{R}}
9408  \DeclareUnicodeCharacter{0159}{\v{r}}
9409  \DeclareUnicodeCharacter{015A}{\'S}
9410  \DeclareUnicodeCharacter{015B}{\'s}
9411  \DeclareUnicodeCharacter{015C}{\^S}
9412  \DeclareUnicodeCharacter{015D}{\^s}
9413  \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9414  \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9415
9416  \DeclareUnicodeCharacter{0160}{\v{S}}
9417  \DeclareUnicodeCharacter{0161}{\v{s}}
9418  \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9419  \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9420  \DeclareUnicodeCharacter{0164}{\v{T}}
9421
9422  \DeclareUnicodeCharacter{0168}{\~U}
9423  \DeclareUnicodeCharacter{0169}{\~u}
9424  \DeclareUnicodeCharacter{016A}{\=U}
9425  \DeclareUnicodeCharacter{016B}{\=u}
9426  \DeclareUnicodeCharacter{016C}{\u{U}}
9427  \DeclareUnicodeCharacter{016D}{\u{u}}
9428  \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9429  \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9430
9431  \DeclareUnicodeCharacter{0170}{\H{U}}
9432  \DeclareUnicodeCharacter{0171}{\H{u}}
9433  \DeclareUnicodeCharacter{0174}{\^W}
9434  \DeclareUnicodeCharacter{0175}{\^w}
9435  \DeclareUnicodeCharacter{0176}{\^Y}
9436  \DeclareUnicodeCharacter{0177}{\^y}
9437  \DeclareUnicodeCharacter{0178}{\"Y}
9438  \DeclareUnicodeCharacter{0179}{\'Z}
9439  \DeclareUnicodeCharacter{017A}{\'z}
9440  \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9441  \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9442  \DeclareUnicodeCharacter{017D}{\v{Z}}
9443  \DeclareUnicodeCharacter{017E}{\v{z}}
9444
9445  \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9446  \DeclareUnicodeCharacter{01C5}{D\v{z}}
9447  \DeclareUnicodeCharacter{01C6}{d\v{z}}
9448  \DeclareUnicodeCharacter{01C7}{LJ}
9449  \DeclareUnicodeCharacter{01C8}{Lj}
9450  \DeclareUnicodeCharacter{01C9}{lj}
9451  \DeclareUnicodeCharacter{01CA}{NJ}
9452  \DeclareUnicodeCharacter{01CB}{Nj}
9453  \DeclareUnicodeCharacter{01CC}{nj}
9454  \DeclareUnicodeCharacter{01CD}{\v{A}}
9455  \DeclareUnicodeCharacter{01CE}{\v{a}}
9456  \DeclareUnicodeCharacter{01CF}{\v{I}}
9457
9458  \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9459  \DeclareUnicodeCharacter{01D1}{\v{O}}
9460  \DeclareUnicodeCharacter{01D2}{\v{o}}
9461  \DeclareUnicodeCharacter{01D3}{\v{U}}
9462  \DeclareUnicodeCharacter{01D4}{\v{u}}
9463
9464  \DeclareUnicodeCharacter{01E2}{\={\AE}}
9465  \DeclareUnicodeCharacter{01E3}{\={\ae}}
9466  \DeclareUnicodeCharacter{01E6}{\v{G}}
9467  \DeclareUnicodeCharacter{01E7}{\v{g}}
9468  \DeclareUnicodeCharacter{01E8}{\v{K}}
9469  \DeclareUnicodeCharacter{01E9}{\v{k}}
9470
9471  \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9472  \DeclareUnicodeCharacter{01F1}{DZ}
9473  \DeclareUnicodeCharacter{01F2}{Dz}
9474  \DeclareUnicodeCharacter{01F3}{dz}
9475  \DeclareUnicodeCharacter{01F4}{\'G}
9476  \DeclareUnicodeCharacter{01F5}{\'g}
9477  \DeclareUnicodeCharacter{01F8}{\`N}
9478  \DeclareUnicodeCharacter{01F9}{\`n}
9479  \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9480  \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9481  \DeclareUnicodeCharacter{01FE}{\'{\O}}
9482  \DeclareUnicodeCharacter{01FF}{\'{\o}}
9483
9484  \DeclareUnicodeCharacter{021E}{\v{H}}
9485  \DeclareUnicodeCharacter{021F}{\v{h}}
9486
9487  \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9488  \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9489  \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9490  \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9491  \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9492  \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9493
9494  \DeclareUnicodeCharacter{0232}{\=Y}
9495  \DeclareUnicodeCharacter{0233}{\=y}
9496  \DeclareUnicodeCharacter{0237}{\dotless{j}}
9497
9498  \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9499
9500  \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9501  \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9502  \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9503  \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9504  \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9505  \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9506  \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9507  \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9508  \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9509  \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9510  \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9511  \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9512
9513  \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9514  \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9515
9516  \DeclareUnicodeCharacter{1E20}{\=G}
9517  \DeclareUnicodeCharacter{1E21}{\=g}
9518  \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9519  \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9520  \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9521  \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9522  \DeclareUnicodeCharacter{1E26}{\"H}
9523  \DeclareUnicodeCharacter{1E27}{\"h}
9524
9525  \DeclareUnicodeCharacter{1E30}{\'K}
9526  \DeclareUnicodeCharacter{1E31}{\'k}
9527  \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9528  \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9529  \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9530  \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9531  \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9532  \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9533  \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9534  \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9535  \DeclareUnicodeCharacter{1E3E}{\'M}
9536  \DeclareUnicodeCharacter{1E3F}{\'m}
9537
9538  \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9539  \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9540  \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9541  \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9542  \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9543  \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9544  \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9545  \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9546  \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9547  \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9548
9549  \DeclareUnicodeCharacter{1E54}{\'P}
9550  \DeclareUnicodeCharacter{1E55}{\'p}
9551  \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9552  \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9553  \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9554  \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9555  \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9556  \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9557  \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9558  \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9559
9560  \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9561  \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9562  \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9563  \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9564  \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9565  \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9566  \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9567  \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9568  \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9569  \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9570
9571  \DeclareUnicodeCharacter{1E7C}{\~V}
9572  \DeclareUnicodeCharacter{1E7D}{\~v}
9573  \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9574  \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9575
9576  \DeclareUnicodeCharacter{1E80}{\`W}
9577  \DeclareUnicodeCharacter{1E81}{\`w}
9578  \DeclareUnicodeCharacter{1E82}{\'W}
9579  \DeclareUnicodeCharacter{1E83}{\'w}
9580  \DeclareUnicodeCharacter{1E84}{\"W}
9581  \DeclareUnicodeCharacter{1E85}{\"w}
9582  \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9583  \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9584  \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9585  \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9586  \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9587  \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9588  \DeclareUnicodeCharacter{1E8C}{\"X}
9589  \DeclareUnicodeCharacter{1E8D}{\"x}
9590  \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9591  \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9592
9593  \DeclareUnicodeCharacter{1E90}{\^Z}
9594  \DeclareUnicodeCharacter{1E91}{\^z}
9595  \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9596  \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9597  \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9598  \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9599  \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9600  \DeclareUnicodeCharacter{1E97}{\"t}
9601  \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9602  \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9603
9604  \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9605  \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9606
9607  \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9608  \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9609  \DeclareUnicodeCharacter{1EBC}{\~E}
9610  \DeclareUnicodeCharacter{1EBD}{\~e}
9611
9612  \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9613  \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9614  \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9615  \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9616
9617  \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9618  \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9619
9620  \DeclareUnicodeCharacter{1EF2}{\`Y}
9621  \DeclareUnicodeCharacter{1EF3}{\`y}
9622  \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9623
9624  \DeclareUnicodeCharacter{1EF8}{\~Y}
9625  \DeclareUnicodeCharacter{1EF9}{\~y}
9626
9627  \DeclareUnicodeCharacter{2013}{--}
9628  \DeclareUnicodeCharacter{2014}{---}
9629  \DeclareUnicodeCharacter{2018}{\quoteleft}
9630  \DeclareUnicodeCharacter{2019}{\quoteright}
9631  \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9632  \DeclareUnicodeCharacter{201C}{\quotedblleft}
9633  \DeclareUnicodeCharacter{201D}{\quotedblright}
9634  \DeclareUnicodeCharacter{201E}{\quotedblbase}
9635  \DeclareUnicodeCharacter{2022}{\bullet}
9636  \DeclareUnicodeCharacter{2026}{\dots}
9637  \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9638  \DeclareUnicodeCharacter{203A}{\guilsinglright}
9639  \DeclareUnicodeCharacter{20AC}{\euro}
9640
9641  \DeclareUnicodeCharacter{2192}{\expansion}
9642  \DeclareUnicodeCharacter{21D2}{\result}
9643
9644  \DeclareUnicodeCharacter{2212}{\minus}
9645  \DeclareUnicodeCharacter{2217}{\point}
9646  \DeclareUnicodeCharacter{2261}{\equiv}
9647}% end of \utfeightchardefs
9648
9649
9650% US-ASCII character definitions.
9651\def\asciichardefs{% nothing need be done
9652   \relax
9653}
9654
9655% Make non-ASCII characters printable again for compatibility with
9656% existing Texinfo documents that may use them, even without declaring a
9657% document encoding.
9658%
9659\setnonasciicharscatcode \other
9660
9661
9662\message{formatting,}
9663
9664\newdimen\defaultparindent \defaultparindent = 15pt
9665
9666\chapheadingskip = 15pt plus 4pt minus 2pt
9667\secheadingskip = 12pt plus 3pt minus 2pt
9668\subsecheadingskip = 9pt plus 2pt minus 2pt
9669
9670% Prevent underfull vbox error messages.
9671\vbadness = 10000
9672
9673% Don't be very finicky about underfull hboxes, either.
9674\hbadness = 6666
9675
9676% Following George Bush, get rid of widows and orphans.
9677\widowpenalty=10000
9678\clubpenalty=10000
9679
9680% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9681% using an old version of TeX, don't do anything.  We want the amount of
9682% stretch added to depend on the line length, hence the dependence on
9683% \hsize.  We call this whenever the paper size is set.
9684%
9685\def\setemergencystretch{%
9686  \ifx\emergencystretch\thisisundefined
9687    % Allow us to assign to \emergencystretch anyway.
9688    \def\emergencystretch{\dimen0}%
9689  \else
9690    \emergencystretch = .15\hsize
9691  \fi
9692}
9693
9694% Parameters in order: 1) textheight; 2) textwidth;
9695% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9696% 7) physical page height; 8) physical page width.
9697%
9698% We also call \setleading{\textleading}, so the caller should define
9699% \textleading.  The caller should also set \parskip.
9700%
9701\def\internalpagesizes#1#2#3#4#5#6#7#8{%
9702  \voffset = #3\relax
9703  \topskip = #6\relax
9704  \splittopskip = \topskip
9705  %
9706  \vsize = #1\relax
9707  \advance\vsize by \topskip
9708  \outervsize = \vsize
9709  \advance\outervsize by 2\topandbottommargin
9710  \pageheight = \vsize
9711  %
9712  \hsize = #2\relax
9713  \outerhsize = \hsize
9714  \advance\outerhsize by 0.5in
9715  \pagewidth = \hsize
9716  %
9717  \normaloffset = #4\relax
9718  \bindingoffset = #5\relax
9719  %
9720  \ifpdf
9721    \pdfpageheight #7\relax
9722    \pdfpagewidth #8\relax
9723    % if we don't reset these, they will remain at "1 true in" of
9724    % whatever layout pdftex was dumped with.
9725    \pdfhorigin = 1 true in
9726    \pdfvorigin = 1 true in
9727  \fi
9728  %
9729  \setleading{\textleading}
9730  %
9731  \parindent = \defaultparindent
9732  \setemergencystretch
9733}
9734
9735% @letterpaper (the default).
9736\def\letterpaper{{\globaldefs = 1
9737  \parskip = 3pt plus 2pt minus 1pt
9738  \textleading = 13.2pt
9739  %
9740  % If page is nothing but text, make it come out even.
9741  \internalpagesizes{607.2pt}{6in}% that's 46 lines
9742                    {\voffset}{.25in}%
9743                    {\bindingoffset}{36pt}%
9744                    {11in}{8.5in}%
9745}}
9746
9747% Use @smallbook to reset parameters for 7x9.25 trim size.
9748\def\smallbook{{\globaldefs = 1
9749  \parskip = 2pt plus 1pt
9750  \textleading = 12pt
9751  %
9752  \internalpagesizes{7.5in}{5in}%
9753                    {-.2in}{0in}%
9754                    {\bindingoffset}{16pt}%
9755                    {9.25in}{7in}%
9756  %
9757  \lispnarrowing = 0.3in
9758  \tolerance = 700
9759  \hfuzz = 1pt
9760  \contentsrightmargin = 0pt
9761  \defbodyindent = .5cm
9762}}
9763
9764% Use @smallerbook to reset parameters for 6x9 trim size.
9765% (Just testing, parameters still in flux.)
9766\def\smallerbook{{\globaldefs = 1
9767  \parskip = 1.5pt plus 1pt
9768  \textleading = 12pt
9769  %
9770  \internalpagesizes{7.4in}{4.8in}%
9771                    {-.2in}{-.4in}%
9772                    {0pt}{14pt}%
9773                    {9in}{6in}%
9774  %
9775  \lispnarrowing = 0.25in
9776  \tolerance = 700
9777  \hfuzz = 1pt
9778  \contentsrightmargin = 0pt
9779  \defbodyindent = .4cm
9780}}
9781
9782% Use @afourpaper to print on European A4 paper.
9783\def\afourpaper{{\globaldefs = 1
9784  \parskip = 3pt plus 2pt minus 1pt
9785  \textleading = 13.2pt
9786  %
9787  % Double-side printing via postscript on Laserjet 4050
9788  % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9789  % To change the settings for a different printer or situation, adjust
9790  % \normaloffset until the front-side and back-side texts align.  Then
9791  % do the same for \bindingoffset.  You can set these for testing in
9792  % your texinfo source file like this:
9793  % @tex
9794  % \global\normaloffset = -6mm
9795  % \global\bindingoffset = 10mm
9796  % @end tex
9797  \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9798                    {\voffset}{\hoffset}%
9799                    {\bindingoffset}{44pt}%
9800                    {297mm}{210mm}%
9801  %
9802  \tolerance = 700
9803  \hfuzz = 1pt
9804  \contentsrightmargin = 0pt
9805  \defbodyindent = 5mm
9806}}
9807
9808% Use @afivepaper to print on European A5 paper.
9809% From romildo@urano.iceb.ufop.br, 2 July 2000.
9810% He also recommends making @example and @lisp be small.
9811\def\afivepaper{{\globaldefs = 1
9812  \parskip = 2pt plus 1pt minus 0.1pt
9813  \textleading = 12.5pt
9814  %
9815  \internalpagesizes{160mm}{120mm}%
9816                    {\voffset}{\hoffset}%
9817                    {\bindingoffset}{8pt}%
9818                    {210mm}{148mm}%
9819  %
9820  \lispnarrowing = 0.2in
9821  \tolerance = 800
9822  \hfuzz = 1.2pt
9823  \contentsrightmargin = 0pt
9824  \defbodyindent = 2mm
9825  \tableindent = 12mm
9826}}
9827
9828% A specific text layout, 24x15cm overall, intended for A4 paper.
9829\def\afourlatex{{\globaldefs = 1
9830  \afourpaper
9831  \internalpagesizes{237mm}{150mm}%
9832                    {\voffset}{4.6mm}%
9833                    {\bindingoffset}{7mm}%
9834                    {297mm}{210mm}%
9835  %
9836  % Must explicitly reset to 0 because we call \afourpaper.
9837  \globaldefs = 0
9838}}
9839
9840% Use @afourwide to print on A4 paper in landscape format.
9841\def\afourwide{{\globaldefs = 1
9842  \afourpaper
9843  \internalpagesizes{241mm}{165mm}%
9844                    {\voffset}{-2.95mm}%
9845                    {\bindingoffset}{7mm}%
9846                    {297mm}{210mm}%
9847  \globaldefs = 0
9848}}
9849
9850% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9851% Perhaps we should allow setting the margins, \topskip, \parskip,
9852% and/or leading, also. Or perhaps we should compute them somehow.
9853%
9854\parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9855\def\pagesizesyyy#1,#2,#3\finish{{%
9856  \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9857  \globaldefs = 1
9858  %
9859  \parskip = 3pt plus 2pt minus 1pt
9860  \setleading{\textleading}%
9861  %
9862  \dimen0 = #1\relax
9863  \advance\dimen0 by \voffset
9864  %
9865  \dimen2 = \hsize
9866  \advance\dimen2 by \normaloffset
9867  %
9868  \internalpagesizes{#1}{\hsize}%
9869                    {\voffset}{\normaloffset}%
9870                    {\bindingoffset}{44pt}%
9871                    {\dimen0}{\dimen2}%
9872}}
9873
9874% Set default to letter.
9875%
9876\letterpaper
9877
9878
9879\message{and turning on texinfo input format.}
9880
9881\def^^L{\par} % remove \outer, so ^L can appear in an @comment
9882
9883% DEL is a comment character, in case @c does not suffice.
9884\catcode`\^^? = 14
9885
9886% Define macros to output various characters with catcode for normal text.
9887\catcode`\"=\other \def\normaldoublequote{"}
9888\catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9889\catcode`\+=\other \def\normalplus{+}
9890\catcode`\<=\other \def\normalless{<}
9891\catcode`\>=\other \def\normalgreater{>}
9892\catcode`\^=\other \def\normalcaret{^}
9893\catcode`\_=\other \def\normalunderscore{_}
9894\catcode`\|=\other \def\normalverticalbar{|}
9895\catcode`\~=\other \def\normaltilde{~}
9896
9897% This macro is used to make a character print one way in \tt
9898% (where it can probably be output as-is), and another way in other fonts,
9899% where something hairier probably needs to be done.
9900%
9901% #1 is what to print if we are indeed using \tt; #2 is what to print
9902% otherwise.  Since all the Computer Modern typewriter fonts have zero
9903% interword stretch (and shrink), and it is reasonable to expect all
9904% typewriter fonts to have this, we can check that font parameter.
9905%
9906\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9907
9908% Same as above, but check for italic font.  Actually this also catches
9909% non-italic slanted fonts since it is impossible to distinguish them from
9910% italic fonts.  But since this is only used by $ and it uses \sl anyway
9911% this is not a problem.
9912\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9913
9914% Turn off all special characters except @
9915% (and those which the user can use as if they were ordinary).
9916% Most of these we simply print from the \tt font, but for some, we can
9917% use math or other variants that look better in normal text.
9918
9919\catcode`\"=\active
9920\def\activedoublequote{{\tt\char34}}
9921\let"=\activedoublequote
9922\catcode`\~=\active
9923\def~{{\tt\char126}}
9924\chardef\hat=`\^
9925\catcode`\^=\active
9926\def^{{\tt \hat}}
9927
9928\catcode`\_=\active
9929\def_{\ifusingtt\normalunderscore\_}
9930\let\realunder=_
9931% Subroutine for the previous macro.
9932\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9933
9934\catcode`\|=\active
9935\def|{{\tt\char124}}
9936\chardef \less=`\<
9937\catcode`\<=\active
9938\def<{{\tt \less}}
9939\chardef \gtr=`\>
9940\catcode`\>=\active
9941\def>{{\tt \gtr}}
9942\catcode`\+=\active
9943\def+{{\tt \char 43}}
9944\catcode`\$=\active
9945\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9946
9947% If a .fmt file is being used, characters that might appear in a file
9948% name cannot be active until we have parsed the command line.
9949% So turn them off again, and have \everyjob (or @setfilename) turn them on.
9950% \otherifyactive is called near the end of this file.
9951\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9952
9953% Used sometimes to turn off (effectively) the active characters even after
9954% parsing them.
9955\def\turnoffactive{%
9956  \normalturnoffactive
9957  \otherbackslash
9958}
9959
9960\catcode`\@=0
9961
9962% \backslashcurfont outputs one backslash character in current font,
9963% as in \char`\\.
9964\global\chardef\backslashcurfont=`\\
9965\global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
9966
9967% \realbackslash is an actual character `\' with catcode other, and
9968% \doublebackslash is two of them (for the pdf outlines).
9969{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9970
9971% In texinfo, backslash is an active character; it prints the backslash
9972% in fixed width font.
9973\catcode`\\=\active  % @ for escape char from now on.
9974
9975% The story here is that in math mode, the \char of \backslashcurfont
9976% ends up printing the roman \ from the math symbol font (because \char
9977% in math mode uses the \mathcode, and plain.tex sets
9978% \mathcode`\\="026E).  It seems better for @backslashchar{} to always
9979% print a typewriter backslash, hence we use an explicit \mathchar,
9980% which is the decimal equivalent of "715c (class 7, e.g., use \fam;
9981% ignored family value; char position "5C).  We can't use " for the
9982% usual hex value because it has already been made active.
9983@def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
9984@let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
9985
9986% On startup, @fixbackslash assigns:
9987%  @let \ = @normalbackslash
9988% \rawbackslash defines an active \ to do \backslashcurfont.
9989% \otherbackslash defines an active \ to be a literal `\' character with
9990% catcode other.  We switch back and forth between these.
9991@gdef@rawbackslash{@let\=@backslashcurfont}
9992@gdef@otherbackslash{@let\=@realbackslash}
9993
9994% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9995% the literal character `\'.
9996%
9997@def@normalturnoffactive{%
9998  @let"=@normaldoublequote
9999  @let$=@normaldollar %$ font-lock fix
10000  @let+=@normalplus
10001  @let<=@normalless
10002  @let>=@normalgreater
10003  @let\=@normalbackslash
10004  @let^=@normalcaret
10005  @let_=@normalunderscore
10006  @let|=@normalverticalbar
10007  @let~=@normaltilde
10008  @markupsetuplqdefault
10009  @markupsetuprqdefault
10010  @unsepspaces
10011}
10012
10013% Make _ and + \other characters, temporarily.
10014% This is canceled by @fixbackslash.
10015@otherifyactive
10016
10017% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10018% That is what \eatinput is for; after that, the `\' should revert to printing
10019% a backslash.
10020%
10021@gdef@eatinput input texinfo{@fixbackslash}
10022@global@let\ = @eatinput
10023
10024% On the other hand, perhaps the file did not have a `\input texinfo'. Then
10025% the first `\' in the file would cause an error. This macro tries to fix
10026% that, assuming it is called before the first `\' could plausibly occur.
10027% Also turn back on active characters that might appear in the input
10028% file name, in case not using a pre-dumped format.
10029%
10030@gdef@fixbackslash{%
10031  @ifx\@eatinput @let\ = @normalbackslash @fi
10032  @catcode`+=@active
10033  @catcode`@_=@active
10034}
10035
10036% Say @foo, not \foo, in error messages.
10037@escapechar = `@@
10038
10039% These (along with & and #) are made active for url-breaking, so need
10040% active definitions as the normal characters.
10041@def@normaldot{.}
10042@def@normalquest{?}
10043@def@normalslash{/}
10044
10045% These look ok in all fonts, so just make them not special.
10046% @hashchar{} gets its own user-level command, because of #line.
10047@catcode`@& = @other @def@normalamp{&}
10048@catcode`@# = @other @def@normalhash{#}
10049@catcode`@% = @other @def@normalpercent{%}
10050
10051@let @hashchar = @normalhash
10052
10053@c Finally, make ` and ' active, so that txicodequoteundirected and
10054@c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
10055@c don't make ` and ' active, @code will not get them as active chars.
10056@c Do this last of all since we use ` in the previous @catcode assignments.
10057@catcode`@'=@active
10058@catcode`@`=@active
10059@markupsetuplqdefault
10060@markupsetuprqdefault
10061
10062@c Local variables:
10063@c eval: (add-hook 'write-file-hooks 'time-stamp)
10064@c page-delimiter: "^\\\\message"
10065@c time-stamp-start: "def\\\\texinfoversion{"
10066@c time-stamp-format: "%:y-%02m-%02d.%02H"
10067@c time-stamp-end: "}"
10068@c End:
10069
10070@c vim:sw=2:
10071
10072@ignore
10073   arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
10074@end ignore
10075