"Fossies" - the Fresh Open Source Software Archive 
Member "alive-2.0.5/build-aux/texinfo.tex" (2 Jan 2022, 374287 Bytes) of package /linux/privat/alive-2.0.5.tar.lz:
As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) TeX and LaTeX source code syntax highlighting (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
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{2021-11-01.16}
7 %
8 % Copyright 1985, 1986, 1988, 1990-2021 Free Software Foundation, Inc.
9 %
10 % This texinfo.tex file is free software: you can redistribute it and/or
11 % modify it under the terms of the GNU General Public License as
12 % published by the Free Software Foundation, either version 3 of the
13 % License, or (at your option) any later version.
14 %
15 % This texinfo.tex file is distributed in the hope that it will be
16 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 % General Public License for more details.
19 %
20 % You should have received a copy of the GNU General Public License
21 % along with this program. If not, see <https://www.gnu.org/licenses/>.
22 %
23 % As a special exception, when this file is read by TeX when processing
24 % a Texinfo source document, you may use the result without
25 % restriction. This Exception is an additional permission under section 7
26 % of the GNU General Public License, version 3 ("GPLv3").
27 %
28 % Please try the latest version of texinfo.tex before submitting bug
29 % reports; you can get the latest version from:
30 % https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
31 % https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
32 % https://www.gnu.org/software/texinfo/ (the Texinfo home page)
33 % The texinfo.tex in any given distribution could well be out
34 % of date, so if that's what you're using, please check.
35 %
36 % Send bug reports to bug-texinfo@gnu.org. Please include a
37 % complete document in each bug report with which we can reproduce the
38 % problem. Patches are, of course, greatly appreciated.
39 %
40 % To process a Texinfo manual with TeX, it's most reliable to use the
41 % texi2dvi shell script that comes with the distribution. For a simple
42 % manual foo.texi, however, you can get away with this:
43 % tex foo.texi
44 % texindex foo.??
45 % tex foo.texi
46 % tex foo.texi
47 % dvips foo.dvi -o # or whatever; this makes foo.ps.
48 % The extra TeX runs get the cross-reference information correct.
49 % Sometimes one run after texindex suffices, and sometimes you need more
50 % than two; texi2dvi does it as many times as necessary.
51 %
52 % It is possible to adapt texinfo.tex for other languages, to some
53 % extent. You can get the existing language-specific files from the
54 % full Texinfo distribution.
55 %
56 % The GNU Texinfo home page is https://www.gnu.org/software/texinfo.
57
58
59 \message{Loading texinfo [version \texinfoversion]:}
60
61 % If in a .fmt file, print the version number
62 % and turn on active characters that we couldn't do earlier because
63 % they might have appeared in the input file name.
64 \everyjob{\message{[Texinfo version \texinfoversion]}%
65 \catcode`+=\active \catcode`\_=\active}
66
67 % LaTeX's \typeout. This ensures that the messages it is used for
68 % are identical in format to the corresponding ones from latex/pdflatex.
69 \def\typeout{\immediate\write17}%
70
71 \chardef\other=12
72
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
76
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
93 \let\ptexlbrace=\{
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
97 \let\ptexplus=+
98 \let\ptexraggedright=\raggedright
99 \let\ptexrbrace=\}
100 \let\ptexslash=\/
101 \let\ptexsp=\sp
102 \let\ptexstar=\*
103 \let\ptexsup=\sup
104 \let\ptext=\t
105 \let\ptextop=\top
106 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
107
108 % If this character appears in an error message or help string, it
109 % starts a new line in the output.
110 \newlinechar = `^^J
111
112 % Use TeX 3.0's \inputlineno to get the line number, for better error
113 % messages, but if we're using an old version of TeX, don't do anything.
114 %
115 \ifx\inputlineno\thisisundefined
116 \let\linenumber = \empty % Pre-3.0.
117 \else
118 \def\linenumber{l.\the\inputlineno:\space}
119 \fi
120
121 % Set up fixed words for English if not already set.
122 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
123 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
124 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
125 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
126 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
127 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
128 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
129 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
130 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
131 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
132 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
133 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
134 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
135 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
136 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
137 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
138 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
139 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
140 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
141 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
142 %
143 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
144 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
145 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
146 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
147 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
148 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
149 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
150 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
151 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
152 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
153 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
154 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
155 %
156 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
157 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
158 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
159 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
160 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
161
162 % Give the space character the catcode for a space.
163 \def\spaceisspace{\catcode`\ =10\relax}
164
165 % Likewise for ^^M, the end of line character.
166 \def\endlineisspace{\catcode13=10\relax}
167
168 \chardef\dashChar = `\-
169 \chardef\slashChar = `\/
170 \chardef\underChar = `\_
171
172 % Ignore a token.
173 %
174 \def\gobble#1{}
175
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
178
179 % Hyphenation fixes.
180 \hyphenation{
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186 spell-ing spell-ings
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
189 }
190
191 % Sometimes it is convenient to have everything in the transcript file
192 % and nothing on the terminal. We don't just call \tracingall here,
193 % since that produces some useless output on the terminal. We also make
194 % some effort to order the tracing commands to reduce output in the log
195 % file; cf. trace.sty in LaTeX.
196 %
197 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
198 \def\loggingall{%
199 \tracingstats2
200 \tracingpages1
201 \tracinglostchars2 % 2 gives us more in etex
202 \tracingparagraphs1
203 \tracingoutput1
204 \tracingmacros2
205 \tracingrestores1
206 \showboxbreadth\maxdimen \showboxdepth\maxdimen
207 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
208 \tracingscantokens1
209 \tracingifs1
210 \tracinggroups1
211 \tracingnesting2
212 \tracingassigns1
213 \fi
214 \tracingcommands3 % 3 gives us more in etex
215 \errorcontextlines16
216 }%
217
218 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
219 % aren't perfect, it's not the end of the world, being an error message,
220 % after all.
221 %
222 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
223 \def\doerrormsg#1{\errmessage{#1}}
224
225 % add check for \lastpenalty to plain's definitions. If the last thing
226 % we did was a \nobreak, we don't want to insert more space.
227 %
228 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
229 \removelastskip\penalty-50\smallskip\fi\fi}
230 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
231 \removelastskip\penalty-100\medskip\fi\fi}
232 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
233 \removelastskip\penalty-200\bigskip\fi\fi}
234
235 % Output routine
236 %
237
238 % For a final copy, take out the rectangles
239 % that mark overfull boxes (in case you have decided
240 % that the text looks ok even though it passes the margin).
241 %
242 \def\finalout{\overfullrule=0pt }
243
244 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
245 \newdimen\topandbottommargin \topandbottommargin=.75in
246
247 % Output a mark which sets \thischapter, \thissection and \thiscolor.
248 % We dump everything together because we only have one kind of mark.
249 % This works because we only use \botmark / \topmark, not \firstmark.
250 %
251 % A mark contains a subexpression of the \ifcase ... \fi construct.
252 % \get*marks macros below extract the needed part using \ifcase.
253 %
254 % Another complication is to let the user choose whether \thischapter
255 % (\thissection) refers to the chapter (section) in effect at the top
256 % of a page, or that at the bottom of a page.
257
258 % \domark is called twice inside \chapmacro, to add one
259 % mark before the section break, and one after.
260 % In the second call \prevchapterdefs is the same as \currentchapterdefs,
261 % and \prevsectiondefs is the same as \currentsectiondefs.
262 % Then if the page is not broken at the mark, some of the previous
263 % section appears on the page, and we can get the name of this section
264 % from \firstmark for @everyheadingmarks top.
265 % @everyheadingmarks bottom uses \botmark.
266 %
267 % See page 260 of The TeXbook.
268 \def\domark{%
269 \toks0=\expandafter{\currentchapterdefs}%
270 \toks2=\expandafter{\currentsectiondefs}%
271 \toks4=\expandafter{\prevchapterdefs}%
272 \toks6=\expandafter{\prevsectiondefs}%
273 \toks8=\expandafter{\currentcolordefs}%
274 \mark{%
275 \the\toks0 \the\toks2 % 0: marks for @everyheadingmarks top
276 \noexpand\or \the\toks4 \the\toks6 % 1: for @everyheadingmarks bottom
277 \noexpand\else \the\toks8 % 2: color marks
278 }%
279 }
280
281 % \gettopheadingmarks, \getbottomheadingmarks,
282 % \getcolormarks - extract needed part of mark.
283 %
284 % \topmark doesn't work for the very first chapter (after the title
285 % page or the contents), so we use \firstmark there -- this gets us
286 % the mark with the chapter defs, unless the user sneaks in, e.g.,
287 % @setcolor (or @url, or @link, etc.) between @contents and the very
288 % first @chapter.
289 \def\gettopheadingmarks{%
290 \ifcase0\the\savedtopmark\fi
291 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
292 }
293 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
294 \def\getcolormarks{\ifcase2\the\savedtopmark\fi}
295
296 % Avoid "undefined control sequence" errors.
297 \def\currentchapterdefs{}
298 \def\currentsectiondefs{}
299 \def\currentsection{}
300 \def\prevchapterdefs{}
301 \def\prevsectiondefs{}
302 \def\currentcolordefs{}
303
304 % Margin to add to right of even pages, to left of odd pages.
305 \newdimen\bindingoffset
306 \newdimen\normaloffset
307 \newdimen\txipagewidth \newdimen\txipageheight
308
309 % Main output routine.
310 %
311 \chardef\PAGE = 255
312 \newtoks\defaultoutput
313 \defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}}
314 \output=\expandafter{\the\defaultoutput}
315
316 \newbox\headlinebox
317 \newbox\footlinebox
318
319 % When outputting the double column layout for indices, an output routine
320 % is run several times, which hides the original value of \topmark. This
321 % can lead to a page heading being output and duplicating the chapter heading
322 % of the index. Hence, save the contents of \topmark at the beginning of
323 % the output routine. The saved contents are valid until we actually
324 % \shipout a page.
325 %
326 % (We used to run a short output routine to actually set \topmark and
327 % \firstmark to the right values, but if this was called with an empty page
328 % containing whatsits for writing index entries, the whatsits would be thrown
329 % away and the index auxiliary file would remain empty.)
330 %
331 \newtoks\savedtopmark
332 \newif\iftopmarksaved
333 \topmarksavedtrue
334 \def\savetopmark{%
335 \iftopmarksaved\else
336 \global\savedtopmark=\expandafter{\topmark}%
337 \global\topmarksavedtrue
338 \fi
339 }
340
341 % \onepageout takes a vbox as an argument.
342 % \shipout a vbox for a single page, adding an optional header, footer
343 % and footnote. This also causes index entries for this page to be written
344 % to the auxiliary files.
345 %
346 \def\onepageout#1{%
347 \hoffset=\normaloffset
348 %
349 \ifodd\pageno \advance\hoffset by \bindingoffset
350 \else \advance\hoffset by -\bindingoffset\fi
351 %
352 \checkchapterpage
353 %
354 % Retrieve the information for the headings from the marks in the page,
355 % and call Plain TeX's \makeheadline and \makefootline, which use the
356 % values in \headline and \footline.
357 %
358 % Common context changes for both heading and footing.
359 % Do this outside of the \shipout so @code etc. will be expanded in
360 % the headline as they should be, not taken literally (outputting ''code).
361 \def\commonheadfootline{\let\hsize=\txipagewidth \texinfochars}
362 %
363 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
364 \global\setbox\headlinebox = \vbox{\commonheadfootline \makeheadline}%
365 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
366 \global\setbox\footlinebox = \vbox{\commonheadfootline \makefootline}%
367 %
368 {%
369 % Set context for writing to auxiliary files like index files.
370 % Have to do this stuff outside the \shipout because we want it to
371 % take effect in \write's, yet the group defined by the \vbox ends
372 % before the \shipout runs.
373 %
374 \atdummies % don't expand commands in the output.
375 \turnoffactive
376 \shipout\vbox{%
377 % Do this early so pdf references go to the beginning of the page.
378 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
379 %
380 \unvbox\headlinebox
381 \pagebody{#1}%
382 \ifdim\ht\footlinebox > 0pt
383 % Only leave this space if the footline is nonempty.
384 % (We lessened \vsize for it in \oddfootingyyy.)
385 % The \baselineskip=24pt in plain's \makefootline has no effect.
386 \vskip 24pt
387 \unvbox\footlinebox
388 \fi
389 %
390 }%
391 }%
392 \global\topmarksavedfalse
393 \advancepageno
394 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
395 }
396
397 \newinsert\margin \dimen\margin=\maxdimen
398
399 % Main part of page, including any footnotes
400 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
401 {\catcode`\@ =11
402 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
403 % marginal hacks, juha@viisa.uucp (Juha Takala)
404 \ifvoid\margin\else % marginal info is present
405 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
406 \dimen@=\dp#1\relax \unvbox#1\relax
407 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
408 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
409 }
410
411 % Check if we are on the first page of a chapter. Used for printing headings.
412 \newif\ifchapterpage
413 \def\checkchapterpage{%
414 % Get the chapter that was current at the end of the last page
415 \ifcase1\the\savedtopmark\fi
416 \let\prevchaptername\thischaptername
417 %
418 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
419 \let\curchaptername\thischaptername
420 %
421 \ifx\curchaptername\prevchaptername
422 \chapterpagefalse
423 \else
424 \chapterpagetrue
425 \fi
426 }
427
428 % Argument parsing
429
430 % Parse an argument, then pass it to #1. The argument is the rest of
431 % the input line (except we remove a trailing comment). #1 should be a
432 % macro which expects an ordinary undelimited TeX argument.
433 % For example, \def\foo{\parsearg\fooxxx}.
434 %
435 \def\parsearg{\parseargusing{}}
436 \def\parseargusing#1#2{%
437 \def\argtorun{#2}%
438 \begingroup
439 \obeylines
440 \spaceisspace
441 #1%
442 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
443 }
444
445 {\obeylines %
446 \gdef\parseargline#1^^M{%
447 \endgroup % End of the group started in \parsearg.
448 \argremovecomment #1\comment\ArgTerm%
449 }%
450 }
451
452 % First remove any @comment, then any @c comment. Pass the result on to
453 % \argcheckspaces.
454 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
455 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
456
457 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
458 %
459 % \argremovec might leave us with trailing space, e.g.,
460 % @end itemize @c foo
461 % This space token undergoes the same procedure and is eventually removed
462 % by \finishparsearg.
463 %
464 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
465 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
466 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
467 \def\temp{#3}%
468 \ifx\temp\empty
469 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
470 \let\temp\finishparsearg
471 \else
472 \let\temp\argcheckspaces
473 \fi
474 % Put the space token in:
475 \temp#1 #3\ArgTerm
476 }
477
478 % If a _delimited_ argument is enclosed in braces, they get stripped; so
479 % to get _exactly_ the rest of the line, we had to prevent such situation.
480 % We prepended an \empty token at the very beginning and we expand it now,
481 % just before passing the control to \argtorun.
482 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
483 % either the null string, or it ends with \^^M---thus there is no danger
484 % that a pair of braces would be stripped.
485 %
486 % But first, we have to remove the trailing space token.
487 %
488 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
489
490
491 % \parseargdef - define a command taking an argument on the line
492 %
493 % \parseargdef\foo{...}
494 % is roughly equivalent to
495 % \def\foo{\parsearg\Xfoo}
496 % \def\Xfoo#1{...}
497 \def\parseargdef#1{%
498 \expandafter \doparseargdef \csname\string#1\endcsname #1%
499 }
500 \def\doparseargdef#1#2{%
501 \def#2{\parsearg#1}%
502 \def#1##1%
503 }
504
505 % Several utility definitions with active space:
506 {
507 \obeyspaces
508 \gdef\obeyedspace{ }
509
510 % Make each space character in the input produce a normal interword
511 % space in the output. Don't allow a line break at this space, as this
512 % is used only in environments like @example, where each line of input
513 % should produce a line of output anyway.
514 %
515 \gdef\sepspaces{\obeyspaces\let =\tie}
516
517 % If an index command is used in an @example environment, any spaces
518 % therein should become regular spaces in the raw index file, not the
519 % expansion of \tie (\leavevmode \penalty \@M \ ).
520 \gdef\unsepspaces{\let =\space}
521 }
522
523
524 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
525
526 % Define the framework for environments in texinfo.tex. It's used like this:
527 %
528 % \envdef\foo{...}
529 % \def\Efoo{...}
530 %
531 % It's the responsibility of \envdef to insert \begingroup before the
532 % actual body; @end closes the group after calling \Efoo. \envdef also
533 % defines \thisenv, so the current environment is known; @end checks
534 % whether the environment name matches. The \checkenv macro can also be
535 % used to check whether the current environment is the one expected.
536 %
537 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
538 % are not treated as environments; they don't open a group. (The
539 % implementation of @end takes care not to call \endgroup in this
540 % special case.)
541
542
543 % At run-time, environments start with this:
544 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
545 % initialize
546 \let\thisenv\empty
547
548 % ... but they get defined via ``\envdef\foo{...}'':
549 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
550 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
551
552 % Check whether we're in the right environment:
553 \def\checkenv#1{%
554 \def\temp{#1}%
555 \ifx\thisenv\temp
556 \else
557 \badenverr
558 \fi
559 }
560
561 % Environment mismatch, #1 expected:
562 \def\badenverr{%
563 \errhelp = \EMsimple
564 \errmessage{This command can appear only \inenvironment\temp,
565 not \inenvironment\thisenv}%
566 }
567 \def\inenvironment#1{%
568 \ifx#1\empty
569 outside of any environment%
570 \else
571 in environment \expandafter\string#1%
572 \fi
573 }
574
575
576 % @end foo calls \checkenv and executes the definition of \Efoo.
577 \parseargdef\end{%
578 \if 1\csname iscond.#1\endcsname
579 \else
580 % The general wording of \badenverr may not be ideal.
581 \expandafter\checkenv\csname#1\endcsname
582 \csname E#1\endcsname
583 \endgroup
584 \fi
585 }
586
587 \newhelp\EMsimple{Press RETURN to continue.}
588
589
590 % Be sure we're in horizontal mode when doing a tie, since we make space
591 % equivalent to this in @example-like environments. Otherwise, a space
592 % at the beginning of a line will start with \penalty -- and
593 % since \penalty is valid in vertical mode, we'd end up putting the
594 % penalty on the vertical list instead of in the new paragraph.
595 {\catcode`@ = 11
596 % Avoid using \@M directly, because that causes trouble
597 % if the definition is written into an index file.
598 \global\let\tiepenalty = \@M
599 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
600 }
601
602 % @: forces normal size whitespace following.
603 \def\:{\spacefactor=1000 }
604
605 % @* forces a line break.
606 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
607
608 % @/ allows a line break.
609 \let\/=\allowbreak
610
611 % @. is an end-of-sentence period.
612 \def\.{.\spacefactor=\endofsentencespacefactor\space}
613
614 % @! is an end-of-sentence bang.
615 \def\!{!\spacefactor=\endofsentencespacefactor\space}
616
617 % @? is an end-of-sentence query.
618 \def\?{?\spacefactor=\endofsentencespacefactor\space}
619
620 % @frenchspacing on|off says whether to put extra space after punctuation.
621 %
622 \def\onword{on}
623 \def\offword{off}
624 %
625 \parseargdef\frenchspacing{%
626 \def\temp{#1}%
627 \ifx\temp\onword \plainfrenchspacing
628 \else\ifx\temp\offword \plainnonfrenchspacing
629 \else
630 \errhelp = \EMsimple
631 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
632 \fi\fi
633 }
634
635 % @w prevents a word break. Without the \leavevmode, @w at the
636 % beginning of a paragraph, when TeX is still in vertical mode, would
637 % produce a whole line of output instead of starting the paragraph.
638 \def\w#1{\leavevmode\hbox{#1}}
639
640 % @group ... @end group forces ... to be all on one page, by enclosing
641 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
642 % to keep its height that of a normal line. According to the rules for
643 % \topskip (p.114 of the TeXbook), the glue inserted is
644 % max (\topskip - \ht (first item), 0). If that height is large,
645 % therefore, no glue is inserted, and the space between the headline and
646 % the text is small, which looks bad.
647 %
648 % Another complication is that the group might be very large. This can
649 % cause the glue on the previous page to be unduly stretched, because it
650 % does not have much material. In this case, it's better to add an
651 % explicit \vfill so that the extra space is at the bottom. The
652 % threshold for doing this is if the group is more than \vfilllimit
653 % percent of a page (\vfilllimit can be changed inside of @tex).
654 %
655 \newbox\groupbox
656 \def\vfilllimit{0.7}
657 %
658 \envdef\group{%
659 \ifnum\catcode`\^^M=\active \else
660 \errhelp = \groupinvalidhelp
661 \errmessage{@group invalid in context where filling is enabled}%
662 \fi
663 \startsavinginserts
664 %
665 \setbox\groupbox = \vtop\bgroup
666 % Do @comment since we are called inside an environment such as
667 % @example, where each end-of-line in the input causes an
668 % end-of-line in the output. We don't want the end-of-line after
669 % the `@group' to put extra space in the output. Since @group
670 % should appear on a line by itself (according to the Texinfo
671 % manual), we don't worry about eating any user text.
672 \comment
673 }
674 %
675 % The \vtop produces a box with normal height and large depth; thus, TeX puts
676 % \baselineskip glue before it, and (when the next line of text is done)
677 % \lineskip glue after it. Thus, space below is not quite equal to space
678 % above. But it's pretty close.
679 \def\Egroup{%
680 % To get correct interline space between the last line of the group
681 % and the first line afterwards, we have to propagate \prevdepth.
682 \endgraf % Not \par, as it may have been set to \lisppar.
683 \global\dimen1 = \prevdepth
684 \egroup % End the \vtop.
685 \addgroupbox
686 \prevdepth = \dimen1
687 \checkinserts
688 }
689
690 \def\addgroupbox{
691 % \dimen0 is the vertical size of the group's box.
692 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
693 % \dimen2 is how much space is left on the page (more or less).
694 \dimen2 = \txipageheight \advance\dimen2 by -\pagetotal
695 % if the group doesn't fit on the current page, and it's a big big
696 % group, force a page break.
697 \ifdim \dimen0 > \dimen2
698 \ifdim \pagetotal < \vfilllimit\txipageheight
699 \page
700 \fi
701 \fi
702 \box\groupbox
703 }
704
705 %
706 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
707 % message, so this ends up printing `@group can only ...'.
708 %
709 \newhelp\groupinvalidhelp{%
710 group can only be used in environments such as @example,^^J%
711 where each line of input produces a line of output.}
712
713 % @need space-in-mils
714 % forces a page break if there is not space-in-mils remaining.
715
716 \newdimen\mil \mil=0.001in
717
718 \parseargdef\need{%
719 % Ensure vertical mode, so we don't make a big box in the middle of a
720 % paragraph.
721 \par
722 %
723 % If the @need value is less than one line space, it's useless.
724 \dimen0 = #1\mil
725 \dimen2 = \ht\strutbox
726 \advance\dimen2 by \dp\strutbox
727 \ifdim\dimen0 > \dimen2
728 %
729 % Do a \strut just to make the height of this box be normal, so the
730 % normal leading is inserted relative to the preceding line.
731 % And a page break here is fine.
732 \vtop to #1\mil{\strut\vfil}%
733 %
734 % TeX does not even consider page breaks if a penalty added to the
735 % main vertical list is 10000 or more. But in order to see if the
736 % empty box we just added fits on the page, we must make it consider
737 % page breaks. On the other hand, we don't want to actually break the
738 % page after the empty box. So we use a penalty of 9999.
739 %
740 % There is an extremely small chance that TeX will actually break the
741 % page at this \penalty, if there are no other feasible breakpoints in
742 % sight. (If the user is using lots of big @group commands, which
743 % almost-but-not-quite fill up a page, TeX will have a hard time doing
744 % good page breaking, for example.) However, I could not construct an
745 % example where a page broke at this \penalty; if it happens in a real
746 % document, then we can reconsider our strategy.
747 \penalty9999
748 %
749 % Back up by the size of the box, whether we did a page break or not.
750 \kern -#1\mil
751 %
752 % Do not allow a page break right after this kern.
753 \nobreak
754 \fi
755 }
756
757 % @br forces paragraph break (and is undocumented).
758
759 \let\br = \par
760
761 % @page forces the start of a new page.
762 %
763 \def\page{\par\vfill\supereject}
764
765 % @exdent text....
766 % outputs text on separate line in roman font, starting at standard page margin
767
768 % This records the amount of indent in the innermost environment.
769 % That's how much \exdent should take out.
770 \newskip\exdentamount
771
772 % This defn is used inside fill environments such as @defun.
773 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
774
775 % This defn is used inside nofill environments such as @example.
776 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
777 \leftline{\hskip\leftskip{\rm#1}}}}
778
779 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
780 % paragraph. For more general purposes, use the \margin insertion
781 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
782 %
783 \newskip\inmarginspacing \inmarginspacing=1cm
784 \def\strutdepth{\dp\strutbox}
785 %
786 \def\doinmargin#1#2{\strut\vadjust{%
787 \nobreak
788 \kern-\strutdepth
789 \vtop to \strutdepth{%
790 \baselineskip=\strutdepth
791 \vss
792 % if you have multiple lines of stuff to put here, you'll need to
793 % make the vbox yourself of the appropriate size.
794 \ifx#1l%
795 \llap{\ignorespaces #2\hskip\inmarginspacing}%
796 \else
797 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
798 \fi
799 \null
800 }%
801 }}
802 \def\inleftmargin{\doinmargin l}
803 \def\inrightmargin{\doinmargin r}
804 %
805 % @inmargin{TEXT [, RIGHT-TEXT]}
806 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
807 % else use TEXT for both).
808 %
809 \def\inmargin#1{\parseinmargin #1,,\finish}
810 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
811 \setbox0 = \hbox{\ignorespaces #2}%
812 \ifdim\wd0 > 0pt
813 \def\lefttext{#1}% have both texts
814 \def\righttext{#2}%
815 \else
816 \def\lefttext{#1}% have only one text
817 \def\righttext{#1}%
818 \fi
819 %
820 \ifodd\pageno
821 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
822 \else
823 \def\temp{\inleftmargin\lefttext}%
824 \fi
825 \temp
826 }
827
828 % @include FILE -- \input text of FILE.
829 %
830 \def\include{\parseargusing\filenamecatcodes\includezzz}
831 \def\includezzz#1{%
832 \pushthisfilestack
833 \def\thisfile{#1}%
834 {%
835 \makevalueexpandable % we want to expand any @value in FILE.
836 \turnoffactive % and allow special characters in the expansion
837 \indexnofonts % Allow `@@' and other weird things in file names.
838 \wlog{texinfo.tex: doing @include of #1^^J}%
839 \edef\temp{\noexpand\input #1 }%
840 %
841 % This trickery is to read FILE outside of a group, in case it makes
842 % definitions, etc.
843 \expandafter
844 }\temp
845 \popthisfilestack
846 }
847 \def\filenamecatcodes{%
848 \catcode`\\=\other
849 \catcode`~=\other
850 \catcode`^=\other
851 \catcode`_=\other
852 \catcode`|=\other
853 \catcode`<=\other
854 \catcode`>=\other
855 \catcode`+=\other
856 \catcode`-=\other
857 \catcode`\`=\other
858 \catcode`\'=\other
859 }
860
861 \def\pushthisfilestack{%
862 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
863 }
864 \def\pushthisfilestackX{%
865 \expandafter\pushthisfilestackY\thisfile\StackTerm
866 }
867 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
868 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
869 }
870
871 \def\popthisfilestack{\errthisfilestackempty}
872 \def\errthisfilestackempty{\errmessage{Internal error:
873 the stack of filenames is empty.}}
874 %
875 \def\thisfile{}
876
877 % @center line
878 % outputs that line, centered.
879 %
880 \parseargdef\center{%
881 \ifhmode
882 \let\centersub\centerH
883 \else
884 \let\centersub\centerV
885 \fi
886 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
887 \let\centersub\relax % don't let the definition persist, just in case
888 }
889 \def\centerH#1{{%
890 \hfil\break
891 \advance\hsize by -\leftskip
892 \advance\hsize by -\rightskip
893 \line{#1}%
894 \break
895 }}
896 %
897 \newcount\centerpenalty
898 \def\centerV#1{%
899 % The idea here is the same as in \startdefun, \cartouche, etc.: if
900 % @center is the first thing after a section heading, we need to wipe
901 % out the negative parskip inserted by \sectionheading, but still
902 % prevent a page break here.
903 \centerpenalty = \lastpenalty
904 \ifnum\centerpenalty>10000 \vskip\parskip \fi
905 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
906 \line{\kern\leftskip #1\kern\rightskip}%
907 }
908
909 % @sp n outputs n lines of vertical space
910 %
911 \parseargdef\sp{\vskip #1\baselineskip}
912
913 % @comment ...line which is ignored...
914 % @c is the same as @comment
915 % @ignore ... @end ignore is another way to write a comment
916
917
918 \def\c{\begingroup \catcode`\^^M=\active%
919 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
920 \cxxx}
921 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
922 %
923 \let\comment\c
924
925 % @paragraphindent NCHARS
926 % We'll use ems for NCHARS, close enough.
927 % NCHARS can also be the word `asis' or `none'.
928 % We cannot feasibly implement @paragraphindent asis, though.
929 %
930 \def\asisword{asis} % no translation, these are keywords
931 \def\noneword{none}
932 %
933 \parseargdef\paragraphindent{%
934 \def\temp{#1}%
935 \ifx\temp\asisword
936 \else
937 \ifx\temp\noneword
938 \defaultparindent = 0pt
939 \else
940 \defaultparindent = #1em
941 \fi
942 \fi
943 \parindent = \defaultparindent
944 }
945
946 % @exampleindent NCHARS
947 % We'll use ems for NCHARS like @paragraphindent.
948 % It seems @exampleindent asis isn't necessary, but
949 % I preserve it to make it similar to @paragraphindent.
950 \parseargdef\exampleindent{%
951 \def\temp{#1}%
952 \ifx\temp\asisword
953 \else
954 \ifx\temp\noneword
955 \lispnarrowing = 0pt
956 \else
957 \lispnarrowing = #1em
958 \fi
959 \fi
960 }
961
962 % @firstparagraphindent WORD
963 % If WORD is `none', then suppress indentation of the first paragraph
964 % after a section heading. If WORD is `insert', then do indent at such
965 % paragraphs.
966 %
967 % The paragraph indentation is suppressed or not by calling
968 % \suppressfirstparagraphindent, which the sectioning commands do.
969 % We switch the definition of this back and forth according to WORD.
970 % By default, we suppress indentation.
971 %
972 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
973 \def\insertword{insert}
974 %
975 \parseargdef\firstparagraphindent{%
976 \def\temp{#1}%
977 \ifx\temp\noneword
978 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
979 \else\ifx\temp\insertword
980 \let\suppressfirstparagraphindent = \relax
981 \else
982 \errhelp = \EMsimple
983 \errmessage{Unknown @firstparagraphindent option `\temp'}%
984 \fi\fi
985 }
986
987 % Here is how we actually suppress indentation. Redefine \everypar to
988 % \kern backwards by \parindent, and then reset itself to empty.
989 %
990 % We also make \indent itself not actually do anything until the next
991 % paragraph.
992 %
993 \gdef\dosuppressfirstparagraphindent{%
994 \gdef\indent {\restorefirstparagraphindent \indent}%
995 \gdef\noindent{\restorefirstparagraphindent \noindent}%
996 \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
997 }
998 %
999 \gdef\restorefirstparagraphindent{%
1000 \global\let\indent = \ptexindent
1001 \global\let\noindent = \ptexnoindent
1002 \global\everypar = {}%
1003 }
1004
1005 % leave vertical mode without cancelling any first paragraph indent
1006 \gdef\imageindent{%
1007 \toks0=\everypar
1008 \everypar={}%
1009 \ptexnoindent
1010 \global\everypar=\toks0
1011 }
1012
1013
1014 % @refill is a no-op.
1015 \let\refill=\relax
1016
1017 % @setfilename INFO-FILENAME - ignored
1018 \let\setfilename=\comment
1019
1020 % @bye.
1021 \outer\def\bye{\chappager\pagelabels\tracingstats=1\ptexend}
1022
1023
1024 \message{pdf,}
1025 % adobe `portable' document format
1026 \newcount\tempnum
1027 \newcount\lnkcount
1028 \newtoks\filename
1029 \newcount\filenamelength
1030 \newcount\pgn
1031 \newtoks\toksA
1032 \newtoks\toksB
1033 \newtoks\toksC
1034 \newtoks\toksD
1035 \newbox\boxA
1036 \newbox\boxB
1037 \newcount\countA
1038 \newif\ifpdf
1039 \newif\ifpdfmakepagedest
1040
1041 %
1042 % For LuaTeX
1043 %
1044
1045 \newif\iftxiuseunicodedestname
1046 \txiuseunicodedestnamefalse % For pdfTeX etc.
1047
1048 \ifx\luatexversion\thisisundefined
1049 \else
1050 % Use Unicode destination names
1051 \txiuseunicodedestnametrue
1052 % Escape PDF strings with converting UTF-16 from UTF-8
1053 \begingroup
1054 \catcode`\%=12
1055 \directlua{
1056 function UTF16oct(str)
1057 tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
1058 for c in string.utfvalues(str) do
1059 if c < 0x10000 then
1060 tex.sprint(
1061 string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1062 string.char(0x5c) .. string.char(0x25) .. '03o',
1063 math.floor(c / 256), math.floor(c % 256)))
1064 else
1065 c = c - 0x10000
1066 local c_hi = c / 1024 + 0xd800
1067 local c_lo = c % 1024 + 0xdc00
1068 tex.sprint(
1069 string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1070 string.char(0x5c) .. string.char(0x25) .. '03o' ..
1071 string.char(0x5c) .. string.char(0x25) .. '03o' ..
1072 string.char(0x5c) .. string.char(0x25) .. '03o',
1073 math.floor(c_hi / 256), math.floor(c_hi % 256),
1074 math.floor(c_lo / 256), math.floor(c_lo % 256)))
1075 end
1076 end
1077 end
1078 }
1079 \endgroup
1080 \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
1081 % Escape PDF strings without converting
1082 \begingroup
1083 \directlua{
1084 function PDFescstr(str)
1085 for c in string.bytes(str) do
1086 if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
1087 tex.sprint(-2,
1088 string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
1089 c))
1090 else
1091 tex.sprint(-2, string.char(c))
1092 end
1093 end
1094 end
1095 }
1096 % The -2 in the arguments here gives all the input to TeX catcode 12
1097 % (other) or 10 (space), preventing undefined control sequence errors. See
1098 % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
1099 %
1100 \endgroup
1101 \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
1102 \ifnum\luatexversion>84
1103 % For LuaTeX >= 0.85
1104 \def\pdfdest{\pdfextension dest}
1105 \let\pdfoutput\outputmode
1106 \def\pdfliteral{\pdfextension literal}
1107 \def\pdfcatalog{\pdfextension catalog}
1108 \def\pdftexversion{\numexpr\pdffeedback version\relax}
1109 \let\pdfximage\saveimageresource
1110 \let\pdfrefximage\useimageresource
1111 \let\pdflastximage\lastsavedimageresourceindex
1112 \def\pdfendlink{\pdfextension endlink\relax}
1113 \def\pdfoutline{\pdfextension outline}
1114 \def\pdfstartlink{\pdfextension startlink}
1115 \def\pdffontattr{\pdfextension fontattr}
1116 \def\pdfobj{\pdfextension obj}
1117 \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
1118 \let\pdfpagewidth\pagewidth
1119 \let\pdfpageheight\pageheight
1120 \edef\pdfhorigin{\pdfvariable horigin}
1121 \edef\pdfvorigin{\pdfvariable vorigin}
1122 \fi
1123 \fi
1124
1125 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1126 % can be set). So we test for \relax and 0 as well as being undefined.
1127 \ifx\pdfoutput\thisisundefined
1128 \else
1129 \ifx\pdfoutput\relax
1130 \else
1131 \ifcase\pdfoutput
1132 \else
1133 \pdftrue
1134 \fi
1135 \fi
1136 \fi
1137
1138 \newif\ifpdforxetex
1139 \pdforxetexfalse
1140 \ifpdf
1141 \pdforxetextrue
1142 \fi
1143 \ifx\XeTeXrevision\thisisundefined\else
1144 \pdforxetextrue
1145 \fi
1146
1147
1148 % Output page labels information.
1149 % See PDF reference v.1.7 p.594, section 8.3.1.
1150 \ifpdf
1151 \def\pagelabels{%
1152 \def\title{0 << /P (T-) /S /D >>}%
1153 \edef\roman{\the\romancount << /S /r >>}%
1154 \edef\arabic{\the\arabiccount << /S /D >>}%
1155 %
1156 % Page label ranges must be increasing. Remove any duplicates.
1157 % (There is a slight chance of this being wrong if e.g. there is
1158 % a @contents but no @titlepage, etc.)
1159 %
1160 \ifnum\romancount=0 \def\roman{}\fi
1161 \ifnum\arabiccount=0 \def\title{}%
1162 \else
1163 \ifnum\romancount=\arabiccount \def\roman{}\fi
1164 \fi
1165 %
1166 \ifnum\romancount<\arabiccount
1167 \pdfcatalog{/PageLabels << /Nums [\title \roman \arabic ] >> }\relax
1168 \else
1169 \pdfcatalog{/PageLabels << /Nums [\title \arabic \roman ] >> }\relax
1170 \fi
1171 }
1172 \else
1173 \let\pagelabels\relax
1174 \fi
1175
1176 \newcount\pagecount \pagecount=0
1177 \newcount\romancount \romancount=0
1178 \newcount\arabiccount \arabiccount=0
1179 \ifpdf
1180 \let\ptxadvancepageno\advancepageno
1181 \def\advancepageno{%
1182 \ptxadvancepageno\global\advance\pagecount by 1
1183 }
1184 \fi
1185
1186
1187 % PDF uses PostScript string constants for the names of xref targets,
1188 % for display in the outlines, and in other places. Thus, we have to
1189 % double any backslashes. Otherwise, a name like "\node" will be
1190 % interpreted as a newline (\n), followed by o, d, e. Not good.
1191 %
1192 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1193 % related messages. The final outcome is that it is up to the TeX user
1194 % to double the backslashes and otherwise make the string valid, so
1195 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1196 % do this reliably, so we use it.
1197
1198 % #1 is a control sequence in which to do the replacements,
1199 % which we \xdef.
1200 \def\txiescapepdf#1{%
1201 \ifx\pdfescapestring\thisisundefined
1202 % No primitive available; should we give a warning or log?
1203 % Many times it won't matter.
1204 \xdef#1{#1}%
1205 \else
1206 % The expandable \pdfescapestring primitive escapes parentheses,
1207 % backslashes, and other special chars.
1208 \xdef#1{\pdfescapestring{#1}}%
1209 \fi
1210 }
1211 \def\txiescapepdfutfsixteen#1{%
1212 \ifx\pdfescapestrutfsixteen\thisisundefined
1213 % No UTF-16 converting macro available.
1214 \txiescapepdf{#1}%
1215 \else
1216 \xdef#1{\pdfescapestrutfsixteen{#1}}%
1217 \fi
1218 }
1219
1220 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1221 with PDF output, and none of those formats could be found. (.eps cannot
1222 be supported due to the design of the PDF format; use regular TeX (DVI
1223 output) for that.)}
1224
1225 \ifpdf
1226 %
1227 % Color manipulation macros using ideas from pdfcolor.tex,
1228 % except using rgb instead of cmyk; the latter is said to render as a
1229 % very dark gray on-screen and a very dark halftone in print, instead
1230 % of actual black. The dark red here is dark enough to print on paper as
1231 % nearly black, but still distinguishable for online viewing. We use
1232 % black by default, though.
1233 \def\rgbDarkRed{0.50 0.09 0.12}
1234 \def\rgbBlack{0 0 0}
1235 %
1236 % rg sets the color for filling (usual text, etc.);
1237 % RG sets the color for stroking (thin rules, e.g., normal _'s).
1238 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1239 %
1240 % Set color, and create a mark which defines \thiscolor accordingly,
1241 % so that \makeheadline knows which color to restore.
1242 \def\setcolor#1{%
1243 \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1244 \domark
1245 \pdfsetcolor{#1}%
1246 }
1247 %
1248 \def\maincolor{\rgbBlack}
1249 \pdfsetcolor{\maincolor}
1250 \edef\thiscolor{\maincolor}
1251 \def\currentcolordefs{}
1252 %
1253 \def\makefootline{%
1254 \baselineskip24pt
1255 \line{\pdfsetcolor{\maincolor}\the\footline}%
1256 }
1257 %
1258 \def\makeheadline{%
1259 \vbox to 0pt{%
1260 \vskip-22.5pt
1261 \line{%
1262 \vbox to8.5pt{}%
1263 % Extract \thiscolor definition from the marks.
1264 \getcolormarks
1265 % Typeset the headline with \maincolor, then restore the color.
1266 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1267 }%
1268 \vss
1269 }%
1270 \nointerlineskip
1271 }
1272 %
1273 %
1274 \pdfcatalog{/PageMode /UseOutlines}
1275 %
1276 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1277 \def\dopdfimage#1#2#3{%
1278 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1279 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1280 %
1281 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1282 % others). Let's try in that order, PDF first since if
1283 % someone has a scalable image, presumably better to use that than a
1284 % bitmap.
1285 \let\pdfimgext=\empty
1286 \begingroup
1287 \openin 1 #1.pdf \ifeof 1
1288 \openin 1 #1.PDF \ifeof 1
1289 \openin 1 #1.png \ifeof 1
1290 \openin 1 #1.jpg \ifeof 1
1291 \openin 1 #1.jpeg \ifeof 1
1292 \openin 1 #1.JPG \ifeof 1
1293 \errhelp = \nopdfimagehelp
1294 \errmessage{Could not find image file #1 for pdf}%
1295 \else \gdef\pdfimgext{JPG}%
1296 \fi
1297 \else \gdef\pdfimgext{jpeg}%
1298 \fi
1299 \else \gdef\pdfimgext{jpg}%
1300 \fi
1301 \else \gdef\pdfimgext{png}%
1302 \fi
1303 \else \gdef\pdfimgext{PDF}%
1304 \fi
1305 \else \gdef\pdfimgext{pdf}%
1306 \fi
1307 \closein 1
1308 \endgroup
1309 %
1310 % without \immediate, ancient pdftex seg faults when the same image is
1311 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1312 \ifnum\pdftexversion < 14
1313 \immediate\pdfimage
1314 \else
1315 \immediate\pdfximage
1316 \fi
1317 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1318 \ifdim \wd2 >0pt height \pdfimageheight \fi
1319 \ifnum\pdftexversion<13
1320 #1.\pdfimgext
1321 \else
1322 {#1.\pdfimgext}%
1323 \fi
1324 \ifnum\pdftexversion < 14 \else
1325 \pdfrefximage \pdflastximage
1326 \fi}
1327 %
1328 \def\setpdfdestname#1{{%
1329 % We have to set dummies so commands such as @code, and characters
1330 % such as \, aren't expanded when present in a section title.
1331 \indexnofonts
1332 \makevalueexpandable
1333 \turnoffactive
1334 \iftxiuseunicodedestname
1335 \ifx \declaredencoding \latone
1336 % Pass through Latin-1 characters.
1337 % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
1338 \else
1339 \ifx \declaredencoding \utfeight
1340 % Pass through Unicode characters.
1341 \else
1342 % Use ASCII approximations in destination names.
1343 \passthroughcharsfalse
1344 \fi
1345 \fi
1346 \else
1347 % Use ASCII approximations in destination names.
1348 \passthroughcharsfalse
1349 \fi
1350 \def\pdfdestname{#1}%
1351 \txiescapepdf\pdfdestname
1352 }}
1353 %
1354 \def\setpdfoutlinetext#1{{%
1355 \indexnofonts
1356 \makevalueexpandable
1357 \turnoffactive
1358 \ifx \declaredencoding \latone
1359 % The PDF format can use an extended form of Latin-1 in bookmark
1360 % strings. See Appendix D of the PDF Reference, Sixth Edition, for
1361 % the "PDFDocEncoding".
1362 \passthroughcharstrue
1363 % Pass through Latin-1 characters.
1364 % LuaTeX: Convert to Unicode
1365 % pdfTeX: Use Latin-1 as PDFDocEncoding
1366 \def\pdfoutlinetext{#1}%
1367 \else
1368 \ifx \declaredencoding \utfeight
1369 \ifx\luatexversion\thisisundefined
1370 % For pdfTeX with UTF-8.
1371 % TODO: the PDF format can use UTF-16 in bookmark strings,
1372 % but the code for this isn't done yet.
1373 % Use ASCII approximations.
1374 \passthroughcharsfalse
1375 \def\pdfoutlinetext{#1}%
1376 \else
1377 % For LuaTeX with UTF-8.
1378 % Pass through Unicode characters for title texts.
1379 \passthroughcharstrue
1380 \def\pdfoutlinetext{#1}%
1381 \fi
1382 \else
1383 % For non-Latin-1 or non-UTF-8 encodings.
1384 % Use ASCII approximations.
1385 \passthroughcharsfalse
1386 \def\pdfoutlinetext{#1}%
1387 \fi
1388 \fi
1389 % LuaTeX: Convert to UTF-16
1390 % pdfTeX: Use Latin-1 as PDFDocEncoding
1391 \txiescapepdfutfsixteen\pdfoutlinetext
1392 }}
1393 %
1394 \def\pdfmkdest#1{%
1395 \setpdfdestname{#1}%
1396 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1397 }
1398 %
1399 % used to mark target names; must be expandable.
1400 \def\pdfmkpgn#1{#1}
1401 %
1402 % by default, use black for everything.
1403 \def\urlcolor{\rgbBlack}
1404 \def\linkcolor{\rgbBlack}
1405 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1406 %
1407 % Adding outlines to PDF; macros for calculating structure of outlines
1408 % come from Petr Olsak
1409 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1410 \else \csname#1\endcsname \fi}
1411 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1412 \advance\tempnum by 1
1413 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1414 %
1415 % #1 is the section text, which is what will be displayed in the
1416 % outline by the pdf viewer. #2 is the pdf expression for the number
1417 % of subentries (or empty, for subsubsections). #3 is the node text,
1418 % which might be empty if this toc entry had no corresponding node.
1419 % #4 is the page number
1420 %
1421 \def\dopdfoutline#1#2#3#4{%
1422 % Generate a link to the node text if that exists; else, use the
1423 % page number. We could generate a destination for the section
1424 % text in the case where a section has no node, but it doesn't
1425 % seem worth the trouble, since most documents are normally structured.
1426 \setpdfoutlinetext{#1}
1427 \setpdfdestname{#3}
1428 \ifx\pdfdestname\empty
1429 \def\pdfdestname{#4}%
1430 \fi
1431 %
1432 \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
1433 }
1434 %
1435 \def\pdfmakeoutlines{%
1436 \begingroup
1437 % Read toc silently, to get counts of subentries for \pdfoutline.
1438 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1439 \def\numchapentry##1##2##3##4{%
1440 \def\thischapnum{##2}%
1441 \def\thissecnum{0}%
1442 \def\thissubsecnum{0}%
1443 }%
1444 \def\numsecentry##1##2##3##4{%
1445 \advancenumber{chap\thischapnum}%
1446 \def\thissecnum{##2}%
1447 \def\thissubsecnum{0}%
1448 }%
1449 \def\numsubsecentry##1##2##3##4{%
1450 \advancenumber{sec\thissecnum}%
1451 \def\thissubsecnum{##2}%
1452 }%
1453 \def\numsubsubsecentry##1##2##3##4{%
1454 \advancenumber{subsec\thissubsecnum}%
1455 }%
1456 \def\thischapnum{0}%
1457 \def\thissecnum{0}%
1458 \def\thissubsecnum{0}%
1459 %
1460 % use \def rather than \let here because we redefine \chapentry et
1461 % al. a second time, below.
1462 \def\appentry{\numchapentry}%
1463 \def\appsecentry{\numsecentry}%
1464 \def\appsubsecentry{\numsubsecentry}%
1465 \def\appsubsubsecentry{\numsubsubsecentry}%
1466 \def\unnchapentry{\numchapentry}%
1467 \def\unnsecentry{\numsecentry}%
1468 \def\unnsubsecentry{\numsubsecentry}%
1469 \def\unnsubsubsecentry{\numsubsubsecentry}%
1470 \readdatafile{toc}%
1471 %
1472 % Read toc second time, this time actually producing the outlines.
1473 % The `-' means take the \expnumber as the absolute number of
1474 % subentries, which we calculated on our first read of the .toc above.
1475 %
1476 % We use the node names as the destinations.
1477 %
1478 % Currently we prefix the section name with the section number
1479 % for chapter and appendix headings only in order to avoid too much
1480 % horizontal space being required in the PDF viewer.
1481 \def\numchapentry##1##2##3##4{%
1482 \dopdfoutline{##2 ##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1483 \def\unnchapentry##1##2##3##4{%
1484 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1485 \def\numsecentry##1##2##3##4{%
1486 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1487 \def\numsubsecentry##1##2##3##4{%
1488 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1489 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1490 \dopdfoutline{##1}{}{##3}{##4}}%
1491 %
1492 % PDF outlines are displayed using system fonts, instead of
1493 % document fonts. Therefore we cannot use special characters,
1494 % since the encoding is unknown. For example, the eogonek from
1495 % Latin 2 (0xea) gets translated to a | character. Info from
1496 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1497 %
1498 % TODO this right, we have to translate 8-bit characters to
1499 % their "best" equivalent, based on the @documentencoding. Too
1500 % much work for too little return. Just use the ASCII equivalents
1501 % we use for the index sort strings.
1502 %
1503 \indexnofonts
1504 \setupdatafile
1505 % We can have normal brace characters in the PDF outlines, unlike
1506 % Texinfo index files. So set that up.
1507 \def\{{\lbracecharliteral}%
1508 \def\}{\rbracecharliteral}%
1509 \catcode`\\=\active \otherbackslash
1510 \input \tocreadfilename
1511 \endgroup
1512 }
1513 {\catcode`[=1 \catcode`]=2
1514 \catcode`{=\other \catcode`}=\other
1515 \gdef\lbracecharliteral[{]%
1516 \gdef\rbracecharliteral[}]%
1517 ]
1518 %
1519 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1520 \ifx\PP\D\let\nextsp\relax
1521 \else\let\nextsp\skipspaces
1522 \addtokens{\filename}{\PP}%
1523 \advance\filenamelength by 1
1524 \fi
1525 \nextsp}
1526 \def\getfilename#1{%
1527 \filenamelength=0
1528 % If we don't expand the argument now, \skipspaces will get
1529 % snagged on things like "@value{foo}".
1530 \edef\temp{#1}%
1531 \expandafter\skipspaces\temp|\relax
1532 }
1533 \ifnum\pdftexversion < 14
1534 \let \startlink \pdfannotlink
1535 \else
1536 \let \startlink \pdfstartlink
1537 \fi
1538 % make a live url in pdf output.
1539 \def\pdfurl#1{%
1540 \begingroup
1541 % it seems we really need yet another set of dummies; have not
1542 % tried to figure out what each command should do in the context
1543 % of @url. for now, just make @/ a no-op, that's the only one
1544 % people have actually reported a problem with.
1545 %
1546 \normalturnoffactive
1547 \def\@{@}%
1548 \let\/=\empty
1549 \makevalueexpandable
1550 % do we want to go so far as to use \indexnofonts instead of just
1551 % special-casing \var here?
1552 \def\var##1{##1}%
1553 %
1554 \leavevmode\setcolor{\urlcolor}%
1555 \startlink attr{/Border [0 0 0]}%
1556 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1557 \endgroup}
1558 % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may
1559 % be a simple number, or a list of numbers in the case of an index
1560 % entry.
1561 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1562 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1563 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1564 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1565 \def\maketoks{%
1566 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1567 \ifx\first0\adn0
1568 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1569 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1570 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1571 \else
1572 \ifnum0=\countA\else\makelink\fi
1573 \ifx\first.\let\next=\done\else
1574 \let\next=\maketoks
1575 \addtokens{\toksB}{\the\toksD}
1576 \ifx\first,\addtokens{\toksB}{\space}\fi
1577 \fi
1578 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1579 \next}
1580 \def\makelink{\addtokens{\toksB}%
1581 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1582 \def\pdflink#1{%
1583 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1584 \setcolor{\linkcolor}#1\endlink}
1585 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1586 \else
1587 % non-pdf mode
1588 \let\pdfmkdest = \gobble
1589 \let\pdfurl = \gobble
1590 \let\endlink = \relax
1591 \let\setcolor = \gobble
1592 \let\pdfsetcolor = \gobble
1593 \let\pdfmakeoutlines = \relax
1594 \fi % \ifx\pdfoutput
1595
1596 %
1597 % For XeTeX
1598 %
1599 \ifx\XeTeXrevision\thisisundefined
1600 \else
1601 %
1602 % XeTeX version check
1603 %
1604 \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
1605 % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
1606 % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
1607 % For avoiding PDF destination name replacement, we use this special
1608 % instead of xdvipdfmx's command line option `-C 0x0010'.
1609 \special{dvipdfmx:config C 0x0010}
1610 % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
1611 % It can handle Unicode destination names for PDF.
1612 \txiuseunicodedestnametrue
1613 \else
1614 % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
1615 % `dvipdfmx:config' special.
1616 % So for avoiding PDF destination name replacement,
1617 % xdvipdfmx's command line option `-C 0x0010' is necessary.
1618 %
1619 % XeTeX < 0.99995 can not handle Unicode destination names for PDF
1620 % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
1621 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1622 \txiuseunicodedestnamefalse
1623 \fi
1624 %
1625 % Color support
1626 %
1627 \def\rgbDarkRed{0.50 0.09 0.12}
1628 \def\rgbBlack{0 0 0}
1629 %
1630 \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
1631 %
1632 % Set color, and create a mark which defines \thiscolor accordingly,
1633 % so that \makeheadline knows which color to restore.
1634 \def\setcolor#1{%
1635 \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1636 \domark
1637 \pdfsetcolor{#1}%
1638 }
1639 %
1640 \def\maincolor{\rgbBlack}
1641 \pdfsetcolor{\maincolor}
1642 \edef\thiscolor{\maincolor}
1643 \def\currentcolordefs{}
1644 %
1645 \def\makefootline{%
1646 \baselineskip24pt
1647 \line{\pdfsetcolor{\maincolor}\the\footline}%
1648 }
1649 %
1650 \def\makeheadline{%
1651 \vbox to 0pt{%
1652 \vskip-22.5pt
1653 \line{%
1654 \vbox to8.5pt{}%
1655 % Extract \thiscolor definition from the marks.
1656 \getcolormarks
1657 % Typeset the headline with \maincolor, then restore the color.
1658 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1659 }%
1660 \vss
1661 }%
1662 \nointerlineskip
1663 }
1664 %
1665 % PDF outline support
1666 %
1667 % Emulate pdfTeX primitive
1668 \def\pdfdest name#1 xyz{%
1669 \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
1670 }
1671 %
1672 \def\setpdfdestname#1{{%
1673 % We have to set dummies so commands such as @code, and characters
1674 % such as \, aren't expanded when present in a section title.
1675 \indexnofonts
1676 \makevalueexpandable
1677 \turnoffactive
1678 \iftxiuseunicodedestname
1679 % Pass through Unicode characters.
1680 \else
1681 % Use ASCII approximations in destination names.
1682 \passthroughcharsfalse
1683 \fi
1684 \def\pdfdestname{#1}%
1685 \txiescapepdf\pdfdestname
1686 }}
1687 %
1688 \def\setpdfoutlinetext#1{{%
1689 \turnoffactive
1690 % Always use Unicode characters in title texts.
1691 \def\pdfoutlinetext{#1}%
1692 % For XeTeX, xdvipdfmx converts to UTF-16.
1693 % So we do not convert.
1694 \txiescapepdf\pdfoutlinetext
1695 }}
1696 %
1697 \def\pdfmkdest#1{%
1698 \setpdfdestname{#1}%
1699 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1700 }
1701 %
1702 % by default, use black for everything.
1703 \def\urlcolor{\rgbBlack}
1704 \def\linkcolor{\rgbBlack}
1705 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1706 %
1707 \def\dopdfoutline#1#2#3#4{%
1708 \setpdfoutlinetext{#1}
1709 \setpdfdestname{#3}
1710 \ifx\pdfdestname\empty
1711 \def\pdfdestname{#4}%
1712 \fi
1713 %
1714 \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1715 << /S /GoTo /D (\pdfdestname) >> >> }%
1716 }
1717 %
1718 \def\pdfmakeoutlines{%
1719 \begingroup
1720 %
1721 % For XeTeX, counts of subentries are not necessary.
1722 % Therefore, we read toc only once.
1723 %
1724 % We use node names as destinations.
1725 %
1726 % Currently we prefix the section name with the section number
1727 % for chapter and appendix headings only in order to avoid too much
1728 % horizontal space being required in the PDF viewer.
1729 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1730 \def\numchapentry##1##2##3##4{%
1731 \dopdfoutline{##2 ##1}{1}{##3}{##4}}%
1732 \def\numsecentry##1##2##3##4{%
1733 \dopdfoutline{##1}{2}{##3}{##4}}%
1734 \def\numsubsecentry##1##2##3##4{%
1735 \dopdfoutline{##1}{3}{##3}{##4}}%
1736 \def\numsubsubsecentry##1##2##3##4{%
1737 \dopdfoutline{##1}{4}{##3}{##4}}%
1738 %
1739 \let\appentry\numchapentry%
1740 \let\appsecentry\numsecentry%
1741 \let\appsubsecentry\numsubsecentry%
1742 \let\appsubsubsecentry\numsubsubsecentry%
1743 \def\unnchapentry##1##2##3##4{%
1744 \dopdfoutline{##1}{1}{##3}{##4}}%
1745 \let\unnsecentry\numsecentry%
1746 \let\unnsubsecentry\numsubsecentry%
1747 \let\unnsubsubsecentry\numsubsubsecentry%
1748 %
1749 % For XeTeX, xdvipdfmx converts strings to UTF-16.
1750 % Therefore, the encoding and the language may not be considered.
1751 %
1752 \indexnofonts
1753 \setupdatafile
1754 % We can have normal brace characters in the PDF outlines, unlike
1755 % Texinfo index files. So set that up.
1756 \def\{{\lbracecharliteral}%
1757 \def\}{\rbracecharliteral}%
1758 \catcode`\\=\active \otherbackslash
1759 \input \tocreadfilename
1760 \endgroup
1761 }
1762 {\catcode`[=1 \catcode`]=2
1763 \catcode`{=\other \catcode`}=\other
1764 \gdef\lbracecharliteral[{]%
1765 \gdef\rbracecharliteral[}]%
1766 ]
1767
1768 \special{pdf:docview << /PageMode /UseOutlines >> }
1769 % ``\special{pdf:tounicode ...}'' is not necessary
1770 % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1771 % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
1772 % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
1773 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1774 %
1775 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1776 \ifx\PP\D\let\nextsp\relax
1777 \else\let\nextsp\skipspaces
1778 \addtokens{\filename}{\PP}%
1779 \advance\filenamelength by 1
1780 \fi
1781 \nextsp}
1782 \def\getfilename#1{%
1783 \filenamelength=0
1784 % If we don't expand the argument now, \skipspaces will get
1785 % snagged on things like "@value{foo}".
1786 \edef\temp{#1}%
1787 \expandafter\skipspaces\temp|\relax
1788 }
1789 % make a live url in pdf output.
1790 \def\pdfurl#1{%
1791 \begingroup
1792 % it seems we really need yet another set of dummies; have not
1793 % tried to figure out what each command should do in the context
1794 % of @url. for now, just make @/ a no-op, that's the only one
1795 % people have actually reported a problem with.
1796 %
1797 \normalturnoffactive
1798 \def\@{@}%
1799 \let\/=\empty
1800 \makevalueexpandable
1801 % do we want to go so far as to use \indexnofonts instead of just
1802 % special-casing \var here?
1803 \def\var##1{##1}%
1804 %
1805 \leavevmode\setcolor{\urlcolor}%
1806 \special{pdf:bann << /Border [0 0 0]
1807 /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
1808 \endgroup}
1809 \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
1810 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1811 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1812 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1813 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1814 \def\maketoks{%
1815 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1816 \ifx\first0\adn0
1817 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1818 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1819 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1820 \else
1821 \ifnum0=\countA\else\makelink\fi
1822 \ifx\first.\let\next=\done\else
1823 \let\next=\maketoks
1824 \addtokens{\toksB}{\the\toksD}
1825 \ifx\first,\addtokens{\toksB}{\space}\fi
1826 \fi
1827 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1828 \next}
1829 \def\makelink{\addtokens{\toksB}%
1830 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1831 \def\pdflink#1{%
1832 \special{pdf:bann << /Border [0 0 0]
1833 /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
1834 \setcolor{\linkcolor}#1\endlink}
1835 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1836 %
1837 %
1838 % @image support
1839 %
1840 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1841 \def\doxeteximage#1#2#3{%
1842 \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1843 \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1844 %
1845 % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
1846 % others). Let's try in that order, PDF first since if
1847 % someone has a scalable image, presumably better to use that than a
1848 % bitmap.
1849 \let\xeteximgext=\empty
1850 \begingroup
1851 \openin 1 #1.pdf \ifeof 1
1852 \openin 1 #1.PDF \ifeof 1
1853 \openin 1 #1.png \ifeof 1
1854 \openin 1 #1.jpg \ifeof 1
1855 \openin 1 #1.jpeg \ifeof 1
1856 \openin 1 #1.JPG \ifeof 1
1857 \errmessage{Could not find image file #1 for XeTeX}%
1858 \else \gdef\xeteximgext{JPG}%
1859 \fi
1860 \else \gdef\xeteximgext{jpeg}%
1861 \fi
1862 \else \gdef\xeteximgext{jpg}%
1863 \fi
1864 \else \gdef\xeteximgext{png}%
1865 \fi
1866 \else \gdef\xeteximgext{PDF}%
1867 \fi
1868 \else \gdef\xeteximgext{pdf}%
1869 \fi
1870 \closein 1
1871 \endgroup
1872 %
1873 % Putting an \hbox around the image can prevent an over-long line
1874 % after the image.
1875 \hbox\bgroup
1876 \def\xetexpdfext{pdf}%
1877 \ifx\xeteximgext\xetexpdfext
1878 \XeTeXpdffile "#1".\xeteximgext ""
1879 \else
1880 \def\xetexpdfext{PDF}%
1881 \ifx\xeteximgext\xetexpdfext
1882 \XeTeXpdffile "#1".\xeteximgext ""
1883 \else
1884 \XeTeXpicfile "#1".\xeteximgext ""
1885 \fi
1886 \fi
1887 \ifdim \wd0 >0pt width \xeteximagewidth \fi
1888 \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
1889 \egroup
1890 }
1891 \fi
1892
1893
1894 %
1895 \message{fonts,}
1896
1897 % Set the baselineskip to #1, and the lineskip and strut size
1898 % correspondingly. There is no deep meaning behind these magic numbers
1899 % used as factors; they just match (closely enough) what Knuth defined.
1900 %
1901 \def\lineskipfactor{.08333}
1902 \def\strutheightpercent{.70833}
1903 \def\strutdepthpercent {.29167}
1904 %
1905 % can get a sort of poor man's double spacing by redefining this.
1906 \def\baselinefactor{1}
1907 %
1908 \newdimen\textleading
1909 \def\setleading#1{%
1910 \dimen0 = #1\relax
1911 \normalbaselineskip = \baselinefactor\dimen0
1912 \normallineskip = \lineskipfactor\normalbaselineskip
1913 \normalbaselines
1914 \setbox\strutbox =\hbox{%
1915 \vrule width0pt height\strutheightpercent\baselineskip
1916 depth \strutdepthpercent \baselineskip
1917 }%
1918 }
1919
1920 % PDF CMaps. See also LaTeX's t1.cmap.
1921 %
1922 % do nothing with this by default.
1923 \expandafter\let\csname cmapOT1\endcsname\gobble
1924 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1925 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1926
1927 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1928 % (\pdffontattr was introduced many years ago, but people still run
1929 % older pdftex's; it's easy to conditionalize, so we do.)
1930 \ifpdf \ifx\pdffontattr\thisisundefined \else
1931 \begingroup
1932 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1933 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1934 %%DocumentNeededResources: ProcSet (CIDInit)
1935 %%IncludeResource: ProcSet (CIDInit)
1936 %%BeginResource: CMap (TeX-OT1-0)
1937 %%Title: (TeX-OT1-0 TeX OT1 0)
1938 %%Version: 1.000
1939 %%EndComments
1940 /CIDInit /ProcSet findresource begin
1941 12 dict begin
1942 begincmap
1943 /CIDSystemInfo
1944 << /Registry (TeX)
1945 /Ordering (OT1)
1946 /Supplement 0
1947 >> def
1948 /CMapName /TeX-OT1-0 def
1949 /CMapType 2 def
1950 1 begincodespacerange
1951 <00> <7F>
1952 endcodespacerange
1953 8 beginbfrange
1954 <00> <01> <0393>
1955 <09> <0A> <03A8>
1956 <23> <26> <0023>
1957 <28> <3B> <0028>
1958 <3F> <5B> <003F>
1959 <5D> <5E> <005D>
1960 <61> <7A> <0061>
1961 <7B> <7C> <2013>
1962 endbfrange
1963 40 beginbfchar
1964 <02> <0398>
1965 <03> <039B>
1966 <04> <039E>
1967 <05> <03A0>
1968 <06> <03A3>
1969 <07> <03D2>
1970 <08> <03A6>
1971 <0B> <00660066>
1972 <0C> <00660069>
1973 <0D> <0066006C>
1974 <0E> <006600660069>
1975 <0F> <00660066006C>
1976 <10> <0131>
1977 <11> <0237>
1978 <12> <0060>
1979 <13> <00B4>
1980 <14> <02C7>
1981 <15> <02D8>
1982 <16> <00AF>
1983 <17> <02DA>
1984 <18> <00B8>
1985 <19> <00DF>
1986 <1A> <00E6>
1987 <1B> <0153>
1988 <1C> <00F8>
1989 <1D> <00C6>
1990 <1E> <0152>
1991 <1F> <00D8>
1992 <21> <0021>
1993 <22> <201D>
1994 <27> <2019>
1995 <3C> <00A1>
1996 <3D> <003D>
1997 <3E> <00BF>
1998 <5C> <201C>
1999 <5F> <02D9>
2000 <60> <2018>
2001 <7D> <02DD>
2002 <7E> <007E>
2003 <7F> <00A8>
2004 endbfchar
2005 endcmap
2006 CMapName currentdict /CMap defineresource pop
2007 end
2008 end
2009 %%EndResource
2010 %%EOF
2011 }\endgroup
2012 \expandafter\edef\csname cmapOT1\endcsname#1{%
2013 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2014 }%
2015 %
2016 % \cmapOT1IT
2017 \begingroup
2018 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2019 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2020 %%DocumentNeededResources: ProcSet (CIDInit)
2021 %%IncludeResource: ProcSet (CIDInit)
2022 %%BeginResource: CMap (TeX-OT1IT-0)
2023 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
2024 %%Version: 1.000
2025 %%EndComments
2026 /CIDInit /ProcSet findresource begin
2027 12 dict begin
2028 begincmap
2029 /CIDSystemInfo
2030 << /Registry (TeX)
2031 /Ordering (OT1IT)
2032 /Supplement 0
2033 >> def
2034 /CMapName /TeX-OT1IT-0 def
2035 /CMapType 2 def
2036 1 begincodespacerange
2037 <00> <7F>
2038 endcodespacerange
2039 8 beginbfrange
2040 <00> <01> <0393>
2041 <09> <0A> <03A8>
2042 <25> <26> <0025>
2043 <28> <3B> <0028>
2044 <3F> <5B> <003F>
2045 <5D> <5E> <005D>
2046 <61> <7A> <0061>
2047 <7B> <7C> <2013>
2048 endbfrange
2049 42 beginbfchar
2050 <02> <0398>
2051 <03> <039B>
2052 <04> <039E>
2053 <05> <03A0>
2054 <06> <03A3>
2055 <07> <03D2>
2056 <08> <03A6>
2057 <0B> <00660066>
2058 <0C> <00660069>
2059 <0D> <0066006C>
2060 <0E> <006600660069>
2061 <0F> <00660066006C>
2062 <10> <0131>
2063 <11> <0237>
2064 <12> <0060>
2065 <13> <00B4>
2066 <14> <02C7>
2067 <15> <02D8>
2068 <16> <00AF>
2069 <17> <02DA>
2070 <18> <00B8>
2071 <19> <00DF>
2072 <1A> <00E6>
2073 <1B> <0153>
2074 <1C> <00F8>
2075 <1D> <00C6>
2076 <1E> <0152>
2077 <1F> <00D8>
2078 <21> <0021>
2079 <22> <201D>
2080 <23> <0023>
2081 <24> <00A3>
2082 <27> <2019>
2083 <3C> <00A1>
2084 <3D> <003D>
2085 <3E> <00BF>
2086 <5C> <201C>
2087 <5F> <02D9>
2088 <60> <2018>
2089 <7D> <02DD>
2090 <7E> <007E>
2091 <7F> <00A8>
2092 endbfchar
2093 endcmap
2094 CMapName currentdict /CMap defineresource pop
2095 end
2096 end
2097 %%EndResource
2098 %%EOF
2099 }\endgroup
2100 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
2101 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2102 }%
2103 %
2104 % \cmapOT1TT
2105 \begingroup
2106 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2107 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2108 %%DocumentNeededResources: ProcSet (CIDInit)
2109 %%IncludeResource: ProcSet (CIDInit)
2110 %%BeginResource: CMap (TeX-OT1TT-0)
2111 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
2112 %%Version: 1.000
2113 %%EndComments
2114 /CIDInit /ProcSet findresource begin
2115 12 dict begin
2116 begincmap
2117 /CIDSystemInfo
2118 << /Registry (TeX)
2119 /Ordering (OT1TT)
2120 /Supplement 0
2121 >> def
2122 /CMapName /TeX-OT1TT-0 def
2123 /CMapType 2 def
2124 1 begincodespacerange
2125 <00> <7F>
2126 endcodespacerange
2127 5 beginbfrange
2128 <00> <01> <0393>
2129 <09> <0A> <03A8>
2130 <21> <26> <0021>
2131 <28> <5F> <0028>
2132 <61> <7E> <0061>
2133 endbfrange
2134 32 beginbfchar
2135 <02> <0398>
2136 <03> <039B>
2137 <04> <039E>
2138 <05> <03A0>
2139 <06> <03A3>
2140 <07> <03D2>
2141 <08> <03A6>
2142 <0B> <2191>
2143 <0C> <2193>
2144 <0D> <0027>
2145 <0E> <00A1>
2146 <0F> <00BF>
2147 <10> <0131>
2148 <11> <0237>
2149 <12> <0060>
2150 <13> <00B4>
2151 <14> <02C7>
2152 <15> <02D8>
2153 <16> <00AF>
2154 <17> <02DA>
2155 <18> <00B8>
2156 <19> <00DF>
2157 <1A> <00E6>
2158 <1B> <0153>
2159 <1C> <00F8>
2160 <1D> <00C6>
2161 <1E> <0152>
2162 <1F> <00D8>
2163 <20> <2423>
2164 <27> <2019>
2165 <60> <2018>
2166 <7F> <00A8>
2167 endbfchar
2168 endcmap
2169 CMapName currentdict /CMap defineresource pop
2170 end
2171 end
2172 %%EndResource
2173 %%EOF
2174 }\endgroup
2175 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
2176 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2177 }%
2178 \fi\fi
2179
2180
2181 % Set the font macro #1 to the font named \fontprefix#2.
2182 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2183 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2184 % Example:
2185 % #1 = \textrm
2186 % #2 = \rmshape
2187 % #3 = 10
2188 % #4 = \mainmagstep
2189 % #5 = OT1
2190 %
2191 \def\setfont#1#2#3#4#5{%
2192 \font#1=\fontprefix#2#3 scaled #4
2193 \csname cmap#5\endcsname#1%
2194 }
2195 % This is what gets called when #5 of \setfont is empty.
2196 \let\cmap\gobble
2197 %
2198 % (end of cmaps)
2199
2200 % Use cm as the default font prefix.
2201 % To specify the font prefix, you must define \fontprefix
2202 % before you read in texinfo.tex.
2203 \ifx\fontprefix\thisisundefined
2204 \def\fontprefix{cm}
2205 \fi
2206 % Support font families that don't use the same naming scheme as CM.
2207 \def\rmshape{r}
2208 \def\rmbshape{bx} % where the normal face is bold
2209 \def\bfshape{b}
2210 \def\bxshape{bx}
2211 \def\ttshape{tt}
2212 \def\ttbshape{tt}
2213 \def\ttslshape{sltt}
2214 \def\itshape{ti}
2215 \def\itbshape{bxti}
2216 \def\slshape{sl}
2217 \def\slbshape{bxsl}
2218 \def\sfshape{ss}
2219 \def\sfbshape{ss}
2220 \def\scshape{csc}
2221 \def\scbshape{csc}
2222
2223 % Definitions for a main text size of 11pt. (The default in Texinfo.)
2224 %
2225 \def\definetextfontsizexi{%
2226 % Text fonts (11.2pt, magstep1).
2227 \def\textnominalsize{11pt}
2228 \edef\mainmagstep{\magstephalf}
2229 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2230 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2231 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2232 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2233 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2234 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2235 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2236 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2237 \font\texti=cmmi10 scaled \mainmagstep
2238 \font\textsy=cmsy10 scaled \mainmagstep
2239 \def\textecsize{1095}
2240
2241 % A few fonts for @defun names and args.
2242 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2243 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2244 \setfont\defsl\slshape{10}{\magstep1}{OT1}
2245 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2246 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2247 \let\ttslfont=\defttsl \let\slfont=\defsl \bf}
2248
2249 % Fonts for indices, footnotes, small examples (9pt).
2250 \def\smallnominalsize{9pt}
2251 \setfont\smallrm\rmshape{9}{1000}{OT1}
2252 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2253 \setfont\smallbf\bfshape{10}{900}{OT1}
2254 \setfont\smallit\itshape{9}{1000}{OT1IT}
2255 \setfont\smallsl\slshape{9}{1000}{OT1}
2256 \setfont\smallsf\sfshape{9}{1000}{OT1}
2257 \setfont\smallsc\scshape{10}{900}{OT1}
2258 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2259 \font\smalli=cmmi9
2260 \font\smallsy=cmsy9
2261 \def\smallecsize{0900}
2262
2263 % Fonts for small examples (8pt).
2264 \def\smallernominalsize{8pt}
2265 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2266 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2267 \setfont\smallerbf\bfshape{10}{800}{OT1}
2268 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2269 \setfont\smallersl\slshape{8}{1000}{OT1}
2270 \setfont\smallersf\sfshape{8}{1000}{OT1}
2271 \setfont\smallersc\scshape{10}{800}{OT1}
2272 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2273 \font\smalleri=cmmi8
2274 \font\smallersy=cmsy8
2275 \def\smallerecsize{0800}
2276
2277 % Fonts for math mode superscripts (7pt).
2278 \def\sevennominalsize{7pt}
2279 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2280 \setfont\seventt\ttshape{10}{700}{OT1TT}
2281 \setfont\sevenbf\bfshape{10}{700}{OT1}
2282 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2283 \setfont\sevensl\slshape{10}{700}{OT1}
2284 \setfont\sevensf\sfshape{10}{700}{OT1}
2285 \setfont\sevensc\scshape{10}{700}{OT1}
2286 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2287 \font\seveni=cmmi7
2288 \font\sevensy=cmsy7
2289 \def\sevenecsize{0700}
2290
2291 % Fonts for title page (20.4pt):
2292 \def\titlenominalsize{20pt}
2293 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2294 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2295 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2296 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2297 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2298 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2299 \let\titlebf=\titlerm
2300 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2301 \font\titlei=cmmi12 scaled \magstep3
2302 \font\titlesy=cmsy10 scaled \magstep4
2303 \def\titleecsize{2074}
2304
2305 % Chapter (and unnumbered) fonts (17.28pt).
2306 \def\chapnominalsize{17pt}
2307 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2308 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2309 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2310 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2311 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2312 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2313 \let\chapbf=\chaprm
2314 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2315 \font\chapi=cmmi12 scaled \magstep2
2316 \font\chapsy=cmsy10 scaled \magstep3
2317 \def\chapecsize{1728}
2318
2319 % Section fonts (14.4pt).
2320 \def\secnominalsize{14pt}
2321 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2322 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
2323 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2324 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2325 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2326 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2327 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2328 \let\secbf\secrm
2329 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2330 \font\seci=cmmi12 scaled \magstep1
2331 \font\secsy=cmsy10 scaled \magstep2
2332 \def\sececsize{1440}
2333
2334 % Subsection fonts (13.15pt).
2335 \def\ssecnominalsize{13pt}
2336 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2337 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2338 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2339 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2340 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2341 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2342 \let\ssecbf\ssecrm
2343 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2344 \font\sseci=cmmi12 scaled \magstephalf
2345 \font\ssecsy=cmsy10 scaled 1315
2346 \def\ssececsize{1200}
2347
2348 % Reduced fonts for @acronym in text (10pt).
2349 \def\reducednominalsize{10pt}
2350 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2351 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2352 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2353 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2354 \setfont\reducedsl\slshape{10}{1000}{OT1}
2355 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2356 \setfont\reducedsc\scshape{10}{1000}{OT1}
2357 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2358 \font\reducedi=cmmi10
2359 \font\reducedsy=cmsy10
2360 \def\reducedecsize{1000}
2361
2362 \textleading = 13.2pt % line spacing for 11pt CM
2363 \textfonts % reset the current fonts
2364 \rm
2365 } % end of 11pt text font size definitions, \definetextfontsizexi
2366
2367
2368 % Definitions to make the main text be 10pt Computer Modern, with
2369 % section, chapter, etc., sizes following suit. This is for the GNU
2370 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2371 % future. Used with @smallbook, which sets the leading to 12pt.
2372 %
2373 \def\definetextfontsizex{%
2374 % Text fonts (10pt).
2375 \def\textnominalsize{10pt}
2376 \edef\mainmagstep{1000}
2377 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2378 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2379 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2380 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2381 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2382 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2383 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2384 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2385 \font\texti=cmmi10 scaled \mainmagstep
2386 \font\textsy=cmsy10 scaled \mainmagstep
2387 \def\textecsize{1000}
2388
2389 % A few fonts for @defun names and args.
2390 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2391 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2392 \setfont\defsl\slshape{10}{\magstephalf}{OT1}
2393 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2394 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2395 \let\slfont=\defsl \let\ttslfont=\defttsl \bf}
2396
2397 % Fonts for indices, footnotes, small examples (9pt).
2398 \def\smallnominalsize{9pt}
2399 \setfont\smallrm\rmshape{9}{1000}{OT1}
2400 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2401 \setfont\smallbf\bfshape{10}{900}{OT1}
2402 \setfont\smallit\itshape{9}{1000}{OT1IT}
2403 \setfont\smallsl\slshape{9}{1000}{OT1}
2404 \setfont\smallsf\sfshape{9}{1000}{OT1}
2405 \setfont\smallsc\scshape{10}{900}{OT1}
2406 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2407 \font\smalli=cmmi9
2408 \font\smallsy=cmsy9
2409 \def\smallecsize{0900}
2410
2411 % Fonts for small examples (8pt).
2412 \def\smallernominalsize{8pt}
2413 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2414 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2415 \setfont\smallerbf\bfshape{10}{800}{OT1}
2416 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2417 \setfont\smallersl\slshape{8}{1000}{OT1}
2418 \setfont\smallersf\sfshape{8}{1000}{OT1}
2419 \setfont\smallersc\scshape{10}{800}{OT1}
2420 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2421 \font\smalleri=cmmi8
2422 \font\smallersy=cmsy8
2423 \def\smallerecsize{0800}
2424
2425 % Fonts for math mode superscripts (7pt).
2426 \def\sevennominalsize{7pt}
2427 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2428 \setfont\seventt\ttshape{10}{700}{OT1TT}
2429 \setfont\sevenbf\bfshape{10}{700}{OT1}
2430 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2431 \setfont\sevensl\slshape{10}{700}{OT1}
2432 \setfont\sevensf\sfshape{10}{700}{OT1}
2433 \setfont\sevensc\scshape{10}{700}{OT1}
2434 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2435 \font\seveni=cmmi7
2436 \font\sevensy=cmsy7
2437 \def\sevenecsize{0700}
2438
2439 % Fonts for title page (20.4pt):
2440 \def\titlenominalsize{20pt}
2441 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2442 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2443 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2444 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2445 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2446 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2447 \let\titlebf=\titlerm
2448 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2449 \font\titlei=cmmi12 scaled \magstep3
2450 \font\titlesy=cmsy10 scaled \magstep4
2451 \def\titleecsize{2074}
2452
2453 % Chapter fonts (14.4pt).
2454 \def\chapnominalsize{14pt}
2455 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2456 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2457 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2458 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2459 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2460 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2461 \let\chapbf\chaprm
2462 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2463 \font\chapi=cmmi12 scaled \magstep1
2464 \font\chapsy=cmsy10 scaled \magstep2
2465 \def\chapecsize{1440}
2466
2467 % Section fonts (12pt).
2468 \def\secnominalsize{12pt}
2469 \setfont\secrm\rmbshape{12}{1000}{OT1}
2470 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2471 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2472 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2473 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2474 \setfont\secsf\sfbshape{12}{1000}{OT1}
2475 \let\secbf\secrm
2476 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2477 \font\seci=cmmi12
2478 \font\secsy=cmsy10 scaled \magstep1
2479 \def\sececsize{1200}
2480
2481 % Subsection fonts (10pt).
2482 \def\ssecnominalsize{10pt}
2483 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2484 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2485 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2486 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2487 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2488 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2489 \let\ssecbf\ssecrm
2490 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2491 \font\sseci=cmmi10
2492 \font\ssecsy=cmsy10
2493 \def\ssececsize{1000}
2494
2495 % Reduced fonts for @acronym in text (9pt).
2496 \def\reducednominalsize{9pt}
2497 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2498 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2499 \setfont\reducedbf\bfshape{10}{900}{OT1}
2500 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2501 \setfont\reducedsl\slshape{9}{1000}{OT1}
2502 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2503 \setfont\reducedsc\scshape{10}{900}{OT1}
2504 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2505 \font\reducedi=cmmi9
2506 \font\reducedsy=cmsy9
2507 \def\reducedecsize{0900}
2508
2509 \divide\parskip by 2 % reduce space between paragraphs
2510 \textleading = 12pt % line spacing for 10pt CM
2511 \textfonts % reset the current fonts
2512 \rm
2513 } % end of 10pt text font size definitions, \definetextfontsizex
2514
2515 % Fonts for short table of contents.
2516 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2517 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2518 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2519 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2520
2521
2522 % We provide the user-level command
2523 % @fonttextsize 10
2524 % (or 11) to redefine the text font size. pt is assumed.
2525 %
2526 \def\xiword{11}
2527 \def\xword{10}
2528 \def\xwordpt{10pt}
2529 %
2530 \parseargdef\fonttextsize{%
2531 \def\textsizearg{#1}%
2532 %\wlog{doing @fonttextsize \textsizearg}%
2533 %
2534 % Set \globaldefs so that documents can use this inside @tex, since
2535 % makeinfo 4.8 does not support it, but we need it nonetheless.
2536 %
2537 \begingroup \globaldefs=1
2538 \ifx\textsizearg\xword \definetextfontsizex
2539 \else \ifx\textsizearg\xiword \definetextfontsizexi
2540 \else
2541 \errhelp=\EMsimple
2542 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2543 \fi\fi
2544 \endgroup
2545 }
2546
2547 %
2548 % Change the current font style to #1, remembering it in \curfontstyle.
2549 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
2550 % italics, not bold italics.
2551 %
2552 \def\setfontstyle#1{%
2553 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
2554 \csname #1font\endcsname % change the current font
2555 }
2556
2557 \def\rm{\fam=0 \setfontstyle{rm}}
2558 \def\it{\fam=\itfam \setfontstyle{it}}
2559 \def\sl{\fam=\slfam \setfontstyle{sl}}
2560 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
2561 \def\tt{\fam=\ttfam \setfontstyle{tt}}\def\ttstylename{tt}
2562
2563 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
2564 % So we set up a \sf.
2565 \newfam\sffam
2566 \def\sf{\fam=\sffam \setfontstyle{sf}}
2567
2568 % We don't need math for this font style.
2569 \def\ttsl{\setfontstyle{ttsl}}
2570
2571
2572 % In order for the font changes to affect most math symbols and letters,
2573 % we have to define the \textfont of the standard families.
2574 % We don't bother to reset \scriptscriptfont; awaiting user need.
2575 %
2576 \def\resetmathfonts{%
2577 \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
2578 \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
2579 \textfont\ttfam=\ttfont \textfont\sffam=\sffont
2580 %
2581 % Fonts for superscript. Note that the 7pt fonts are used regardless
2582 % of the current font size.
2583 \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
2584 \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
2585 \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
2586 \scriptfont\sffam=\sevensf
2587 }
2588
2589 %
2590
2591 % The font-changing commands (all called \...fonts) redefine the meanings
2592 % of \STYLEfont, instead of just \STYLE. We do this because \STYLE needs
2593 % to also set the current \fam for math mode. Our \STYLE (e.g., \rm)
2594 % commands hardwire \STYLEfont to set the current font.
2595 %
2596 % The fonts used for \ifont are for "math italics" (\itfont is for italics
2597 % in regular text). \syfont is also used in math mode only.
2598 %
2599 % Each font-changing command also sets the names \lsize (one size lower)
2600 % and \lllsize (three sizes lower). These relative commands are used
2601 % in, e.g., the LaTeX logo and acronyms.
2602 %
2603 % This all needs generalizing, badly.
2604 %
2605
2606 \def\assignfonts#1{%
2607 \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
2608 \expandafter\let\expandafter\itfont\csname #1it\endcsname
2609 \expandafter\let\expandafter\slfont\csname #1sl\endcsname
2610 \expandafter\let\expandafter\bffont\csname #1bf\endcsname
2611 \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
2612 \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
2613 \expandafter\let\expandafter\sffont \csname #1sf\endcsname
2614 \expandafter\let\expandafter\ifont \csname #1i\endcsname
2615 \expandafter\let\expandafter\syfont \csname #1sy\endcsname
2616 \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
2617 }
2618
2619 \newif\ifrmisbold
2620
2621 % Select smaller font size with the current style. Used to change font size
2622 % in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for
2623 % normal roman text, also use bold fonts for roman text in the smaller size.
2624 \def\switchtolllsize{%
2625 \expandafter\assignfonts\expandafter{\lllsize}%
2626 \ifrmisbold
2627 \let\rmfont\bffont
2628 \fi
2629 \csname\curfontstyle\endcsname
2630 }%
2631
2632 \def\switchtolsize{%
2633 \expandafter\assignfonts\expandafter{\lsize}%
2634 \ifrmisbold
2635 \let\rmfont\bffont
2636 \fi
2637 \csname\curfontstyle\endcsname
2638 }%
2639
2640 \def\definefontsetatsize#1#2#3#4#5{%
2641 \expandafter\def\csname #1fonts\endcsname{%
2642 \def\curfontsize{#1}%
2643 \def\lsize{#2}\def\lllsize{#3}%
2644 \csname rmisbold#5\endcsname
2645 \assignfonts{#1}%
2646 \resetmathfonts
2647 \setleading{#4}%
2648 }}
2649
2650 \definefontsetatsize{text} {reduced}{smaller}{\textleading}{false}
2651 \definefontsetatsize{title} {chap} {subsec} {27pt} {true}
2652 \definefontsetatsize{chap} {sec} {text} {19pt} {true}
2653 \definefontsetatsize{sec} {subsec} {reduced}{17pt} {true}
2654 \definefontsetatsize{ssec} {text} {small} {15pt} {true}
2655 \definefontsetatsize{reduced}{small} {smaller}{10.5pt}{false}
2656 \definefontsetatsize{small} {smaller}{smaller}{10.5pt}{false}
2657 \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
2658
2659 \def\titlefont#1{{\titlefonts\rm #1}}
2660 \let\subsecfonts = \ssecfonts
2661 \let\subsubsecfonts = \ssecfonts
2662
2663 % Define these just so they can be easily changed for other fonts.
2664 \def\angleleft{$\langle$}
2665 \def\angleright{$\rangle$}
2666
2667 % Set the fonts to use with the @small... environments.
2668 \let\smallexamplefonts = \smallfonts
2669
2670 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2671 % can fit this many characters:
2672 % 8.5x11=86 smallbook=72 a4=90 a5=69
2673 % If we use \scriptfonts (8pt), then we can fit this many characters:
2674 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2675 % For me, subjectively, the few extra characters that fit aren't worth
2676 % the additional smallness of 8pt. So I'm making the default 9pt.
2677 %
2678 % By the way, for comparison, here's what fits with @example (10pt):
2679 % 8.5x11=71 smallbook=60 a4=75 a5=58
2680 % --karl, 24jan03.
2681
2682 % Set up the default fonts, so we can use them for creating boxes.
2683 %
2684 \definetextfontsizexi
2685
2686
2687 % Check if we are currently using a typewriter font. Since all the
2688 % Computer Modern typewriter fonts have zero interword stretch (and
2689 % shrink), and it is reasonable to expect all typewriter fonts to have
2690 % this property, we can check that font parameter.
2691 %
2692 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2693
2694 {
2695 \catcode`\'=\active
2696 \catcode`\`=\active
2697
2698 \gdef\setcodequotes{\let`\codequoteleft \let'\codequoteright}
2699 \gdef\setregularquotes{\let`\lq \let'\rq}
2700 }
2701
2702 % Allow an option to not use regular directed right quote/apostrophe
2703 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2704 % The undirected quote is ugly, so don't make it the default, but it
2705 % works for pasting with more pdf viewers (at least evince), the
2706 % lilypond developers report. xpdf does work with the regular 0x27.
2707 %
2708 \def\codequoteright{%
2709 \ifmonospace
2710 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2711 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2712 '%
2713 \else \char'15 \fi
2714 \else \char'15 \fi
2715 \else
2716 '%
2717 \fi
2718 }
2719 %
2720 % and a similar option for the left quote char vs. a grave accent.
2721 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2722 % the code environments to do likewise.
2723 %
2724 \def\codequoteleft{%
2725 \ifmonospace
2726 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2727 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2728 % [Knuth] pp. 380,381,391
2729 % \relax disables Spanish ligatures ?` and !` of \tt font.
2730 \relax`%
2731 \else \char'22 \fi
2732 \else \char'22 \fi
2733 \else
2734 \relax`%
2735 \fi
2736 }
2737
2738 % Commands to set the quote options.
2739 %
2740 \parseargdef\codequoteundirected{%
2741 \def\temp{#1}%
2742 \ifx\temp\onword
2743 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2744 = t%
2745 \else\ifx\temp\offword
2746 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2747 = \relax
2748 \else
2749 \errhelp = \EMsimple
2750 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2751 \fi\fi
2752 }
2753 %
2754 \parseargdef\codequotebacktick{%
2755 \def\temp{#1}%
2756 \ifx\temp\onword
2757 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2758 = t%
2759 \else\ifx\temp\offword
2760 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2761 = \relax
2762 \else
2763 \errhelp = \EMsimple
2764 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2765 \fi\fi
2766 }
2767
2768 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2769 \def\noligaturesquoteleft{\relax\lq}
2770
2771 % Count depth in font-changes, for error checks
2772 \newcount\fontdepth \fontdepth=0
2773
2774 % Font commands.
2775
2776 % #1 is the font command (\sl or \it), #2 is the text to slant.
2777 % If we are in a monospaced environment, however, 1) always use \ttsl,
2778 % and 2) do not add an italic correction.
2779 \def\dosmartslant#1#2{%
2780 \ifusingtt
2781 {{\ttsl #2}\let\next=\relax}%
2782 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2783 \next
2784 }
2785 \def\smartslanted{\dosmartslant\sl}
2786 \def\smartitalic{\dosmartslant\it}
2787
2788 % Output an italic correction unless \next (presumed to be the following
2789 % character) is such as not to need one.
2790 \def\smartitaliccorrection{%
2791 \ifx\next,%
2792 \else\ifx\next-%
2793 \else\ifx\next.%
2794 \else\ifx\next\.%
2795 \else\ifx\next\comma%
2796 \else\ptexslash
2797 \fi\fi\fi\fi\fi
2798 \aftersmartic
2799 }
2800
2801 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2802 \def\ttslanted#1{{\ttsl #1}}
2803
2804 % @cite is like \smartslanted except unconditionally use \sl. We never want
2805 % ttsl for book titles, do we?
2806 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2807
2808 \def\aftersmartic{}
2809 \def\var#1{%
2810 \let\saveaftersmartic = \aftersmartic
2811 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2812 \smartslanted{#1}%
2813 }
2814
2815 \let\i=\smartitalic
2816 \let\slanted=\smartslanted
2817 \let\dfn=\smartslanted
2818 \let\emph=\smartitalic
2819
2820 % Explicit font changes: @r, @sc, undocumented @ii.
2821 \def\r#1{{\rm #1}} % roman font
2822 \def\sc#1{{\smallcaps#1}} % smallcaps font
2823 \def\ii#1{{\it #1}} % italic font
2824
2825 % @b, explicit bold. Also @strong.
2826 \def\b#1{{\bf #1}}
2827 \let\strong=\b
2828
2829 % @sansserif, explicit sans.
2830 \def\sansserif#1{{\sf #1}}
2831
2832 % We can't just use \exhyphenpenalty, because that only has effect at
2833 % the end of a paragraph. Restore normal hyphenation at the end of the
2834 % group within which \nohyphenation is presumably called.
2835 %
2836 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2837 \def\restorehyphenation{\hyphenchar\font = `- }
2838
2839 % Set sfcode to normal for the chars that usually have another value.
2840 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2841 % sometimes \x has an active definition that messes things up.
2842 %
2843 \catcode`@=11
2844 \def\plainfrenchspacing{%
2845 \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
2846 \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
2847 \def\endofsentencespacefactor{1000}% for @. and friends
2848 }
2849 \def\plainnonfrenchspacing{%
2850 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2851 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2852 \def\endofsentencespacefactor{3000}% for @. and friends
2853 }
2854 \catcode`@=\other
2855 \def\endofsentencespacefactor{3000}% default
2856
2857 % @t, explicit typewriter.
2858 \def\t#1{%
2859 {\tt \plainfrenchspacing #1}%
2860 \null
2861 }
2862
2863 % @samp.
2864 \def\samp#1{{\setcodequotes\lq\tclose{#1}\rq\null}}
2865
2866 % @indicateurl is \samp, that is, with quotes.
2867 \let\indicateurl=\samp
2868
2869 % @code (and similar) prints in typewriter, but with spaces the same
2870 % size as normal in the surrounding text, without hyphenation, etc.
2871 % This is a subroutine for that.
2872 \def\tclose#1{%
2873 {%
2874 % Change normal interword space to be same as for the current font.
2875 \spaceskip = \fontdimen2\font
2876 %
2877 % Switch to typewriter.
2878 \tt
2879 %
2880 % But `\ ' produces the large typewriter interword space.
2881 \def\ {{\spaceskip = 0pt{} }}%
2882 %
2883 % Turn off hyphenation.
2884 \nohyphenation
2885 %
2886 \plainfrenchspacing
2887 #1%
2888 }%
2889 \null % reset spacefactor to 1000
2890 }
2891
2892 % We *must* turn on hyphenation at `-' and `_' in @code.
2893 % (But see \codedashfinish below.)
2894 % Otherwise, it is too hard to avoid overfull hboxes
2895 % in the Emacs manual, the Library manual, etc.
2896 %
2897 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2898 % both hyphenation at - and hyphenation within words.
2899 % We must therefore turn them both off (\tclose does that)
2900 % and arrange explicitly to hyphenate at a dash. -- rms.
2901 {
2902 \catcode`\-=\active \catcode`\_=\active
2903 \catcode`\'=\active \catcode`\`=\active
2904 \global\let'=\rq \global\let`=\lq % default definitions
2905 %
2906 \global\def\code{\begingroup
2907 \setcodequotes
2908 \catcode\dashChar=\active \catcode\underChar=\active
2909 \ifallowcodebreaks
2910 \let-\codedash
2911 \let_\codeunder
2912 \else
2913 \let-\normaldash
2914 \let_\realunder
2915 \fi
2916 % Given -foo (with a single dash), we do not want to allow a break
2917 % after the hyphen.
2918 \global\let\codedashprev=\codedash
2919 %
2920 \codex
2921 }
2922 %
2923 \gdef\codedash{\futurelet\next\codedashfinish}
2924 \gdef\codedashfinish{%
2925 \normaldash % always output the dash character itself.
2926 %
2927 % Now, output a discretionary to allow a line break, unless
2928 % (a) the next character is a -, or
2929 % (b) the preceding character is a -.
2930 % E.g., given --posix, we do not want to allow a break after either -.
2931 % Given --foo-bar, we do want to allow a break between the - and the b.
2932 \ifx\next\codedash \else
2933 \ifx\codedashprev\codedash
2934 \else \discretionary{}{}{}\fi
2935 \fi
2936 % we need the space after the = for the case when \next itself is a
2937 % space token; it would get swallowed otherwise. As in @code{- a}.
2938 \global\let\codedashprev= \next
2939 }
2940 }
2941 \def\normaldash{-}
2942 %
2943 \def\codex #1{\tclose{#1}\endgroup}
2944
2945 \def\codeunder{%
2946 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2947 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2948 % will therefore expand the active definition of _, which is us
2949 % (inside @code that is), therefore an endless loop.
2950 \ifusingtt{\ifmmode
2951 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2952 \else\normalunderscore \fi
2953 \discretionary{}{}{}}%
2954 {\_}%
2955 }
2956
2957 % An additional complication: the above will allow breaks after, e.g.,
2958 % each of the four underscores in __typeof__. This is bad.
2959 % @allowcodebreaks provides a document-level way to turn breaking at -
2960 % and _ on and off.
2961 %
2962 \newif\ifallowcodebreaks \allowcodebreakstrue
2963
2964 \def\keywordtrue{true}
2965 \def\keywordfalse{false}
2966
2967 \parseargdef\allowcodebreaks{%
2968 \def\txiarg{#1}%
2969 \ifx\txiarg\keywordtrue
2970 \allowcodebreakstrue
2971 \else\ifx\txiarg\keywordfalse
2972 \allowcodebreaksfalse
2973 \else
2974 \errhelp = \EMsimple
2975 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2976 \fi\fi
2977 }
2978
2979 % For @command, @env, @file, @option quotes seem unnecessary,
2980 % so use \code rather than \samp.
2981 \let\command=\code
2982 \let\env=\code
2983 \let\file=\code
2984 \let\option=\code
2985
2986 % @uref (abbreviation for `urlref') aka @url takes an optional
2987 % (comma-separated) second argument specifying the text to display and
2988 % an optional third arg as text to display instead of (rather than in
2989 % addition to) the url itself. First (mandatory) arg is the url.
2990
2991 % TeX-only option to allow changing PDF output to show only the second
2992 % arg (if given), and not the url (which is then just the link target).
2993 \newif\ifurefurlonlylink
2994
2995 % The default \pretolerance setting stops the penalty inserted in
2996 % \urefallowbreak being a discouragement to line breaking. Set it to
2997 % a negative value for this paragraph only. Hopefully this does not
2998 % conflict with redefinitions of \par done elsewhere.
2999 \def\nopretolerance{%
3000 \pretolerance=-1
3001 \def\par{\endgraf\pretolerance=100 \let\par\endgraf}%
3002 }
3003
3004 % The main macro is \urefbreak, which allows breaking at expected
3005 % places within the url.
3006 \def\urefbreak{\nopretolerance \begingroup \urefcatcodes \dourefbreak}
3007 \let\uref=\urefbreak
3008 %
3009 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
3010 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
3011 \unsepspaces
3012 \pdfurl{#1}%
3013 \setbox0 = \hbox{\ignorespaces #3}%
3014 \ifdim\wd0 > 0pt
3015 \unhbox0 % third arg given, show only that
3016 \else
3017 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
3018 \ifdim\wd0 > 0pt
3019 \ifpdf
3020 % For pdfTeX and LuaTeX
3021 \ifurefurlonlylink
3022 % PDF plus option to not display url, show just arg
3023 \unhbox0
3024 \else
3025 % PDF, normally display both arg and url for consistency,
3026 % visibility, if the pdf is eventually used to print, etc.
3027 \unhbox0\ (\urefcode{#1})%
3028 \fi
3029 \else
3030 \ifx\XeTeXrevision\thisisundefined
3031 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
3032 \else
3033 % For XeTeX
3034 \ifurefurlonlylink
3035 % PDF plus option to not display url, show just arg
3036 \unhbox0
3037 \else
3038 % PDF, normally display both arg and url for consistency,
3039 % visibility, if the pdf is eventually used to print, etc.
3040 \unhbox0\ (\urefcode{#1})%
3041 \fi
3042 \fi
3043 \fi
3044 \else
3045 \urefcode{#1}% only url given, so show it
3046 \fi
3047 \fi
3048 \endlink
3049 \endgroup}
3050
3051 % Allow line breaks around only a few characters (only).
3052 \def\urefcatcodes{%
3053 \catcode`\&=\active \catcode`\.=\active
3054 \catcode`\#=\active \catcode`\?=\active
3055 \catcode`\/=\active
3056 }
3057 {
3058 \urefcatcodes
3059 %
3060 \global\def\urefcode{\begingroup
3061 \setcodequotes
3062 \urefcatcodes
3063 \let&\urefcodeamp
3064 \let.\urefcodedot
3065 \let#\urefcodehash
3066 \let?\urefcodequest
3067 \let/\urefcodeslash
3068 \codex
3069 }
3070 %
3071 % By default, they are just regular characters.
3072 \global\def&{\normalamp}
3073 \global\def.{\normaldot}
3074 \global\def#{\normalhash}
3075 \global\def?{\normalquest}
3076 \global\def/{\normalslash}
3077 }
3078
3079 \def\urefcodeamp{\urefprebreak \&\urefpostbreak}
3080 \def\urefcodedot{\urefprebreak .\urefpostbreak}
3081 \def\urefcodehash{\urefprebreak \#\urefpostbreak}
3082 \def\urefcodequest{\urefprebreak ?\urefpostbreak}
3083 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
3084 {
3085 \catcode`\/=\active
3086 \global\def\urefcodeslashfinish{%
3087 \urefprebreak \slashChar
3088 % Allow line break only after the final / in a sequence of
3089 % slashes, to avoid line break between the slashes in http://.
3090 \ifx\next/\else \urefpostbreak \fi
3091 }
3092 }
3093
3094 % By default we'll break after the special characters, but some people like to
3095 % break before the special chars, so allow that. Also allow no breaking at
3096 % all, for manual control.
3097 %
3098 \parseargdef\urefbreakstyle{%
3099 \def\txiarg{#1}%
3100 \ifx\txiarg\wordnone
3101 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
3102 \else\ifx\txiarg\wordbefore
3103 \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak}
3104 \else\ifx\txiarg\wordafter
3105 \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak}
3106 \else
3107 \errhelp = \EMsimple
3108 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
3109 \fi\fi\fi
3110 }
3111 \def\wordafter{after}
3112 \def\wordbefore{before}
3113 \def\wordnone{none}
3114
3115 % Allow a ragged right output to aid breaking long URL's. There can
3116 % be a break at the \allowbreak with no extra glue (if the existing stretch in
3117 % the line is sufficient), a break at the \penalty with extra glue added
3118 % at the end of the line, or no break at all here.
3119 % Changing the value of the penalty and/or the amount of stretch affects how
3120 % preferable one choice is over the other.
3121 \def\urefallowbreak{%
3122 \penalty0\relax
3123 \hskip 0pt plus 2 em\relax
3124 \penalty1000\relax
3125 \hskip 0pt plus -2 em\relax
3126 }
3127
3128 \urefbreakstyle after
3129
3130 % @url synonym for @uref, since that's how everyone uses it.
3131 %
3132 \let\url=\uref
3133
3134 % rms does not like angle brackets --karl, 17may97.
3135 % So now @email is just like @uref, unless we are pdf.
3136 %
3137 %\def\email#1{\angleleft{\tt #1}\angleright}
3138 \ifpdforxetex
3139 \def\email#1{\doemail#1,,\finish}
3140 \def\doemail#1,#2,#3\finish{\begingroup
3141 \unsepspaces
3142 \pdfurl{mailto:#1}%
3143 \setbox0 = \hbox{\ignorespaces #2}%
3144 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3145 \endlink
3146 \endgroup}
3147 \else
3148 \let\email=\uref
3149 \fi
3150
3151 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3152 % `example' (@kbd uses ttsl only inside of @example and friends),
3153 % or `code' (@kbd uses normal tty font always).
3154 \parseargdef\kbdinputstyle{%
3155 \def\txiarg{#1}%
3156 \ifx\txiarg\worddistinct
3157 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
3158 \else\ifx\txiarg\wordexample
3159 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
3160 \else\ifx\txiarg\wordcode
3161 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
3162 \else
3163 \errhelp = \EMsimple
3164 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
3165 \fi\fi\fi
3166 }
3167 \def\worddistinct{distinct}
3168 \def\wordexample{example}
3169 \def\wordcode{code}
3170
3171 % Default is `distinct'.
3172 \kbdinputstyle distinct
3173
3174 % @kbd is like @code, except that if the argument is just one @key command,
3175 % then @kbd has no effect.
3176 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
3177
3178 \def\xkey{\key}
3179 \def\kbdsub#1#2#3\par{%
3180 \def\one{#1}\def\three{#3}\def\threex{??}%
3181 \ifx\one\xkey\ifx\threex\three \key{#2}%
3182 \else{\tclose{\kbdfont\setcodequotes\look}}\fi
3183 \else{\tclose{\kbdfont\setcodequotes\look}}\fi
3184 }
3185
3186 % definition of @key that produces a lozenge. Doesn't adjust to text size.
3187 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3188 %\font\keysy=cmsy9
3189 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3190 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3191 % \vbox{\hrule\kern-0.4pt
3192 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3193 % \kern-0.4pt\hrule}%
3194 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3195
3196 % definition of @key with no lozenge. If the current font is already
3197 % monospace, don't change it; that way, we respect @kbdinputstyle. But
3198 % if it isn't monospace, then use \tt.
3199 %
3200 \def\key#1{{\setregularquotes
3201 \nohyphenation
3202 \ifmonospace\else\tt\fi
3203 #1}\null}
3204
3205 % @clicksequence{File @click{} Open ...}
3206 \def\clicksequence#1{\begingroup #1\endgroup}
3207
3208 % @clickstyle @arrow (by default)
3209 \parseargdef\clickstyle{\def\click{#1}}
3210 \def\click{\arrow}
3211
3212 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
3213 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
3214 %
3215 \def\dmn#1{\thinspace #1}
3216
3217 % @acronym for "FBI", "NATO", and the like.
3218 % We print this one point size smaller, since it's intended for
3219 % all-uppercase.
3220 %
3221 \def\acronym#1{\doacronym #1,,\finish}
3222 \def\doacronym#1,#2,#3\finish{%
3223 {\switchtolsize #1}%
3224 \def\temp{#2}%
3225 \ifx\temp\empty \else
3226 \space ({\unsepspaces \ignorespaces \temp \unskip})%
3227 \fi
3228 \null % reset \spacefactor=1000
3229 }
3230
3231 % @abbr for "Comput. J." and the like.
3232 % No font change, but don't do end-of-sentence spacing.
3233 %
3234 \def\abbr#1{\doabbr #1,,\finish}
3235 \def\doabbr#1,#2,#3\finish{%
3236 {\plainfrenchspacing #1}%
3237 \def\temp{#2}%
3238 \ifx\temp\empty \else
3239 \space ({\unsepspaces \ignorespaces \temp \unskip})%
3240 \fi
3241 \null % reset \spacefactor=1000
3242 }
3243
3244 % @asis just yields its argument. Used with @table, for example.
3245 %
3246 \def\asis#1{#1}
3247
3248 % @math outputs its argument in math mode.
3249 %
3250 % One complication: _ usually means subscripts, but it could also mean
3251 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
3252 % _ active, and distinguish by seeing if the current family is \slfam,
3253 % which is what @var uses.
3254 {
3255 \catcode`\_ = \active
3256 \gdef\mathunderscore{%
3257 \catcode`\_=\active
3258 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
3259 }
3260 }
3261 % Another complication: we want \\ (and @\) to output a math (or tt) \.
3262 % FYI, plain.tex uses \\ as a temporary control sequence (for no
3263 % particular reason), but this is not advertised and we don't care.
3264 %
3265 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
3266 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
3267 %
3268 \def\math{%
3269 \ifmmode\else % only go into math if not in math mode already
3270 \tex
3271 \mathunderscore
3272 \let\\ = \mathbackslash
3273 \mathactive
3274 % make the texinfo accent commands work in math mode
3275 \let\"=\ddot
3276 \let\'=\acute
3277 \let\==\bar
3278 \let\^=\hat
3279 \let\`=\grave
3280 \let\u=\breve
3281 \let\v=\check
3282 \let\~=\tilde
3283 \let\dotaccent=\dot
3284 % have to provide another name for sup operator
3285 \let\mathopsup=\sup
3286 $\expandafter\finishmath\fi
3287 }
3288 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
3289
3290 % Some active characters (such as <) are spaced differently in math.
3291 % We have to reset their definitions in case the @math was an argument
3292 % to a command which sets the catcodes (such as @item or @section).
3293 %
3294 {
3295 \catcode`^ = \active
3296 \catcode`< = \active
3297 \catcode`> = \active
3298 \catcode`+ = \active
3299 \catcode`' = \active
3300 \gdef\mathactive{%
3301 \let^ = \ptexhat
3302 \let< = \ptexless
3303 \let> = \ptexgtr
3304 \let+ = \ptexplus
3305 \let' = \ptexquoteright
3306 }
3307 }
3308
3309 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
3310 % If in text, use math to place as sub/superscript, but switch
3311 % into text mode, with smaller fonts. This is a different font than the
3312 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
3313 % fix it (significant additions to font machinery) until someone notices.
3314 %
3315 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
3316 \def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
3317 %
3318 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
3319 \def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
3320
3321 % provide this command from LaTeX as it is very common
3322 \def\frac#1#2{{{#1}\over{#2}}}
3323
3324 % @displaymath.
3325 % \globaldefs is needed to recognize the end lines in \tex and
3326 % \end tex. Set \thisenv as @end displaymath is seen before @end tex.
3327 {\obeylines
3328 \globaldefs=1
3329 \envdef\displaymath{%
3330 \tex%
3331 \def\thisenv{\displaymath}%
3332 \begingroup\let\end\displaymathend%
3333 $$%
3334 }
3335
3336 \def\displaymathend{$$\endgroup\end}%
3337
3338 \def\Edisplaymath{%
3339 \def\thisenv{\tex}%
3340 \end tex
3341 }}
3342
3343
3344 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3345 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3346 % except specified as a normal braced arg, so no newlines to worry about.
3347 %
3348 \def\outfmtnametex{tex}
3349 %
3350 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
3351 \long\def\doinlinefmt#1,#2,\finish{%
3352 \def\inlinefmtname{#1}%
3353 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
3354 }
3355 %
3356 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3357 % FMTNAME is tex, else ELSE-TEXT.
3358 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
3359 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
3360 \def\inlinefmtname{#1}%
3361 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
3362 }
3363 %
3364 % For raw, must switch into @tex before parsing the argument, to avoid
3365 % setting catcodes prematurely. Doing it this way means that, for
3366 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3367 % ignored. But this isn't important because if people want a literal
3368 % *right* brace they would have to use a command anyway, so they may as
3369 % well use a command to get a left brace too. We could re-use the
3370 % delimiter character idea from \verb, but it seems like overkill.
3371 %
3372 \long\def\inlineraw{\tex \doinlineraw}
3373 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
3374 \def\doinlinerawtwo#1,#2,\finish{%
3375 \def\inlinerawname{#1}%
3376 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
3377 \endgroup % close group opened by \tex.
3378 }
3379
3380 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3381 %
3382 \long\def\inlineifset#1{\doinlineifset #1,\finish}
3383 \long\def\doinlineifset#1,#2,\finish{%
3384 \def\inlinevarname{#1}%
3385 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
3386 \else\ignorespaces#2\fi
3387 }
3388
3389 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3390 %
3391 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
3392 \long\def\doinlineifclear#1,#2,\finish{%
3393 \def\inlinevarname{#1}%
3394 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
3395 }
3396
3397
3398 \message{glyphs,}
3399 % and logos.
3400
3401 % @@ prints an @, as does @atchar{}.
3402 \def\@{\char64 }
3403 \let\atchar=\@
3404
3405 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3406 \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
3407 \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
3408 \let\{=\lbracechar
3409 \let\}=\rbracechar
3410
3411 % @comma{} to avoid , parsing problems.
3412 \let\comma = ,
3413
3414 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3415 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3416 \let\, = \ptexc
3417 \let\dotaccent = \ptexdot
3418 \def\ringaccent#1{{\accent23 #1}}
3419 \let\tieaccent = \ptext
3420 \let\ubaraccent = \ptexb
3421 \let\udotaccent = \d
3422
3423 % Other special characters: @questiondown @exclamdown @ordf @ordm
3424 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3425 \def\questiondown{?`}
3426 \def\exclamdown{!`}
3427 \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
3428 \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
3429
3430 % Dotless i and dotless j, used for accents.
3431 \def\imacro{i}
3432 \def\jmacro{j}
3433 \def\dotless#1{%
3434 \def\temp{#1}%
3435 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3436 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3437 \else \errmessage{@dotless can be used only with i or j}%
3438 \fi\fi
3439 }
3440
3441 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3442 % period following counts as ending a sentence. (Idea found in latex.)
3443 %
3444 \edef\TeX{\TeX \spacefactor=1000 }
3445
3446 % @LaTeX{} logo. Not quite the same results as the definition in
3447 % latex.ltx, since we use a different font for the raised A; it's most
3448 % convenient for us to use an explicitly smaller font, rather than using
3449 % the \scriptstyle font (since we don't reset \scriptstyle and
3450 % \scriptscriptstyle).
3451 %
3452 \def\LaTeX{%
3453 L\kern-.36em
3454 {\setbox0=\hbox{T}%
3455 \vbox to \ht0{\hbox{%
3456 \ifx\textnominalsize\xwordpt
3457 % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
3458 % Revert to plain's \scriptsize, which is 7pt.
3459 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3460 \else
3461 % For 11pt, we can use our lllsize.
3462 \switchtolllsize A%
3463 \fi
3464 }%
3465 \vss
3466 }}%
3467 \kern-.15em
3468 \TeX
3469 }
3470
3471 % Some math mode symbols. Define \ensuremath to switch into math mode
3472 % unless we are already there. Expansion tricks may not be needed here,
3473 % but safer, and can't hurt.
3474 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3475 \def\ensuredmath#1{$\relax#1$}
3476 %
3477 \def\bullet{\ensuremath\ptexbullet}
3478 \def\geq{\ensuremath\ge}
3479 \def\leq{\ensuremath\le}
3480 \def\minus{\ensuremath-}
3481
3482 % @dots{} outputs an ellipsis using the current font.
3483 % We do .5em per period so that it has the same spacing in the cm
3484 % typewriter fonts as three actual period characters; on the other hand,
3485 % in other typewriter fonts three periods are wider than 1.5em. So do
3486 % whichever is larger.
3487 %
3488 \def\dots{%
3489 \leavevmode
3490 \setbox0=\hbox{...}% get width of three periods
3491 \ifdim\wd0 > 1.5em
3492 \dimen0 = \wd0
3493 \else
3494 \dimen0 = 1.5em
3495 \fi
3496 \hbox to \dimen0{%
3497 \hskip 0pt plus.25fil
3498 .\hskip 0pt plus1fil
3499 .\hskip 0pt plus1fil
3500 .\hskip 0pt plus.5fil
3501 }%
3502 }
3503
3504 % @enddots{} is an end-of-sentence ellipsis.
3505 %
3506 \def\enddots{%
3507 \dots
3508 \spacefactor=\endofsentencespacefactor
3509 }
3510
3511 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3512 %
3513 % Since these characters are used in examples, they should be an even number of
3514 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3515 %
3516 \def\point{$\star$}
3517 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3518 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3519 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3520 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3521 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3522
3523 % The @error{} command.
3524 % Adapted from the TeXbook's \boxit.
3525 %
3526 \newbox\errorbox
3527 %
3528 {\ttfont \global\dimen0 = 3em}% Width of the box.
3529 \dimen2 = .55pt % Thickness of rules
3530 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3531 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3532 %
3533 \setbox\errorbox=\hbox to \dimen0{\hfil
3534 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3535 \advance\hsize by -2\dimen2 % Rules.
3536 \vbox{%
3537 \hrule height\dimen2
3538 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3539 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3540 \kern3pt\vrule width\dimen2}% Space to right.
3541 \hrule height\dimen2}
3542 \hfil}
3543 %
3544 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3545
3546 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3547 %
3548 \def\pounds{\ifmonospace{\ecfont\char"BF}\else{\it\$}\fi}
3549
3550 % @euro{} comes from a separate font, depending on the current style.
3551 % We use the free feym* fonts from the eurosym package by Henrik
3552 % Theiling, which support regular, slanted, bold and bold slanted (and
3553 % "outlined" (blackboard board, sort of) versions, which we don't need).
3554 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3555 %
3556 % Although only regular is the truly official Euro symbol, we ignore
3557 % that. The Euro is designed to be slightly taller than the regular
3558 % font height.
3559 %
3560 % feymr - regular
3561 % feymo - slanted
3562 % feybr - bold
3563 % feybo - bold slanted
3564 %
3565 % There is no good (free) typewriter version, to my knowledge.
3566 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3567 % Hmm.
3568 %
3569 % Also doesn't work in math. Do we need to do math with euro symbols?
3570 % Hope not.
3571 %
3572 %
3573 \def\euro{{\eurofont e}}
3574 \def\eurofont{%
3575 % We set the font at each command, rather than predefining it in
3576 % \textfonts and the other font-switching commands, so that
3577 % installations which never need the symbol don't have to have the
3578 % font installed.
3579 %
3580 % There is only one designed size (nominal 10pt), so we always scale
3581 % that to the current nominal size.
3582 %
3583 % By the way, simply using "at 1em" works for cmr10 and the like, but
3584 % does not work for cmbx10 and other extended/shrunken fonts.
3585 %
3586 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3587 %
3588 \ifx\curfontstyle\bfstylename
3589 % bold:
3590 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3591 \else
3592 % regular:
3593 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3594 \fi
3595 \thiseurofont
3596 }
3597
3598 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3599 % sometimes we redefine the original macro, and the alias should reflect
3600 % the redefinition.
3601 %
3602 % Use LaTeX names for the Icelandic letters.
3603 \def\DH{{\ecfont \char"D0}} % Eth
3604 \def\dh{{\ecfont \char"F0}} % eth
3605 \def\TH{{\ecfont \char"DE}} % Thorn
3606 \def\th{{\ecfont \char"FE}} % thorn
3607 %
3608 \def\guillemetleft{{\ecfont \char"13}}
3609 \def\guillemotleft{\guillemetleft}
3610 \def\guillemetright{{\ecfont \char"14}}
3611 \def\guillemotright{\guillemetright}
3612 \def\guilsinglleft{{\ecfont \char"0E}}
3613 \def\guilsinglright{{\ecfont \char"0F}}
3614 \def\quotedblbase{{\ecfont \char"12}}
3615 \def\quotesinglbase{{\ecfont \char"0D}}
3616 %
3617 \def\L{{\ecfont \char"8A}} % L with stroke
3618 \def\l{{\ecfont \char"AA}} % l with stroke
3619 %
3620 % This positioning is not perfect (see the ogonek LaTeX package), but
3621 % we have the precomposed glyphs for the most common cases. We put the
3622 % tests to use those glyphs in the single \ogonek macro so we have fewer
3623 % dummy definitions to worry about for index entries, etc.
3624 %
3625 % ogonek is also used with other letters in Lithuanian (IOU), but using
3626 % the precomposed glyphs for those is not so easy since they aren't in
3627 % the same EC font.
3628 \def\ogonek#1{{%
3629 \def\temp{#1}%
3630 \ifx\temp\macrocharA\Aogonek
3631 \else\ifx\temp\macrochara\aogonek
3632 \else\ifx\temp\macrocharE\Eogonek
3633 \else\ifx\temp\macrochare\eogonek
3634 \else
3635 \ecfont \setbox0=\hbox{#1}%
3636 \ifdim\ht0=1ex\accent"0C #1%
3637 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3638 \fi
3639 \fi\fi\fi\fi
3640 }%
3641 }
3642 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3643 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3644 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3645 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3646 %
3647 % Use the European Computer Modern fonts (cm-super in outline format)
3648 % for non-CM glyphs. That is ec* for regular text and tc* for the text
3649 % companion symbols (LaTeX TS1 encoding). Both are part of the ec
3650 % package and follow the same conventions.
3651 %
3652 \def\ecfont{\etcfont{e}}
3653 \def\tcfont{\etcfont{t}}
3654 %
3655 \def\etcfont#1{%
3656 % We can't distinguish serif/sans and italic/slanted, but this
3657 % is used for crude hacks anyway (like adding French and German
3658 % quotes to documents typeset with CM, where we lose kerning), so
3659 % hopefully nobody will notice/care.
3660 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3661 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3662 \ifmonospace
3663 % typewriter:
3664 \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3665 \else
3666 \ifx\curfontstyle\bfstylename
3667 % bold:
3668 \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3669 \else
3670 % regular:
3671 \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3672 \fi
3673 \fi
3674 \thisecfont
3675 }
3676
3677 % @registeredsymbol - R in a circle. The font for the R should really
3678 % be smaller yet, but lllsize is the best we can do for now.
3679 % Adapted from the plain.tex definition of \copyright.
3680 %
3681 \def\registeredsymbol{%
3682 $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
3683 \hfil\crcr\Orb}}%
3684 }$%
3685 }
3686
3687 % @textdegree - the normal degrees sign.
3688 %
3689 \def\textdegree{$^\circ$}
3690
3691 % Laurent Siebenmann reports \Orb undefined with:
3692 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3693 % so we'll define it if necessary.
3694 %
3695 \ifx\Orb\thisisundefined
3696 \def\Orb{\mathhexbox20D}
3697 \fi
3698
3699 % Quotes.
3700 \chardef\quoteleft=`\`
3701 \chardef\quoteright=`\'
3702
3703 % only change font for tt for correct kerning and to avoid using
3704 % \ecfont unless necessary.
3705 \def\quotedblleft{%
3706 \ifmonospace{\ecfont\char"10}\else{\char"5C}\fi
3707 }
3708
3709 \def\quotedblright{%
3710 \ifmonospace{\ecfont\char"11}\else{\char`\"}\fi
3711 }
3712
3713
3714 \message{page headings,}
3715
3716 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3717 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3718
3719 % First the title page. Must do @settitle before @titlepage.
3720 \newif\ifseenauthor
3721 \newif\iffinishedtitlepage
3722
3723 % @setcontentsaftertitlepage used to do an implicit @contents or
3724 % @shortcontents after @end titlepage, but it is now obsolete.
3725 \def\setcontentsaftertitlepage{%
3726 \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
3727 command; move your @contents command if you want the contents
3728 after the title page.}}%
3729 \def\setshortcontentsaftertitlepage{%
3730 \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
3731 command; move your @shortcontents and @contents commands if you
3732 want the contents after the title page.}}%
3733
3734 \parseargdef\shorttitlepage{%
3735 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3736 \endgroup\page\hbox{}\page}
3737
3738 \envdef\titlepage{%
3739 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3740 \begingroup
3741 \parindent=0pt \textfonts
3742 % Leave some space at the very top of the page.
3743 \vglue\titlepagetopglue
3744 % No rule at page bottom unless we print one at the top with @title.
3745 \finishedtitlepagetrue
3746 %
3747 % Most title ``pages'' are actually two pages long, with space
3748 % at the top of the second. We don't want the ragged left on the second.
3749 \let\oldpage = \page
3750 \def\page{%
3751 \iffinishedtitlepage\else
3752 \finishtitlepage
3753 \fi
3754 \let\page = \oldpage
3755 \page
3756 \null
3757 }%
3758 }
3759
3760 \def\Etitlepage{%
3761 \iffinishedtitlepage\else
3762 \finishtitlepage
3763 \fi
3764 % It is important to do the page break before ending the group,
3765 % because the headline and footline are only empty inside the group.
3766 % If we use the new definition of \page, we always get a blank page
3767 % after the title page, which we certainly don't want.
3768 \oldpage
3769 \endgroup
3770 %
3771 % Need this before the \...aftertitlepage checks so that if they are
3772 % in effect the toc pages will come out with page numbers.
3773 \HEADINGSon
3774 }
3775
3776 \def\finishtitlepage{%
3777 \vskip4pt \hrule height 2pt width \hsize
3778 \vskip\titlepagebottomglue
3779 \finishedtitlepagetrue
3780 }
3781
3782 % Settings used for typesetting titles: no hyphenation, no indentation,
3783 % don't worry much about spacing, ragged right. This should be used
3784 % inside a \vbox, and fonts need to be set appropriately first. \par should
3785 % be specified before the end of the \vbox, since a vbox is a group.
3786 %
3787 \def\raggedtitlesettings{%
3788 \rm
3789 \hyphenpenalty=10000
3790 \parindent=0pt
3791 \tolerance=5000
3792 \ptexraggedright
3793 }
3794
3795 % Macros to be used within @titlepage:
3796
3797 \let\subtitlerm=\rmfont
3798 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3799
3800 \parseargdef\title{%
3801 \checkenv\titlepage
3802 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3803 % print a rule at the page bottom also.
3804 \finishedtitlepagefalse
3805 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3806 }
3807
3808 \parseargdef\subtitle{%
3809 \checkenv\titlepage
3810 {\subtitlefont \rightline{#1}}%
3811 }
3812
3813 % @author should come last, but may come many times.
3814 % It can also be used inside @quotation.
3815 %
3816 \parseargdef\author{%
3817 \def\temp{\quotation}%
3818 \ifx\thisenv\temp
3819 \def\quotationauthor{#1}% printed in \Equotation.
3820 \else
3821 \checkenv\titlepage
3822 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3823 {\secfonts\rm \leftline{#1}}%
3824 \fi
3825 }
3826
3827
3828 % Set up page headings and footings.
3829
3830 \let\thispage=\folio
3831
3832 \newtoks\evenheadline % headline on even pages
3833 \newtoks\oddheadline % headline on odd pages
3834 \newtoks\evenchapheadline% headline on even pages with a new chapter
3835 \newtoks\oddchapheadline % headline on odd pages with a new chapter
3836 \newtoks\evenfootline % footline on even pages
3837 \newtoks\oddfootline % footline on odd pages
3838
3839 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3840 \headline={{\textfonts\rm
3841 \ifchapterpage
3842 \ifodd\pageno\the\oddchapheadline\else\the\evenchapheadline\fi
3843 \else
3844 \ifodd\pageno\the\oddheadline\else\the\evenheadline\fi
3845 \fi}}
3846
3847 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3848 \else \the\evenfootline \fi}\HEADINGShook}
3849 \let\HEADINGShook=\relax
3850
3851 % Commands to set those variables.
3852 % For example, this is what @headings on does
3853 % @evenheading @thistitle|@thispage|@thischapter
3854 % @oddheading @thischapter|@thispage|@thistitle
3855 % @evenfooting @thisfile||
3856 % @oddfooting ||@thisfile
3857
3858
3859 \def\evenheading{\parsearg\evenheadingxxx}
3860 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3861 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3862 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
3863 \global\evenchapheadline=\evenheadline}
3864
3865 \def\oddheading{\parsearg\oddheadingxxx}
3866 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3867 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3868 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3869 \global\oddchapheadline=\oddheadline}
3870
3871 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3872
3873 \def\evenfooting{\parsearg\evenfootingxxx}
3874 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3875 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3876 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3877
3878 \def\oddfooting{\parsearg\oddfootingxxx}
3879 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3880 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3881 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3882 %
3883 % Leave some space for the footline. Hopefully ok to assume
3884 % @evenfooting will not be used by itself.
3885 \global\advance\txipageheight by -12pt
3886 \global\advance\vsize by -12pt
3887 }
3888
3889 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3890
3891 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3892 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3893 %
3894 % The same set of arguments for:
3895 %
3896 % @oddheadingmarks
3897 % @evenfootingmarks
3898 % @oddfootingmarks
3899 % @everyheadingmarks
3900 % @everyfootingmarks
3901
3902 % These define \getoddheadingmarks, \getevenheadingmarks,
3903 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3904 % \gettopheadingmarks, \getbottomheadingmarks.
3905 %
3906 \def\evenheadingmarks{\headingmarks{even}{heading}}
3907 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3908 \def\evenfootingmarks{\headingmarks{even}{footing}}
3909 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3910 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
3911 \headingmarks{odd}{heading}{#1} }
3912 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
3913 \headingmarks{odd}{footing}{#1} }
3914 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3915 \def\headingmarks#1#2#3 {%
3916 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3917 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3918 }
3919
3920 \everyheadingmarks bottom
3921 \everyfootingmarks bottom
3922
3923 % @headings double turns headings on for double-sided printing.
3924 % @headings single turns headings on for single-sided printing.
3925 % @headings off turns them off.
3926 % @headings on same as @headings double, retained for compatibility.
3927 % @headings after turns on double-sided headings after this page.
3928 % @headings doubleafter turns on double-sided headings after this page.
3929 % @headings singleafter turns on single-sided headings after this page.
3930 % By default, they are off at the start of a document,
3931 % and turned `on' after @end titlepage.
3932
3933 \parseargdef\headings{\csname HEADINGS#1\endcsname}
3934
3935 \def\headingsoff{% non-global headings elimination
3936 \evenheadline={\hfil}\evenfootline={\hfil}\evenchapheadline={\hfil}%
3937 \oddheadline={\hfil}\oddfootline={\hfil}\oddchapheadline={\hfil}%
3938 }
3939
3940 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3941 \HEADINGSoff % it's the default
3942
3943 % When we turn headings on, set the page number to 1.
3944 \def\pageone{
3945 \global\pageno=1
3946 \global\arabiccount = \pagecount
3947 }
3948
3949 % For double-sided printing, put current file name in lower left corner,
3950 % chapter name on inside top of right hand pages, document
3951 % title on inside top of left hand pages, and page numbers on outside top
3952 % edge of all pages.
3953 \def\HEADINGSdouble{%
3954 \pageone
3955 \HEADINGSdoublex
3956 }
3957 \let\contentsalignmacro = \chappager
3958
3959 % For single-sided printing, chapter title goes across top left of page,
3960 % page number on top right.
3961 \def\HEADINGSsingle{%
3962 \pageone
3963 \HEADINGSsinglex
3964 }
3965 \def\HEADINGSon{\HEADINGSdouble}
3966
3967 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3968 \let\HEADINGSdoubleafter=\HEADINGSafter
3969 \def\HEADINGSdoublex{%
3970 \global\evenfootline={\hfil}
3971 \global\oddfootline={\hfil}
3972 \global\evenheadline={\line{\folio\hfil\thistitle}}
3973 \global\oddheadline={\line{\thischapter\hfil\folio}}
3974 \global\evenchapheadline={\line{\folio\hfil}}
3975 \global\oddchapheadline={\line{\hfil\folio}}
3976 \global\let\contentsalignmacro = \chapoddpage
3977 }
3978
3979 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3980 \def\HEADINGSsinglex{%
3981 \global\evenfootline={\hfil}
3982 \global\oddfootline={\hfil}
3983 \global\evenheadline={\line{\thischapter\hfil\folio}}
3984 \global\oddheadline={\line{\thischapter\hfil\folio}}
3985 \global\evenchapheadline={\line{\hfil\folio}}
3986 \global\oddchapheadline={\line{\hfil\folio}}
3987 \global\let\contentsalignmacro = \chappager
3988 }
3989
3990 % for @setchapternewpage off
3991 \def\HEADINGSsinglechapoff{%
3992 \pageone
3993 \global\evenfootline={\hfil}
3994 \global\oddfootline={\hfil}
3995 \global\evenheadline={\line{\thischapter\hfil\folio}}
3996 \global\oddheadline={\line{\thischapter\hfil\folio}}
3997 \global\evenchapheadline=\evenheadline
3998 \global\oddchapheadline=\oddheadline
3999 \global\let\contentsalignmacro = \chappager
4000 }
4001
4002 % Subroutines used in generating headings
4003 % This produces Day Month Year style of output.
4004 % Only define if not already defined, in case a txi-??.tex file has set
4005 % up a different format (e.g., txi-cs.tex does this).
4006 \ifx\today\thisisundefined
4007 \def\today{%
4008 \number\day\space
4009 \ifcase\month
4010 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
4011 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
4012 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
4013 \fi
4014 \space\number\year}
4015 \fi
4016
4017 % @settitle line... specifies the title of the document, for headings.
4018 % It generates no output of its own.
4019 \def\thistitle{\putwordNoTitle}
4020 \def\settitle{\parsearg{\gdef\thistitle}}
4021
4022
4023 \message{tables,}
4024 % Tables -- @table, @ftable, @vtable, @item(x).
4025
4026 % default indentation of table text
4027 \newdimen\tableindent \tableindent=.8in
4028 % default indentation of @itemize and @enumerate text
4029 \newdimen\itemindent \itemindent=.3in
4030 % margin between end of table item and start of table text.
4031 \newdimen\itemmargin \itemmargin=.1in
4032
4033 % used internally for \itemindent minus \itemmargin
4034 \newdimen\itemmax
4035
4036 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
4037 % these defs.
4038 % They also define \itemindex
4039 % to index the item name in whatever manner is desired (perhaps none).
4040
4041 \newif\ifitemxneedsnegativevskip
4042
4043 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
4044
4045 \def\internalBitem{\smallbreak \parsearg\itemzzz}
4046 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
4047
4048 \def\itemzzz #1{\begingroup %
4049 \advance\hsize by -\rightskip
4050 \advance\hsize by -\tableindent
4051 \setbox0=\hbox{\itemindicate{#1}}%
4052 \itemindex{#1}%
4053 \nobreak % This prevents a break before @itemx.
4054 %
4055 % If the item text does not fit in the space we have, put it on a line
4056 % by itself, and do not allow a page break either before or after that
4057 % line. We do not start a paragraph here because then if the next
4058 % command is, e.g., @kindex, the whatsit would get put into the
4059 % horizontal list on a line by itself, resulting in extra blank space.
4060 \ifdim \wd0>\itemmax
4061 %
4062 % Make this a paragraph so we get the \parskip glue and wrapping,
4063 % but leave it ragged-right.
4064 \begingroup
4065 \advance\leftskip by-\tableindent
4066 \advance\hsize by\tableindent
4067 \advance\rightskip by0pt plus1fil\relax
4068 \leavevmode\unhbox0\par
4069 \endgroup
4070 %
4071 % We're going to be starting a paragraph, but we don't want the
4072 % \parskip glue -- logically it's part of the @item we just started.
4073 \nobreak \vskip-\parskip
4074 %
4075 % Stop a page break at the \parskip glue coming up. However, if
4076 % what follows is an environment such as @example, there will be no
4077 % \parskip glue; then the negative vskip we just inserted would
4078 % cause the example and the item to crash together. So we use this
4079 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
4080 % \parskip glue after all. Section titles are handled this way also.
4081 %
4082 \penalty 10001
4083 \endgroup
4084 \itemxneedsnegativevskipfalse
4085 \else
4086 % The item text fits into the space. Start a paragraph, so that the
4087 % following text (if any) will end up on the same line.
4088 \noindent
4089 % Do this with kerns and \unhbox so that if there is a footnote in
4090 % the item text, it can migrate to the main vertical list and
4091 % eventually be printed.
4092 \nobreak\kern-\tableindent
4093 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
4094 \unhbox0
4095 \nobreak\kern\dimen0
4096 \endgroup
4097 \itemxneedsnegativevskiptrue
4098 \fi
4099 }
4100
4101 \def\item{\errmessage{@item while not in a list environment}}
4102 \def\itemx{\errmessage{@itemx while not in a list environment}}
4103
4104 % @table, @ftable, @vtable.
4105 \envdef\table{%
4106 \let\itemindex\gobble
4107 \tablecheck{table}%
4108 }
4109 \envdef\ftable{%
4110 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
4111 \tablecheck{ftable}%
4112 }
4113 \envdef\vtable{%
4114 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
4115 \tablecheck{vtable}%
4116 }
4117 \def\tablecheck#1{%
4118 \ifnum \the\catcode`\^^M=\active
4119 \endgroup
4120 \errmessage{This command won't work in this context; perhaps the problem is
4121 that we are \inenvironment\thisenv}%
4122 \def\next{\doignore{#1}}%
4123 \else
4124 \let\next\tablex
4125 \fi
4126 \next
4127 }
4128 \def\tablex#1{%
4129 \def\itemindicate{#1}%
4130 \parsearg\tabley
4131 }
4132 \def\tabley#1{%
4133 {%
4134 \makevalueexpandable
4135 \edef\temp{\noexpand\tablez #1\space\space\space}%
4136 \expandafter
4137 }\temp \endtablez
4138 }
4139 \def\tablez #1 #2 #3 #4\endtablez{%
4140 \aboveenvbreak
4141 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
4142 \ifnum 0#2>0 \tableindent=#2\mil \fi
4143 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
4144 \itemmax=\tableindent
4145 \advance \itemmax by -\itemmargin
4146 \advance \leftskip by \tableindent
4147 \exdentamount=\tableindent
4148 \parindent = 0pt
4149 \parskip = \smallskipamount
4150 \ifdim \parskip=0pt \parskip=2pt \fi
4151 \let\item = \internalBitem
4152 \let\itemx = \internalBitemx
4153 }
4154 \def\Etable{\endgraf\afterenvbreak}
4155 \let\Eftable\Etable
4156 \let\Evtable\Etable
4157 \let\Eitemize\Etable
4158 \let\Eenumerate\Etable
4159
4160 % This is the counter used by @enumerate, which is really @itemize
4161
4162 \newcount \itemno
4163
4164 \envdef\itemize{\parsearg\doitemize}
4165
4166 \def\doitemize#1{%
4167 \aboveenvbreak
4168 \itemmax=\itemindent
4169 \advance\itemmax by -\itemmargin
4170 \advance\leftskip by \itemindent
4171 \exdentamount=\itemindent
4172 \parindent=0pt
4173 \parskip=\smallskipamount
4174 \ifdim\parskip=0pt \parskip=2pt \fi
4175 %
4176 % Try typesetting the item mark so that if the document erroneously says
4177 % something like @itemize @samp (intending @table), there's an error
4178 % right away at the @itemize. It's not the best error message in the
4179 % world, but it's better than leaving it to the @item. This means if
4180 % the user wants an empty mark, they have to say @w{} not just @w.
4181 \def\itemcontents{#1}%
4182 \setbox0 = \hbox{\itemcontents}%
4183 %
4184 % @itemize with no arg is equivalent to @itemize @bullet.
4185 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
4186 %
4187 \let\item=\itemizeitem
4188 }
4189
4190 % Definition of @item while inside @itemize and @enumerate.
4191 %
4192 \def\itemizeitem{%
4193 \advance\itemno by 1 % for enumerations
4194 {\let\par=\endgraf \smallbreak}% reasonable place to break
4195 {%
4196 % If the document has an @itemize directly after a section title, a
4197 % \nobreak will be last on the list, and \sectionheading will have
4198 % done a \vskip-\parskip. In that case, we don't want to zero
4199 % parskip, or the item text will crash with the heading. On the
4200 % other hand, when there is normal text preceding the item (as there
4201 % usually is), we do want to zero parskip, or there would be too much
4202 % space. In that case, we won't have a \nobreak before. At least
4203 % that's the theory.
4204 \ifnum\lastpenalty<10000 \parskip=0in \fi
4205 \noindent
4206 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
4207 %
4208 \ifinner\else
4209 \vadjust{\penalty 1200}% not good to break after first line of item.
4210 \fi
4211 % We can be in inner vertical mode in a footnote, although an
4212 % @itemize looks awful there.
4213 }%
4214 \flushcr
4215 }
4216
4217 % \splitoff TOKENS\endmark defines \first to be the first token in
4218 % TOKENS, and \rest to be the remainder.
4219 %
4220 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
4221
4222 % Allow an optional argument of an uppercase letter, lowercase letter,
4223 % or number, to specify the first label in the enumerated list. No
4224 % argument is the same as `1'.
4225 %
4226 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
4227 \def\enumeratey #1 #2\endenumeratey{%
4228 % If we were given no argument, pretend we were given `1'.
4229 \def\thearg{#1}%
4230 \ifx\thearg\empty \def\thearg{1}\fi
4231 %
4232 % Detect if the argument is a single token. If so, it might be a
4233 % letter. Otherwise, the only valid thing it can be is a number.
4234 % (We will always have one token, because of the test we just made.
4235 % This is a good thing, since \splitoff doesn't work given nothing at
4236 % all -- the first parameter is undelimited.)
4237 \expandafter\splitoff\thearg\endmark
4238 \ifx\rest\empty
4239 % Only one token in the argument. It could still be anything.
4240 % A ``lowercase letter'' is one whose \lccode is nonzero.
4241 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4242 % not equal to itself.
4243 % Otherwise, we assume it's a number.
4244 %
4245 % We need the \relax at the end of the \ifnum lines to stop TeX from
4246 % continuing to look for a <number>.
4247 %
4248 \ifnum\lccode\expandafter`\thearg=0\relax
4249 \numericenumerate % a number (we hope)
4250 \else
4251 % It's a letter.
4252 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
4253 \lowercaseenumerate % lowercase letter
4254 \else
4255 \uppercaseenumerate % uppercase letter
4256 \fi
4257 \fi
4258 \else
4259 % Multiple tokens in the argument. We hope it's a number.
4260 \numericenumerate
4261 \fi
4262 }
4263
4264 % An @enumerate whose labels are integers. The starting integer is
4265 % given in \thearg.
4266 %
4267 \def\numericenumerate{%
4268 \itemno = \thearg
4269 \startenumeration{\the\itemno}%
4270 }
4271
4272 % The starting (lowercase) letter is in \thearg.
4273 \def\lowercaseenumerate{%
4274 \itemno = \expandafter`\thearg
4275 \startenumeration{%
4276 % Be sure we're not beyond the end of the alphabet.
4277 \ifnum\itemno=0
4278 \errmessage{No more lowercase letters in @enumerate; get a bigger
4279 alphabet}%
4280 \fi
4281 \char\lccode\itemno
4282 }%
4283 }
4284
4285 % The starting (uppercase) letter is in \thearg.
4286 \def\uppercaseenumerate{%
4287 \itemno = \expandafter`\thearg
4288 \startenumeration{%
4289 % Be sure we're not beyond the end of the alphabet.
4290 \ifnum\itemno=0
4291 \errmessage{No more uppercase letters in @enumerate; get a bigger
4292 alphabet}
4293 \fi
4294 \char\uccode\itemno
4295 }%
4296 }
4297
4298 % Call \doitemize, adding a period to the first argument and supplying the
4299 % common last two arguments. Also subtract one from the initial value in
4300 % \itemno, since @item increments \itemno.
4301 %
4302 \def\startenumeration#1{%
4303 \advance\itemno by -1
4304 \doitemize{#1.}\flushcr
4305 }
4306
4307
4308 % @multitable macros
4309
4310 % Macros used to set up halign preamble:
4311 %
4312 \let\endsetuptable\relax
4313 \def\xendsetuptable{\endsetuptable}
4314 \let\columnfractions\relax
4315 \def\xcolumnfractions{\columnfractions}
4316 \newif\ifsetpercent
4317
4318 % #1 is the @columnfraction, usually a decimal number like .5, but might
4319 % be just 1. We just use it, whatever it is.
4320 %
4321 \def\pickupwholefraction#1 {%
4322 \global\advance\colcount by 1
4323 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
4324 \setuptable
4325 }
4326
4327 \newcount\colcount
4328 \def\setuptable#1{%
4329 \def\firstarg{#1}%
4330 \ifx\firstarg\xendsetuptable
4331 \let\go = \relax
4332 \else
4333 \ifx\firstarg\xcolumnfractions
4334 \global\setpercenttrue
4335 \else
4336 \ifsetpercent
4337 \let\go\pickupwholefraction
4338 \else
4339 \global\advance\colcount by 1
4340 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
4341 % separator; typically that is always in the input, anyway.
4342 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
4343 \fi
4344 \fi
4345 \ifx\go\pickupwholefraction
4346 % Put the argument back for the \pickupwholefraction call, so
4347 % we'll always have a period there to be parsed.
4348 \def\go{\pickupwholefraction#1}%
4349 \else
4350 \let\go = \setuptable
4351 \fi%
4352 \fi
4353 \go
4354 }
4355
4356 % @headitem starts a heading row, which we typeset in bold. Assignments
4357 % have to be global since we are inside the implicit group of an
4358 % alignment entry. \everycr below resets \everytab so we don't have to
4359 % undo it ourselves.
4360 \def\headitemfont{\b}% for people to use in the template row; not changeable
4361 \def\headitem{%
4362 \checkenv\multitable
4363 \crcr
4364 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
4365 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
4366 \the\everytab % for the first item
4367 }%
4368 %
4369 % default for tables with no headings.
4370 \let\headitemcrhook=\relax
4371 %
4372 \def\tab{\checkenv\multitable &\the\everytab}%
4373
4374 \newtoks\everytab % insert after every tab.
4375 %
4376 \envdef\multitable{%
4377 \vskip\parskip
4378 \startsavinginserts
4379 %
4380 % @item within a multitable starts a normal row.
4381 % We use \def instead of \let so that if one of the multitable entries
4382 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4383 % \endtemplate) expanding \doitemize.
4384 \def\item{\crcr}%
4385 %
4386 \tolerance=9500
4387 \hbadness=9500
4388 \parskip=0pt
4389 \parindent=6pt
4390 \overfullrule=0pt
4391 \global\colcount=0
4392 %
4393 \everycr = {%
4394 \noalign{%
4395 \global\everytab={}% Reset from possible headitem.
4396 \global\colcount=0 % Reset the column counter.
4397 %
4398 % Check for saved footnotes, etc.:
4399 \checkinserts
4400 %
4401 % Perhaps a \nobreak, then reset:
4402 \headitemcrhook
4403 \global\let\headitemcrhook=\relax
4404 }%
4405 }%
4406 %
4407 \parsearg\domultitable
4408 }
4409 \def\domultitable#1{%
4410 % To parse everything between @multitable and @item:
4411 \setuptable#1 \endsetuptable
4412 %
4413 % This preamble sets up a generic column definition, which will
4414 % be used as many times as user calls for columns.
4415 % \vtop will set a single line and will also let text wrap and
4416 % continue for many paragraphs if desired.
4417 \halign\bgroup &%
4418 \global\advance\colcount by 1
4419 \strut
4420 \vtop{%
4421 \advance\hsize by -1\leftskip
4422 % Find the correct column width
4423 \hsize=\expandafter\csname col\the\colcount\endcsname
4424 %
4425 \rightskip=0pt
4426 \ifnum\colcount=1
4427 \advance\hsize by\leftskip % Add indent of surrounding text
4428 \else
4429 % In order to keep entries from bumping into each other.
4430 \leftskip=12pt
4431 \ifsetpercent \else
4432 % If a template has been used
4433 \advance\hsize by \leftskip
4434 \fi
4435 \fi
4436 \noindent\ignorespaces##\unskip\strut
4437 }\cr
4438 }
4439 \def\Emultitable{%
4440 \crcr
4441 \egroup % end the \halign
4442 \global\setpercentfalse
4443 }
4444
4445
4446 \message{conditionals,}
4447
4448 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4449 % @ifnotxml always succeed. They currently do nothing; we don't
4450 % attempt to check whether the conditionals are properly nested. But we
4451 % have to remember that they are conditionals, so that @end doesn't
4452 % attempt to close an environment group.
4453 %
4454 \def\makecond#1{%
4455 \expandafter\let\csname #1\endcsname = \relax
4456 \expandafter\let\csname iscond.#1\endcsname = 1
4457 }
4458 \makecond{iftex}
4459 \makecond{ifnotdocbook}
4460 \makecond{ifnothtml}
4461 \makecond{ifnotinfo}
4462 \makecond{ifnotplaintext}
4463 \makecond{ifnotxml}
4464
4465 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4466 %
4467 \def\direntry{\doignore{direntry}}
4468 \def\documentdescription{\doignore{documentdescription}}
4469 \def\docbook{\doignore{docbook}}
4470 \def\html{\doignore{html}}
4471 \def\ifdocbook{\doignore{ifdocbook}}
4472 \def\ifhtml{\doignore{ifhtml}}
4473 \def\ifinfo{\doignore{ifinfo}}
4474 \def\ifnottex{\doignore{ifnottex}}
4475 \def\ifplaintext{\doignore{ifplaintext}}
4476 \def\ifxml{\doignore{ifxml}}
4477 \def\ignore{\doignore{ignore}}
4478 \def\menu{\doignore{menu}}
4479 \def\xml{\doignore{xml}}
4480
4481 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4482 %
4483 % A count to remember the depth of nesting.
4484 \newcount\doignorecount
4485
4486 \def\doignore#1{\begingroup
4487 % Scan in ``verbatim'' mode:
4488 \obeylines
4489 \catcode`\@ = \other
4490 \catcode`\{ = \other
4491 \catcode`\} = \other
4492 %
4493 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4494 \spaceisspace
4495 %
4496 % Count number of #1's that we've seen.
4497 \doignorecount = 0
4498 %
4499 % Swallow text until we reach the matching `@end #1'.
4500 \dodoignore{#1}%
4501 }
4502
4503 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4504 \obeylines %
4505 %
4506 \gdef\dodoignore#1{%
4507 % #1 contains the command name as a string, e.g., `ifinfo'.
4508 %
4509 % Define a command to find the next `@end #1'.
4510 \long\def\doignoretext##1^^M@end #1{%
4511 \doignoretextyyy##1^^M@#1\_STOP_}%
4512 %
4513 % And this command to find another #1 command, at the beginning of a
4514 % line. (Otherwise, we would consider a line `@c @ifset', for
4515 % example, to count as an @ifset for nesting.)
4516 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4517 %
4518 % And now expand that command.
4519 \doignoretext ^^M%
4520 }%
4521 }
4522
4523 \def\doignoreyyy#1{%
4524 \def\temp{#1}%
4525 \ifx\temp\empty % Nothing found.
4526 \let\next\doignoretextzzz
4527 \else % Found a nested condition, ...
4528 \advance\doignorecount by 1
4529 \let\next\doignoretextyyy % ..., look for another.
4530 % If we're here, #1 ends with ^^M\ifinfo (for example).
4531 \fi
4532 \next #1% the token \_STOP_ is present just after this macro.
4533 }
4534
4535 % We have to swallow the remaining "\_STOP_".
4536 %
4537 \def\doignoretextzzz#1{%
4538 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4539 \let\next\enddoignore
4540 \else % Still inside a nested condition.
4541 \advance\doignorecount by -1
4542 \let\next\doignoretext % Look for the next @end.
4543 \fi
4544 \next
4545 }
4546
4547 % Finish off ignored text.
4548 { \obeylines%
4549 % Ignore anything after the last `@end #1'; this matters in verbatim
4550 % environments, where otherwise the newline after an ignored conditional
4551 % would result in a blank line in the output.
4552 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4553 }
4554
4555
4556 % @set VAR sets the variable VAR to an empty value.
4557 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4558 %
4559 % Since we want to separate VAR from REST-OF-LINE (which might be
4560 % empty), we can't just use \parsearg; we have to insert a space of our
4561 % own to delimit the rest of the line, and then take it out again if we
4562 % didn't need it.
4563 % We rely on the fact that \parsearg sets \catcode`\ =10.
4564 %
4565 \parseargdef\set{\setyyy#1 \endsetyyy}
4566 \def\setyyy#1 #2\endsetyyy{%
4567 {%
4568 \makevalueexpandable
4569 \def\temp{#2}%
4570 \edef\next{\gdef\makecsname{SET#1}}%
4571 \ifx\temp\empty
4572 \next{}%
4573 \else
4574 \setzzz#2\endsetzzz
4575 \fi
4576 }%
4577 }
4578 % Remove the trailing space \setxxx inserted.
4579 \def\setzzz#1 \endsetzzz{\next{#1}}
4580
4581 % @clear VAR clears (i.e., unsets) the variable VAR.
4582 %
4583 \parseargdef\clear{%
4584 {%
4585 \makevalueexpandable
4586 \global\expandafter\let\csname SET#1\endcsname=\relax
4587 }%
4588 }
4589
4590 % @value{foo} gets the text saved in variable foo.
4591 \def\value{\begingroup\makevalueexpandable\valuexxx}
4592 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4593 {
4594 \catcode`\-=\active \catcode`\_=\active
4595 %
4596 \gdef\makevalueexpandable{%
4597 \let\value = \expandablevalue
4598 % We don't want these characters active, ...
4599 \catcode`\-=\other \catcode`\_=\other
4600 % ..., but we might end up with active ones in the argument if
4601 % we're called from @code, as @code{@value{foo-bar_}}, though.
4602 % So \let them to their normal equivalents.
4603 \let-\normaldash \let_\normalunderscore
4604 }
4605 }
4606
4607 \def\expandablevalue#1{%
4608 \expandafter\ifx\csname SET#1\endcsname\relax
4609 {[No value for ``#1'']}%
4610 \message{Variable `#1', used in @value, is not set.}%
4611 \else
4612 \csname SET#1\endcsname
4613 \fi
4614 }
4615
4616 % Like \expandablevalue, but completely expandable (the \message in the
4617 % definition above operates at the execution level of TeX). Used when
4618 % writing to auxiliary files, due to the expansion that \write does.
4619 % If flag is undefined, pass through an unexpanded @value command: maybe it
4620 % will be set by the time it is read back in.
4621 %
4622 % NB flag names containing - or _ may not work here.
4623 \def\dummyvalue#1{%
4624 \expandafter\ifx\csname SET#1\endcsname\relax
4625 \string\value{#1}%
4626 \else
4627 \csname SET#1\endcsname
4628 \fi
4629 }
4630
4631 % Used for @value's in index entries to form the sort key: expand the @value
4632 % if possible, otherwise sort late.
4633 \def\indexnofontsvalue#1{%
4634 \expandafter\ifx\csname SET#1\endcsname\relax
4635 ZZZZZZZ%
4636 \else
4637 \csname SET#1\endcsname
4638 \fi
4639 }
4640
4641 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4642 % with @set.
4643 %
4644 % To get the special treatment we need for `@end ifset,' we call
4645 % \makecond and then redefine.
4646 %
4647 \makecond{ifset}
4648 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4649 \def\doifset#1#2{%
4650 {%
4651 \makevalueexpandable
4652 \let\next=\empty
4653 \expandafter\ifx\csname SET#2\endcsname\relax
4654 #1% If not set, redefine \next.
4655 \fi
4656 \expandafter
4657 }\next
4658 }
4659 \def\ifsetfail{\doignore{ifset}}
4660
4661 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4662 % defined with @set, or has been undefined with @clear.
4663 %
4664 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4665 % above code: if the variable is not set, do nothing, if it is set,
4666 % then redefine \next to \ifclearfail.
4667 %
4668 \makecond{ifclear}
4669 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4670 \def\ifclearfail{\doignore{ifclear}}
4671
4672 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4673 % without the @) is in fact defined. We can only feasibly check at the
4674 % TeX level, so something like `mathcode' is going to considered
4675 % defined even though it is not a Texinfo command.
4676 %
4677 \makecond{ifcommanddefined}
4678 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4679 %
4680 \def\doifcmddefined#1#2{{%
4681 \makevalueexpandable
4682 \let\next=\empty
4683 \expandafter\ifx\csname #2\endcsname\relax
4684 #1% If not defined, \let\next as above.
4685 \fi
4686 \expandafter
4687 }\next
4688 }
4689 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4690
4691 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4692 \makecond{ifcommandnotdefined}
4693 \def\ifcommandnotdefined{%
4694 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4695 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4696
4697 % Set the `txicommandconditionals' variable, so documents have a way to
4698 % test if the @ifcommand...defined conditionals are available.
4699 \set txicommandconditionals
4700
4701 % @dircategory CATEGORY -- specify a category of the dir file
4702 % which this file should belong to. Ignore this in TeX.
4703 \let\dircategory=\comment
4704
4705 % @defininfoenclose.
4706 \let\definfoenclose=\comment
4707
4708
4709 \message{indexing,}
4710 % Index generation facilities
4711
4712 % Define \newwrite to be identical to plain tex's \newwrite
4713 % except not \outer, so it can be used within macros and \if's.
4714 \edef\newwrite{\makecsname{ptexnewwrite}}
4715
4716 % \newindex {foo} defines an index named IX.
4717 % It automatically defines \IXindex such that
4718 % \IXindex ...rest of line... puts an entry in the index IX.
4719 % It also defines \IXindfile to be the number of the output channel for
4720 % the file that accumulates this index. The file's extension is IX.
4721 % The name of an index should be no more than 2 characters long
4722 % for the sake of vms.
4723 %
4724 \def\newindex#1{%
4725 \expandafter\chardef\csname#1indfile\endcsname=0
4726 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4727 \noexpand\doindex{#1}}
4728 }
4729
4730 % @defindex foo == \newindex{foo}
4731 %
4732 \def\defindex{\parsearg\newindex}
4733
4734 % Define @defcodeindex, like @defindex except put all entries in @code.
4735 %
4736 \def\defcodeindex{\parsearg\newcodeindex}
4737 %
4738 \def\newcodeindex#1{%
4739 \expandafter\chardef\csname#1indfile\endcsname=0
4740 \expandafter\xdef\csname#1index\endcsname{%
4741 \noexpand\docodeindex{#1}}%
4742 }
4743
4744 % The default indices:
4745 \newindex{cp}% concepts,
4746 \newcodeindex{fn}% functions,
4747 \newcodeindex{vr}% variables,
4748 \newcodeindex{tp}% types,
4749 \newcodeindex{ky}% keys
4750 \newcodeindex{pg}% and programs.
4751
4752
4753 % @synindex foo bar makes index foo feed into index bar.
4754 % Do this instead of @defindex foo if you don't want it as a separate index.
4755 %
4756 % @syncodeindex foo bar similar, but put all entries made for index foo
4757 % inside @code.
4758 %
4759 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4760 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4761
4762 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4763 % #3 the target index (bar).
4764 \def\dosynindex#1#2#3{%
4765 \requireopenindexfile{#3}%
4766 % redefine \fooindfile:
4767 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4768 \expandafter\let\csname#2indfile\endcsname=\temp
4769 % redefine \fooindex:
4770 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4771 }
4772
4773 % Define \doindex, the driver for all index macros.
4774 % Argument #1 is generated by the calling \fooindex macro,
4775 % and it is the two-letter name of the index.
4776
4777 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4778 \def\doindexxxx #1{\doind{\indexname}{#1}}
4779
4780 % like the previous two, but they put @code around the argument.
4781 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4782 \def\docodeindexxxx #1{\docind{\indexname}{#1}}
4783
4784
4785 % Used for the aux, toc and index files to prevent expansion of Texinfo
4786 % commands.
4787 %
4788 \def\atdummies{%
4789 \definedummyletter\@%
4790 \definedummyletter\ %
4791 \definedummyletter\{%
4792 \definedummyletter\}%
4793 \definedummyletter\&%
4794 %
4795 % Do the redefinitions.
4796 \definedummies
4797 \otherbackslash
4798 }
4799
4800 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4801 % preventing its expansion. This is used only for control words,
4802 % not control letters, because the \space would be incorrect for
4803 % control characters, but is needed to separate the control word
4804 % from whatever follows.
4805 %
4806 % These can be used both for control words that take an argument and
4807 % those that do not. If it is followed by {arg} in the input, then
4808 % that will dutifully get written to the index (or wherever).
4809 %
4810 % For control letters, we have \definedummyletter, which omits the
4811 % space.
4812 %
4813 \def\definedummyword #1{\def#1{\string#1\space}}%
4814 \def\definedummyletter#1{\def#1{\string#1}}%
4815 \let\definedummyaccent\definedummyletter
4816
4817 % Called from \atdummies to prevent the expansion of commands.
4818 %
4819 \def\definedummies{%
4820 %
4821 \let\commondummyword\definedummyword
4822 \let\commondummyletter\definedummyletter
4823 \let\commondummyaccent\definedummyaccent
4824 \commondummiesnofonts
4825 %
4826 \definedummyletter\_%
4827 \definedummyletter\-%
4828 %
4829 % Non-English letters.
4830 \definedummyword\AA
4831 \definedummyword\AE
4832 \definedummyword\DH
4833 \definedummyword\L
4834 \definedummyword\O
4835 \definedummyword\OE
4836 \definedummyword\TH
4837 \definedummyword\aa
4838 \definedummyword\ae
4839 \definedummyword\dh
4840 \definedummyword\exclamdown
4841 \definedummyword\l
4842 \definedummyword\o
4843 \definedummyword\oe
4844 \definedummyword\ordf
4845 \definedummyword\ordm
4846 \definedummyword\questiondown
4847 \definedummyword\ss
4848 \definedummyword\th
4849 %
4850 % Although these internal commands shouldn't show up, sometimes they do.
4851 \definedummyword\bf
4852 \definedummyword\gtr
4853 \definedummyword\hat
4854 \definedummyword\less
4855 \definedummyword\sf
4856 \definedummyword\sl
4857 \definedummyword\tclose
4858 \definedummyword\tt
4859 %
4860 \definedummyword\LaTeX
4861 \definedummyword\TeX
4862 %
4863 % Assorted special characters.
4864 \definedummyword\ampchar
4865 \definedummyword\atchar
4866 \definedummyword\arrow
4867 \definedummyword\backslashchar
4868 \definedummyword\bullet
4869 \definedummyword\comma
4870 \definedummyword\copyright
4871 \definedummyword\registeredsymbol
4872 \definedummyword\dots
4873 \definedummyword\enddots
4874 \definedummyword\entrybreak
4875 \definedummyword\equiv
4876 \definedummyword\error
4877 \definedummyword\euro
4878 \definedummyword\expansion
4879 \definedummyword\geq
4880 \definedummyword\guillemetleft
4881 \definedummyword\guillemetright
4882 \definedummyword\guilsinglleft
4883 \definedummyword\guilsinglright
4884 \definedummyword\lbracechar
4885 \definedummyword\leq
4886 \definedummyword\mathopsup
4887 \definedummyword\minus
4888 \definedummyword\ogonek
4889 \definedummyword\pounds
4890 \definedummyword\point
4891 \definedummyword\print
4892 \definedummyword\quotedblbase
4893 \definedummyword\quotedblleft
4894 \definedummyword\quotedblright
4895 \definedummyword\quoteleft
4896 \definedummyword\quoteright
4897 \definedummyword\quotesinglbase
4898 \definedummyword\rbracechar
4899 \definedummyword\result
4900 \definedummyword\sub
4901 \definedummyword\sup
4902 \definedummyword\textdegree
4903 %
4904 \definedummyword\subentry
4905 %
4906 % We want to disable all macros so that they are not expanded by \write.
4907 \macrolist
4908 \let\value\dummyvalue
4909 %
4910 \normalturnoffactive
4911 }
4912
4913 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
4914 % Define \commondummyletter, \commondummyaccent and \commondummyword before
4915 % using. Used for accents, font commands, and various control letters.
4916 %
4917 \def\commondummiesnofonts{%
4918 % Control letters and accents.
4919 \commondummyletter\!%
4920 \commondummyaccent\"%
4921 \commondummyaccent\'%
4922 \commondummyletter\*%
4923 \commondummyaccent\,%
4924 \commondummyletter\.%
4925 \commondummyletter\/%
4926 \commondummyletter\:%
4927 \commondummyaccent\=%
4928 \commondummyletter\?%
4929 \commondummyaccent\^%
4930 \commondummyaccent\`%
4931 \commondummyaccent\~%
4932 \commondummyword\u
4933 \commondummyword\v
4934 \commondummyword\H
4935 \commondummyword\dotaccent
4936 \commondummyword\ogonek
4937 \commondummyword\ringaccent
4938 \commondummyword\tieaccent
4939 \commondummyword\ubaraccent
4940 \commondummyword\udotaccent
4941 \commondummyword\dotless
4942 %
4943 % Texinfo font commands.
4944 \commondummyword\b
4945 \commondummyword\i
4946 \commondummyword\r
4947 \commondummyword\sansserif
4948 \commondummyword\sc
4949 \commondummyword\slanted
4950 \commondummyword\t
4951 %
4952 % Commands that take arguments.
4953 \commondummyword\abbr
4954 \commondummyword\acronym
4955 \commondummyword\anchor
4956 \commondummyword\cite
4957 \commondummyword\code
4958 \commondummyword\command
4959 \commondummyword\dfn
4960 \commondummyword\dmn
4961 \commondummyword\email
4962 \commondummyword\emph
4963 \commondummyword\env
4964 \commondummyword\file
4965 \commondummyword\image
4966 \commondummyword\indicateurl
4967 \commondummyword\inforef
4968 \commondummyword\kbd
4969 \commondummyword\key
4970 \commondummyword\math
4971 \commondummyword\option
4972 \commondummyword\pxref
4973 \commondummyword\ref
4974 \commondummyword\samp
4975 \commondummyword\strong
4976 \commondummyword\tie
4977 \commondummyword\U
4978 \commondummyword\uref
4979 \commondummyword\url
4980 \commondummyword\var
4981 \commondummyword\verb
4982 \commondummyword\w
4983 \commondummyword\xref
4984 }
4985
4986 \let\indexlbrace\relax
4987 \let\indexrbrace\relax
4988 \let\indexatchar\relax
4989 \let\indexbackslash\relax
4990
4991 {\catcode`\@=0
4992 \catcode`\\=13
4993 @gdef@backslashdisappear{@def\{}}
4994 }
4995
4996 {
4997 \catcode`\<=13
4998 \catcode`\-=13
4999 \catcode`\`=13
5000 \gdef\indexnonalnumdisappear{%
5001 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
5002 % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
5003 % (Introduced for FSFS 2nd ed.)
5004 \let`=\empty
5005 \fi
5006 %
5007 \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
5008 \backslashdisappear
5009 \fi
5010 %
5011 \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
5012 \def-{}%
5013 \fi
5014 \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
5015 \def<{}%
5016 \fi
5017 \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
5018 \def\@{}%
5019 \fi
5020 }
5021
5022 \gdef\indexnonalnumreappear{%
5023 \let-\normaldash
5024 \let<\normalless
5025 }
5026 }
5027
5028
5029 % \indexnofonts is used when outputting the strings to sort the index
5030 % by, and when constructing control sequence names. It eliminates all
5031 % control sequences and just writes whatever the best ASCII sort string
5032 % would be for a given command (usually its argument).
5033 %
5034 \def\indexnofonts{%
5035 % Accent commands should become @asis.
5036 \def\commondummyaccent##1{\let##1\asis}%
5037 % We can just ignore other control letters.
5038 \def\commondummyletter##1{\let##1\empty}%
5039 % All control words become @asis by default; overrides below.
5040 \let\commondummyword\commondummyaccent
5041 \commondummiesnofonts
5042 %
5043 % Don't no-op \tt, since it isn't a user-level command
5044 % and is used in the definitions of the active chars like <, >, |, etc.
5045 % Likewise with the other plain tex font commands.
5046 %\let\tt=\asis
5047 %
5048 \def\ { }%
5049 \def\@{@}%
5050 \def\_{\normalunderscore}%
5051 \def\-{}% @- shouldn't affect sorting
5052 %
5053 \uccode`\1=`\{ \uppercase{\def\{{1}}%
5054 \uccode`\1=`\} \uppercase{\def\}{1}}%
5055 \let\lbracechar\{%
5056 \let\rbracechar\}%
5057 %
5058 % Non-English letters.
5059 \def\AA{AA}%
5060 \def\AE{AE}%
5061 \def\DH{DZZ}%
5062 \def\L{L}%
5063 \def\OE{OE}%
5064 \def\O{O}%
5065 \def\TH{TH}%
5066 \def\aa{aa}%
5067 \def\ae{ae}%
5068 \def\dh{dzz}%
5069 \def\exclamdown{!}%
5070 \def\l{l}%
5071 \def\oe{oe}%
5072 \def\ordf{a}%
5073 \def\ordm{o}%
5074 \def\o{o}%
5075 \def\questiondown{?}%
5076 \def\ss{ss}%
5077 \def\th{th}%
5078 %
5079 \let\do\indexnofontsdef
5080 %
5081 \do\LaTeX{LaTeX}%
5082 \do\TeX{TeX}%
5083 %
5084 % Assorted special characters.
5085 \do\atchar{@}%
5086 \do\arrow{->}%
5087 \do\bullet{bullet}%
5088 \do\comma{,}%
5089 \do\copyright{copyright}%
5090 \do\dots{...}%
5091 \do\enddots{...}%
5092 \do\equiv{==}%
5093 \do\error{error}%
5094 \do\euro{euro}%
5095 \do\expansion{==>}%
5096 \do\geq{>=}%
5097 \do\guillemetleft{<<}%
5098 \do\guillemetright{>>}%
5099 \do\guilsinglleft{<}%
5100 \do\guilsinglright{>}%
5101 \do\leq{<=}%
5102 \do\lbracechar{\{}%
5103 \do\minus{-}%
5104 \do\point{.}%
5105 \do\pounds{pounds}%
5106 \do\print{-|}%
5107 \do\quotedblbase{"}%
5108 \do\quotedblleft{"}%
5109 \do\quotedblright{"}%
5110 \do\quoteleft{`}%
5111 \do\quoteright{'}%
5112 \do\quotesinglbase{,}%
5113 \do\rbracechar{\}}%
5114 \do\registeredsymbol{R}%
5115 \do\result{=>}%
5116 \do\textdegree{o}%
5117 %
5118 % We need to get rid of all macros, leaving only the arguments (if present).
5119 % Of course this is not nearly correct, but it is the best we can do for now.
5120 % makeinfo does not expand macros in the argument to @deffn, which ends up
5121 % writing an index entry, and texindex isn't prepared for an index sort entry
5122 % that starts with \.
5123 %
5124 % Since macro invocations are followed by braces, we can just redefine them
5125 % to take a single TeX argument. The case of a macro invocation that
5126 % goes to end-of-line is not handled.
5127 %
5128 \macrolist
5129 \let\value\indexnofontsvalue
5130 }
5131
5132 % Give the control sequence a definition that removes the {} that follows
5133 % its use, e.g. @AA{} -> AA
5134 \def\indexnofontsdef#1#2{\def#1##1{#2}}%
5135
5136
5137
5138
5139 % #1 is the index name, #2 is the entry text.
5140 \def\doind#1#2{%
5141 \iflinks
5142 {%
5143 %
5144 \requireopenindexfile{#1}%
5145 \edef\writeto{\csname#1indfile\endcsname}%
5146 %
5147 \def\indextext{#2}%
5148 \safewhatsit\doindwrite
5149 }%
5150 \fi
5151 }
5152
5153 % Same as \doind, but for code indices
5154 \def\docind#1#2{%
5155 \iflinks
5156 {%
5157 %
5158 \requireopenindexfile{#1}%
5159 \edef\writeto{\csname#1indfile\endcsname}%
5160 %
5161 \def\indextext{#2}%
5162 \safewhatsit\docindwrite
5163 }%
5164 \fi
5165 }
5166
5167 % Check if an index file has been opened, and if not, open it.
5168 \def\requireopenindexfile#1{%
5169 \ifnum\csname #1indfile\endcsname=0
5170 \expandafter\newwrite \csname#1indfile\endcsname
5171 \edef\suffix{#1}%
5172 % A .fls suffix would conflict with the file extension for the output
5173 % of -recorder, so use .f1s instead.
5174 \ifx\suffix\indexisfl\def\suffix{f1}\fi
5175 % Open the file
5176 \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
5177 % Using \immediate above here prevents an object entering into the current
5178 % box, which could confound checks such as those in \safewhatsit for
5179 % preceding skips.
5180 \typeout{Writing index file \jobname.\suffix}%
5181 \fi}
5182 \def\indexisfl{fl}
5183
5184 % Definition for writing index entry sort key.
5185 {
5186 \catcode`\-=13
5187 \gdef\indexwritesortas{%
5188 \begingroup
5189 \indexnonalnumreappear
5190 \indexwritesortasxxx}
5191 \gdef\indexwritesortasxxx#1{%
5192 \xdef\indexsortkey{#1}\endgroup}
5193 }
5194
5195 \def\indexwriteseealso#1{
5196 \gdef\pagenumbertext{\string\seealso{#1}}%
5197 }
5198 \def\indexwriteseeentry#1{
5199 \gdef\pagenumbertext{\string\seeentry{#1}}%
5200 }
5201
5202 % The default definitions
5203 \def\sortas#1{}%
5204 \def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only
5205 \def\putwordSeeAlso{See also}
5206 \def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only
5207
5208
5209 % Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
5210 % * Set \bracedtext to "{aaa}{bbb}"
5211 % * Set \fullindexsortkey to "aaa @subentry ZZZ"
5212 % * If @seealso occurs, set \pagenumbertext
5213 %
5214 \def\splitindexentry#1{%
5215 \gdef\fullindexsortkey{}%
5216 \xdef\bracedtext{}%
5217 \def\sep{}%
5218 \def\seealso##1{}%
5219 \def\seeentry##1{}%
5220 \expandafter\doindexsegment#1\subentry\finish\subentry
5221 }
5222
5223 % append the results from the next segment
5224 \def\doindexsegment#1\subentry{%
5225 \def\segment{#1}%
5226 \ifx\segment\isfinish
5227 \else
5228 %
5229 % Fully expand the segment, throwing away any @sortas directives, and
5230 % trim spaces.
5231 \edef\trimmed{\segment}%
5232 \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5233 \ifincodeindex
5234 \edef\trimmed{\noexpand\code{\trimmed}}%
5235 \fi
5236 %
5237 \xdef\bracedtext{\bracedtext{\trimmed}}%
5238 %
5239 % Get the string to sort by. Process the segment with all
5240 % font commands turned off.
5241 \bgroup
5242 \let\sortas\indexwritesortas
5243 \let\seealso\indexwriteseealso
5244 \let\seeentry\indexwriteseeentry
5245 \indexnofonts
5246 % The braces around the commands are recognized by texindex.
5247 \def\lbracechar{{\string\indexlbrace}}%
5248 \def\rbracechar{{\string\indexrbrace}}%
5249 \let\{=\lbracechar
5250 \let\}=\rbracechar
5251 \def\@{{\string\indexatchar}}%
5252 \def\atchar##1{\@}%
5253 \def\backslashchar{{\string\indexbackslash}}%
5254 \uccode`\~=`\\ \uppercase{\let~\backslashchar}%
5255 %
5256 \let\indexsortkey\empty
5257 \global\let\pagenumbertext\empty
5258 % Execute the segment and throw away the typeset output. This executes
5259 % any @sortas or @seealso commands in this segment.
5260 \setbox\dummybox = \hbox{\segment}%
5261 \ifx\indexsortkey\empty{%
5262 \indexnonalnumdisappear
5263 \xdef\trimmed{\segment}%
5264 \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5265 \xdef\indexsortkey{\trimmed}%
5266 \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
5267 }\fi
5268 %
5269 % Append to \fullindexsortkey.
5270 \edef\tmp{\gdef\noexpand\fullindexsortkey{%
5271 \fullindexsortkey\sep\indexsortkey}}%
5272 \tmp
5273 \egroup
5274 \def\sep{\subentry}%
5275 %
5276 \expandafter\doindexsegment
5277 \fi
5278 }
5279 \def\isfinish{\finish}%
5280 \newbox\dummybox % used above
5281
5282 \let\subentry\relax
5283
5284 % Use \ instead of @ in index files. To support old texi2dvi and texindex.
5285 % This works without changing the escape character used in the toc or aux
5286 % files because the index entries are fully expanded here, and \string uses
5287 % the current value of \escapechar.
5288 \def\escapeisbackslash{\escapechar=`\\}
5289
5290 % Use \ in index files by default. texi2dvi didn't support @ as the escape
5291 % character (as it checked for "\entry" in the files, and not "@entry"). When
5292 % the new version of texi2dvi has had a chance to become more prevalent, then
5293 % the escape character can change back to @ again. This should be an easy
5294 % change to make now because both @ and \ are only used as escape characters in
5295 % index files, never standing for themselves.
5296 %
5297 \set txiindexescapeisbackslash
5298
5299 % Write the entry in \indextext to the index file.
5300 %
5301
5302 \newif\ifincodeindex
5303 \def\doindwrite{\incodeindexfalse\doindwritex}
5304 \def\docindwrite{\incodeindextrue\doindwritex}
5305
5306 \def\doindwritex{%
5307 \maybemarginindex
5308 %
5309 \atdummies
5310 %
5311 \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax\else
5312 \escapeisbackslash
5313 \fi
5314 %
5315 % For texindex which always views { and } as separators.
5316 \def\{{\lbracechar{}}%
5317 \def\}{\rbracechar{}}%
5318 \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}%
5319 %
5320 % Split the entry into primary entry and any subentries, and get the index
5321 % sort key.
5322 \splitindexentry\indextext
5323 %
5324 % Set up the complete index entry, with both the sort key and
5325 % the original text, including any font commands. We write
5326 % three arguments to \entry to the .?? file (four in the
5327 % subentry case), texindex reduces to two when writing the .??s
5328 % sorted result.
5329 %
5330 \edef\temp{%
5331 \write\writeto{%
5332 \string\entry{\fullindexsortkey}%
5333 {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}%
5334 \bracedtext}%
5335 }%
5336 \temp
5337 }
5338
5339 % Put the index entry in the margin if desired (undocumented).
5340 \def\maybemarginindex{%
5341 \ifx\SETmarginindex\relax\else
5342 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}%
5343 \fi
5344 }
5345 \let\SETmarginindex=\relax
5346
5347
5348 % Take care of unwanted page breaks/skips around a whatsit:
5349 %
5350 % If a skip is the last thing on the list now, preserve it
5351 % by backing up by \lastskip, doing the \write, then inserting
5352 % the skip again. Otherwise, the whatsit generated by the
5353 % \write or \pdfdest will make \lastskip zero. The result is that
5354 % sequences like this:
5355 % @end defun
5356 % @tindex whatever
5357 % @defun ...
5358 % will have extra space inserted, because the \medbreak in the
5359 % start of the @defun won't see the skip inserted by the @end of
5360 % the previous defun.
5361 %
5362 % But don't do any of this if we're not in vertical mode. We
5363 % don't want to do a \vskip and prematurely end a paragraph.
5364 %
5365 % Avoid page breaks due to these extra skips, too.
5366 %
5367 % But wait, there is a catch there:
5368 % We'll have to check whether \lastskip is zero skip. \ifdim is not
5369 % sufficient for this purpose, as it ignores stretch and shrink parts
5370 % of the skip. The only way seems to be to check the textual
5371 % representation of the skip.
5372 %
5373 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5374 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5375 %
5376 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
5377 %
5378 \newskip\whatsitskip
5379 \newcount\whatsitpenalty
5380 %
5381 % ..., ready, GO:
5382 %
5383 \def\safewhatsit#1{\ifhmode
5384 #1%
5385 \else
5386 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5387 \whatsitskip = \lastskip
5388 \edef\lastskipmacro{\the\lastskip}%
5389 \whatsitpenalty = \lastpenalty
5390 %
5391 % If \lastskip is nonzero, that means the last item was a
5392 % skip. And since a skip is discardable, that means this
5393 % -\whatsitskip glue we're inserting is preceded by a
5394 % non-discardable item, therefore it is not a potential
5395 % breakpoint, therefore no \nobreak needed.
5396 \ifx\lastskipmacro\zeroskipmacro
5397 \else
5398 \vskip-\whatsitskip
5399 \fi
5400 %
5401 #1%
5402 %
5403 \ifx\lastskipmacro\zeroskipmacro
5404 % If \lastskip was zero, perhaps the last item was a penalty, and
5405 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
5406 % to re-insert the same penalty (values >10000 are used for various
5407 % signals); since we just inserted a non-discardable item, any
5408 % following glue (such as a \parskip) would be a breakpoint. For example:
5409 % @deffn deffn-whatever
5410 % @vindex index-whatever
5411 % Description.
5412 % would allow a break between the index-whatever whatsit
5413 % and the "Description." paragraph.
5414 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
5415 \else
5416 % On the other hand, if we had a nonzero \lastskip,
5417 % this make-up glue would be preceded by a non-discardable item
5418 % (the whatsit from the \write), so we must insert a \nobreak.
5419 \nobreak\vskip\whatsitskip
5420 \fi
5421 \fi}
5422
5423 % The index entry written in the file actually looks like
5424 % \entry {sortstring}{page}{topic}
5425 % or
5426 % \entry {sortstring}{page}{topic}{subtopic}
5427 % The texindex program reads in these files and writes files
5428 % containing these kinds of lines:
5429 % \initial {c}
5430 % before the first topic whose initial is c
5431 % \entry {topic}{pagelist}
5432 % for a topic that is used without subtopics
5433 % \primary {topic}
5434 % \entry {topic}{}
5435 % for the beginning of a topic that is used with subtopics
5436 % \secondary {subtopic}{pagelist}
5437 % for each subtopic.
5438 % \secondary {subtopic}{}
5439 % for a subtopic with sub-subtopics
5440 % \tertiary {subtopic}{subsubtopic}{pagelist}
5441 % for each sub-subtopic.
5442
5443 % Define the user-accessible indexing commands
5444 % @findex, @vindex, @kindex, @cindex.
5445
5446 \def\findex {\fnindex}
5447 \def\kindex {\kyindex}
5448 \def\cindex {\cpindex}
5449 \def\vindex {\vrindex}
5450 \def\tindex {\tpindex}
5451 \def\pindex {\pgindex}
5452
5453 % Define the macros used in formatting output of the sorted index material.
5454
5455 % @printindex causes a particular index (the ??s file) to get printed.
5456 % It does not print any chapter heading (usually an @unnumbered).
5457 %
5458 \parseargdef\printindex{\begingroup
5459 \dobreak \chapheadingskip{10000}%
5460 %
5461 \smallfonts \rm
5462 \tolerance = 9500
5463 \plainfrenchspacing
5464 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
5465 %
5466 % See comment in \requireopenindexfile.
5467 \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
5468 %
5469 % See if the index file exists and is nonempty.
5470 \openin 1 \jobname.\indexname s
5471 \ifeof 1
5472 % \enddoublecolumns gets confused if there is no text in the index,
5473 % and it loses the chapter title and the aux file entries for the
5474 % index. The easiest way to prevent this problem is to make sure
5475 % there is some text.
5476 \putwordIndexNonexistent
5477 \typeout{No file \jobname.\indexname s.}%
5478 \else
5479 % If the index file exists but is empty, then \openin leaves \ifeof
5480 % false. We have to make TeX try to read something from the file, so
5481 % it can discover if there is anything in it.
5482 \read 1 to \thisline
5483 \ifeof 1
5484 \putwordIndexIsEmpty
5485 \else
5486 \expandafter\printindexzz\thisline\relax\relax\finish%
5487 \fi
5488 \fi
5489 \closein 1
5490 \endgroup}
5491
5492 % If the index file starts with a backslash, forgo reading the index
5493 % file altogether. If somebody upgrades texinfo.tex they may still have
5494 % old index files using \ as the escape character. Reading this would
5495 % at best lead to typesetting garbage, at worst a TeX syntax error.
5496 \def\printindexzz#1#2\finish{%
5497 \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax
5498 \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1
5499 \expandafter\ifx\csname SETtxiskipindexfileswithbackslash\endcsname\relax
5500 \errmessage{%
5501 ERROR: A sorted index file in an obsolete format was skipped.
5502 To fix this problem, please upgrade your version of 'texi2dvi'
5503 or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
5504 If you are using an old version of 'texindex' (part of the Texinfo
5505 distribution), you may also need to upgrade to a newer version (at least 6.0).
5506 You may be able to typeset the index if you run
5507 'texindex \jobname.\indexname' yourself.
5508 You could also try setting the 'txiindexescapeisbackslash' flag by
5509 running a command like
5510 'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do
5511 this, Texinfo will try to use index files in the old format.
5512 If you continue to have problems, deleting the index files and starting again
5513 might help (with 'rm \jobname.?? \jobname.??s')%
5514 }%
5515 \else
5516 (Skipped sorted index file in obsolete format)
5517 \fi
5518 \else
5519 \begindoublecolumns
5520 \input \jobname.\indexname s
5521 \enddoublecolumns
5522 \fi
5523 \else
5524 \begindoublecolumns
5525 \catcode`\\=0\relax
5526 %
5527 % Make @ an escape character to give macros a chance to work. This
5528 % should work because we (hopefully) don't otherwise use @ in index files.
5529 %\catcode`\@=12\relax
5530 \catcode`\@=0\relax
5531 \input \jobname.\indexname s
5532 \enddoublecolumns
5533 \fi
5534 }
5535
5536 % These macros are used by the sorted index file itself.
5537 % Change them to control the appearance of the index.
5538
5539 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5540 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5541 \catcode`\$=3
5542 \gdef\initialglyphs{%
5543 % special control sequences used in the index sort key
5544 \let\indexlbrace\{%
5545 \let\indexrbrace\}%
5546 \let\indexatchar\@%
5547 \def\indexbackslash{\math{\backslash}}%
5548 %
5549 % Some changes for non-alphabetic characters. Using the glyphs from the
5550 % math fonts looks more consistent than the typewriter font used elsewhere
5551 % for these characters.
5552 \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}}
5553 %
5554 % In case @\ is used for backslash
5555 \uppercase{\let\\=~}
5556 % Can't get bold backslash so don't use bold forward slash
5557 \catcode`\/=13
5558 \def/{{\secrmnotbold \normalslash}}%
5559 \def-{{\normaldash\normaldash}}% en dash `--'
5560 \def^{{\chapbf \normalcaret}}%
5561 \def~{{\chapbf \normaltilde}}%
5562 \def\_{%
5563 \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
5564 \def|{$\vert$}%
5565 \def<{$\less$}%
5566 \def>{$\gtr$}%
5567 \def+{$\normalplus$}%
5568 }}
5569
5570 \def\initial{%
5571 \bgroup
5572 \initialglyphs
5573 \initialx
5574 }
5575
5576 \def\initialx#1{%
5577 % Remove any glue we may have, we'll be inserting our own.
5578 \removelastskip
5579 %
5580 % We like breaks before the index initials, so insert a bonus.
5581 % The glue before the bonus allows a little bit of space at the
5582 % bottom of a column to reduce an increase in inter-line spacing.
5583 \nobreak
5584 \vskip 0pt plus 5\baselineskip
5585 \penalty -300
5586 \vskip 0pt plus -5\baselineskip
5587 %
5588 % Typeset the initial. Making this add up to a whole number of
5589 % baselineskips increases the chance of the dots lining up from column
5590 % to column. It still won't often be perfect, because of the stretch
5591 % we need before each entry, but it's better.
5592 %
5593 % No shrink because it confuses \balancecolumns.
5594 \vskip 1.67\baselineskip plus 1\baselineskip
5595 \leftline{\secfonts \kern-0.05em \secbf #1}%
5596 % \secfonts is inside the argument of \leftline so that the change of
5597 % \baselineskip will not affect any glue inserted before the vbox that
5598 % \leftline creates.
5599 % Do our best not to break after the initial.
5600 \nobreak
5601 \vskip .33\baselineskip plus .1\baselineskip
5602 \egroup % \initialglyphs
5603 }
5604
5605 \newdimen\entryrightmargin
5606 \entryrightmargin=0pt
5607
5608 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5609 % then page number (#2) flushed to the right margin. It is used for index
5610 % and table of contents entries. The paragraph is indented by \leftskip.
5611 %
5612 \def\entry{%
5613 \begingroup
5614 %
5615 % Start a new paragraph if necessary, so our assignments below can't
5616 % affect previous text.
5617 \par
5618 %
5619 % No extra space above this paragraph.
5620 \parskip = 0in
5621 %
5622 % When reading the text of entry, convert explicit line breaks
5623 % from @* into spaces. The user might give these in long section
5624 % titles, for instance.
5625 \def\*{\unskip\space\ignorespaces}%
5626 \def\entrybreak{\hfil\break}% An undocumented command
5627 %
5628 % Swallow the left brace of the text (first parameter):
5629 \afterassignment\doentry
5630 \let\temp =
5631 }
5632 \def\entrybreak{\unskip\space\ignorespaces}%
5633 \def\doentry{%
5634 % Save the text of the entry
5635 \global\setbox\boxA=\hbox\bgroup
5636 \bgroup % Instead of the swallowed brace.
5637 \noindent
5638 \aftergroup\finishentry
5639 % And now comes the text of the entry.
5640 % Not absorbing as a macro argument reduces the chance of problems
5641 % with catcodes occurring.
5642 }
5643 {\catcode`\@=11
5644 \gdef\finishentry#1{%
5645 \egroup % end box A
5646 \dimen@ = \wd\boxA % Length of text of entry
5647 \global\setbox\boxA=\hbox\bgroup
5648 \unhbox\boxA
5649 % #1 is the page number.
5650 %
5651 % Get the width of the page numbers, and only use
5652 % leaders if they are present.
5653 \global\setbox\boxB = \hbox{#1}%
5654 \ifdim\wd\boxB = 0pt
5655 \null\nobreak\hfill\ %
5656 \else
5657 %
5658 \null\nobreak\indexdotfill % Have leaders before the page number.
5659 %
5660 \ifpdforxetex
5661 \pdfgettoks#1.%
5662 \hskip\skip\thinshrinkable\the\toksA
5663 \else
5664 \hskip\skip\thinshrinkable #1%
5665 \fi
5666 \fi
5667 \egroup % end \boxA
5668 \ifdim\wd\boxB = 0pt
5669 \noindent\unhbox\boxA\par
5670 \nobreak
5671 \else\bgroup
5672 % We want the text of the entries to be aligned to the left, and the
5673 % page numbers to be aligned to the right.
5674 %
5675 \parindent = 0pt
5676 \advance\leftskip by 0pt plus 1fil
5677 \advance\leftskip by 0pt plus -1fill
5678 \rightskip = 0pt plus -1fil
5679 \advance\rightskip by 0pt plus 1fill
5680 % Cause last line, which could consist of page numbers on their own
5681 % if the list of page numbers is long, to be aligned to the right.
5682 \parfillskip=0pt plus -1fill
5683 %
5684 \advance\rightskip by \entryrightmargin
5685 % Determine how far we can stretch into the margin.
5686 % This allows, e.g., "Appendix H GNU Free Documentation License" to
5687 % fit on one line in @letterpaper format.
5688 \ifdim\entryrightmargin>2.1em
5689 \dimen@i=2.1em
5690 \else
5691 \dimen@i=0em
5692 \fi
5693 \advance \parfillskip by 0pt minus 1\dimen@i
5694 %
5695 \dimen@ii = \hsize
5696 \advance\dimen@ii by -1\leftskip
5697 \advance\dimen@ii by -1\entryrightmargin
5698 \advance\dimen@ii by 1\dimen@i
5699 \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
5700 \ifdim\dimen@ > 0.8\dimen@ii % due to long index text
5701 % Try to split the text roughly evenly. \dimen@ will be the length of
5702 % the first line.
5703 \dimen@ = 0.7\dimen@
5704 \dimen@ii = \hsize
5705 \ifnum\dimen@>\dimen@ii
5706 % If the entry is too long (for example, if it needs more than
5707 % two lines), use all the space in the first line.
5708 \dimen@ = \dimen@ii
5709 \fi
5710 \advance\leftskip by 0pt plus 1fill % ragged right
5711 \advance \dimen@ by 1\rightskip
5712 \parshape = 2 0pt \dimen@ 0em \dimen@ii
5713 % Ideally we'd add a finite glue at the end of the first line only,
5714 % instead of using \parshape with explicit line lengths, but TeX
5715 % doesn't seem to provide a way to do such a thing.
5716 %
5717 % Indent all lines but the first one.
5718 \advance\leftskip by 1em
5719 \advance\parindent by -1em
5720 \fi\fi
5721 \indent % start paragraph
5722 \unhbox\boxA
5723 %
5724 % Do not prefer a separate line ending with a hyphen to fewer lines.
5725 \finalhyphendemerits = 0
5726 %
5727 % Word spacing - no stretch
5728 \spaceskip=\fontdimen2\font minus \fontdimen4\font
5729 %
5730 \linepenalty=1000 % Discourage line breaks.
5731 \hyphenpenalty=5000 % Discourage hyphenation.
5732 %
5733 \par % format the paragraph
5734 \egroup % The \vbox
5735 \fi
5736 \endgroup
5737 }}
5738
5739 \newskip\thinshrinkable
5740 \skip\thinshrinkable=.15em minus .15em
5741
5742 % Like plain.tex's \dotfill, except uses up at least 1 em.
5743 % The filll stretch here overpowers both the fil and fill stretch to push
5744 % the page number to the right.
5745 \def\indexdotfill{\cleaders
5746 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
5747
5748
5749 \def\primary #1{\line{#1\hfil}}
5750
5751 \def\secondary{\indententry{0.5cm}}
5752 \def\tertiary{\indententry{1cm}}
5753
5754 \def\indententry#1#2#3{%
5755 \bgroup
5756 \leftskip=#1
5757 \entry{#2}{#3}%
5758 \egroup
5759 }
5760
5761 % Define two-column mode, which we use to typeset indexes.
5762 % Adapted from the TeXbook, page 416, which is to say,
5763 % the manmac.tex format used to print the TeXbook itself.
5764 \catcode`\@=11 % private names
5765
5766 \newbox\partialpage
5767 \newdimen\doublecolumnhsize
5768
5769 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5770 % If not much space left on page, start a new page.
5771 \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
5772 %
5773 % Grab any single-column material above us.
5774 \output = {%
5775 \savetopmark
5776 %
5777 \global\setbox\partialpage = \vbox{%
5778 % Unvbox the main output page.
5779 \unvbox\PAGE
5780 \kern-\topskip \kern\baselineskip
5781 }%
5782 }%
5783 \eject % run that output routine to set \partialpage
5784 %
5785 % Use the double-column output routine for subsequent pages.
5786 \output = {\doublecolumnout}%
5787 %
5788 % Change the page size parameters. We could do this once outside this
5789 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5790 % format, but then we repeat the same computation. Repeating a couple
5791 % of assignments once per index is clearly meaningless for the
5792 % execution time, so we may as well do it in one place.
5793 %
5794 % First we halve the line length, less a little for the gutter between
5795 % the columns. We compute the gutter based on the line length, so it
5796 % changes automatically with the paper format. The magic constant
5797 % below is chosen so that the gutter has the same value (well, +-<1pt)
5798 % as it did when we hard-coded it.
5799 %
5800 % We put the result in a separate register, \doublecolumhsize, so we
5801 % can restore it in \pagesofar, after \hsize itself has (potentially)
5802 % been clobbered.
5803 %
5804 \doublecolumnhsize = \hsize
5805 \advance\doublecolumnhsize by -.04154\hsize
5806 \divide\doublecolumnhsize by 2
5807 \hsize = \doublecolumnhsize
5808 %
5809 % Get the available space for the double columns -- the normal
5810 % (undoubled) page height minus any material left over from the
5811 % previous page.
5812 \advance\vsize by -\ht\partialpage
5813 \vsize = 2\vsize
5814 %
5815 % For the benefit of balancing columns
5816 \advance\baselineskip by 0pt plus 0.5pt
5817 }
5818
5819 % The double-column output routine for all double-column pages except
5820 % the last, which is done by \balancecolumns.
5821 %
5822 \def\doublecolumnout{%
5823 %
5824 \savetopmark
5825 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5826 \dimen@ = \vsize
5827 \divide\dimen@ by 2
5828 %
5829 % box0 will be the left-hand column, box2 the right.
5830 \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
5831 \global\advance\vsize by 2\ht\partialpage
5832 \onepageout\pagesofar % empty except for the first time we are called
5833 \unvbox\PAGE
5834 \penalty\outputpenalty
5835 }
5836 %
5837 % Re-output the contents of the output page -- any previous material,
5838 % followed by the two boxes we just split, in box0 and box2.
5839 \def\pagesofar{%
5840 \unvbox\partialpage
5841 %
5842 \hsize = \doublecolumnhsize
5843 \wd0=\hsize \wd2=\hsize
5844 \hbox to\txipagewidth{\box0\hfil\box2}%
5845 }
5846
5847
5848 % Finished with double columns.
5849 \def\enddoublecolumns{%
5850 % The following penalty ensures that the page builder is exercised
5851 % _before_ we change the output routine. This is necessary in the
5852 % following situation:
5853 %
5854 % The last section of the index consists only of a single entry.
5855 % Before this section, \pagetotal is less than \pagegoal, so no
5856 % break occurs before the last section starts. However, the last
5857 % section, consisting of \initial and the single \entry, does not
5858 % fit on the page and has to be broken off. Without the following
5859 % penalty the page builder will not be exercised until \eject
5860 % below, and by that time we'll already have changed the output
5861 % routine to the \balancecolumns version, so the next-to-last
5862 % double-column page will be processed with \balancecolumns, which
5863 % is wrong: The two columns will go to the main vertical list, with
5864 % the broken-off section in the recent contributions. As soon as
5865 % the output routine finishes, TeX starts reconsidering the page
5866 % break. The two columns and the broken-off section both fit on the
5867 % page, because the two columns now take up only half of the page
5868 % goal. When TeX sees \eject from below which follows the final
5869 % section, it invokes the new output routine that we've set after
5870 % \balancecolumns below; \onepageout will try to fit the two columns
5871 % and the final section into the vbox of \txipageheight (see
5872 % \pagebody), causing an overfull box.
5873 %
5874 % Note that glue won't work here, because glue does not exercise the
5875 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5876 \penalty0
5877 %
5878 \output = {%
5879 % Split the last of the double-column material.
5880 \savetopmark
5881 \balancecolumns
5882 }%
5883 \eject % call the \output just set
5884 \ifdim\pagetotal=0pt
5885 % Having called \balancecolumns once, we do not
5886 % want to call it again. Therefore, reset \output to its normal
5887 % definition right away.
5888 \global\output=\expandafter{\the\defaultoutput}
5889 %
5890 \endgroup % started in \begindoublecolumns
5891 % Leave the double-column material on the current page, no automatic
5892 % page break.
5893 \box\balancedcolumns
5894 %
5895 % \pagegoal was set to the doubled \vsize above, since we restarted
5896 % the current page. We're now back to normal single-column
5897 % typesetting, so reset \pagegoal to the normal \vsize.
5898 \global\vsize = \txipageheight %
5899 \pagegoal = \txipageheight %
5900 \else
5901 % We had some left-over material. This might happen when \doublecolumnout
5902 % is called in \balancecolumns. Try again.
5903 \expandafter\enddoublecolumns
5904 \fi
5905 }
5906 \newbox\balancedcolumns
5907 \setbox\balancedcolumns=\vbox{shouldnt see this}%
5908 %
5909 % Only called for the last of the double column material. \doublecolumnout
5910 % does the others.
5911 \def\balancecolumns{%
5912 \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
5913 \dimen@ = \ht0
5914 \ifdim\dimen@<7\baselineskip
5915 % Don't split a short final column in two.
5916 \setbox2=\vbox{}%
5917 \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5918 \else
5919 % double the leading vertical space
5920 \advance\dimen@ by \topskip
5921 \advance\dimen@ by-\baselineskip
5922 \divide\dimen@ by 2 % target to split to
5923 \dimen@ii = \dimen@
5924 \splittopskip = \topskip
5925 % Loop until left column is at least as high as the right column.
5926 {%
5927 \vbadness = 10000
5928 \loop
5929 \global\setbox3 = \copy0
5930 \global\setbox1 = \vsplit3 to \dimen@
5931 \ifdim\ht1<\ht3
5932 \global\advance\dimen@ by 1pt
5933 \repeat
5934 }%
5935 % Now the left column is in box 1, and the right column in box 3.
5936 %
5937 % Check whether the left column has come out higher than the page itself.
5938 % (Note that we have doubled \vsize for the double columns, so
5939 % the actual height of the page is 0.5\vsize).
5940 \ifdim2\ht1>\vsize
5941 % It appears that we have been called upon to balance too much material.
5942 % Output some of it with \doublecolumnout, leaving the rest on the page.
5943 \setbox\PAGE=\box0
5944 \doublecolumnout
5945 \else
5946 % Compare the heights of the two columns.
5947 \ifdim4\ht1>5\ht3
5948 % Column heights are too different, so don't make their bottoms
5949 % flush with each other.
5950 \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
5951 \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
5952 \else
5953 % Make column bottoms flush with each other.
5954 \setbox2=\vbox to\ht1{\unvbox3\unskip}%
5955 \setbox0=\vbox to\ht1{\unvbox1\unskip}%
5956 \fi
5957 \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5958 \fi
5959 \fi
5960 %
5961 }
5962 \catcode`\@ = \other
5963
5964
5965 \message{sectioning,}
5966 % Chapters, sections, etc.
5967
5968 % Let's start with @part.
5969 \outer\parseargdef\part{\partzzz{#1}}
5970 \def\partzzz#1{%
5971 \chapoddpage
5972 \null
5973 \vskip.3\vsize % move it down on the page a bit
5974 \begingroup
5975 \noindent \titlefonts\rm #1\par % the text
5976 \let\lastnode=\empty % no node to associate with
5977 \writetocentry{part}{#1}{}% but put it in the toc
5978 \headingsoff % no headline or footline on the part page
5979 % This outputs a mark at the end of the page that clears \thischapter
5980 % and \thissection, as is done in \startcontents.
5981 \let\pchapsepmacro\relax
5982 \chapmacro{}{Yomitfromtoc}{}%
5983 \chapoddpage
5984 \endgroup
5985 }
5986
5987 % \unnumberedno is an oxymoron. But we count the unnumbered
5988 % sections so that we can refer to them unambiguously in the pdf
5989 % outlines by their "section number". We avoid collisions with chapter
5990 % numbers by starting them at 10000. (If a document ever has 10000
5991 % chapters, we're in trouble anyway, I'm sure.)
5992 \newcount\unnumberedno \unnumberedno = 10000
5993 \newcount\chapno
5994 \newcount\secno \secno=0
5995 \newcount\subsecno \subsecno=0
5996 \newcount\subsubsecno \subsubsecno=0
5997
5998 % This counter is funny since it counts through charcodes of letters A, B, ...
5999 \newcount\appendixno \appendixno = `\@
6000 %
6001 % \def\appendixletter{\char\the\appendixno}
6002 % We do the following ugly conditional instead of the above simple
6003 % construct for the sake of pdftex, which needs the actual
6004 % letter in the expansion, not just typeset.
6005 %
6006 \def\appendixletter{%
6007 \ifnum\appendixno=`A A%
6008 \else\ifnum\appendixno=`B B%
6009 \else\ifnum\appendixno=`C C%
6010 \else\ifnum\appendixno=`D D%
6011 \else\ifnum\appendixno=`E E%
6012 \else\ifnum\appendixno=`F F%
6013 \else\ifnum\appendixno=`G G%
6014 \else\ifnum\appendixno=`H H%
6015 \else\ifnum\appendixno=`I I%
6016 \else\ifnum\appendixno=`J J%
6017 \else\ifnum\appendixno=`K K%
6018 \else\ifnum\appendixno=`L L%
6019 \else\ifnum\appendixno=`M M%
6020 \else\ifnum\appendixno=`N N%
6021 \else\ifnum\appendixno=`O O%
6022 \else\ifnum\appendixno=`P P%
6023 \else\ifnum\appendixno=`Q Q%
6024 \else\ifnum\appendixno=`R R%
6025 \else\ifnum\appendixno=`S S%
6026 \else\ifnum\appendixno=`T T%
6027 \else\ifnum\appendixno=`U U%
6028 \else\ifnum\appendixno=`V V%
6029 \else\ifnum\appendixno=`W W%
6030 \else\ifnum\appendixno=`X X%
6031 \else\ifnum\appendixno=`Y Y%
6032 \else\ifnum\appendixno=`Z Z%
6033 % The \the is necessary, despite appearances, because \appendixletter is
6034 % expanded while writing the .toc file. \char\appendixno is not
6035 % expandable, thus it is written literally, thus all appendixes come out
6036 % with the same letter (or @) in the toc without it.
6037 \else\char\the\appendixno
6038 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6039 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
6040
6041 % Each @chapter defines these (using marks) as the number+name, number
6042 % and name of the chapter. Page headings and footings can use
6043 % these. @section does likewise.
6044 \def\thischapter{}
6045 \def\thischapternum{}
6046 \def\thischaptername{}
6047 \def\thissection{}
6048 \def\thissectionnum{}
6049 \def\thissectionname{}
6050
6051 \newcount\absseclevel % used to calculate proper heading level
6052 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
6053
6054 % @raisesections: treat @section as chapter, @subsection as section, etc.
6055 \def\raisesections{\global\advance\secbase by -1}
6056
6057 % @lowersections: treat @chapter as section, @section as subsection, etc.
6058 \def\lowersections{\global\advance\secbase by 1}
6059
6060 % we only have subsub.
6061 \chardef\maxseclevel = 3
6062 %
6063 % A numbered section within an unnumbered changes to unnumbered too.
6064 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6065 \chardef\unnlevel = \maxseclevel
6066 %
6067 % Trace whether the current chapter is an appendix or not:
6068 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6069 \def\chapheadtype{N}
6070
6071 % Choose a heading macro
6072 % #1 is heading type
6073 % #2 is heading level
6074 % #3 is text for heading
6075 \def\genhead#1#2#3{%
6076 % Compute the abs. sec. level:
6077 \absseclevel=#2
6078 \advance\absseclevel by \secbase
6079 % Make sure \absseclevel doesn't fall outside the range:
6080 \ifnum \absseclevel < 0
6081 \absseclevel = 0
6082 \else
6083 \ifnum \absseclevel > 3
6084 \absseclevel = 3
6085 \fi
6086 \fi
6087 % The heading type:
6088 \def\headtype{#1}%
6089 \if \headtype U%
6090 \ifnum \absseclevel < \unnlevel
6091 \chardef\unnlevel = \absseclevel
6092 \fi
6093 \else
6094 % Check for appendix sections:
6095 \ifnum \absseclevel = 0
6096 \edef\chapheadtype{\headtype}%
6097 \else
6098 \if \headtype A\if \chapheadtype N%
6099 \errmessage{@appendix... within a non-appendix chapter}%
6100 \fi\fi
6101 \fi
6102 % Check for numbered within unnumbered:
6103 \ifnum \absseclevel > \unnlevel
6104 \def\headtype{U}%
6105 \else
6106 \chardef\unnlevel = 3
6107 \fi
6108 \fi
6109 % Now print the heading:
6110 \if \headtype U%
6111 \ifcase\absseclevel
6112 \unnumberedzzz{#3}%
6113 \or \unnumberedseczzz{#3}%
6114 \or \unnumberedsubseczzz{#3}%
6115 \or \unnumberedsubsubseczzz{#3}%
6116 \fi
6117 \else
6118 \if \headtype A%
6119 \ifcase\absseclevel
6120 \appendixzzz{#3}%
6121 \or \appendixsectionzzz{#3}%
6122 \or \appendixsubseczzz{#3}%
6123 \or \appendixsubsubseczzz{#3}%
6124 \fi
6125 \else
6126 \ifcase\absseclevel
6127 \chapterzzz{#3}%
6128 \or \seczzz{#3}%
6129 \or \numberedsubseczzz{#3}%
6130 \or \numberedsubsubseczzz{#3}%
6131 \fi
6132 \fi
6133 \fi
6134 \suppressfirstparagraphindent
6135 }
6136
6137 % an interface:
6138 \def\numhead{\genhead N}
6139 \def\apphead{\genhead A}
6140 \def\unnmhead{\genhead U}
6141
6142 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
6143 % all lower-level sectioning counters to zero.
6144 %
6145 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6146 % (e.g., figures), q.v. By default (before any chapter), that is empty.
6147 \let\chaplevelprefix = \empty
6148 %
6149 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
6150 \def\chapterzzz#1{%
6151 % section resetting is \global in case the chapter is in a group, such
6152 % as an @include file.
6153 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6154 \global\advance\chapno by 1
6155 %
6156 % Used for \float.
6157 \gdef\chaplevelprefix{\the\chapno.}%
6158 \resetallfloatnos
6159 %
6160 % \putwordChapter can contain complex things in translations.
6161 \toks0=\expandafter{\putwordChapter}%
6162 \message{\the\toks0 \space \the\chapno}%
6163 %
6164 % Write the actual heading.
6165 \chapmacro{#1}{Ynumbered}{\the\chapno}%
6166 %
6167 % So @section and the like are numbered underneath this chapter.
6168 \global\let\section = \numberedsec
6169 \global\let\subsection = \numberedsubsec
6170 \global\let\subsubsection = \numberedsubsubsec
6171 }
6172
6173 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
6174 %
6175 \def\appendixzzz#1{%
6176 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6177 \global\advance\appendixno by 1
6178 \gdef\chaplevelprefix{\appendixletter.}%
6179 \resetallfloatnos
6180 %
6181 % \putwordAppendix can contain complex things in translations.
6182 \toks0=\expandafter{\putwordAppendix}%
6183 \message{\the\toks0 \space \appendixletter}%
6184 %
6185 \chapmacro{#1}{Yappendix}{\appendixletter}%
6186 %
6187 \global\let\section = \appendixsec
6188 \global\let\subsection = \appendixsubsec
6189 \global\let\subsubsection = \appendixsubsubsec
6190 }
6191
6192 % normally unnmhead0 calls unnumberedzzz:
6193 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
6194 \def\unnumberedzzz#1{%
6195 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6196 \global\advance\unnumberedno by 1
6197 %
6198 % Since an unnumbered has no number, no prefix for figures.
6199 \global\let\chaplevelprefix = \empty
6200 \resetallfloatnos
6201 %
6202 % This used to be simply \message{#1}, but TeX fully expands the
6203 % argument to \message. Therefore, if #1 contained @-commands, TeX
6204 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
6205 % expanded @cite (which turns out to cause errors because \cite is meant
6206 % to be executed, not expanded).
6207 %
6208 % Anyway, we don't want the fully-expanded definition of @cite to appear
6209 % as a result of the \message, we just want `@cite' itself. We use
6210 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6211 % simply yielding the contents of <toks register>. (We also do this for
6212 % the toc entries.)
6213 \toks0 = {#1}%
6214 \message{(\the\toks0)}%
6215 %
6216 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
6217 %
6218 \global\let\section = \unnumberedsec
6219 \global\let\subsection = \unnumberedsubsec
6220 \global\let\subsubsection = \unnumberedsubsubsec
6221 }
6222
6223 % @centerchap is like @unnumbered, but the heading is centered.
6224 \outer\parseargdef\centerchap{%
6225 \let\centerparametersmaybe = \centerparameters
6226 \unnmhead0{#1}%
6227 \let\centerparametersmaybe = \relax
6228 }
6229
6230 % @top is like @unnumbered.
6231 \let\top\unnumbered
6232
6233 % Sections.