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