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