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