« back to all changes in this revision
Viewing changes to doc/texinfo.tex
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Takuo KITAME
- Date: 2002-02-20 21:51:16 UTC
- Revision ID: james.westby@ubuntu.com-20020220215116-htmbfdwsdr25nnhm
Tags: upstream-2.8.1
Import upstream version 2.8.1
- files added:
- doc
- elmo
- etc
- etc/icons
- samples
- samples/en
- samples/ja
- tests
- utils
- wl
added
removed
doc/texinfo.tex
1
% texinfo.tex -- TeX macros to handle Texinfo files.
2
%
3
% Load plain if necessary, i.e., if running under initex.
4
\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5
%
6
\def\texinfoversion{2001-07-31.06}
7
%
8
% Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99,
9
% 2000, 01 Free Software Foundation, Inc.
10
%
11
% This texinfo.tex file is free software; you can redistribute it and/or
12
% modify it under the terms of the GNU General Public License as
13
% published by the Free Software Foundation; either version 2, or (at
14
% your option) any later version.
15
%
16
% This texinfo.tex file is distributed in the hope that it will be
17
% useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18
% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19
% General Public License for more details.
20
%
21
% You should have received a copy of the GNU General Public License
22
% along with this texinfo.tex file; see the file COPYING. If not, write
23
% to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24
% Boston, MA 02111-1307, USA.
25
%
26
% In other words, you are welcome to use, share and improve this program.
27
% You are forbidden to forbid anyone else to use, share and improve
28
% what you give them. Help stamp out software-hoarding!
29
%
30
% Please try the latest version of texinfo.tex before submitting bug
31
% reports; you can get the latest version from:
32
% ftp://ftp.gnu.org/gnu/texinfo.tex
33
% (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34
% ftp://texinfo.org/texinfo/texinfo.tex
35
% ftp://tug.org/tex/texinfo.tex
36
% (and all CTAN mirrors, see http://www.ctan.org),
37
% and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38
%
39
% The texinfo.tex in any given Texinfo distribution could well be out
40
% of date, so if that's what you're using, please check.
41
%
42
% Texinfo has a small home page at http://texinfo.org/ and also
43
% http://www.gnu.org/software/texinfo.
44
%
45
% Send bug reports to bug-texinfo@gnu.org. Please include including a
46
% complete document in each bug report with which we can reproduce the
47
% problem. Patches are, of course, greatly appreciated.
48
%
49
% To process a Texinfo manual with TeX, it's most reliable to use the
50
% texi2dvi shell script that comes with the distribution. For a simple
51
% manual foo.texi, however, you can get away with this:
52
% tex foo.texi
53
% texindex foo.??
54
% tex foo.texi
55
% tex foo.texi
56
% dvips foo.dvi -o # or whatever, to process the dvi file; this makes foo.ps.
57
% The extra runs of TeX get the cross-reference information correct.
58
% Sometimes one run after texindex suffices, and sometimes you need more
59
% than two; texi2dvi does it as many times as necessary.
60
%
61
% It is possible to adapt texinfo.tex for other languages. You can get
62
% the existing language-specific files from ftp://ftp.gnu.org/gnu/texinfo/.
63
64
\message{Loading texinfo [version \texinfoversion]:}
65
66
% If in a .fmt file, print the version number
67
% and turn on active characters that we couldn't do earlier because
68
% they might have appeared in the input file name.
69
\everyjob{\message{[Texinfo version \texinfoversion]}%
70
\catcode`+=\active \catcode`\_=\active}
71
72
% Save some parts of plain tex whose names we will redefine.
73
\let\ptexb=\b
74
\let\ptexbullet=\bullet
75
\let\ptexc=\c
76
\let\ptexcomma=\,
77
\let\ptexdot=\.
78
\let\ptexdots=\dots
79
\let\ptexend=\end
80
\let\ptexequiv=\equiv
81
\let\ptexexclam=\!
82
\let\ptexi=\i
83
\let\ptexlbrace=\{
84
\let\ptexrbrace=\}
85
\let\ptexstar=\*
86
\let\ptext=\t
87
88
% We never want plain's outer \+ definition in Texinfo.
89
% For @tex, we can use \tabalign.
90
\let\+ = \relax
91
92
\message{Basics,}
93
\chardef\other=12
94
95
% If this character appears in an error message or help string, it
96
% starts a new line in the output.
97
\newlinechar = `^^J
98
99
% Set up fixed words for English if not already set.
100
\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
101
\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
102
\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
103
\ifx\putwordin\undefined \gdef\putwordin{in}\fi
104
\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
105
\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
106
\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
107
\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
108
\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
109
\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
110
\ifx\putwordof\undefined \gdef\putwordof{of}\fi
111
\ifx\putwordon\undefined \gdef\putwordon{on}\fi
112
\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
113
\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
114
\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
115
\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
116
\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
117
\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
118
\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
119
%
120
\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
121
\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
122
\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
123
\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
124
\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
125
\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
126
\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
127
\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
128
\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
129
\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
130
\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
131
\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
132
%
133
\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
134
\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
135
\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
136
\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
137
\ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
138
\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
139
\ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
140
141
% Ignore a token.
142
%
143
\def\gobble#1{}
144
145
\hyphenation{ap-pen-dix}
146
\hyphenation{mini-buf-fer mini-buf-fers}
147
\hyphenation{eshell}
148
\hyphenation{white-space}
149
150
% Margin to add to right of even pages, to left of odd pages.
151
\newdimen \bindingoffset
152
\newdimen \normaloffset
153
\newdimen\pagewidth \newdimen\pageheight
154
155
% Sometimes it is convenient to have everything in the transcript file
156
% and nothing on the terminal. We don't just call \tracingall here,
157
% since that produces some useless output on the terminal.
158
%
159
\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
160
\ifx\eTeXversion\undefined
161
\def\loggingall{\tracingcommands2 \tracingstats2
162
\tracingpages1 \tracingoutput1 \tracinglostchars1
163
\tracingmacros2 \tracingparagraphs1 \tracingrestores1
164
\showboxbreadth\maxdimen\showboxdepth\maxdimen
165
}%
166
\else
167
\def\loggingall{\tracingcommands3 \tracingstats2
168
\tracingpages1 \tracingoutput1 \tracinglostchars1
169
\tracingmacros2 \tracingparagraphs1 \tracingrestores1
170
\tracingscantokens1 \tracingassigns1 \tracingifs1
171
\tracinggroups1 \tracingnesting2
172
\showboxbreadth\maxdimen\showboxdepth\maxdimen
173
}%
174
\fi
175
176
% add check for \lastpenalty to plain's definitions. If the last thing
177
% we did was a \nobreak, we don't want to insert more space.
178
%
179
\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
180
\removelastskip\penalty-50\smallskip\fi\fi}
181
\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
182
\removelastskip\penalty-100\medskip\fi\fi}
183
\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
184
\removelastskip\penalty-200\bigskip\fi\fi}
185
186
% For @cropmarks command.
187
% Do @cropmarks to get crop marks.
188
%
189
\newif\ifcropmarks
190
\let\cropmarks = \cropmarkstrue
191
%
192
% Dimensions to add cropmarks at corners.
193
% Added by P. A. MacKay, 12 Nov. 1986
194
%
195
\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
196
\newdimen\cornerlong \cornerlong=1pc
197
\newdimen\cornerthick \cornerthick=.3pt
198
\newdimen\topandbottommargin \topandbottommargin=.75in
199
200
% Main output routine.
201
\chardef\PAGE = 255
202
\output = {\onepageout{\pagecontents\PAGE}}
203
204
\newbox\headlinebox
205
\newbox\footlinebox
206
207
% \onepageout takes a vbox as an argument. Note that \pagecontents
208
% does insertions, but you have to call it yourself.
209
\def\onepageout#1{%
210
\ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
211
%
212
\ifodd\pageno \advance\hoffset by \bindingoffset
213
\else \advance\hoffset by -\bindingoffset\fi
214
%
215
% Do this outside of the \shipout so @code etc. will be expanded in
216
% the headline as they should be, not taken literally (outputting ''code).
217
\setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
218
\setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
219
%
220
{%
221
% Have to do this stuff outside the \shipout because we want it to
222
% take effect in \write's, yet the group defined by the \vbox ends
223
% before the \shipout runs.
224
%
225
\escapechar = `\\ % use backslash in output files.
226
\indexdummies % don't expand commands in the output.
227
\normalturnoffactive % \ in index entries must not stay \, e.g., if
228
% the page break happens to be in the middle of an example.
229
\shipout\vbox{%
230
% Do this early so pdf references go to the beginning of the page.
231
\ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
232
%
233
\ifcropmarks \vbox to \outervsize\bgroup
234
\hsize = \outerhsize
235
\vskip-\topandbottommargin
236
\vtop to0pt{%
237
\line{\ewtop\hfil\ewtop}%
238
\nointerlineskip
239
\line{%
240
\vbox{\moveleft\cornerthick\nstop}%
241
\hfill
242
\vbox{\moveright\cornerthick\nstop}%
243
}%
244
\vss}%
245
\vskip\topandbottommargin
246
\line\bgroup
247
\hfil % center the page within the outer (page) hsize.
248
\ifodd\pageno\hskip\bindingoffset\fi
249
\vbox\bgroup
250
\fi
251
%
252
\unvbox\headlinebox
253
\pagebody{#1}%
254
\ifdim\ht\footlinebox > 0pt
255
% Only leave this space if the footline is nonempty.
256
% (We lessened \vsize for it in \oddfootingxxx.)
257
% The \baselineskip=24pt in plain's \makefootline has no effect.
258
\vskip 2\baselineskip
259
\unvbox\footlinebox
260
\fi
261
%
262
\ifcropmarks
263
\egroup % end of \vbox\bgroup
264
\hfil\egroup % end of (centering) \line\bgroup
265
\vskip\topandbottommargin plus1fill minus1fill
266
\boxmaxdepth = \cornerthick
267
\vbox to0pt{\vss
268
\line{%
269
\vbox{\moveleft\cornerthick\nsbot}%
270
\hfill
271
\vbox{\moveright\cornerthick\nsbot}%
272
}%
273
\nointerlineskip
274
\line{\ewbot\hfil\ewbot}%
275
}%
276
\egroup % \vbox from first cropmarks clause
277
\fi
278
}% end of \shipout\vbox
279
}% end of group with \turnoffactive
280
\advancepageno
281
\ifnum\outputpenalty>-20000 \else\dosupereject\fi
282
}
283
284
\newinsert\margin \dimen\margin=\maxdimen
285
286
\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
287
{\catcode`\@ =11
288
\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
289
% marginal hacks, juha@viisa.uucp (Juha Takala)
290
\ifvoid\margin\else % marginal info is present
291
\rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
292
\dimen@=\dp#1 \unvbox#1
293
\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
294
\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
295
}
296
297
% Here are the rules for the cropmarks. Note that they are
298
% offset so that the space between them is truly \outerhsize or \outervsize
299
% (P. A. MacKay, 12 November, 1986)
300
%
301
\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
302
\def\nstop{\vbox
303
{\hrule height\cornerthick depth\cornerlong width\cornerthick}}
304
\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
305
\def\nsbot{\vbox
306
{\hrule height\cornerlong depth\cornerthick width\cornerthick}}
307
308
% Parse an argument, then pass it to #1. The argument is the rest of
309
% the input line (except we remove a trailing comment). #1 should be a
310
% macro which expects an ordinary undelimited TeX argument.
311
%
312
\def\parsearg#1{%
313
\let\next = #1%
314
\begingroup
315
\obeylines
316
\futurelet\temp\parseargx
317
}
318
319
% If the next token is an obeyed space (from an @example environment or
320
% the like), remove it and recurse. Otherwise, we're done.
321
\def\parseargx{%
322
% \obeyedspace is defined far below, after the definition of \sepspaces.
323
\ifx\obeyedspace\temp
324
\expandafter\parseargdiscardspace
325
\else
326
\expandafter\parseargline
327
\fi
328
}
329
330
% Remove a single space (as the delimiter token to the macro call).
331
{\obeyspaces %
332
\gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
333
334
{\obeylines %
335
\gdef\parseargline#1^^M{%
336
\endgroup % End of the group started in \parsearg.
337
%
338
% First remove any @c comment, then any @comment.
339
% Result of each macro is put in \toks0.
340
\argremovec #1\c\relax %
341
\expandafter\argremovecomment \the\toks0 \comment\relax %
342
%
343
% Call the caller's macro, saved as \next in \parsearg.
344
\expandafter\next\expandafter{\the\toks0}%
345
}%
346
}
347
348
% Since all \c{,omment} does is throw away the argument, we can let TeX
349
% do that for us. The \relax here is matched by the \relax in the call
350
% in \parseargline; it could be more or less anything, its purpose is
351
% just to delimit the argument to the \c.
352
\def\argremovec#1\c#2\relax{\toks0 = {#1}}
353
\def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
354
355
% \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
356
% @end itemize @c foo
357
% will have two active spaces as part of the argument with the
358
% `itemize'. Here we remove all active spaces from #1, and assign the
359
% result to \toks0.
360
%
361
% This loses if there are any *other* active characters besides spaces
362
% in the argument -- _ ^ +, for example -- since they get expanded.
363
% Fortunately, Texinfo does not define any such commands. (If it ever
364
% does, the catcode of the characters in questionwill have to be changed
365
% here.) But this means we cannot call \removeactivespaces as part of
366
% \argremovec{,omment}, since @c uses \parsearg, and thus the argument
367
% that \parsearg gets might well have any character at all in it.
368
%
369
\def\removeactivespaces#1{%
370
\begingroup
371
\ignoreactivespaces
372
\edef\temp{#1}%
373
\global\toks0 = \expandafter{\temp}%
374
\endgroup
375
}
376
377
% Change the active space to expand to nothing.
378
%
379
\begingroup
380
\obeyspaces
381
\gdef\ignoreactivespaces{\obeyspaces\let =\empty}
382
\endgroup
383
384
385
\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
386
387
%% These are used to keep @begin/@end levels from running away
388
%% Call \inENV within environments (after a \begingroup)
389
\newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
390
\def\ENVcheck{%
391
\ifENV\errmessage{Still within an environment; press RETURN to continue}
392
\endgroup\fi} % This is not perfect, but it should reduce lossage
393
394
% @begin foo is the same as @foo, for now.
395
\newhelp\EMsimple{Press RETURN to continue.}
396
397
\outer\def\begin{\parsearg\beginxxx}
398
399
\def\beginxxx #1{%
400
\expandafter\ifx\csname #1\endcsname\relax
401
{\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
402
\csname #1\endcsname\fi}
403
404
% @end foo executes the definition of \Efoo.
405
%
406
\def\end{\parsearg\endxxx}
407
\def\endxxx #1{%
408
\removeactivespaces{#1}%
409
\edef\endthing{\the\toks0}%
410
%
411
\expandafter\ifx\csname E\endthing\endcsname\relax
412
\expandafter\ifx\csname \endthing\endcsname\relax
413
% There's no \foo, i.e., no ``environment'' foo.
414
\errhelp = \EMsimple
415
\errmessage{Undefined command `@end \endthing'}%
416
\else
417
\unmatchedenderror\endthing
418
\fi
419
\else
420
% Everything's ok; the right environment has been started.
421
\csname E\endthing\endcsname
422
\fi
423
}
424
425
% There is an environment #1, but it hasn't been started. Give an error.
426
%
427
\def\unmatchedenderror#1{%
428
\errhelp = \EMsimple
429
\errmessage{This `@end #1' doesn't have a matching `@#1'}%
430
}
431
432
% Define the control sequence \E#1 to give an unmatched @end error.
433
%
434
\def\defineunmatchedend#1{%
435
\expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
436
}
437
438
439
% Single-spacing is done by various environments (specifically, in
440
% \nonfillstart and \quotations).
441
\newskip\singlespaceskip \singlespaceskip = 12.5pt
442
\def\singlespace{%
443
% Why was this kern here? It messes up equalizing space above and below
444
% environments. --karl, 6may93
445
%{\advance \baselineskip by -\singlespaceskip
446
%\kern \baselineskip}%
447
\setleading\singlespaceskip
448
}
449
450
%% Simple single-character @ commands
451
452
% @@ prints an @
453
% Kludge this until the fonts are right (grr).
454
\def\@{{\tt\char64}}
455
456
% This is turned off because it was never documented
457
% and you can use @w{...} around a quote to suppress ligatures.
458
%% Define @` and @' to be the same as ` and '
459
%% but suppressing ligatures.
460
%\def\`{{`}}
461
%\def\'{{'}}
462
463
% Used to generate quoted braces.
464
\def\mylbrace {{\tt\char123}}
465
\def\myrbrace {{\tt\char125}}
466
\let\{=\mylbrace
467
\let\}=\myrbrace
468
\begingroup
469
% Definitions to produce actual \{ & \} command in an index.
470
\catcode`\{ = 12 \catcode`\} = 12
471
\catcode`\[ = 1 \catcode`\] = 2
472
\catcode`\@ = 0 \catcode`\\ = 12
473
@gdef@lbracecmd[\{]%
474
@gdef@rbracecmd[\}]%
475
@endgroup
476
477
% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
478
% Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
479
\let\, = \c
480
\let\dotaccent = \.
481
\def\ringaccent#1{{\accent23 #1}}
482
\let\tieaccent = \t
483
\let\ubaraccent = \b
484
\let\udotaccent = \d
485
486
% Other special characters: @questiondown @exclamdown
487
% Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
488
\def\questiondown{?`}
489
\def\exclamdown{!`}
490
491
% Dotless i and dotless j, used for accents.
492
\def\imacro{i}
493
\def\jmacro{j}
494
\def\dotless#1{%
495
\def\temp{#1}%
496
\ifx\temp\imacro \ptexi
497
\else\ifx\temp\jmacro \j
498
\else \errmessage{@dotless can be used only with i or j}%
499
\fi\fi
500
}
501
502
% Be sure we're in horizontal mode when doing a tie, since we make space
503
% equivalent to this in @example-like environments. Otherwise, a space
504
% at the beginning of a line will start with \penalty -- and
505
% since \penalty is valid in vertical mode, we'd end up putting the
506
% penalty on the vertical list instead of in the new paragraph.
507
{\catcode`@ = 11
508
% Avoid using \@M directly, because that causes trouble
509
% if the definition is written into an index file.
510
\global\let\tiepenalty = \@M
511
\gdef\tie{\leavevmode\penalty\tiepenalty\ }
512
}
513
514
% @: forces normal size whitespace following.
515
\def\:{\spacefactor=1000 }
516
517
% @* forces a line break.
518
\def\*{\hfil\break\hbox{}\ignorespaces}
519
520
% @. is an end-of-sentence period.
521
\def\.{.\spacefactor=3000 }
522
523
% @! is an end-of-sentence bang.
524
\def\!{!\spacefactor=3000 }
525
526
% @? is an end-of-sentence query.
527
\def\?{?\spacefactor=3000 }
528
529
% @w prevents a word break. Without the \leavevmode, @w at the
530
% beginning of a paragraph, when TeX is still in vertical mode, would
531
% produce a whole line of output instead of starting the paragraph.
532
\def\w#1{\leavevmode\hbox{#1}}
533
534
% @group ... @end group forces ... to be all on one page, by enclosing
535
% it in a TeX vbox. We use \vtop instead of \vbox to construct the box
536
% to keep its height that of a normal line. According to the rules for
537
% \topskip (p.114 of the TeXbook), the glue inserted is
538
% max (\topskip - \ht (first item), 0). If that height is large,
539
% therefore, no glue is inserted, and the space between the headline and
540
% the text is small, which looks bad.
541
%
542
\def\group{\begingroup
543
\ifnum\catcode13=\active \else
544
\errhelp = \groupinvalidhelp
545
\errmessage{@group invalid in context where filling is enabled}%
546
\fi
547
%
548
% The \vtop we start below produces a box with normal height and large
549
% depth; thus, TeX puts \baselineskip glue before it, and (when the
550
% next line of text is done) \lineskip glue after it. (See p.82 of
551
% the TeXbook.) Thus, space below is not quite equal to space
552
% above. But it's pretty close.
553
\def\Egroup{%
554
\egroup % End the \vtop.
555
\endgroup % End the \group.
556
}%
557
%
558
\vtop\bgroup
559
% We have to put a strut on the last line in case the @group is in
560
% the midst of an example, rather than completely enclosing it.
561
% Otherwise, the interline space between the last line of the group
562
% and the first line afterwards is too small. But we can't put the
563
% strut in \Egroup, since there it would be on a line by itself.
564
% Hence this just inserts a strut at the beginning of each line.
565
\everypar = {\strut}%
566
%
567
% Since we have a strut on every line, we don't need any of TeX's
568
% normal interline spacing.
569
\offinterlineskip
570
%
571
% OK, but now we have to do something about blank
572
% lines in the input in @example-like environments, which normally
573
% just turn into \lisppar, which will insert no space now that we've
574
% turned off the interline space. Simplest is to make them be an
575
% empty paragraph.
576
\ifx\par\lisppar
577
\edef\par{\leavevmode \par}%
578
%
579
% Reset ^^M's definition to new definition of \par.
580
\obeylines
581
\fi
582
%
583
% Do @comment since we are called inside an environment such as
584
% @example, where each end-of-line in the input causes an
585
% end-of-line in the output. We don't want the end-of-line after
586
% the `@group' to put extra space in the output. Since @group
587
% should appear on a line by itself (according to the Texinfo
588
% manual), we don't worry about eating any user text.
589
\comment
590
}
591
%
592
% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
593
% message, so this ends up printing `@group can only ...'.
594
%
595
\newhelp\groupinvalidhelp{%
596
group can only be used in environments such as @example,^^J%
597
where each line of input produces a line of output.}
598
599
% @need space-in-mils
600
% forces a page break if there is not space-in-mils remaining.
601
602
\newdimen\mil \mil=0.001in
603
604
\def\need{\parsearg\needx}
605
606
% Old definition--didn't work.
607
%\def\needx #1{\par %
608
%% This method tries to make TeX break the page naturally
609
%% if the depth of the box does not fit.
610
%{\baselineskip=0pt%
611
%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
612
%\prevdepth=-1000pt
613
%}}
614
615
\def\needx#1{%
616
% Ensure vertical mode, so we don't make a big box in the middle of a
617
% paragraph.
618
\par
619
%
620
% If the @need value is less than one line space, it's useless.
621
\dimen0 = #1\mil
622
\dimen2 = \ht\strutbox
623
\advance\dimen2 by \dp\strutbox
624
\ifdim\dimen0 > \dimen2
625
%
626
% Do a \strut just to make the height of this box be normal, so the
627
% normal leading is inserted relative to the preceding line.
628
% And a page break here is fine.
629
\vtop to #1\mil{\strut\vfil}%
630
%
631
% TeX does not even consider page breaks if a penalty added to the
632
% main vertical list is 10000 or more. But in order to see if the
633
% empty box we just added fits on the page, we must make it consider
634
% page breaks. On the other hand, we don't want to actually break the
635
% page after the empty box. So we use a penalty of 9999.
636
%
637
% There is an extremely small chance that TeX will actually break the
638
% page at this \penalty, if there are no other feasible breakpoints in
639
% sight. (If the user is using lots of big @group commands, which
640
% almost-but-not-quite fill up a page, TeX will have a hard time doing
641
% good page breaking, for example.) However, I could not construct an
642
% example where a page broke at this \penalty; if it happens in a real
643
% document, then we can reconsider our strategy.
644
\penalty9999
645
%
646
% Back up by the size of the box, whether we did a page break or not.
647
\kern -#1\mil
648
%
649
% Do not allow a page break right after this kern.
650
\nobreak
651
\fi
652
}
653
654
% @br forces paragraph break
655
656
\let\br = \par
657
658
% @dots{} output an ellipsis using the current font.
659
% We do .5em per period so that it has the same spacing in a typewriter
660
% font as three actual period characters.
661
%
662
\def\dots{%
663
\leavevmode
664
\hbox to 1.5em{%
665
\hskip 0pt plus 0.25fil minus 0.25fil
666
.\hss.\hss.%
667
\hskip 0pt plus 0.5fil minus 0.5fil
668
}%
669
}
670
671
% @enddots{} is an end-of-sentence ellipsis.
672
%
673
\def\enddots{%
674
\leavevmode
675
\hbox to 2em{%
676
\hskip 0pt plus 0.25fil minus 0.25fil
677
.\hss.\hss.\hss.%
678
\hskip 0pt plus 0.5fil minus 0.5fil
679
}%
680
\spacefactor=3000
681
}
682
683
684
% @page forces the start of a new page
685
%
686
\def\page{\par\vfill\supereject}
687
688
% @exdent text....
689
% outputs text on separate line in roman font, starting at standard page margin
690
691
% This records the amount of indent in the innermost environment.
692
% That's how much \exdent should take out.
693
\newskip\exdentamount
694
695
% This defn is used inside fill environments such as @defun.
696
\def\exdent{\parsearg\exdentyyy}
697
\def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
698
699
% This defn is used inside nofill environments such as @example.
700
\def\nofillexdent{\parsearg\nofillexdentyyy}
701
\def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
702
\leftline{\hskip\leftskip{\rm#1}}}}
703
704
% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
705
% paragraph. For more general purposes, use the \margin insertion
706
% class. WHICH is `l' or `r'.
707
%
708
\newskip\inmarginspacing \inmarginspacing=1cm
709
\def\strutdepth{\dp\strutbox}
710
%
711
\def\doinmargin#1#2{\strut\vadjust{%
712
\nobreak
713
\kern-\strutdepth
714
\vtop to \strutdepth{%
715
\baselineskip=\strutdepth
716
\vss
717
% if you have multiple lines of stuff to put here, you'll need to
718
% make the vbox yourself of the appropriate size.
719
\ifx#1l%
720
\llap{\ignorespaces #2\hskip\inmarginspacing}%
721
\else
722
\rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
723
\fi
724
\null
725
}%
726
}}
727
\def\inleftmargin{\doinmargin l}
728
\def\inrightmargin{\doinmargin r}
729
%
730
% @inmargin{TEXT [, RIGHT-TEXT]}
731
% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
732
% else use TEXT for both).
733
%
734
\def\inmargin#1{\parseinmargin #1,,\finish}
735
\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
736
\setbox0 = \hbox{\ignorespaces #2}%
737
\ifdim\wd0 > 0pt
738
\def\lefttext{#1}% have both texts
739
\def\righttext{#2}%
740
\else
741
\def\lefttext{#1}% have only one text
742
\def\righttext{#1}%
743
\fi
744
%
745
\ifodd\pageno
746
\def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
747
\else
748
\def\temp{\inleftmargin\lefttext}%
749
\fi
750
\temp
751
}
752
753
% @include file insert text of that file as input.
754
% Allow normal characters that we make active in the argument (a file name).
755
\def\include{\begingroup
756
\catcode`\\=12
757
\catcode`~=12
758
\catcode`^=12
759
\catcode`_=12
760
\catcode`|=12
761
\catcode`<=12
762
\catcode`>=12
763
\catcode`+=12
764
\parsearg\includezzz}
765
% Restore active chars for included file.
766
\def\includezzz#1{\endgroup\begingroup
767
% Read the included file in a group so nested @include's work.
768
\def\thisfile{#1}%
769
\input\thisfile
770
\endgroup}
771
772
\def\thisfile{}
773
774
% @center line outputs that line, centered
775
776
\def\center{\parsearg\centerzzz}
777
\def\centerzzz #1{{\advance\hsize by -\leftskip
778
\advance\hsize by -\rightskip
779
\centerline{#1}}}
780
781
% @sp n outputs n lines of vertical space
782
783
\def\sp{\parsearg\spxxx}
784
\def\spxxx #1{\vskip #1\baselineskip}
785
786
% @comment ...line which is ignored...
787
% @c is the same as @comment
788
% @ignore ... @end ignore is another way to write a comment
789
790
\def\comment{\begingroup \catcode`\^^M=\other%
791
\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
792
\commentxxx}
793
{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
794
795
\let\c=\comment
796
797
% @paragraphindent NCHARS
798
% We'll use ems for NCHARS, close enough.
799
% We cannot implement @paragraphindent asis, though.
800
%
801
\def\asisword{asis} % no translation, these are keywords
802
\def\noneword{none}
803
%
804
\def\paragraphindent{\parsearg\doparagraphindent}
805
\def\doparagraphindent#1{%
806
\def\temp{#1}%
807
\ifx\temp\asisword
808
\else
809
\ifx\temp\noneword
810
\defaultparindent = 0pt
811
\else
812
\defaultparindent = #1em
813
\fi
814
\fi
815
\parindent = \defaultparindent
816
}
817
818
% @exampleindent NCHARS
819
% We'll use ems for NCHARS like @paragraphindent.
820
% It seems @exampleindent asis isn't necessary, but
821
% I preserve it to make it similar to @paragraphindent.
822
\def\exampleindent{\parsearg\doexampleindent}
823
\def\doexampleindent#1{%
824
\def\temp{#1}%
825
\ifx\temp\asisword
826
\else
827
\ifx\temp\noneword
828
\lispnarrowing = 0pt
829
\else
830
\lispnarrowing = #1em
831
\fi
832
\fi
833
}
834
835
% @asis just yields its argument. Used with @table, for example.
836
%
837
\def\asis#1{#1}
838
839
% @math means output in math mode.
840
% We don't use $'s directly in the definition of \math because control
841
% sequences like \math are expanded when the toc file is written. Then,
842
% we read the toc file back, the $'s will be normal characters (as they
843
% should be, according to the definition of Texinfo). So we must use a
844
% control sequence to switch into and out of math mode.
845
%
846
% This isn't quite enough for @math to work properly in indices, but it
847
% seems unlikely it will ever be needed there.
848
%
849
\let\implicitmath = $
850
\def\math#1{\implicitmath #1\implicitmath}
851
852
% @bullet and @minus need the same treatment as @math, just above.
853
\def\bullet{\implicitmath\ptexbullet\implicitmath}
854
\def\minus{\implicitmath-\implicitmath}
855
856
% @refill is a no-op.
857
\let\refill=\relax
858
859
% If working on a large document in chapters, it is convenient to
860
% be able to disable indexing, cross-referencing, and contents, for test runs.
861
% This is done with @novalidate (before @setfilename).
862
%
863
\newif\iflinks \linkstrue % by default we want the aux files.
864
\let\novalidate = \linksfalse
865
866
% @setfilename is done at the beginning of every texinfo file.
867
% So open here the files we need to have open while reading the input.
868
% This makes it possible to make a .fmt file for texinfo.
869
\def\setfilename{%
870
\iflinks
871
\readauxfile
872
\fi % \openindices needs to do some work in any case.
873
\openindices
874
\fixbackslash % Turn off hack to swallow `\input texinfo'.
875
\global\let\setfilename=\comment % Ignore extra @setfilename cmds.
876
%
877
% If texinfo.cnf is present on the system, read it.
878
% Useful for site-wide @afourpaper, etc.
879
% Just to be on the safe side, close the input stream before the \input.
880
\openin 1 texinfo.cnf
881
\ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
882
\closein1
883
\temp
884
%
885
\comment % Ignore the actual filename.
886
}
887
888
% Called from \setfilename.
889
%
890
\def\openindices{%
891
\newindex{cp}%
892
\newcodeindex{fn}%
893
\newcodeindex{vr}%
894
\newcodeindex{tp}%
895
\newcodeindex{ky}%
896
\newcodeindex{pg}%
897
}
898
899
% @bye.
900
\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
901
902
903
\message{pdf,}
904
% adobe `portable' document format
905
\newcount\tempnum
906
\newcount\lnkcount
907
\newtoks\filename
908
\newcount\filenamelength
909
\newcount\pgn
910
\newtoks\toksA
911
\newtoks\toksB
912
\newtoks\toksC
913
\newtoks\toksD
914
\newbox\boxA
915
\newcount\countA
916
\newif\ifpdf
917
\newif\ifpdfmakepagedest
918
919
\ifx\pdfoutput\undefined
920
\pdffalse
921
\let\pdfmkdest = \gobble
922
\let\pdfurl = \gobble
923
\let\endlink = \relax
924
\let\linkcolor = \relax
925
\let\pdfmakeoutlines = \relax
926
\else
927
\pdftrue
928
\pdfoutput = 1
929
\input pdfcolor
930
\def\dopdfimage#1#2#3{%
931
\def\imagewidth{#2}%
932
\def\imageheight{#3}%
933
\ifnum\pdftexversion < 14
934
\pdfimage
935
\else
936
\pdfximage
937
\fi
938
\ifx\empty\imagewidth\else width \imagewidth \fi
939
\ifx\empty\imageheight\else height \imageheight \fi
940
\ifnum\pdftexversion<13
941
#1.pdf%
942
\else
943
{#1.pdf}%
944
\fi
945
\ifnum\pdftexversion < 14 \else
946
\pdfrefximage \pdflastximage
947
\fi}
948
\def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
949
\def\pdfmkpgn#1{#1@}
950
\let\linkcolor = \Blue % was Cyan, but that seems light?
951
\def\endlink{\Black\pdfendlink}
952
% Adding outlines to PDF; macros for calculating structure of outlines
953
% come from Petr Olsak
954
\def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
955
\else \csname#1\endcsname \fi}
956
\def\advancenumber#1{\tempnum=\expnumber{#1}\relax
957
\advance\tempnum by1
958
\expandafter\xdef\csname#1\endcsname{\the\tempnum}}
959
\def\pdfmakeoutlines{{%
960
\openin 1 \jobname.toc
961
\ifeof 1\else\bgroup
962
\closein 1
963
\indexnofonts
964
\def\tt{}
965
\let\_ = \normalunderscore
966
% Thanh's hack / proper braces in bookmarks
967
\edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
968
\edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
969
%
970
\def\chapentry ##1##2##3{}
971
\def\unnumbchapentry ##1##2{}
972
\def\secentry ##1##2##3##4{\advancenumber{chap##2}}
973
\def\unnumbsecentry ##1##2{}
974
\def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
975
\def\unnumbsubsecentry ##1##2{}
976
\def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
977
\def\unnumbsubsubsecentry ##1##2{}
978
\input \jobname.toc
979
\def\chapentry ##1##2##3{%
980
\pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
981
\def\unnumbchapentry ##1##2{%
982
\pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
983
\def\secentry ##1##2##3##4{%
984
\pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
985
\def\unnumbsecentry ##1##2{%
986
\pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
987
\def\subsecentry ##1##2##3##4##5{%
988
\pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
989
\def\unnumbsubsecentry ##1##2{%
990
\pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
991
\def\subsubsecentry ##1##2##3##4##5##6{%
992
\pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
993
\def\unnumbsubsubsecentry ##1##2{%
994
\pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
995
\input \jobname.toc
996
\egroup\fi
997
}}
998
\def\makelinks #1,{%
999
\def\params{#1}\def\E{END}%
1000
\ifx\params\E
1001
\let\nextmakelinks=\relax
1002
\else
1003
\let\nextmakelinks=\makelinks
1004
\ifnum\lnkcount>0,\fi
1005
\picknum{#1}%
1006
\startlink attr{/Border [0 0 0]}
1007
goto name{\pdfmkpgn{\the\pgn}}%
1008
\linkcolor #1%
1009
\advance\lnkcount by 1%
1010
\endlink
1011
\fi
1012
\nextmakelinks
1013
}
1014
\def\picknum#1{\expandafter\pn#1}
1015
\def\pn#1{%
1016
\def\p{#1}%
1017
\ifx\p\lbrace
1018
\let\nextpn=\ppn
1019
\else
1020
\let\nextpn=\ppnn
1021
\def\first{#1}
1022
\fi
1023
\nextpn
1024
}
1025
\def\ppn#1{\pgn=#1\gobble}
1026
\def\ppnn{\pgn=\first}
1027
\def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1028
\def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1029
\def\skipspaces#1{\def\PP{#1}\def\D{|}%
1030
\ifx\PP\D\let\nextsp\relax
1031
\else\let\nextsp\skipspaces
1032
\ifx\p\space\else\addtokens{\filename}{\PP}%
1033
\advance\filenamelength by 1
1034
\fi
1035
\fi
1036
\nextsp}
1037
\def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1038
\ifnum\pdftexversion < 14
1039
\let \startlink \pdfannotlink
1040
\else
1041
\let \startlink \pdfstartlink
1042
\fi
1043
\def\pdfurl#1{%
1044
\begingroup
1045
\normalturnoffactive\def\@{@}%
1046
\let\value=\expandablevalue
1047
\leavevmode\Red
1048
\startlink attr{/Border [0 0 0]}%
1049
user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1050
% #1
1051
\endgroup}
1052
\def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1053
\def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1054
\def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1055
\def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1056
\def\maketoks{%
1057
\expandafter\poptoks\the\toksA|ENDTOKS|
1058
\ifx\first0\adn0
1059
\else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1060
\else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1061
\else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1062
\else
1063
\ifnum0=\countA\else\makelink\fi
1064
\ifx\first.\let\next=\done\else
1065
\let\next=\maketoks
1066
\addtokens{\toksB}{\the\toksD}
1067
\ifx\first,\addtokens{\toksB}{\space}\fi
1068
\fi
1069
\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1070
\next}
1071
\def\makelink{\addtokens{\toksB}%
1072
{\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1073
\def\pdflink#1{%
1074
\startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1075
\linkcolor #1\endlink}
1076
\def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1077
\fi % \ifx\pdfoutput
1078
1079
1080
\message{fonts,}
1081
% Font-change commands.
1082
1083
% Texinfo sort of supports the sans serif font style, which plain TeX does not.
1084
% So we set up a \sf analogous to plain's \rm, etc.
1085
\newfam\sffam
1086
\def\sf{\fam=\sffam \tensf}
1087
\let\li = \sf % Sometimes we call it \li, not \sf.
1088
1089
% We don't need math for this one.
1090
\def\ttsl{\tenttsl}
1091
1092
% Default leading.
1093
\newdimen\textleading \textleading = 13.2pt
1094
1095
% Set the baselineskip to #1, and the lineskip and strut size
1096
% correspondingly. There is no deep meaning behind these magic numbers
1097
% used as factors; they just match (closely enough) what Knuth defined.
1098
%
1099
\def\lineskipfactor{.08333}
1100
\def\strutheightpercent{.70833}
1101
\def\strutdepthpercent {.29167}
1102
%
1103
\def\setleading#1{%
1104
\normalbaselineskip = #1\relax
1105
\normallineskip = \lineskipfactor\normalbaselineskip
1106
\normalbaselines
1107
\setbox\strutbox =\hbox{%
1108
\vrule width0pt height\strutheightpercent\baselineskip
1109
depth \strutdepthpercent \baselineskip
1110
}%
1111
}
1112
1113
% Use Computer Modern fonts at \magstephalf (11pt).
1114
\newcount\mainmagstep \mainmagstep=\magstephalf
1115
1116
% Set the font macro #1 to the font named #2, adding on the
1117
% specified font prefix (normally `cm').
1118
% #3 is the font's design size, #4 is a scale factor
1119
\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1120
1121
% Use cm as the default font prefix.
1122
% To specify the font prefix, you must define \fontprefix
1123
% before you read in texinfo.tex.
1124
\ifx\fontprefix\undefined
1125
\def\fontprefix{cm}
1126
\fi
1127
% Support font families that don't use the same naming scheme as CM.
1128
\def\rmshape{r}
1129
\def\rmbshape{bx} %where the normal face is bold
1130
\def\bfshape{b}
1131
\def\bxshape{bx}
1132
\def\ttshape{tt}
1133
\def\ttbshape{tt}
1134
\def\ttslshape{sltt}
1135
\def\itshape{ti}
1136
\def\itbshape{bxti}
1137
\def\slshape{sl}
1138
\def\slbshape{bxsl}
1139
\def\sfshape{ss}
1140
\def\sfbshape{ss}
1141
\def\scshape{csc}
1142
\def\scbshape{csc}
1143
1144
\ifx\bigger\relax
1145
\let\mainmagstep=\magstep1
1146
\setfont\textrm\rmshape{12}{1000}
1147
\setfont\texttt\ttshape{12}{1000}
1148
\else
1149
\setfont\textrm\rmshape{10}{\mainmagstep}
1150
\setfont\texttt\ttshape{10}{\mainmagstep}
1151
\fi
1152
% Instead of cmb10, you many want to use cmbx10.
1153
% cmbx10 is a prettier font on its own, but cmb10
1154
% looks better when embedded in a line with cmr10.
1155
\setfont\textbf\bfshape{10}{\mainmagstep}
1156
\setfont\textit\itshape{10}{\mainmagstep}
1157
\setfont\textsl\slshape{10}{\mainmagstep}
1158
\setfont\textsf\sfshape{10}{\mainmagstep}
1159
\setfont\textsc\scshape{10}{\mainmagstep}
1160
\setfont\textttsl\ttslshape{10}{\mainmagstep}
1161
\font\texti=cmmi10 scaled \mainmagstep
1162
\font\textsy=cmsy10 scaled \mainmagstep
1163
1164
% A few fonts for @defun, etc.
1165
\setfont\defbf\bxshape{10}{\magstep1} %was 1314
1166
\setfont\deftt\ttshape{10}{\magstep1}
1167
\def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1168
1169
% Fonts for indices, footnotes, small examples (9pt).
1170
\setfont\smallrm\rmshape{9}{1000}
1171
\setfont\smalltt\ttshape{9}{1000}
1172
\setfont\smallbf\bfshape{10}{900}
1173
\setfont\smallit\itshape{9}{1000}
1174
\setfont\smallsl\slshape{9}{1000}
1175
\setfont\smallsf\sfshape{9}{1000}
1176
\setfont\smallsc\scshape{10}{900}
1177
\setfont\smallttsl\ttslshape{10}{900}
1178
\font\smalli=cmmi9
1179
\font\smallsy=cmsy9
1180
1181
% Fonts for small examples (8pt).
1182
\setfont\smallerrm\rmshape{8}{1000}
1183
\setfont\smallertt\ttshape{8}{1000}
1184
\setfont\smallerbf\bfshape{10}{800}
1185
\setfont\smallerit\itshape{8}{1000}
1186
\setfont\smallersl\slshape{8}{1000}
1187
\setfont\smallersf\sfshape{8}{1000}
1188
\setfont\smallersc\scshape{10}{800}
1189
\setfont\smallerttsl\ttslshape{10}{800}
1190
\font\smalleri=cmmi8
1191
\font\smallersy=cmsy8
1192
1193
% Fonts for title page:
1194
\setfont\titlerm\rmbshape{12}{\magstep3}
1195
\setfont\titleit\itbshape{10}{\magstep4}
1196
\setfont\titlesl\slbshape{10}{\magstep4}
1197
\setfont\titlett\ttbshape{12}{\magstep3}
1198
\setfont\titlettsl\ttslshape{10}{\magstep4}
1199
\setfont\titlesf\sfbshape{17}{\magstep1}
1200
\let\titlebf=\titlerm
1201
\setfont\titlesc\scbshape{10}{\magstep4}
1202
\font\titlei=cmmi12 scaled \magstep3
1203
\font\titlesy=cmsy10 scaled \magstep4
1204
\def\authorrm{\secrm}
1205
1206
% Chapter (and unnumbered) fonts (17.28pt).
1207
\setfont\chaprm\rmbshape{12}{\magstep2}
1208
\setfont\chapit\itbshape{10}{\magstep3}
1209
\setfont\chapsl\slbshape{10}{\magstep3}
1210
\setfont\chaptt\ttbshape{12}{\magstep2}
1211
\setfont\chapttsl\ttslshape{10}{\magstep3}
1212
\setfont\chapsf\sfbshape{17}{1000}
1213
\let\chapbf=\chaprm
1214
\setfont\chapsc\scbshape{10}{\magstep3}
1215
\font\chapi=cmmi12 scaled \magstep2
1216
\font\chapsy=cmsy10 scaled \magstep3
1217
1218
% Section fonts (14.4pt).
1219
\setfont\secrm\rmbshape{12}{\magstep1}
1220
\setfont\secit\itbshape{10}{\magstep2}
1221
\setfont\secsl\slbshape{10}{\magstep2}
1222
\setfont\sectt\ttbshape{12}{\magstep1}
1223
\setfont\secttsl\ttslshape{10}{\magstep2}
1224
\setfont\secsf\sfbshape{12}{\magstep1}
1225
\let\secbf\secrm
1226
\setfont\secsc\scbshape{10}{\magstep2}
1227
\font\seci=cmmi12 scaled \magstep1
1228
\font\secsy=cmsy10 scaled \magstep2
1229
1230
% \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1231
% \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1232
% \setfont\ssecsl\slshape{10}{\magstep1}
1233
% \setfont\ssectt\ttshape{10}{\magstep1}
1234
% \setfont\ssecsf\sfshape{10}{\magstep1}
1235
1236
%\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1237
%\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1238
%\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1239
%\setfont\ssectt\ttshape{10}{1315}
1240
%\setfont\ssecsf\sfshape{10}{1315}
1241
1242
%\let\ssecbf=\ssecrm
1243
1244
% Subsection fonts (13.15pt).
1245
\setfont\ssecrm\rmbshape{12}{\magstephalf}
1246
\setfont\ssecit\itbshape{10}{1315}
1247
\setfont\ssecsl\slbshape{10}{1315}
1248
\setfont\ssectt\ttbshape{12}{\magstephalf}
1249
\setfont\ssecttsl\ttslshape{10}{1315}
1250
\setfont\ssecsf\sfbshape{12}{\magstephalf}
1251
\let\ssecbf\ssecrm
1252
\setfont\ssecsc\scbshape{10}{\magstep1}
1253
\font\sseci=cmmi12 scaled \magstephalf
1254
\font\ssecsy=cmsy10 scaled 1315
1255
% The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1256
% but that is not a standard magnification.
1257
1258
% In order for the font changes to affect most math symbols and letters,
1259
% we have to define the \textfont of the standard families. Since
1260
% texinfo doesn't allow for producing subscripts and superscripts, we
1261
% don't bother to reset \scriptfont and \scriptscriptfont (which would
1262
% also require loading a lot more fonts).
1263
%
1264
\def\resetmathfonts{%
1265
\textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1266
\textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1267
\textfont\ttfam = \tentt \textfont\sffam = \tensf
1268
}
1269
1270
1271
% The font-changing commands redefine the meanings of \tenSTYLE, instead
1272
% of just \STYLE. We do this so that font changes will continue to work
1273
% in math mode, where it is the current \fam that is relevant in most
1274
% cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1275
% \tenbf}, for example. By redefining \tenbf, we obviate the need to
1276
% redefine \bf itself.
1277
\def\textfonts{%
1278
\let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1279
\let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1280
\let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1281
\resetmathfonts \setleading{\textleading}}
1282
\def\titlefonts{%
1283
\let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1284
\let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1285
\let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1286
\let\tenttsl=\titlettsl
1287
\resetmathfonts \setleading{25pt}}
1288
\def\titlefont#1{{\titlefonts\rm #1}}
1289
\def\chapfonts{%
1290
\let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1291
\let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1292
\let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1293
\resetmathfonts \setleading{19pt}}
1294
\def\secfonts{%
1295
\let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1296
\let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1297
\let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1298
\resetmathfonts \setleading{16pt}}
1299
\def\subsecfonts{%
1300
\let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1301
\let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1302
\let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1303
\resetmathfonts \setleading{15pt}}
1304
\let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1305
\def\smallfonts{%
1306
\let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1307
\let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1308
\let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1309
\let\tenttsl=\smallttsl
1310
\resetmathfonts \setleading{10.5pt}}
1311
\def\smallerfonts{%
1312
\let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1313
\let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1314
\let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1315
\let\tenttsl=\smallerttsl
1316
\resetmathfonts \setleading{9.5pt}}
1317
\let\smallexamplefonts = \smallerfonts
1318
1319
% Set up the default fonts, so we can use them for creating boxes.
1320
%
1321
\textfonts
1322
1323
% Define these so they can be easily changed for other fonts.
1324
\def\angleleft{$\langle$}
1325
\def\angleright{$\rangle$}
1326
1327
% Count depth in font-changes, for error checks
1328
\newcount\fontdepth \fontdepth=0
1329
1330
% Fonts for short table of contents.
1331
\setfont\shortcontrm\rmshape{12}{1000}
1332
\setfont\shortcontbf\bxshape{12}{1000}
1333
\setfont\shortcontsl\slshape{12}{1000}
1334
1335
%% Add scribe-like font environments, plus @l for inline lisp (usually sans
1336
%% serif) and @ii for TeX italic
1337
1338
% \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1339
% unless the following character is such as not to need one.
1340
\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1341
\def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx}
1342
\def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx}
1343
1344
\let\i=\smartitalic
1345
\let\var=\smartslanted
1346
\let\dfn=\smartslanted
1347
\let\emph=\smartitalic
1348
\let\cite=\smartslanted
1349
1350
\def\b#1{{\bf #1}}
1351
\let\strong=\b
1352
1353
% We can't just use \exhyphenpenalty, because that only has effect at
1354
% the end of a paragraph. Restore normal hyphenation at the end of the
1355
% group within which \nohyphenation is presumably called.
1356
%
1357
\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1358
\def\restorehyphenation{\hyphenchar\font = `- }
1359
1360
\def\t#1{%
1361
{\tt \rawbackslash \frenchspacing #1}%
1362
\null
1363
}
1364
\let\ttfont=\t
1365
\def\samp#1{`\tclose{#1}'\null}
1366
\setfont\keyrm\rmshape{8}{1000}
1367
\font\keysy=cmsy9
1368
\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1369
\raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1370
\vbox{\hrule\kern-0.4pt
1371
\hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1372
\kern-0.4pt\hrule}%
1373
\kern-.06em\raise0.4pt\hbox{\angleright}}}}
1374
% The old definition, with no lozenge:
1375
%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1376
\def\ctrl #1{{\tt \rawbackslash \hat}#1}
1377
1378
% @file, @option are the same as @samp.
1379
\let\file=\samp
1380
\let\option=\samp
1381
1382
% @code is a modification of @t,
1383
% which makes spaces the same size as normal in the surrounding text.
1384
\def\tclose#1{%
1385
{%
1386
% Change normal interword space to be same as for the current font.
1387
\spaceskip = \fontdimen2\font
1388
%
1389
% Switch to typewriter.
1390
\tt
1391
%
1392
% But `\ ' produces the large typewriter interword space.
1393
\def\ {{\spaceskip = 0pt{} }}%
1394
%
1395
% Turn off hyphenation.
1396
\nohyphenation
1397
%
1398
\rawbackslash
1399
\frenchspacing
1400
#1%
1401
}%
1402
\null
1403
}
1404
1405
% We *must* turn on hyphenation at `-' and `_' in \code.
1406
% Otherwise, it is too hard to avoid overfull hboxes
1407
% in the Emacs manual, the Library manual, etc.
1408
1409
% Unfortunately, TeX uses one parameter (\hyphenchar) to control
1410
% both hyphenation at - and hyphenation within words.
1411
% We must therefore turn them both off (\tclose does that)
1412
% and arrange explicitly to hyphenate at a dash.
1413
% -- rms.
1414
{
1415
\catcode`\-=\active
1416
\catcode`\_=\active
1417
%
1418
\global\def\code{\begingroup
1419
\catcode`\-=\active \let-\codedash
1420
\catcode`\_=\active \let_\codeunder
1421
\codex
1422
}
1423
%
1424
% If we end up with any active - characters when handling the index,
1425
% just treat them as a normal -.
1426
\global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1427
}
1428
1429
\def\realdash{-}
1430
\def\codedash{-\discretionary{}{}{}}
1431
\def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}}
1432
\def\codex #1{\tclose{#1}\endgroup}
1433
1434
%\let\exp=\tclose %Was temporary
1435
1436
% @kbd is like @code, except that if the argument is just one @key command,
1437
% then @kbd has no effect.
1438
1439
% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1440
% `example' (@kbd uses ttsl only inside of @example and friends),
1441
% or `code' (@kbd uses normal tty font always).
1442
\def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1443
\def\kbdinputstylexxx#1{%
1444
\def\arg{#1}%
1445
\ifx\arg\worddistinct
1446
\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1447
\else\ifx\arg\wordexample
1448
\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1449
\else\ifx\arg\wordcode
1450
\gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1451
\fi\fi\fi
1452
}
1453
\def\worddistinct{distinct}
1454
\def\wordexample{example}
1455
\def\wordcode{code}
1456
1457
% Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1458
% the catcodes are wrong for parsearg to work.)
1459
\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1460
1461
\def\xkey{\key}
1462
\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1463
\ifx\one\xkey\ifx\threex\three \key{#2}%
1464
\else{\tclose{\kbdfont\look}}\fi
1465
\else{\tclose{\kbdfont\look}}\fi}
1466
1467
% For @url, @env, @command quotes seem unnecessary, so use \code.
1468
\let\url=\code
1469
\let\env=\code
1470
\let\command=\code
1471
1472
% @uref (abbreviation for `urlref') takes an optional (comma-separated)
1473
% second argument specifying the text to display and an optional third
1474
% arg as text to display instead of (rather than in addition to) the url
1475
% itself. First (mandatory) arg is the url. Perhaps eventually put in
1476
% a hypertex \special here.
1477
%
1478
\def\uref#1{\douref #1,,,\finish}
1479
\def\douref#1,#2,#3,#4\finish{\begingroup
1480
\unsepspaces
1481
\pdfurl{#1}%
1482
\setbox0 = \hbox{\ignorespaces #3}%
1483
\ifdim\wd0 > 0pt
1484
\unhbox0 % third arg given, show only that
1485
\else
1486
\setbox0 = \hbox{\ignorespaces #2}%
1487
\ifdim\wd0 > 0pt
1488
\ifpdf
1489
\unhbox0 % PDF: 2nd arg given, show only it
1490
\else
1491
\unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1492
\fi
1493
\else
1494
\code{#1}% only url given, so show it
1495
\fi
1496
\fi
1497
\endlink
1498
\endgroup}
1499
1500
% rms does not like angle brackets --karl, 17may97.
1501
% So now @email is just like @uref, unless we are pdf.
1502
%
1503
%\def\email#1{\angleleft{\tt #1}\angleright}
1504
\ifpdf
1505
\def\email#1{\doemail#1,,\finish}
1506
\def\doemail#1,#2,#3\finish{\begingroup
1507
\unsepspaces
1508
\pdfurl{mailto:#1}%
1509
\setbox0 = \hbox{\ignorespaces #2}%
1510
\ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1511
\endlink
1512
\endgroup}
1513
\else
1514
\let\email=\uref
1515
\fi
1516
1517
% Check if we are currently using a typewriter font. Since all the
1518
% Computer Modern typewriter fonts have zero interword stretch (and
1519
% shrink), and it is reasonable to expect all typewriter fonts to have
1520
% this property, we can check that font parameter.
1521
%
1522
\def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1523
1524
% Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1525
% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1526
%
1527
\def\dmn#1{\thinspace #1}
1528
1529
\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1530
1531
% @l was never documented to mean ``switch to the Lisp font'',
1532
% and it is not used as such in any manual I can find. We need it for
1533
% Polish suppressed-l. --karl, 22sep96.
1534
%\def\l#1{{\li #1}\null}
1535
1536
% Explicit font changes: @r, @sc, undocumented @ii.
1537
\def\r#1{{\rm #1}} % roman font
1538
\def\sc#1{{\smallcaps#1}} % smallcaps font
1539
\def\ii#1{{\it #1}} % italic font
1540
1541
% @acronym downcases the argument and prints in smallcaps.
1542
\def\acronym#1{{\smallcaps \lowercase{#1}}}
1543
1544
% @pounds{} is a sterling sign.
1545
\def\pounds{{\it\$}}
1546
1547
1548
\message{page headings,}
1549
1550
\newskip\titlepagetopglue \titlepagetopglue = 1.5in
1551
\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1552
1553
% First the title page. Must do @settitle before @titlepage.
1554
\newif\ifseenauthor
1555
\newif\iffinishedtitlepage
1556
1557
% Do an implicit @contents or @shortcontents after @end titlepage if the
1558
% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1559
%
1560
\newif\ifsetcontentsaftertitlepage
1561
\let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1562
\newif\ifsetshortcontentsaftertitlepage
1563
\let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1564
1565
\def\shorttitlepage{\parsearg\shorttitlepagezzz}
1566
\def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1567
\endgroup\page\hbox{}\page}
1568
1569
\def\titlepage{\begingroup \parindent=0pt \textfonts
1570
\let\subtitlerm=\tenrm
1571
\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1572
%
1573
\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1574
%
1575
% Leave some space at the very top of the page.
1576
\vglue\titlepagetopglue
1577
%
1578
% Now you can print the title using @title.
1579
\def\title{\parsearg\titlezzz}%
1580
\def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1581
% print a rule at the page bottom also.
1582
\finishedtitlepagefalse
1583
\vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1584
% No rule at page bottom unless we print one at the top with @title.
1585
\finishedtitlepagetrue
1586
%
1587
% Now you can put text using @subtitle.
1588
\def\subtitle{\parsearg\subtitlezzz}%
1589
\def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1590
%
1591
% @author should come last, but may come many times.
1592
\def\author{\parsearg\authorzzz}%
1593
\def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1594
{\authorfont \leftline{##1}}}%
1595
%
1596
% Most title ``pages'' are actually two pages long, with space
1597
% at the top of the second. We don't want the ragged left on the second.
1598
\let\oldpage = \page
1599
\def\page{%
1600
\iffinishedtitlepage\else
1601
\finishtitlepage
1602
\fi
1603
\oldpage
1604
\let\page = \oldpage
1605
\hbox{}}%
1606
% \def\page{\oldpage \hbox{}}
1607
}
1608
1609
\def\Etitlepage{%
1610
\iffinishedtitlepage\else
1611
\finishtitlepage
1612
\fi
1613
% It is important to do the page break before ending the group,
1614
% because the headline and footline are only empty inside the group.
1615
% If we use the new definition of \page, we always get a blank page
1616
% after the title page, which we certainly don't want.
1617
\oldpage
1618
\endgroup
1619
%
1620
% Need this before the \...aftertitlepage checks so that if they are
1621
% in effect the toc pages will come out with page numbers.
1622
\HEADINGSon
1623
%
1624
% If they want short, they certainly want long too.
1625
\ifsetshortcontentsaftertitlepage
1626
\shortcontents
1627
\contents
1628
\global\let\shortcontents = \relax
1629
\global\let\contents = \relax
1630
\fi
1631
%
1632
\ifsetcontentsaftertitlepage
1633
\contents
1634
\global\let\contents = \relax
1635
\global\let\shortcontents = \relax
1636
\fi
1637
%
1638
\ifpdf \pdfmakepagedesttrue \fi
1639
}
1640
1641
\def\finishtitlepage{%
1642
\vskip4pt \hrule height 2pt width \hsize
1643
\vskip\titlepagebottomglue
1644
\finishedtitlepagetrue
1645
}
1646
1647
%%% Set up page headings and footings.
1648
1649
\let\thispage=\folio
1650
1651
\newtoks\evenheadline % headline on even pages
1652
\newtoks\oddheadline % headline on odd pages
1653
\newtoks\evenfootline % footline on even pages
1654
\newtoks\oddfootline % footline on odd pages
1655
1656
% Now make Tex use those variables
1657
\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1658
\else \the\evenheadline \fi}}
1659
\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1660
\else \the\evenfootline \fi}\HEADINGShook}
1661
\let\HEADINGShook=\relax
1662
1663
% Commands to set those variables.
1664
% For example, this is what @headings on does
1665
% @evenheading @thistitle|@thispage|@thischapter
1666
% @oddheading @thischapter|@thispage|@thistitle
1667
% @evenfooting @thisfile||
1668
% @oddfooting ||@thisfile
1669
1670
\def\evenheading{\parsearg\evenheadingxxx}
1671
\def\oddheading{\parsearg\oddheadingxxx}
1672
\def\everyheading{\parsearg\everyheadingxxx}
1673
1674
\def\evenfooting{\parsearg\evenfootingxxx}
1675
\def\oddfooting{\parsearg\oddfootingxxx}
1676
\def\everyfooting{\parsearg\everyfootingxxx}
1677
1678
{\catcode`\@=0 %
1679
1680
\gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1681
\gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1682
\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1683
1684
\gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1685
\gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1686
\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1687
1688
\gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1689
1690
\gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1691
\gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1692
\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1693
1694
\gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1695
\gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1696
\global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1697
%
1698
% Leave some space for the footline. Hopefully ok to assume
1699
% @evenfooting will not be used by itself.
1700
\global\advance\pageheight by -\baselineskip
1701
\global\advance\vsize by -\baselineskip
1702
}
1703
1704
\gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1705
%
1706
}% unbind the catcode of @.
1707
1708
% @headings double turns headings on for double-sided printing.
1709
% @headings single turns headings on for single-sided printing.
1710
% @headings off turns them off.
1711
% @headings on same as @headings double, retained for compatibility.
1712
% @headings after turns on double-sided headings after this page.
1713
% @headings doubleafter turns on double-sided headings after this page.
1714
% @headings singleafter turns on single-sided headings after this page.
1715
% By default, they are off at the start of a document,
1716
% and turned `on' after @end titlepage.
1717
1718
\def\headings #1 {\csname HEADINGS#1\endcsname}
1719
1720
\def\HEADINGSoff{
1721
\global\evenheadline={\hfil} \global\evenfootline={\hfil}
1722
\global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1723
\HEADINGSoff
1724
% When we turn headings on, set the page number to 1.
1725
% For double-sided printing, put current file name in lower left corner,
1726
% chapter name on inside top of right hand pages, document
1727
% title on inside top of left hand pages, and page numbers on outside top
1728
% edge of all pages.
1729
\def\HEADINGSdouble{
1730
\global\pageno=1
1731
\global\evenfootline={\hfil}
1732
\global\oddfootline={\hfil}
1733
\global\evenheadline={\line{\folio\hfil\thistitle}}
1734
\global\oddheadline={\line{\thischapter\hfil\folio}}
1735
\global\let\contentsalignmacro = \chapoddpage
1736
}
1737
\let\contentsalignmacro = \chappager
1738
1739
% For single-sided printing, chapter title goes across top left of page,
1740
% page number on top right.
1741
\def\HEADINGSsingle{
1742
\global\pageno=1
1743
\global\evenfootline={\hfil}
1744
\global\oddfootline={\hfil}
1745
\global\evenheadline={\line{\thischapter\hfil\folio}}
1746
\global\oddheadline={\line{\thischapter\hfil\folio}}
1747
\global\let\contentsalignmacro = \chappager
1748
}
1749
\def\HEADINGSon{\HEADINGSdouble}
1750
1751
\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1752
\let\HEADINGSdoubleafter=\HEADINGSafter
1753
\def\HEADINGSdoublex{%
1754
\global\evenfootline={\hfil}
1755
\global\oddfootline={\hfil}
1756
\global\evenheadline={\line{\folio\hfil\thistitle}}
1757
\global\oddheadline={\line{\thischapter\hfil\folio}}
1758
\global\let\contentsalignmacro = \chapoddpage
1759
}
1760
1761
\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1762
\def\HEADINGSsinglex{%
1763
\global\evenfootline={\hfil}
1764
\global\oddfootline={\hfil}
1765
\global\evenheadline={\line{\thischapter\hfil\folio}}
1766
\global\oddheadline={\line{\thischapter\hfil\folio}}
1767
\global\let\contentsalignmacro = \chappager
1768
}
1769
1770
% Subroutines used in generating headings
1771
% This produces Day Month Year style of output.
1772
% Only define if not already defined, in case a txi-??.tex file has set
1773
% up a different format (e.g., txi-cs.tex does this).
1774
\ifx\today\undefined
1775
\def\today{%
1776
\number\day\space
1777
\ifcase\month
1778
\or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1779
\or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1780
\or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1781
\fi
1782
\space\number\year}
1783
\fi
1784
1785
% @settitle line... specifies the title of the document, for headings.
1786
% It generates no output of its own.
1787
\def\thistitle{\putwordNoTitle}
1788
\def\settitle{\parsearg\settitlezzz}
1789
\def\settitlezzz #1{\gdef\thistitle{#1}}
1790
1791
1792
\message{tables,}
1793
% Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1794
1795
% default indentation of table text
1796
\newdimen\tableindent \tableindent=.8in
1797
% default indentation of @itemize and @enumerate text
1798
\newdimen\itemindent \itemindent=.3in
1799
% margin between end of table item and start of table text.
1800
\newdimen\itemmargin \itemmargin=.1in
1801
1802
% used internally for \itemindent minus \itemmargin
1803
\newdimen\itemmax
1804
1805
% Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1806
% these defs.
1807
% They also define \itemindex
1808
% to index the item name in whatever manner is desired (perhaps none).
1809
1810
\newif\ifitemxneedsnegativevskip
1811
1812
\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1813
1814
\def\internalBitem{\smallbreak \parsearg\itemzzz}
1815
\def\internalBitemx{\itemxpar \parsearg\itemzzz}
1816
1817
\def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1818
\def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1819
1820
\def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1821
\def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1822
1823
\def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1824
\itemzzz {#1}}
1825
1826
\def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1827
\itemzzz {#1}}
1828
1829
\def\itemzzz #1{\begingroup %
1830
\advance\hsize by -\rightskip
1831
\advance\hsize by -\tableindent
1832
\setbox0=\hbox{\itemfont{#1}}%
1833
\itemindex{#1}%
1834
\nobreak % This prevents a break before @itemx.
1835
%
1836
% If the item text does not fit in the space we have, put it on a line
1837
% by itself, and do not allow a page break either before or after that
1838
% line. We do not start a paragraph here because then if the next
1839
% command is, e.g., @kindex, the whatsit would get put into the
1840
% horizontal list on a line by itself, resulting in extra blank space.
1841
\ifdim \wd0>\itemmax
1842
%
1843
% Make this a paragraph so we get the \parskip glue and wrapping,
1844
% but leave it ragged-right.
1845
\begingroup
1846
\advance\leftskip by-\tableindent
1847
\advance\hsize by\tableindent
1848
\advance\rightskip by0pt plus1fil
1849
\leavevmode\unhbox0\par
1850
\endgroup
1851
%
1852
% We're going to be starting a paragraph, but we don't want the
1853
% \parskip glue -- logically it's part of the @item we just started.
1854
\nobreak \vskip-\parskip
1855
%
1856
% Stop a page break at the \parskip glue coming up. Unfortunately
1857
% we can't prevent a possible page break at the following
1858
% \baselineskip glue.
1859
\nobreak
1860
\endgroup
1861
\itemxneedsnegativevskipfalse
1862
\else
1863
% The item text fits into the space. Start a paragraph, so that the
1864
% following text (if any) will end up on the same line.
1865
\noindent
1866
% Do this with kerns and \unhbox so that if there is a footnote in
1867
% the item text, it can migrate to the main vertical list and
1868
% eventually be printed.
1869
\nobreak\kern-\tableindent
1870
\dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1871
\unhbox0
1872
\nobreak\kern\dimen0
1873
\endgroup
1874
\itemxneedsnegativevskiptrue
1875
\fi
1876
}
1877
1878
\def\item{\errmessage{@item while not in a table}}
1879
\def\itemx{\errmessage{@itemx while not in a table}}
1880
\def\kitem{\errmessage{@kitem while not in a table}}
1881
\def\kitemx{\errmessage{@kitemx while not in a table}}
1882
\def\xitem{\errmessage{@xitem while not in a table}}
1883
\def\xitemx{\errmessage{@xitemx while not in a table}}
1884
1885
% Contains a kludge to get @end[description] to work.
1886
\def\description{\tablez{\dontindex}{1}{}{}{}{}}
1887
1888
% @table, @ftable, @vtable.
1889
\def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1890
{\obeylines\obeyspaces%
1891
\gdef\tablex #1^^M{%
1892
\tabley\dontindex#1 \endtabley}}
1893
1894
\def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1895
{\obeylines\obeyspaces%
1896
\gdef\ftablex #1^^M{%
1897
\tabley\fnitemindex#1 \endtabley
1898
\def\Eftable{\endgraf\afterenvbreak\endgroup}%
1899
\let\Etable=\relax}}
1900
1901
\def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1902
{\obeylines\obeyspaces%
1903
\gdef\vtablex #1^^M{%
1904
\tabley\vritemindex#1 \endtabley
1905
\def\Evtable{\endgraf\afterenvbreak\endgroup}%
1906
\let\Etable=\relax}}
1907
1908
\def\dontindex #1{}
1909
\def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1910
\def\vritemindex #1{\doind {vr}{\code{#1}}}%
1911
1912
{\obeyspaces %
1913
\gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1914
\tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1915
1916
\def\tablez #1#2#3#4#5#6{%
1917
\aboveenvbreak %
1918
\begingroup %
1919
\def\Edescription{\Etable}% Necessary kludge.
1920
\let\itemindex=#1%
1921
\ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1922
\ifnum 0#4>0 \tableindent=#4\mil \fi %
1923
\ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1924
\def\itemfont{#2}%
1925
\itemmax=\tableindent %
1926
\advance \itemmax by -\itemmargin %
1927
\advance \leftskip by \tableindent %
1928
\exdentamount=\tableindent
1929
\parindent = 0pt
1930
\parskip = \smallskipamount
1931
\ifdim \parskip=0pt \parskip=2pt \fi%
1932
\def\Etable{\endgraf\afterenvbreak\endgroup}%
1933
\let\item = \internalBitem %
1934
\let\itemx = \internalBitemx %
1935
\let\kitem = \internalBkitem %
1936
\let\kitemx = \internalBkitemx %
1937
\let\xitem = \internalBxitem %
1938
\let\xitemx = \internalBxitemx %
1939
}
1940
1941
% This is the counter used by @enumerate, which is really @itemize
1942
1943
\newcount \itemno
1944
1945
\def\itemize{\parsearg\itemizezzz}
1946
1947
\def\itemizezzz #1{%
1948
\begingroup % ended by the @end itemize
1949
\itemizey {#1}{\Eitemize}
1950
}
1951
1952
\def\itemizey #1#2{%
1953
\aboveenvbreak %
1954
\itemmax=\itemindent %
1955
\advance \itemmax by -\itemmargin %
1956
\advance \leftskip by \itemindent %
1957
\exdentamount=\itemindent
1958
\parindent = 0pt %
1959
\parskip = \smallskipamount %
1960
\ifdim \parskip=0pt \parskip=2pt \fi%
1961
\def#2{\endgraf\afterenvbreak\endgroup}%
1962
\def\itemcontents{#1}%
1963
\let\item=\itemizeitem}
1964
1965
% Set sfcode to normal for the chars that usually have another value.
1966
% These are `.?!:;,'
1967
\def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1968
\sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1969
1970
% \splitoff TOKENS\endmark defines \first to be the first token in
1971
% TOKENS, and \rest to be the remainder.
1972
%
1973
\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1974
1975
% Allow an optional argument of an uppercase letter, lowercase letter,
1976
% or number, to specify the first label in the enumerated list. No
1977
% argument is the same as `1'.
1978
%
1979
\def\enumerate{\parsearg\enumeratezzz}
1980
\def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1981
\def\enumeratey #1 #2\endenumeratey{%
1982
\begingroup % ended by the @end enumerate
1983
%
1984
% If we were given no argument, pretend we were given `1'.
1985
\def\thearg{#1}%
1986
\ifx\thearg\empty \def\thearg{1}\fi
1987
%
1988
% Detect if the argument is a single token. If so, it might be a
1989
% letter. Otherwise, the only valid thing it can be is a number.
1990
% (We will always have one token, because of the test we just made.
1991
% This is a good thing, since \splitoff doesn't work given nothing at
1992
% all -- the first parameter is undelimited.)
1993
\expandafter\splitoff\thearg\endmark
1994
\ifx\rest\empty
1995
% Only one token in the argument. It could still be anything.
1996
% A ``lowercase letter'' is one whose \lccode is nonzero.
1997
% An ``uppercase letter'' is one whose \lccode is both nonzero, and
1998
% not equal to itself.
1999
% Otherwise, we assume it's a number.
2000
%
2001
% We need the \relax at the end of the \ifnum lines to stop TeX from
2002
% continuing to look for a <number>.
2003
%
2004
\ifnum\lccode\expandafter`\thearg=0\relax
2005
\numericenumerate % a number (we hope)
2006
\else
2007
% It's a letter.
2008
\ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2009
\lowercaseenumerate % lowercase letter
2010
\else
2011
\uppercaseenumerate % uppercase letter
2012
\fi
2013
\fi
2014
\else
2015
% Multiple tokens in the argument. We hope it's a number.
2016
\numericenumerate
2017
\fi
2018
}
2019
2020
% An @enumerate whose labels are integers. The starting integer is
2021
% given in \thearg.
2022
%
2023
\def\numericenumerate{%
2024
\itemno = \thearg
2025
\startenumeration{\the\itemno}%
2026
}
2027
2028
% The starting (lowercase) letter is in \thearg.
2029
\def\lowercaseenumerate{%
2030
\itemno = \expandafter`\thearg
2031
\startenumeration{%
2032
% Be sure we're not beyond the end of the alphabet.
2033
\ifnum\itemno=0
2034
\errmessage{No more lowercase letters in @enumerate; get a bigger
2035
alphabet}%
2036
\fi
2037
\char\lccode\itemno
2038
}%
2039
}
2040
2041
% The starting (uppercase) letter is in \thearg.
2042
\def\uppercaseenumerate{%
2043
\itemno = \expandafter`\thearg
2044
\startenumeration{%
2045
% Be sure we're not beyond the end of the alphabet.
2046
\ifnum\itemno=0
2047
\errmessage{No more uppercase letters in @enumerate; get a bigger
2048
alphabet}
2049
\fi
2050
\char\uccode\itemno
2051
}%
2052
}
2053
2054
% Call itemizey, adding a period to the first argument and supplying the
2055
% common last two arguments. Also subtract one from the initial value in
2056
% \itemno, since @item increments \itemno.
2057
%
2058
\def\startenumeration#1{%
2059
\advance\itemno by -1
2060
\itemizey{#1.}\Eenumerate\flushcr
2061
}
2062
2063
% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2064
% to @enumerate.
2065
%
2066
\def\alphaenumerate{\enumerate{a}}
2067
\def\capsenumerate{\enumerate{A}}
2068
\def\Ealphaenumerate{\Eenumerate}
2069
\def\Ecapsenumerate{\Eenumerate}
2070
2071
% Definition of @item while inside @itemize.
2072
2073
\def\itemizeitem{%
2074
\advance\itemno by 1
2075
{\let\par=\endgraf \smallbreak}%
2076
\ifhmode \errmessage{In hmode at itemizeitem}\fi
2077
{\parskip=0in \hskip 0pt
2078
\hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2079
\vadjust{\penalty 1200}}%
2080
\flushcr}
2081
2082
% @multitable macros
2083
% Amy Hendrickson, 8/18/94, 3/6/96
2084
%
2085
% @multitable ... @end multitable will make as many columns as desired.
2086
% Contents of each column will wrap at width given in preamble. Width
2087
% can be specified either with sample text given in a template line,
2088
% or in percent of \hsize, the current width of text on page.
2089
2090
% Table can continue over pages but will only break between lines.
2091
2092
% To make preamble:
2093
%
2094
% Either define widths of columns in terms of percent of \hsize:
2095
% @multitable @columnfractions .25 .3 .45
2096
% @item ...
2097
%
2098
% Numbers following @columnfractions are the percent of the total
2099
% current hsize to be used for each column. You may use as many
2100
% columns as desired.
2101
2102
2103
% Or use a template:
2104
% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2105
% @item ...
2106
% using the widest term desired in each column.
2107
%
2108
% For those who want to use more than one line's worth of words in
2109
% the preamble, break the line within one argument and it
2110
% will parse correctly, i.e.,
2111
%
2112
% @multitable {Column 1 template} {Column 2 template} {Column 3
2113
% template}
2114
% Not:
2115
% @multitable {Column 1 template} {Column 2 template}
2116
% {Column 3 template}
2117
2118
% Each new table line starts with @item, each subsequent new column
2119
% starts with @tab. Empty columns may be produced by supplying @tab's
2120
% with nothing between them for as many times as empty columns are needed,
2121
% ie, @tab@tab@tab will produce two empty columns.
2122
2123
% @item, @tab, @multitable or @end multitable do not need to be on their
2124
% own lines, but it will not hurt if they are.
2125
2126
% Sample multitable:
2127
2128
% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2129
% @item first col stuff @tab second col stuff @tab third col
2130
% @item
2131
% first col stuff
2132
% @tab
2133
% second col stuff
2134
% @tab
2135
% third col
2136
% @item first col stuff @tab second col stuff
2137
% @tab Many paragraphs of text may be used in any column.
2138
%
2139
% They will wrap at the width determined by the template.
2140
% @item@tab@tab This will be in third column.
2141
% @end multitable
2142
2143
% Default dimensions may be reset by user.
2144
% @multitableparskip is vertical space between paragraphs in table.
2145
% @multitableparindent is paragraph indent in table.
2146
% @multitablecolmargin is horizontal space to be left between columns.
2147
% @multitablelinespace is space to leave between table items, baseline
2148
% to baseline.
2149
% 0pt means it depends on current normal line spacing.
2150
%
2151
\newskip\multitableparskip
2152
\newskip\multitableparindent
2153
\newdimen\multitablecolspace
2154
\newskip\multitablelinespace
2155
\multitableparskip=0pt
2156
\multitableparindent=6pt
2157
\multitablecolspace=12pt
2158
\multitablelinespace=0pt
2159
2160
% Macros used to set up halign preamble:
2161
%
2162
\let\endsetuptable\relax
2163
\def\xendsetuptable{\endsetuptable}
2164
\let\columnfractions\relax
2165
\def\xcolumnfractions{\columnfractions}
2166
\newif\ifsetpercent
2167
2168
% #1 is the part of the @columnfraction before the decimal point, which
2169
% is presumably either 0 or the empty string (but we don't check, we
2170
% just throw it away). #2 is the decimal part, which we use as the
2171
% percent of \hsize for this column.
2172
\def\pickupwholefraction#1.#2 {%
2173
\global\advance\colcount by 1
2174
\expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2175
\setuptable
2176
}
2177
2178
\newcount\colcount
2179
\def\setuptable#1{%
2180
\def\firstarg{#1}%
2181
\ifx\firstarg\xendsetuptable
2182
\let\go = \relax
2183
\else
2184
\ifx\firstarg\xcolumnfractions
2185
\global\setpercenttrue
2186
\else
2187
\ifsetpercent
2188
\let\go\pickupwholefraction
2189
\else
2190
\global\advance\colcount by 1
2191
\setbox0=\hbox{#1\unskip }% Add a normal word space as a separator;
2192
% typically that is always in the input, anyway.
2193
\expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2194
\fi
2195
\fi
2196
\ifx\go\pickupwholefraction
2197
% Put the argument back for the \pickupwholefraction call, so
2198
% we'll always have a period there to be parsed.
2199
\def\go{\pickupwholefraction#1}%
2200
\else
2201
\let\go = \setuptable
2202
\fi%
2203
\fi
2204
\go
2205
}
2206
2207
% This used to have \hskip1sp. But then the space in a template line is
2208
% not enough. That is bad. So let's go back to just & until we
2209
% encounter the problem it was intended to solve again.
2210
% --karl, nathan@acm.org, 20apr99.
2211
\def\tab{&}
2212
2213
% @multitable ... @end multitable definitions:
2214
%
2215
\def\multitable{\parsearg\dotable}
2216
\def\dotable#1{\bgroup
2217
\vskip\parskip
2218
\let\item\crcr
2219
\tolerance=9500
2220
\hbadness=9500
2221
\setmultitablespacing
2222
\parskip=\multitableparskip
2223
\parindent=\multitableparindent
2224
\overfullrule=0pt
2225
\global\colcount=0
2226
\def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2227
%
2228
% To parse everything between @multitable and @item:
2229
\setuptable#1 \endsetuptable
2230
%
2231
% \everycr will reset column counter, \colcount, at the end of
2232
% each line. Every column entry will cause \colcount to advance by one.
2233
% The table preamble
2234
% looks at the current \colcount to find the correct column width.
2235
\everycr{\noalign{%
2236
%
2237
% \filbreak%% keeps underfull box messages off when table breaks over pages.
2238
% Maybe so, but it also creates really weird page breaks when the table
2239
% breaks over pages. Wouldn't \vfil be better? Wait until the problem
2240
% manifests itself, so it can be fixed for real --karl.
2241
\global\colcount=0\relax}}%
2242
%
2243
% This preamble sets up a generic column definition, which will
2244
% be used as many times as user calls for columns.
2245
% \vtop will set a single line and will also let text wrap and
2246
% continue for many paragraphs if desired.
2247
\halign\bgroup&\global\advance\colcount by 1\relax
2248
\multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2249
%
2250
% In order to keep entries from bumping into each other
2251
% we will add a \leftskip of \multitablecolspace to all columns after
2252
% the first one.
2253
%
2254
% If a template has been used, we will add \multitablecolspace
2255
% to the width of each template entry.
2256
%
2257
% If the user has set preamble in terms of percent of \hsize we will
2258
% use that dimension as the width of the column, and the \leftskip
2259
% will keep entries from bumping into each other. Table will start at
2260
% left margin and final column will justify at right margin.
2261
%
2262
% Make sure we don't inherit \rightskip from the outer environment.
2263
\rightskip=0pt
2264
\ifnum\colcount=1
2265
% The first column will be indented with the surrounding text.
2266
\advance\hsize by\leftskip
2267
\else
2268
\ifsetpercent \else
2269
% If user has not set preamble in terms of percent of \hsize
2270
% we will advance \hsize by \multitablecolspace.
2271
\advance\hsize by \multitablecolspace
2272
\fi
2273
% In either case we will make \leftskip=\multitablecolspace:
2274
\leftskip=\multitablecolspace
2275
\fi
2276
% Ignoring space at the beginning and end avoids an occasional spurious
2277
% blank line, when TeX decides to break the line at the space before the
2278
% box from the multistrut, so the strut ends up on a line by itself.
2279
% For example:
2280
% @multitable @columnfractions .11 .89
2281
% @item @code{#}
2282
% @tab Legal holiday which is valid in major parts of the whole country.
2283
% Is automatically provided with highlighting sequences respectively marking
2284
% characters.
2285
\noindent\ignorespaces##\unskip\multistrut}\cr
2286
}
2287
2288
\def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2289
% If so, do nothing. If not, give it an appropriate dimension based on
2290
% current baselineskip.
2291
\ifdim\multitablelinespace=0pt
2292
\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2293
\global\advance\multitablelinespace by-\ht0
2294
%% strut to put in table in case some entry doesn't have descenders,
2295
%% to keep lines equally spaced
2296
\let\multistrut = \strut
2297
\else
2298
%% FIXME: what is \box0 supposed to be?
2299
\gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2300
width0pt\relax} \fi
2301
%% Test to see if parskip is larger than space between lines of
2302
%% table. If not, do nothing.
2303
%% If so, set to same dimension as multitablelinespace.
2304
\ifdim\multitableparskip>\multitablelinespace
2305
\global\multitableparskip=\multitablelinespace
2306
\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2307
%% than skip between lines in the table.
2308
\fi%
2309
\ifdim\multitableparskip=0pt
2310
\global\multitableparskip=\multitablelinespace
2311
\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2312
%% than skip between lines in the table.
2313
\fi}
2314
2315
2316
\message{conditionals,}
2317
% Prevent errors for section commands.
2318
% Used in @ignore and in failing conditionals.
2319
\def\ignoresections{%
2320
\let\chapter=\relax
2321
\let\unnumbered=\relax
2322
\let\top=\relax
2323
\let\unnumberedsec=\relax
2324
\let\unnumberedsection=\relax
2325
\let\unnumberedsubsec=\relax
2326
\let\unnumberedsubsection=\relax
2327
\let\unnumberedsubsubsec=\relax
2328
\let\unnumberedsubsubsection=\relax
2329
\let\section=\relax
2330
\let\subsec=\relax
2331
\let\subsubsec=\relax
2332
\let\subsection=\relax
2333
\let\subsubsection=\relax
2334
\let\appendix=\relax
2335
\let\appendixsec=\relax
2336
\let\appendixsection=\relax
2337
\let\appendixsubsec=\relax
2338
\let\appendixsubsection=\relax
2339
\let\appendixsubsubsec=\relax
2340
\let\appendixsubsubsection=\relax
2341
\let\contents=\relax
2342
\let\smallbook=\relax
2343
\let\titlepage=\relax
2344
}
2345
2346
% Used in nested conditionals, where we have to parse the Texinfo source
2347
% and so want to turn off most commands, in case they are used
2348
% incorrectly.
2349
%
2350
\def\ignoremorecommands{%
2351
\let\defcodeindex = \relax
2352
\let\defcv = \relax
2353
\let\deffn = \relax
2354
\let\deffnx = \relax
2355
\let\defindex = \relax
2356
\let\defivar = \relax
2357
\let\defmac = \relax
2358
\let\defmethod = \relax
2359
\let\defop = \relax
2360
\let\defopt = \relax
2361
\let\defspec = \relax
2362
\let\deftp = \relax
2363
\let\deftypefn = \relax
2364
\let\deftypefun = \relax
2365
\let\deftypeivar = \relax
2366
\let\deftypeop = \relax
2367
\let\deftypevar = \relax
2368
\let\deftypevr = \relax
2369
\let\defun = \relax
2370
\let\defvar = \relax
2371
\let\defvr = \relax
2372
\let\ref = \relax
2373
\let\xref = \relax
2374
\let\printindex = \relax
2375
\let\pxref = \relax
2376
\let\settitle = \relax
2377
\let\setchapternewpage = \relax
2378
\let\setchapterstyle = \relax
2379
\let\everyheading = \relax
2380
\let\evenheading = \relax
2381
\let\oddheading = \relax
2382
\let\everyfooting = \relax
2383
\let\evenfooting = \relax
2384
\let\oddfooting = \relax
2385
\let\headings = \relax
2386
\let\include = \relax
2387
\let\lowersections = \relax
2388
\let\down = \relax
2389
\let\raisesections = \relax
2390
\let\up = \relax
2391
\let\set = \relax
2392
\let\clear = \relax
2393
\let\item = \relax
2394
}
2395
2396
% Ignore @ignore ... @end ignore.
2397
%
2398
\def\ignore{\doignore{ignore}}
2399
2400
% Also ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu,
2401
% @documentdescription, and @direntry text.
2402
%
2403
\def\ifinfo{\doignore{ifinfo}}
2404
\def\ifhtml{\doignore{ifhtml}}
2405
\def\ifnottex{\doignore{ifnottex}}
2406
\def\html{\doignore{html}}
2407
\def\menu{\doignore{menu}}
2408
\def\documentdescription{\doignore{documentdescription}}
2409
\def\direntry{\doignore{direntry}}
2410
2411
% @dircategory CATEGORY -- specify a category of the dir file
2412
% which this file should belong to. Ignore this in TeX.
2413
\let\dircategory = \comment
2414
2415
% Ignore text until a line `@end #1'.
2416
%
2417
\def\doignore#1{\begingroup
2418
% Don't complain about control sequences we have declared \outer.
2419
\ignoresections
2420
%
2421
% Define a command to swallow text until we reach `@end #1'.
2422
% This @ is a catcode 12 token (that is the normal catcode of @ in
2423
% this texinfo.tex file). We change the catcode of @ below to match.
2424
\long\def\doignoretext##1@end #1{\enddoignore}%
2425
%
2426
% Make sure that spaces turn into tokens that match what \doignoretext wants.
2427
\catcode32 = 10
2428
%
2429
% Ignore braces, too, so mismatched braces don't cause trouble.
2430
\catcode`\{ = 9
2431
\catcode`\} = 9
2432
%
2433
% We must not have @c interpreted as a control sequence.
2434
\catcode`\@ = 12
2435
%
2436
% Make the letter c a comment character so that the rest of the line
2437
% will be ignored. This way, the document can have (for example)
2438
% @c @end ifinfo
2439
% and the @end ifinfo will be properly ignored.
2440
% (We've just changed @ to catcode 12.)
2441
\catcode`\c = 14
2442
%
2443
% And now expand that command.
2444
\doignoretext
2445
}
2446
2447
% What we do to finish off ignored text.
2448
%
2449
\def\enddoignore{\endgroup\ignorespaces}%
2450
2451
\newif\ifwarnedobs\warnedobsfalse
2452
\def\obstexwarn{%
2453
\ifwarnedobs\relax\else
2454
% We need to warn folks that they may have trouble with TeX 3.0.
2455
% This uses \immediate\write16 rather than \message to get newlines.
2456
\immediate\write16{}
2457
\immediate\write16{WARNING: for users of Unix TeX 3.0!}
2458
\immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2459
\immediate\write16{If you are running another version of TeX, relax.}
2460
\immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2461
\immediate\write16{ Then upgrade your TeX installation if you can.}
2462
\immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2463
\immediate\write16{If you are stuck with version 3.0, run the}
2464
\immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2465
\immediate\write16{ to use a workaround.}
2466
\immediate\write16{}
2467
\global\warnedobstrue
2468
\fi
2469
}
2470
2471
% **In TeX 3.0, setting text in \nullfont hangs tex. For a
2472
% workaround (which requires the file ``dummy.tfm'' to be installed),
2473
% uncomment the following line:
2474
%%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2475
2476
% Ignore text, except that we keep track of conditional commands for
2477
% purposes of nesting, up to an `@end #1' command.
2478
%
2479
\def\nestedignore#1{%
2480
\obstexwarn
2481
% We must actually expand the ignored text to look for the @end
2482
% command, so that nested ignore constructs work. Thus, we put the
2483
% text into a \vbox and then do nothing with the result. To minimize
2484
% the change of memory overflow, we follow the approach outlined on
2485
% page 401 of the TeXbook: make the current font be a dummy font.
2486
%
2487
\setbox0 = \vbox\bgroup
2488
% Don't complain about control sequences we have declared \outer.
2489
\ignoresections
2490
%
2491
% Define `@end #1' to end the box, which will in turn undefine the
2492
% @end command again.
2493
\expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2494
%
2495
% We are going to be parsing Texinfo commands. Most cause no
2496
% trouble when they are used incorrectly, but some commands do
2497
% complicated argument parsing or otherwise get confused, so we
2498
% undefine them.
2499
%
2500
% We can't do anything about stray @-signs, unfortunately;
2501
% they'll produce `undefined control sequence' errors.
2502
\ignoremorecommands
2503
%
2504
% Set the current font to be \nullfont, a TeX primitive, and define
2505
% all the font commands to also use \nullfont. We don't use
2506
% dummy.tfm, as suggested in the TeXbook, because not all sites
2507
% might have that installed. Therefore, math mode will still
2508
% produce output, but that should be an extremely small amount of
2509
% stuff compared to the main input.
2510
%
2511
\nullfont
2512
\let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2513
\let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2514
\let\tensf=\nullfont
2515
% Similarly for index fonts.
2516
\let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2517
\let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2518
\let\smallsf=\nullfont
2519
% Similarly for smallexample fonts.
2520
\let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2521
\let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2522
\let\smallersf=\nullfont
2523
%
2524
% Don't complain when characters are missing from the fonts.
2525
\tracinglostchars = 0
2526
%
2527
% Don't bother to do space factor calculations.
2528
\frenchspacing
2529
%
2530
% Don't report underfull hboxes.
2531
\hbadness = 10000
2532
%
2533
% Do minimal line-breaking.
2534
\pretolerance = 10000
2535
%
2536
% Do not execute instructions in @tex
2537
\def\tex{\doignore{tex}}%
2538
% Do not execute macro definitions.
2539
% `c' is a comment character, so the word `macro' will get cut off.
2540
\def\macro{\doignore{ma}}%
2541
}
2542
2543
% @set VAR sets the variable VAR to an empty value.
2544
% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2545
%
2546
% Since we want to separate VAR from REST-OF-LINE (which might be
2547
% empty), we can't just use \parsearg; we have to insert a space of our
2548
% own to delimit the rest of the line, and then take it out again if we
2549
% didn't need it. Make sure the catcode of space is correct to avoid
2550
% losing inside @example, for instance.
2551
%
2552
\def\set{\begingroup\catcode` =10
2553
\catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2554
\parsearg\setxxx}
2555
\def\setxxx#1{\setyyy#1 \endsetyyy}
2556
\def\setyyy#1 #2\endsetyyy{%
2557
\def\temp{#2}%
2558
\ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2559
\else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2560
\fi
2561
\endgroup
2562
}
2563
% Can't use \xdef to pre-expand #2 and save some time, since \temp or
2564
% \next or other control sequences that we've defined might get us into
2565
% an infinite loop. Consider `@set foo @cite{bar}'.
2566
\def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2567
2568
% @clear VAR clears (i.e., unsets) the variable VAR.
2569
%
2570
\def\clear{\parsearg\clearxxx}
2571
\def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2572
2573
% @value{foo} gets the text saved in variable foo.
2574
{
2575
\catcode`\_ = \active
2576
%
2577
% We might end up with active _ or - characters in the argument if
2578
% we're called from @code, as @code{@value{foo-bar_}}. So \let any
2579
% such active characters to their normal equivalents.
2580
\gdef\value{\begingroup
2581
\catcode`\-=12 \catcode`\_=12
2582
\indexbreaks \let_\normalunderscore
2583
\valuexxx}
2584
}
2585
\def\valuexxx#1{\expandablevalue{#1}\endgroup}
2586
2587
% We have this subroutine so that we can handle at least some @value's
2588
% properly in indexes (we \let\value to this in \indexdummies). Ones
2589
% whose names contain - or _ still won't work, but we can't do anything
2590
% about that. The command has to be fully expandable, since the result
2591
% winds up in the index file. This means that if the variable's value
2592
% contains other Texinfo commands, it's almost certain it will fail
2593
% (although perhaps we could fix that with sufficient work to do a
2594
% one-level expansion on the result, instead of complete).
2595
%
2596
\def\expandablevalue#1{%
2597
\expandafter\ifx\csname SET#1\endcsname\relax
2598
{[No value for ``#1'']}%
2599
\else
2600
\csname SET#1\endcsname
2601
\fi
2602
}
2603
2604
% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2605
% with @set.
2606
%
2607
\def\ifset{\parsearg\ifsetxxx}
2608
\def\ifsetxxx #1{%
2609
\expandafter\ifx\csname SET#1\endcsname\relax
2610
\expandafter\ifsetfail
2611
\else
2612
\expandafter\ifsetsucceed
2613
\fi
2614
}
2615
\def\ifsetsucceed{\conditionalsucceed{ifset}}
2616
\def\ifsetfail{\nestedignore{ifset}}
2617
\defineunmatchedend{ifset}
2618
2619
% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2620
% defined with @set, or has been undefined with @clear.
2621
%
2622
\def\ifclear{\parsearg\ifclearxxx}
2623
\def\ifclearxxx #1{%
2624
\expandafter\ifx\csname SET#1\endcsname\relax
2625
\expandafter\ifclearsucceed
2626
\else
2627
\expandafter\ifclearfail
2628
\fi
2629
}
2630
\def\ifclearsucceed{\conditionalsucceed{ifclear}}
2631
\def\ifclearfail{\nestedignore{ifclear}}
2632
\defineunmatchedend{ifclear}
2633
2634
% @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
2635
% following, through the first @end iftex (etc.). Make `@end iftex'
2636
% (etc.) valid only after an @iftex.
2637
%
2638
\def\iftex{\conditionalsucceed{iftex}}
2639
\def\ifnothtml{\conditionalsucceed{ifnothtml}}
2640
\def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2641
\defineunmatchedend{iftex}
2642
\defineunmatchedend{ifnothtml}
2643
\defineunmatchedend{ifnotinfo}
2644
2645
% We can't just want to start a group at @iftex (for example) and end it
2646
% at @end iftex, since then @set commands inside the conditional have no
2647
% effect (they'd get reverted at the end of the group). So we must
2648
% define \Eiftex to redefine itself to be its previous value. (We can't
2649
% just define it to fail again with an ``unmatched end'' error, since
2650
% the @ifset might be nested.)
2651
%
2652
\def\conditionalsucceed#1{%
2653
\edef\temp{%
2654
% Remember the current value of \E#1.
2655
\let\nece{prevE#1} = \nece{E#1}%
2656
%
2657
% At the `@end #1', redefine \E#1 to be its previous value.
2658
\def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2659
}%
2660
\temp
2661
}
2662
2663
% We need to expand lots of \csname's, but we don't want to expand the
2664
% control sequences after we've constructed them.
2665
%
2666
\def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2667
2668
% @defininfoenclose.
2669
\let\definfoenclose=\comment
2670
2671
2672
\message{indexing,}
2673
% Index generation facilities
2674
2675
% Define \newwrite to be identical to plain tex's \newwrite
2676
% except not \outer, so it can be used within \newindex.
2677
{\catcode`\@=11
2678
\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2679
2680
% \newindex {foo} defines an index named foo.
2681
% It automatically defines \fooindex such that
2682
% \fooindex ...rest of line... puts an entry in the index foo.
2683
% It also defines \fooindfile to be the number of the output channel for
2684
% the file that accumulates this index. The file's extension is foo.
2685
% The name of an index should be no more than 2 characters long
2686
% for the sake of vms.
2687
%
2688
\def\newindex#1{%
2689
\iflinks
2690
\expandafter\newwrite \csname#1indfile\endcsname
2691
\openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2692
\fi
2693
\expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2694
\noexpand\doindex{#1}}
2695
}
2696
2697
% @defindex foo == \newindex{foo}
2698
%
2699
\def\defindex{\parsearg\newindex}
2700
2701
% Define @defcodeindex, like @defindex except put all entries in @code.
2702
%
2703
\def\defcodeindex{\parsearg\newcodeindex}
2704
%
2705
\def\newcodeindex#1{%
2706
\iflinks
2707
\expandafter\newwrite \csname#1indfile\endcsname
2708
\openout \csname#1indfile\endcsname \jobname.#1
2709
\fi
2710
\expandafter\xdef\csname#1index\endcsname{%
2711
\noexpand\docodeindex{#1}}%
2712
}
2713
2714
2715
% @synindex foo bar makes index foo feed into index bar.
2716
% Do this instead of @defindex foo if you don't want it as a separate index.
2717
%
2718
% @syncodeindex foo bar similar, but put all entries made for index foo
2719
% inside @code.
2720
%
2721
\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2722
\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2723
2724
% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2725
% #3 the target index (bar).
2726
\def\dosynindex#1#2#3{%
2727
% Only do \closeout if we haven't already done it, else we'll end up
2728
% closing the target index.
2729
\expandafter \ifx\csname donesynindex#2\endcsname \undefined
2730
% The \closeout helps reduce unnecessary open files; the limit on the
2731
% Acorn RISC OS is a mere 16 files.
2732
\expandafter\closeout\csname#2indfile\endcsname
2733
\expandafter\let\csname\donesynindex#2\endcsname = 1
2734
\fi
2735
% redefine \fooindfile:
2736
\expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2737
\expandafter\let\csname#2indfile\endcsname=\temp
2738
% redefine \fooindex:
2739
\expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2740
}
2741
2742
% Define \doindex, the driver for all \fooindex macros.
2743
% Argument #1 is generated by the calling \fooindex macro,
2744
% and it is "foo", the name of the index.
2745
2746
% \doindex just uses \parsearg; it calls \doind for the actual work.
2747
% This is because \doind is more useful to call from other macros.
2748
2749
% There is also \dosubind {index}{topic}{subtopic}
2750
% which makes an entry in a two-level index such as the operation index.
2751
2752
\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2753
\def\singleindexer #1{\doind{\indexname}{#1}}
2754
2755
% like the previous two, but they put @code around the argument.
2756
\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2757
\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2758
2759
\def\indexdummies{%
2760
\def\ { }%
2761
% Take care of the plain tex accent commands.
2762
\def\"{\realbackslash "}%
2763
\def\`{\realbackslash `}%
2764
\def\'{\realbackslash '}%
2765
\def\^{\realbackslash ^}%
2766
\def\~{\realbackslash ~}%
2767
\def\={\realbackslash =}%
2768
\def\b{\realbackslash b}%
2769
\def\c{\realbackslash c}%
2770
\def\d{\realbackslash d}%
2771
\def\u{\realbackslash u}%
2772
\def\v{\realbackslash v}%
2773
\def\H{\realbackslash H}%
2774
% Take care of the plain tex special European modified letters.
2775
\def\oe{\realbackslash oe}%
2776
\def\ae{\realbackslash ae}%
2777
\def\aa{\realbackslash aa}%
2778
\def\OE{\realbackslash OE}%
2779
\def\AE{\realbackslash AE}%
2780
\def\AA{\realbackslash AA}%
2781
\def\o{\realbackslash o}%
2782
\def\O{\realbackslash O}%
2783
\def\l{\realbackslash l}%
2784
\def\L{\realbackslash L}%
2785
\def\ss{\realbackslash ss}%
2786
% Take care of texinfo commands likely to appear in an index entry.
2787
% (Must be a way to avoid doing expansion at all, and thus not have to
2788
% laboriously list every single command here.)
2789
\def\@{@}% will be @@ when we switch to @ as escape char.
2790
% Need these in case \tex is in effect and \{ is a \delimiter again.
2791
% But can't use \lbracecmd and \rbracecmd because texindex assumes
2792
% braces and backslashes are used only as delimiters.
2793
\let\{ = \mylbrace
2794
\let\} = \myrbrace
2795
\def\_{{\realbackslash _}}%
2796
\def\w{\realbackslash w }%
2797
\def\bf{\realbackslash bf }%
2798
%\def\rm{\realbackslash rm }%
2799
\def\sl{\realbackslash sl }%
2800
\def\sf{\realbackslash sf}%
2801
\def\tt{\realbackslash tt}%
2802
\def\gtr{\realbackslash gtr}%
2803
\def\less{\realbackslash less}%
2804
\def\hat{\realbackslash hat}%
2805
\def\TeX{\realbackslash TeX}%
2806
\def\dots{\realbackslash dots }%
2807
\def\result{\realbackslash result}%
2808
\def\equiv{\realbackslash equiv}%
2809
\def\expansion{\realbackslash expansion}%
2810
\def\print{\realbackslash print}%
2811
\def\error{\realbackslash error}%
2812
\def\point{\realbackslash point}%
2813
\def\copyright{\realbackslash copyright}%
2814
\def\tclose##1{\realbackslash tclose {##1}}%
2815
\def\code##1{\realbackslash code {##1}}%
2816
\def\uref##1{\realbackslash uref {##1}}%
2817
\def\url##1{\realbackslash url {##1}}%
2818
\def\env##1{\realbackslash env {##1}}%
2819
\def\command##1{\realbackslash command {##1}}%
2820
\def\option##1{\realbackslash option {##1}}%
2821
\def\dotless##1{\realbackslash dotless {##1}}%
2822
\def\samp##1{\realbackslash samp {##1}}%
2823
\def\,##1{\realbackslash ,{##1}}%
2824
\def\t##1{\realbackslash t {##1}}%
2825
\def\r##1{\realbackslash r {##1}}%
2826
\def\i##1{\realbackslash i {##1}}%
2827
\def\b##1{\realbackslash b {##1}}%
2828
\def\sc##1{\realbackslash sc {##1}}%
2829
\def\cite##1{\realbackslash cite {##1}}%
2830
\def\key##1{\realbackslash key {##1}}%
2831
\def\file##1{\realbackslash file {##1}}%
2832
\def\var##1{\realbackslash var {##1}}%
2833
\def\kbd##1{\realbackslash kbd {##1}}%
2834
\def\dfn##1{\realbackslash dfn {##1}}%
2835
\def\emph##1{\realbackslash emph {##1}}%
2836
\def\acronym##1{\realbackslash acronym {##1}}%
2837
%
2838
% Handle some cases of @value -- where the variable name does not
2839
% contain - or _, and the value does not contain any
2840
% (non-fully-expandable) commands.
2841
\let\value = \expandablevalue
2842
%
2843
\unsepspaces
2844
% Turn off macro expansion
2845
\turnoffmacros
2846
}
2847
2848
% If an index command is used in an @example environment, any spaces
2849
% therein should become regular spaces in the raw index file, not the
2850
% expansion of \tie (\\leavevmode \penalty \@M \ ).
2851
{\obeyspaces
2852
\gdef\unsepspaces{\obeyspaces\let =\space}}
2853
2854
% \indexnofonts no-ops all font-change commands.
2855
% This is used when outputting the strings to sort the index by.
2856
\def\indexdummyfont#1{#1}
2857
\def\indexdummytex{TeX}
2858
\def\indexdummydots{...}
2859
2860
\def\indexnofonts{%
2861
% Just ignore accents.
2862
\let\,=\indexdummyfont
2863
\let\"=\indexdummyfont
2864
\let\`=\indexdummyfont
2865
\let\'=\indexdummyfont
2866
\let\^=\indexdummyfont
2867
\let\~=\indexdummyfont
2868
\let\==\indexdummyfont
2869
\let\b=\indexdummyfont
2870
\let\c=\indexdummyfont
2871
\let\d=\indexdummyfont
2872
\let\u=\indexdummyfont
2873
\let\v=\indexdummyfont
2874
\let\H=\indexdummyfont
2875
\let\dotless=\indexdummyfont
2876
% Take care of the plain tex special European modified letters.
2877
\def\oe{oe}%
2878
\def\ae{ae}%
2879
\def\aa{aa}%
2880
\def\OE{OE}%
2881
\def\AE{AE}%
2882
\def\AA{AA}%
2883
\def\o{o}%
2884
\def\O{O}%
2885
\def\l{l}%
2886
\def\L{L}%
2887
\def\ss{ss}%
2888
\let\w=\indexdummyfont
2889
\let\t=\indexdummyfont
2890
\let\r=\indexdummyfont
2891
\let\i=\indexdummyfont
2892
\let\b=\indexdummyfont
2893
\let\emph=\indexdummyfont
2894
\let\strong=\indexdummyfont
2895
\let\cite=\indexdummyfont
2896
\let\sc=\indexdummyfont
2897
%Don't no-op \tt, since it isn't a user-level command
2898
% and is used in the definitions of the active chars like <, >, |...
2899
%\let\tt=\indexdummyfont
2900
\let\tclose=\indexdummyfont
2901
\let\code=\indexdummyfont
2902
\let\url=\indexdummyfont
2903
\let\uref=\indexdummyfont
2904
\let\env=\indexdummyfont
2905
\let\acronym=\indexdummyfont
2906
\let\command=\indexdummyfont
2907
\let\option=\indexdummyfont
2908
\let\file=\indexdummyfont
2909
\let\samp=\indexdummyfont
2910
\let\kbd=\indexdummyfont
2911
\let\key=\indexdummyfont
2912
\let\var=\indexdummyfont
2913
\let\TeX=\indexdummytex
2914
\let\dots=\indexdummydots
2915
\def\@{@}%
2916
}
2917
2918
% To define \realbackslash, we must make \ not be an escape.
2919
% We must first make another character (@) an escape
2920
% so we do not become unable to do a definition.
2921
2922
{\catcode`\@=0 \catcode`\\=\other
2923
@gdef@realbackslash{\}}
2924
2925
\let\indexbackslash=0 %overridden during \printindex.
2926
\let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2927
2928
% For \ifx comparisons.
2929
\def\emptymacro{\empty}
2930
2931
% Most index entries go through here, but \dosubind is the general case.
2932
%
2933
\def\doind#1#2{\dosubind{#1}{#2}\empty}
2934
2935
% Workhorse for all \fooindexes.
2936
% #1 is name of index, #2 is stuff to put there, #3 is subentry --
2937
% \empty if called from \doind, as we usually are. The main exception
2938
% is with defuns, which call us directly.
2939
%
2940
\def\dosubind#1#2#3{%
2941
% Put the index entry in the margin if desired.
2942
\ifx\SETmarginindex\relax\else
2943
\insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2944
\fi
2945
{%
2946
\count255=\lastpenalty
2947
{%
2948
\indexdummies % Must do this here, since \bf, etc expand at this stage
2949
\escapechar=`\\
2950
{%
2951
\let\folio = 0% We will expand all macros now EXCEPT \folio.
2952
\def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2953
% so it will be output as is; and it will print as backslash.
2954
%
2955
\def\thirdarg{#3}%
2956
%
2957
% If third arg is present, precede it with space in sort key.
2958
\ifx\thirdarg\emptymacro
2959
\let\subentry = \empty
2960
\else
2961
\def\subentry{ #3}%
2962
\fi
2963
%
2964
% First process the index entry with all font commands turned
2965
% off to get the string to sort by.
2966
{\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
2967
%
2968
% Now the real index entry with the fonts.
2969
\toks0 = {#2}%
2970
%
2971
% If the third (subentry) arg is present, add it to the index
2972
% line to write.
2973
\ifx\thirdarg\emptymacro \else
2974
\toks0 = \expandafter{\the\toks0{#3}}%
2975
\fi
2976
%
2977
% Set up the complete index entry, with both the sort key and
2978
% the original text, including any font commands. We write
2979
% three arguments to \entry to the .?? file (four in the
2980
% subentry case), texindex reduces to two when writing the .??s
2981
% sorted result.
2982
\edef\temp{%
2983
\write\csname#1indfile\endcsname{%
2984
\realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2985
}%
2986
%
2987
% If a skip is the last thing on the list now, preserve it
2988
% by backing up by \lastskip, doing the \write, then inserting
2989
% the skip again. Otherwise, the whatsit generated by the
2990
% \write will make \lastskip zero. The result is that sequences
2991
% like this:
2992
% @end defun
2993
% @tindex whatever
2994
% @defun ...
2995
% will have extra space inserted, because the \medbreak in the
2996
% start of the @defun won't see the skip inserted by the @end of
2997
% the previous defun.
2998
%
2999
% But don't do any of this if we're not in vertical mode. We
3000
% don't want to do a \vskip and prematurely end a paragraph.
3001
%
3002
% Avoid page breaks due to these extra skips, too.
3003
%
3004
\iflinks
3005
\ifvmode
3006
\skip0 = \lastskip
3007
\ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
3008
\fi
3009
%
3010
\temp % do the write
3011
%
3012
%
3013
\ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3014
\fi
3015
}%
3016
}%
3017
\penalty\count255
3018
}%
3019
}
3020
3021
% The index entry written in the file actually looks like
3022
% \entry {sortstring}{page}{topic}
3023
% or
3024
% \entry {sortstring}{page}{topic}{subtopic}
3025
% The texindex program reads in these files and writes files
3026
% containing these kinds of lines:
3027
% \initial {c}
3028
% before the first topic whose initial is c
3029
% \entry {topic}{pagelist}
3030
% for a topic that is used without subtopics
3031
% \primary {topic}
3032
% for the beginning of a topic that is used with subtopics
3033
% \secondary {subtopic}{pagelist}
3034
% for each subtopic.
3035
3036
% Define the user-accessible indexing commands
3037
% @findex, @vindex, @kindex, @cindex.
3038
3039
\def\findex {\fnindex}
3040
\def\kindex {\kyindex}
3041
\def\cindex {\cpindex}
3042
\def\vindex {\vrindex}
3043
\def\tindex {\tpindex}
3044
\def\pindex {\pgindex}
3045
3046
\def\cindexsub {\begingroup\obeylines\cindexsub}
3047
{\obeylines %
3048
\gdef\cindexsub "#1" #2^^M{\endgroup %
3049
\dosubind{cp}{#2}{#1}}}
3050
3051
% Define the macros used in formatting output of the sorted index material.
3052
3053
% @printindex causes a particular index (the ??s file) to get printed.
3054
% It does not print any chapter heading (usually an @unnumbered).
3055
%
3056
\def\printindex{\parsearg\doprintindex}
3057
\def\doprintindex#1{\begingroup
3058
\dobreak \chapheadingskip{10000}%
3059
%
3060
\smallfonts \rm
3061
\tolerance = 9500
3062
\indexbreaks
3063
%
3064
% See if the index file exists and is nonempty.
3065
% Change catcode of @ here so that if the index file contains
3066
% \initial {@}
3067
% as its first line, TeX doesn't complain about mismatched braces
3068
% (because it thinks @} is a control sequence).
3069
\catcode`\@ = 11
3070
\openin 1 \jobname.#1s
3071
\ifeof 1
3072
% \enddoublecolumns gets confused if there is no text in the index,
3073
% and it loses the chapter title and the aux file entries for the
3074
% index. The easiest way to prevent this problem is to make sure
3075
% there is some text.
3076
\putwordIndexNonexistent
3077
\else
3078
%
3079
% If the index file exists but is empty, then \openin leaves \ifeof
3080
% false. We have to make TeX try to read something from the file, so
3081
% it can discover if there is anything in it.
3082
\read 1 to \temp
3083
\ifeof 1
3084
\putwordIndexIsEmpty
3085
\else
3086
% Index files are almost Texinfo source, but we use \ as the escape
3087
% character. It would be better to use @, but that's too big a change
3088
% to make right now.
3089
\def\indexbackslash{\rawbackslashxx}%
3090
\catcode`\\ = 0
3091
\escapechar = `\\
3092
\begindoublecolumns
3093
\input \jobname.#1s
3094
\enddoublecolumns
3095
\fi
3096
\fi
3097
\closein 1
3098
\endgroup}
3099
3100
% These macros are used by the sorted index file itself.
3101
% Change them to control the appearance of the index.
3102
3103
\def\initial#1{{%
3104
% Some minor font changes for the special characters.
3105
\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3106
%
3107
% Remove any glue we may have, we'll be inserting our own.
3108
\removelastskip
3109
%
3110
% We like breaks before the index initials, so insert a bonus.
3111
\penalty -300
3112
%
3113
% Typeset the initial. Making this add up to a whole number of
3114
% baselineskips increases the chance of the dots lining up from column
3115
% to column. It still won't often be perfect, because of the stretch
3116
% we need before each entry, but it's better.
3117
%
3118
% No shrink because it confuses \balancecolumns.
3119
\vskip 1.67\baselineskip plus .5\baselineskip
3120
\leftline{\secbf #1}%
3121
\vskip .33\baselineskip plus .1\baselineskip
3122
%
3123
% Do our best not to break after the initial.
3124
\nobreak
3125
}}
3126
3127
% This typesets a paragraph consisting of #1, dot leaders, and then #2
3128
% flush to the right margin. It is used for index and table of contents
3129
% entries. The paragraph is indented by \leftskip.
3130
%
3131
\def\entry#1#2{\begingroup
3132
%
3133
% Start a new paragraph if necessary, so our assignments below can't
3134
% affect previous text.
3135
\par
3136
%
3137
% Do not fill out the last line with white space.
3138
\parfillskip = 0in
3139
%
3140
% No extra space above this paragraph.
3141
\parskip = 0in
3142
%
3143
% Do not prefer a separate line ending with a hyphen to fewer lines.
3144
\finalhyphendemerits = 0
3145
%
3146
% \hangindent is only relevant when the entry text and page number
3147
% don't both fit on one line. In that case, bob suggests starting the
3148
% dots pretty far over on the line. Unfortunately, a large
3149
% indentation looks wrong when the entry text itself is broken across
3150
% lines. So we use a small indentation and put up with long leaders.
3151
%
3152
% \hangafter is reset to 1 (which is the value we want) at the start
3153
% of each paragraph, so we need not do anything with that.
3154
\hangindent = 2em
3155
%
3156
% When the entry text needs to be broken, just fill out the first line
3157
% with blank space.
3158
\rightskip = 0pt plus1fil
3159
%
3160
% A bit of stretch before each entry for the benefit of balancing columns.
3161
\vskip 0pt plus1pt
3162
%
3163
% Start a ``paragraph'' for the index entry so the line breaking
3164
% parameters we've set above will have an effect.
3165
\noindent
3166
%
3167
% Insert the text of the index entry. TeX will do line-breaking on it.
3168
#1%
3169
% The following is kludged to not output a line of dots in the index if
3170
% there are no page numbers. The next person who breaks this will be
3171
% cursed by a Unix daemon.
3172
\def\tempa{{\rm }}%
3173
\def\tempb{#2}%
3174
\edef\tempc{\tempa}%
3175
\edef\tempd{\tempb}%
3176
\ifx\tempc\tempd\ \else%
3177
%
3178
% If we must, put the page number on a line of its own, and fill out
3179
% this line with blank space. (The \hfil is overwhelmed with the
3180
% fill leaders glue in \indexdotfill if the page number does fit.)
3181
\hfil\penalty50
3182
\null\nobreak\indexdotfill % Have leaders before the page number.
3183
%
3184
% The `\ ' here is removed by the implicit \unskip that TeX does as
3185
% part of (the primitive) \par. Without it, a spurious underfull
3186
% \hbox ensues.
3187
\ifpdf
3188
\pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3189
\else
3190
\ #2% The page number ends the paragraph.
3191
\fi
3192
\fi%
3193
\par
3194
\endgroup}
3195
3196
% Like \dotfill except takes at least 1 em.
3197
\def\indexdotfill{\cleaders
3198
\hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3199
3200
\def\primary #1{\line{#1\hfil}}
3201
3202
\newskip\secondaryindent \secondaryindent=0.5cm
3203
\def\secondary#1#2{{%
3204
\parfillskip=0in
3205
\parskip=0in
3206
\hangindent=1in
3207
\hangafter=1
3208
\noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3209
\ifpdf
3210
\pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3211
\else
3212
#2
3213
\fi
3214
\par
3215
}}
3216
3217
% Define two-column mode, which we use to typeset indexes.
3218
% Adapted from the TeXbook, page 416, which is to say,
3219
% the manmac.tex format used to print the TeXbook itself.
3220
\catcode`\@=11
3221
3222
\newbox\partialpage
3223
\newdimen\doublecolumnhsize
3224
3225
\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3226
% Grab any single-column material above us.
3227
\output = {%
3228
%
3229
% Here is a possibility not foreseen in manmac: if we accumulate a
3230
% whole lot of material, we might end up calling this \output
3231
% routine twice in a row (see the doublecol-lose test, which is
3232
% essentially a couple of indexes with @setchapternewpage off). In
3233
% that case we just ship out what is in \partialpage with the normal
3234
% output routine. Generally, \partialpage will be empty when this
3235
% runs and this will be a no-op. See the indexspread.tex test case.
3236
\ifvoid\partialpage \else
3237
\onepageout{\pagecontents\partialpage}%
3238
\fi
3239
%
3240
\global\setbox\partialpage = \vbox{%
3241
% Unvbox the main output page.
3242
\unvbox\PAGE
3243
\kern-\topskip \kern\baselineskip
3244
}%
3245
}%
3246
\eject % run that output routine to set \partialpage
3247
%
3248
% Use the double-column output routine for subsequent pages.
3249
\output = {\doublecolumnout}%
3250
%
3251
% Change the page size parameters. We could do this once outside this
3252
% routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3253
% format, but then we repeat the same computation. Repeating a couple
3254
% of assignments once per index is clearly meaningless for the
3255
% execution time, so we may as well do it in one place.
3256
%
3257
% First we halve the line length, less a little for the gutter between
3258
% the columns. We compute the gutter based on the line length, so it
3259
% changes automatically with the paper format. The magic constant
3260
% below is chosen so that the gutter has the same value (well, +-<1pt)
3261
% as it did when we hard-coded it.
3262
%
3263
% We put the result in a separate register, \doublecolumhsize, so we
3264
% can restore it in \pagesofar, after \hsize itself has (potentially)
3265
% been clobbered.
3266
%
3267
\doublecolumnhsize = \hsize
3268
\advance\doublecolumnhsize by -.04154\hsize
3269
\divide\doublecolumnhsize by 2
3270
\hsize = \doublecolumnhsize
3271
%
3272
% Double the \vsize as well. (We don't need a separate register here,
3273
% since nobody clobbers \vsize.)
3274
\vsize = 2\vsize
3275
}
3276
3277
% The double-column output routine for all double-column pages except
3278
% the last.
3279
%
3280
\def\doublecolumnout{%
3281
\splittopskip=\topskip \splitmaxdepth=\maxdepth
3282
% Get the available space for the double columns -- the normal
3283
% (undoubled) page height minus any material left over from the
3284
% previous page.
3285
\dimen@ = \vsize
3286
\divide\dimen@ by 2
3287
\advance\dimen@ by -\ht\partialpage
3288
%
3289
% box0 will be the left-hand column, box2 the right.
3290
\setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3291
\onepageout\pagesofar
3292
\unvbox255
3293
\penalty\outputpenalty
3294
}
3295
%
3296
% Re-output the contents of the output page -- any previous material,
3297
% followed by the two boxes we just split, in box0 and box2.
3298
\def\pagesofar{%
3299
\unvbox\partialpage
3300
%
3301
\hsize = \doublecolumnhsize
3302
\wd0=\hsize \wd2=\hsize
3303
\hbox to\pagewidth{\box0\hfil\box2}%
3304
}
3305
%
3306
% All done with double columns.
3307
\def\enddoublecolumns{%
3308
\output = {%
3309
% Split the last of the double-column material. Leave it on the
3310
% current page, no automatic page break.
3311
\balancecolumns
3312
%
3313
% If we end up splitting too much material for the current page,
3314
% though, there will be another page break right after this \output
3315
% invocation ends. Having called \balancecolumns once, we do not
3316
% want to call it again. Therefore, reset \output to its normal
3317
% definition right away. (We hope \balancecolumns will never be
3318
% called on to balance too much material, but if it is, this makes
3319
% the output somewhat more palatable.)
3320
\global\output = {\onepageout{\pagecontents\PAGE}}%
3321
}%
3322
\eject
3323
\endgroup % started in \begindoublecolumns
3324
%
3325
% \pagegoal was set to the doubled \vsize above, since we restarted
3326
% the current page. We're now back to normal single-column
3327
% typesetting, so reset \pagegoal to the normal \vsize (after the
3328
% \endgroup where \vsize got restored).
3329
\pagegoal = \vsize
3330
}
3331
%
3332
% Called at the end of the double column material.
3333
\def\balancecolumns{%
3334
\setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3335
\dimen@ = \ht0
3336
\advance\dimen@ by \topskip
3337
\advance\dimen@ by-\baselineskip
3338
\divide\dimen@ by 2 % target to split to
3339
%debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3340
\splittopskip = \topskip
3341
% Loop until we get a decent breakpoint.
3342
{%
3343
\vbadness = 10000
3344
\loop
3345
\global\setbox3 = \copy0
3346
\global\setbox1 = \vsplit3 to \dimen@
3347
\ifdim\ht3>\dimen@
3348
\global\advance\dimen@ by 1pt
3349
\repeat
3350
}%
3351
%debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3352
\setbox0=\vbox to\dimen@{\unvbox1}%
3353
\setbox2=\vbox to\dimen@{\unvbox3}%
3354
%
3355
\pagesofar
3356
}
3357
\catcode`\@ = \other
3358
3359
3360
\message{sectioning,}
3361
% Chapters, sections, etc.
3362
3363
\newcount\chapno
3364
\newcount\secno \secno=0
3365
\newcount\subsecno \subsecno=0
3366
\newcount\subsubsecno \subsubsecno=0
3367
3368
% This counter is funny since it counts through charcodes of letters A, B, ...
3369
\newcount\appendixno \appendixno = `\@
3370
% \def\appendixletter{\char\the\appendixno}
3371
% We do the following for the sake of pdftex, which needs the actual
3372
% letter in the expansion, not just typeset.
3373
\def\appendixletter{%
3374
\ifnum\appendixno=`A A%
3375
\else\ifnum\appendixno=`B B%
3376
\else\ifnum\appendixno=`C C%
3377
\else\ifnum\appendixno=`D D%
3378
\else\ifnum\appendixno=`E E%
3379
\else\ifnum\appendixno=`F F%
3380
\else\ifnum\appendixno=`G G%
3381
\else\ifnum\appendixno=`H H%
3382
\else\ifnum\appendixno=`I I%
3383
\else\ifnum\appendixno=`J J%
3384
\else\ifnum\appendixno=`K K%
3385
\else\ifnum\appendixno=`L L%
3386
\else\ifnum\appendixno=`M M%
3387
\else\ifnum\appendixno=`N N%
3388
\else\ifnum\appendixno=`O O%
3389
\else\ifnum\appendixno=`P P%
3390
\else\ifnum\appendixno=`Q Q%
3391
\else\ifnum\appendixno=`R R%
3392
\else\ifnum\appendixno=`S S%
3393
\else\ifnum\appendixno=`T T%
3394
\else\ifnum\appendixno=`U U%
3395
\else\ifnum\appendixno=`V V%
3396
\else\ifnum\appendixno=`W W%
3397
\else\ifnum\appendixno=`X X%
3398
\else\ifnum\appendixno=`Y Y%
3399
\else\ifnum\appendixno=`Z Z%
3400
% The \the is necessary, despite appearances, because \appendixletter is
3401
% expanded while writing the .toc file. \char\appendixno is not
3402
% expandable, thus it is written literally, thus all appendixes come out
3403
% with the same letter (or @) in the toc without it.
3404
\else\char\the\appendixno
3405
\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3406
\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3407
3408
% Each @chapter defines this as the name of the chapter.
3409
% page headings and footings can use it. @section does likewise.
3410
\def\thischapter{}
3411
\def\thissection{}
3412
3413
\newcount\absseclevel % used to calculate proper heading level
3414
\newcount\secbase\secbase=0 % @raise/lowersections modify this count
3415
3416
% @raisesections: treat @section as chapter, @subsection as section, etc.
3417
\def\raisesections{\global\advance\secbase by -1}
3418
\let\up=\raisesections % original BFox name
3419
3420
% @lowersections: treat @chapter as section, @section as subsection, etc.
3421
\def\lowersections{\global\advance\secbase by 1}
3422
\let\down=\lowersections % original BFox name
3423
3424
% Choose a numbered-heading macro
3425
% #1 is heading level if unmodified by @raisesections or @lowersections
3426
% #2 is text for heading
3427
\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3428
\ifcase\absseclevel
3429
\chapterzzz{#2}
3430
\or
3431
\seczzz{#2}
3432
\or
3433
\numberedsubseczzz{#2}
3434
\or
3435
\numberedsubsubseczzz{#2}
3436
\else
3437
\ifnum \absseclevel<0
3438
\chapterzzz{#2}
3439
\else
3440
\numberedsubsubseczzz{#2}
3441
\fi
3442
\fi
3443
}
3444
3445
% like \numhead, but chooses appendix heading levels
3446
\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3447
\ifcase\absseclevel
3448
\appendixzzz{#2}
3449
\or
3450
\appendixsectionzzz{#2}
3451
\or
3452
\appendixsubseczzz{#2}
3453
\or
3454
\appendixsubsubseczzz{#2}
3455
\else
3456
\ifnum \absseclevel<0
3457
\appendixzzz{#2}
3458
\else
3459
\appendixsubsubseczzz{#2}
3460
\fi
3461
\fi
3462
}
3463
3464
% like \numhead, but chooses numberless heading levels
3465
\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3466
\ifcase\absseclevel
3467
\unnumberedzzz{#2}
3468
\or
3469
\unnumberedseczzz{#2}
3470
\or
3471
\unnumberedsubseczzz{#2}
3472
\or
3473
\unnumberedsubsubseczzz{#2}
3474
\else
3475
\ifnum \absseclevel<0
3476
\unnumberedzzz{#2}
3477
\else
3478
\unnumberedsubsubseczzz{#2}
3479
\fi
3480
\fi
3481
}
3482
3483
% @chapter, @appendix, @unnumbered.
3484
\def\thischaptername{No Chapter Title}
3485
\outer\def\chapter{\parsearg\chapteryyy}
3486
\def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3487
\def\chapterzzz #1{%
3488
\secno=0 \subsecno=0 \subsubsecno=0
3489
\global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3490
\chapmacro {#1}{\the\chapno}%
3491
\gdef\thissection{#1}%
3492
\gdef\thischaptername{#1}%
3493
% We don't substitute the actual chapter name into \thischapter
3494
% because we don't want its macros evaluated now.
3495
\xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3496
\toks0 = {#1}%
3497
\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3498
{\the\chapno}}}%
3499
\temp
3500
\donoderef
3501
\global\let\section = \numberedsec
3502
\global\let\subsection = \numberedsubsec
3503
\global\let\subsubsection = \numberedsubsubsec
3504
}
3505
3506
\outer\def\appendix{\parsearg\appendixyyy}
3507
\def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3508
\def\appendixzzz #1{%
3509
\secno=0 \subsecno=0 \subsubsecno=0
3510
\global\advance \appendixno by 1
3511
\message{\putwordAppendix\space \appendixletter}%
3512
\chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3513
\gdef\thissection{#1}%
3514
\gdef\thischaptername{#1}%
3515
\xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3516
\toks0 = {#1}%
3517
\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}%
3518
{\putwordAppendix{} \appendixletter}}}%
3519
\temp
3520
\appendixnoderef
3521
\global\let\section = \appendixsec
3522
\global\let\subsection = \appendixsubsec
3523
\global\let\subsubsection = \appendixsubsubsec
3524
}
3525
3526
% @centerchap is like @unnumbered, but the heading is centered.
3527
\outer\def\centerchap{\parsearg\centerchapyyy}
3528
\def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3529
3530
% @top is like @unnumbered.
3531
\outer\def\top{\parsearg\unnumberedyyy}
3532
3533
\outer\def\unnumbered{\parsearg\unnumberedyyy}
3534
\def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3535
\def\unnumberedzzz #1{%
3536
\secno=0 \subsecno=0 \subsubsecno=0
3537
%
3538
% This used to be simply \message{#1}, but TeX fully expands the
3539
% argument to \message. Therefore, if #1 contained @-commands, TeX
3540
% expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3541
% expanded @cite (which turns out to cause errors because \cite is meant
3542
% to be executed, not expanded).
3543
%
3544
% Anyway, we don't want the fully-expanded definition of @cite to appear
3545
% as a result of the \message, we just want `@cite' itself. We use
3546
% \the<toks register> to achieve this: TeX expands \the<toks> only once,
3547
% simply yielding the contents of <toks register>. (We also do this for
3548
% the toc entries.)
3549
\toks0 = {#1}\message{(\the\toks0)}%
3550
%
3551
\unnumbchapmacro {#1}%
3552
\gdef\thischapter{#1}\gdef\thissection{#1}%
3553
\toks0 = {#1}%
3554
\edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3555
\temp
3556
\unnumbnoderef
3557
\global\let\section = \unnumberedsec
3558
\global\let\subsection = \unnumberedsubsec
3559
\global\let\subsubsection = \unnumberedsubsubsec
3560
}
3561
3562
% Sections.
3563
\outer\def\numberedsec{\parsearg\secyyy}
3564
\def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3565
\def\seczzz #1{%
3566
\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3567
\gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3568
\toks0 = {#1}%
3569
\edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3570
{\the\chapno}{\the\secno}}}%
3571
\temp
3572
\donoderef
3573
\nobreak
3574
}
3575
3576
\outer\def\appendixsection{\parsearg\appendixsecyyy}
3577
\outer\def\appendixsec{\parsearg\appendixsecyyy}
3578
\def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3579
\def\appendixsectionzzz #1{%
3580
\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3581
\gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3582
\toks0 = {#1}%
3583
\edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3584
{\appendixletter}{\the\secno}}}%
3585
\temp
3586
\appendixnoderef
3587
\nobreak
3588
}
3589
3590
\outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3591
\def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3592
\def\unnumberedseczzz #1{%
3593
\plainsecheading {#1}\gdef\thissection{#1}%
3594
\toks0 = {#1}%
3595
\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}%
3596
\temp
3597
\unnumbnoderef
3598
\nobreak
3599
}
3600
3601
% Subsections.
3602
\outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3603
\def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3604
\def\numberedsubseczzz #1{%
3605
\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3606
\subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3607
\toks0 = {#1}%
3608
\edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3609
{\the\chapno}{\the\secno}{\the\subsecno}}}%
3610
\temp
3611
\donoderef
3612
\nobreak
3613
}
3614
3615
\outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3616
\def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3617
\def\appendixsubseczzz #1{%
3618
\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3619
\subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3620
\toks0 = {#1}%
3621
\edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3622
{\appendixletter}{\the\secno}{\the\subsecno}}}%
3623
\temp
3624
\appendixnoderef
3625
\nobreak
3626
}
3627
3628
\outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3629
\def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3630
\def\unnumberedsubseczzz #1{%
3631
\plainsubsecheading {#1}\gdef\thissection{#1}%
3632
\toks0 = {#1}%
3633
\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3634
{\the\toks0}}}%
3635
\temp
3636
\unnumbnoderef
3637
\nobreak
3638
}
3639
3640
% Subsubsections.
3641
\outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3642
\def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3643
\def\numberedsubsubseczzz #1{%
3644
\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3645
\subsubsecheading {#1}
3646
{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3647
\toks0 = {#1}%
3648
\edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3649
{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3650
\temp
3651
\donoderef
3652
\nobreak
3653
}
3654
3655
\outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3656
\def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3657
\def\appendixsubsubseczzz #1{%
3658
\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3659
\subsubsecheading {#1}
3660
{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3661
\toks0 = {#1}%
3662
\edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3663
{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3664
\temp
3665
\appendixnoderef
3666
\nobreak
3667
}
3668
3669
\outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3670
\def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3671
\def\unnumberedsubsubseczzz #1{%
3672
\plainsubsubsecheading {#1}\gdef\thissection{#1}%
3673
\toks0 = {#1}%
3674
\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3675
{\the\toks0}}}%
3676
\temp
3677
\unnumbnoderef
3678
\nobreak
3679
}
3680
3681
% These are variants which are not "outer", so they can appear in @ifinfo.
3682
% Actually, they should now be obsolete; ordinary section commands should work.
3683
\def\infotop{\parsearg\unnumberedzzz}
3684
\def\infounnumbered{\parsearg\unnumberedzzz}
3685
\def\infounnumberedsec{\parsearg\unnumberedseczzz}
3686
\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3687
\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3688
3689
\def\infoappendix{\parsearg\appendixzzz}
3690
\def\infoappendixsec{\parsearg\appendixseczzz}
3691
\def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3692
\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3693
3694
\def\infochapter{\parsearg\chapterzzz}
3695
\def\infosection{\parsearg\sectionzzz}
3696
\def\infosubsection{\parsearg\subsectionzzz}
3697
\def\infosubsubsection{\parsearg\subsubsectionzzz}
3698
3699
% These macros control what the section commands do, according
3700
% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3701
% Define them by default for a numbered chapter.
3702
\global\let\section = \numberedsec
3703
\global\let\subsection = \numberedsubsec
3704
\global\let\subsubsection = \numberedsubsubsec
3705
3706
% Define @majorheading, @heading and @subheading
3707
3708
% NOTE on use of \vbox for chapter headings, section headings, and such:
3709
% 1) We use \vbox rather than the earlier \line to permit
3710
% overlong headings to fold.
3711
% 2) \hyphenpenalty is set to 10000 because hyphenation in a
3712
% heading is obnoxious; this forbids it.
3713
% 3) Likewise, headings look best if no \parindent is used, and
3714
% if justification is not attempted. Hence \raggedright.
3715
3716
3717
\def\majorheading{\parsearg\majorheadingzzz}
3718
\def\majorheadingzzz #1{%
3719
{\advance\chapheadingskip by 10pt \chapbreak }%
3720
{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3721
\parindent=0pt\raggedright
3722
\rm #1\hfill}}\bigskip \par\penalty 200}
3723
3724
\def\chapheading{\parsearg\chapheadingzzz}
3725
\def\chapheadingzzz #1{\chapbreak %
3726
{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3727
\parindent=0pt\raggedright
3728
\rm #1\hfill}}\bigskip \par\penalty 200}
3729
3730
% @heading, @subheading, @subsubheading.
3731
\def\heading{\parsearg\plainsecheading}
3732
\def\subheading{\parsearg\plainsubsecheading}
3733
\def\subsubheading{\parsearg\plainsubsubsecheading}
3734
3735
% These macros generate a chapter, section, etc. heading only
3736
% (including whitespace, linebreaking, etc. around it),
3737
% given all the information in convenient, parsed form.
3738
3739
%%% Args are the skip and penalty (usually negative)
3740
\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3741
3742
\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3743
3744
%%% Define plain chapter starts, and page on/off switching for it
3745
% Parameter controlling skip before chapter headings (if needed)
3746
3747
\newskip\chapheadingskip
3748
3749
\def\chapbreak{\dobreak \chapheadingskip {-4000}}
3750
\def\chappager{\par\vfill\supereject}
3751
\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3752
3753
\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3754
3755
\def\CHAPPAGoff{%
3756
\global\let\contentsalignmacro = \chappager
3757
\global\let\pchapsepmacro=\chapbreak
3758
\global\let\pagealignmacro=\chappager}
3759
3760
\def\CHAPPAGon{%
3761
\global\let\contentsalignmacro = \chappager
3762
\global\let\pchapsepmacro=\chappager
3763
\global\let\pagealignmacro=\chappager
3764
\global\def\HEADINGSon{\HEADINGSsingle}}
3765
3766
\def\CHAPPAGodd{
3767
\global\let\contentsalignmacro = \chapoddpage
3768
\global\let\pchapsepmacro=\chapoddpage
3769
\global\let\pagealignmacro=\chapoddpage
3770
\global\def\HEADINGSon{\HEADINGSdouble}}
3771
3772
\CHAPPAGon
3773
3774
\def\CHAPFplain{
3775
\global\let\chapmacro=\chfplain
3776
\global\let\unnumbchapmacro=\unnchfplain
3777
\global\let\centerchapmacro=\centerchfplain}
3778
3779
% Plain chapter opening.
3780
% #1 is the text, #2 the chapter number or empty if unnumbered.
3781
\def\chfplain#1#2{%
3782
\pchapsepmacro
3783
{%
3784
\chapfonts \rm
3785
\def\chapnum{#2}%
3786
\setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3787
\vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3788
\hangindent = \wd0 \centerparametersmaybe
3789
\unhbox0 #1\par}%
3790
}%
3791
\nobreak\bigskip % no page break after a chapter title
3792
\nobreak
3793
}
3794
3795
% Plain opening for unnumbered.
3796
\def\unnchfplain#1{\chfplain{#1}{}}
3797
3798
% @centerchap -- centered and unnumbered.
3799
\let\centerparametersmaybe = \relax
3800
\def\centerchfplain#1{{%
3801
\def\centerparametersmaybe{%
3802
\advance\rightskip by 3\rightskip
3803
\leftskip = \rightskip
3804
\parfillskip = 0pt
3805
}%
3806
\chfplain{#1}{}%
3807
}}
3808
3809
\CHAPFplain % The default
3810
3811
\def\unnchfopen #1{%
3812
\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3813
\parindent=0pt\raggedright
3814
\rm #1\hfill}}\bigskip \par\nobreak
3815
}
3816
3817
\def\chfopen #1#2{\chapoddpage {\chapfonts
3818
\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3819
\par\penalty 5000 %
3820
}
3821
3822
\def\centerchfopen #1{%
3823
\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3824
\parindent=0pt
3825
\hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3826
}
3827
3828
\def\CHAPFopen{
3829
\global\let\chapmacro=\chfopen
3830
\global\let\unnumbchapmacro=\unnchfopen
3831
\global\let\centerchapmacro=\centerchfopen}
3832
3833
3834
% Section titles.
3835
\newskip\secheadingskip
3836
\def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3837
\def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3838
\def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3839
3840
% Subsection titles.
3841
\newskip \subsecheadingskip
3842
\def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3843
\def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3844
\def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3845
3846
% Subsubsection titles.
3847
\let\subsubsecheadingskip = \subsecheadingskip
3848
\let\subsubsecheadingbreak = \subsecheadingbreak
3849
\def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3850
\def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3851
3852
3853
% Print any size section title.
3854
%
3855
% #1 is the section type (sec/subsec/subsubsec), #2 is the section
3856
% number (maybe empty), #3 the text.
3857
\def\sectionheading#1#2#3{%
3858
{%
3859
\expandafter\advance\csname #1headingskip\endcsname by \parskip
3860
\csname #1headingbreak\endcsname
3861
}%
3862
{%
3863
% Switch to the right set of fonts.
3864
\csname #1fonts\endcsname \rm
3865
%
3866
% Only insert the separating space if we have a section number.
3867
\def\secnum{#2}%
3868
\setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3869
%
3870
\vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3871
\hangindent = \wd0 % zero if no section number
3872
\unhbox0 #3}%
3873
}%
3874
\ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3875
}
3876
3877
3878
\message{toc,}
3879
% Table of contents.
3880
\newwrite\tocfile
3881
3882
% Write an entry to the toc file, opening it if necessary.
3883
% Called from @chapter, etc. We supply {\folio} at the end of the
3884
% argument, which will end up as the last argument to the \...entry macro.
3885
%
3886
% We open the .toc file here instead of at @setfilename or any other
3887
% given time so that @contents can be put in the document anywhere.
3888
%
3889
\newif\iftocfileopened
3890
\def\writetocentry#1{%
3891
\iftocfileopened\else
3892
\immediate\openout\tocfile = \jobname.toc
3893
\global\tocfileopenedtrue
3894
\fi
3895
\iflinks \write\tocfile{#1{\folio}}\fi
3896
}
3897
3898
\newskip\contentsrightmargin \contentsrightmargin=1in
3899
\newcount\savepageno
3900
\newcount\lastnegativepageno \lastnegativepageno = -1
3901
3902
% Finish up the main text and prepare to read what we've written
3903
% to \tocfile.
3904
%
3905
\def\startcontents#1{%
3906
% If @setchapternewpage on, and @headings double, the contents should
3907
% start on an odd page, unlike chapters. Thus, we maintain
3908
% \contentsalignmacro in parallel with \pagealignmacro.
3909
% From: Torbjorn Granlund <tege@matematik.su.se>
3910
\contentsalignmacro
3911
\immediate\closeout\tocfile
3912
%
3913
% Don't need to put `Contents' or `Short Contents' in the headline.
3914
% It is abundantly clear what they are.
3915
\unnumbchapmacro{#1}\def\thischapter{}%
3916
\savepageno = \pageno
3917
\begingroup % Set up to handle contents files properly.
3918
\catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3919
% We can't do this, because then an actual ^ in a section
3920
% title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3921
%\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3922
\raggedbottom % Worry more about breakpoints than the bottom.
3923
\advance\hsize by -\contentsrightmargin % Don't use the full line length.
3924
%
3925
% Roman numerals for page numbers.
3926
\ifnum \pageno>0 \pageno = \lastnegativepageno \fi
3927
}
3928
3929
3930
% Normal (long) toc.
3931
\def\contents{%
3932
\startcontents{\putwordTOC}%
3933
\openin 1 \jobname.toc
3934
\ifeof 1 \else
3935
\closein 1
3936
\input \jobname.toc
3937
\fi
3938
\vfill \eject
3939
\contentsalignmacro % in case @setchapternewpage odd is in effect
3940
\pdfmakeoutlines
3941
\endgroup
3942
\lastnegativepageno = \pageno
3943
\pageno = \savepageno
3944
}
3945
3946
% And just the chapters.
3947
\def\summarycontents{%
3948
\startcontents{\putwordShortTOC}%
3949
%
3950
\let\chapentry = \shortchapentry
3951
\let\unnumbchapentry = \shortunnumberedentry
3952
% We want a true roman here for the page numbers.
3953
\secfonts
3954
\let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3955
\rm
3956
\hyphenpenalty = 10000
3957
\advance\baselineskip by 1pt % Open it up a little.
3958
\def\secentry ##1##2##3##4{}
3959
\def\unnumbsecentry ##1##2{}
3960
\def\subsecentry ##1##2##3##4##5{}
3961
\def\unnumbsubsecentry ##1##2{}
3962
\def\subsubsecentry ##1##2##3##4##5##6{}
3963
\def\unnumbsubsubsecentry ##1##2{}
3964
\openin 1 \jobname.toc
3965
\ifeof 1 \else
3966
\closein 1
3967
\input \jobname.toc
3968
\fi
3969
\vfill \eject
3970
\contentsalignmacro % in case @setchapternewpage odd is in effect
3971
\endgroup
3972
\lastnegativepageno = \pageno
3973
\pageno = \savepageno
3974
}
3975
\let\shortcontents = \summarycontents
3976
3977
\ifpdf
3978
\pdfcatalog{/PageMode /UseOutlines}%
3979
\fi
3980
3981
% These macros generate individual entries in the table of contents.
3982
% The first argument is the chapter or section name.
3983
% The last argument is the page number.
3984
% The arguments in between are the chapter number, section number, ...
3985
3986
% Chapter-level things, for both the long and short contents.
3987
\def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3988
3989
% See comments in \dochapentry re vbox and related settings
3990
\def\shortchapentry#1#2#3{%
3991
\tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
3992
}
3993
3994
% Typeset the label for a chapter or appendix for the short contents.
3995
% The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3996
% We could simplify the code here by writing out an \appendixentry
3997
% command in the toc file for appendices, instead of using \chapentry
3998
% for both, but it doesn't seem worth it.
3999
%
4000
\newdimen\shortappendixwidth
4001
%
4002
\def\shortchaplabel#1{%
4003
% Compute width of word "Appendix", may change with language.
4004
\setbox0 = \hbox{\shortcontrm \putwordAppendix}%
4005
\shortappendixwidth = \wd0
4006
%
4007
% We typeset #1 in a box of constant width, regardless of the text of
4008
% #1, so the chapter titles will come out aligned.
4009
\setbox0 = \hbox{#1}%
4010
\dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
4011
%
4012
% This space should be plenty, since a single number is .5em, and the
4013
% widest letter (M) is 1em, at least in the Computer Modern fonts.
4014
% (This space doesn't include the extra space that gets added after
4015
% the label; that gets put in by \shortchapentry above.)
4016
\advance\dimen0 by 1.1em
4017
\hbox to \dimen0{#1\hfil}%
4018
}
4019
4020
\def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
4021
\def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
4022
4023
% Sections.
4024
\def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4025
\def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
4026
4027
% Subsections.
4028
\def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4029
\def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
4030
4031
% And subsubsections.
4032
\def\subsubsecentry#1#2#3#4#5#6{%
4033
\dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4034
\def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
4035
4036
% This parameter controls the indentation of the various levels.
4037
\newdimen\tocindent \tocindent = 3pc
4038
4039
% Now for the actual typesetting. In all these, #1 is the text and #2 is the
4040
% page number.
4041
%
4042
% If the toc has to be broken over pages, we want it to be at chapters
4043
% if at all possible; hence the \penalty.
4044
\def\dochapentry#1#2{%
4045
\penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4046
\begingroup
4047
\chapentryfonts
4048
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
4049
\endgroup
4050
\nobreak\vskip .25\baselineskip plus.1\baselineskip
4051
}
4052
4053
\def\dosecentry#1#2{\begingroup
4054
\secentryfonts \leftskip=\tocindent
4055
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
4056
\endgroup}
4057
4058
\def\dosubsecentry#1#2{\begingroup
4059
\subsecentryfonts \leftskip=2\tocindent
4060
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
4061
\endgroup}
4062
4063
\def\dosubsubsecentry#1#2{\begingroup
4064
\subsubsecentryfonts \leftskip=3\tocindent
4065
\tocentry{#1}{\dopageno\bgroup#2\egroup}%
4066
\endgroup}
4067
4068
% Final typesetting of a toc entry; we use the same \entry macro as for
4069
% the index entries, but we want to suppress hyphenation here. (We
4070
% can't do that in the \entry macro, since index entries might consist
4071
% of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4072
\def\tocentry#1#2{\begingroup
4073
\vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4074
% Do not use \turnoffactive in these arguments. Since the toc is
4075
% typeset in cmr, so characters such as _ would come out wrong; we
4076
% have to do the usual translation tricks.
4077
\entry{#1}{#2}%
4078
\endgroup}
4079
4080
% Space between chapter (or whatever) number and the title.
4081
\def\labelspace{\hskip1em \relax}
4082
4083
\def\dopageno#1{{\rm #1}}
4084
\def\doshortpageno#1{{\rm #1}}
4085
4086
\def\chapentryfonts{\secfonts \rm}
4087
\def\secentryfonts{\textfonts}
4088
\let\subsecentryfonts = \textfonts
4089
\let\subsubsecentryfonts = \textfonts
4090
4091
4092
\message{environments,}
4093
% @foo ... @end foo.
4094
4095
% Since these characters are used in examples, it should be an even number of
4096
% \tt widths. Each \tt character is 1en, so two makes it 1em.
4097
% Furthermore, these definitions must come after we define our fonts.
4098
\newbox\dblarrowbox \newbox\longdblarrowbox
4099
\newbox\pushcharbox \newbox\bullbox
4100
\newbox\equivbox \newbox\errorbox
4101
4102
%{\tentt
4103
%\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
4104
%\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
4105
%\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
4106
%\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
4107
% Adapted from the manmac format (p.420 of TeXbook)
4108
%\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
4109
% depth .1ex\hfil}
4110
%}
4111
4112
% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4113
\def\point{$\star$}
4114
\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4115
\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4116
\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4117
\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4118
4119
% Adapted from the TeXbook's \boxit.
4120
{\tentt \global\dimen0 = 3em}% Width of the box.
4121
\dimen2 = .55pt % Thickness of rules
4122
% The text. (`r' is open on the right, `e' somewhat less so on the left.)
4123
\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4124
4125
\global\setbox\errorbox=\hbox to \dimen0{\hfil
4126
\hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4127
\advance\hsize by -2\dimen2 % Rules.
4128
\vbox{
4129
\hrule height\dimen2
4130
\hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4131
\vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4132
\kern3pt\vrule width\dimen2}% Space to right.
4133
\hrule height\dimen2}
4134
\hfil}
4135
4136
% The @error{} command.
4137
\def\error{\leavevmode\lower.7ex\copy\errorbox}
4138
4139
% @tex ... @end tex escapes into raw Tex temporarily.
4140
% One exception: @ is still an escape character, so that @end tex works.
4141
% But \@ or @@ will get a plain tex @ character.
4142
4143
\def\tex{\begingroup
4144
\catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4145
\catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4146
\catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
4147
\catcode `\%=14
4148
\catcode 43=12 % plus
4149
\catcode`\"=12
4150
\catcode`\==12
4151
\catcode`\|=12
4152
\catcode`\<=12
4153
\catcode`\>=12
4154
\escapechar=`\\
4155
%
4156
\let\b=\ptexb
4157
\let\bullet=\ptexbullet
4158
\let\c=\ptexc
4159
\let\,=\ptexcomma
4160
\let\.=\ptexdot
4161
\let\dots=\ptexdots
4162
\let\equiv=\ptexequiv
4163
\let\!=\ptexexclam
4164
\let\i=\ptexi
4165
\let\{=\ptexlbrace
4166
\let\+=\tabalign
4167
\let\}=\ptexrbrace
4168
\let\*=\ptexstar
4169
\let\t=\ptext
4170
%
4171
\def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4172
\def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4173
\def\@{@}%
4174
\let\Etex=\endgroup}
4175
4176
% Define @lisp ... @endlisp.
4177
% @lisp does a \begingroup so it can rebind things,
4178
% including the definition of @endlisp (which normally is erroneous).
4179
4180
% Amount to narrow the margins by for @lisp.
4181
\newskip\lispnarrowing \lispnarrowing=0.4in
4182
4183
% This is the definition that ^^M gets inside @lisp, @example, and other
4184
% such environments. \null is better than a space, since it doesn't
4185
% have any width.
4186
\def\lisppar{\null\endgraf}
4187
4188
% Make each space character in the input produce a normal interword
4189
% space in the output. Don't allow a line break at this space, as this
4190
% is used only in environments like @example, where each line of input
4191
% should produce a line of output anyway.
4192
%
4193
{\obeyspaces %
4194
\gdef\sepspaces{\obeyspaces\let =\tie}}
4195
4196
% Define \obeyedspace to be our active space, whatever it is. This is
4197
% for use in \parsearg.
4198
{\sepspaces%
4199
\global\let\obeyedspace= }
4200
4201
% This space is always present above and below environments.
4202
\newskip\envskipamount \envskipamount = 0pt
4203
4204
% Make spacing and below environment symmetrical. We use \parskip here
4205
% to help in doing that, since in @example-like environments \parskip
4206
% is reset to zero; thus the \afterenvbreak inserts no space -- but the
4207
% start of the next paragraph will insert \parskip
4208
%
4209
\def\aboveenvbreak{{%
4210
\ifnum\lastpenalty < 10000
4211
\advance\envskipamount by \parskip
4212
\endgraf
4213
\ifdim\lastskip<\envskipamount
4214
\removelastskip
4215
\penalty-50
4216
\vskip\envskipamount
4217
\fi
4218
\fi
4219
}}
4220
4221
\let\afterenvbreak = \aboveenvbreak
4222
4223
% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4224
\let\nonarrowing=\relax
4225
4226
% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4227
% environment contents.
4228
\font\circle=lcircle10
4229
\newdimen\circthick
4230
\newdimen\cartouter\newdimen\cartinner
4231
\newskip\normbskip\newskip\normpskip\newskip\normlskip
4232
\circthick=\fontdimen8\circle
4233
%
4234
\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4235
\def\ctr{{\hskip 6pt\circle\char'010}}
4236
\def\cbl{{\circle\char'012\hskip -6pt}}
4237
\def\cbr{{\hskip 6pt\circle\char'011}}
4238
\def\carttop{\hbox to \cartouter{\hskip\lskip
4239
\ctl\leaders\hrule height\circthick\hfil\ctr
4240
\hskip\rskip}}
4241
\def\cartbot{\hbox to \cartouter{\hskip\lskip
4242
\cbl\leaders\hrule height\circthick\hfil\cbr
4243
\hskip\rskip}}
4244
%
4245
\newskip\lskip\newskip\rskip
4246
4247
\long\def\cartouche{%
4248
\begingroup
4249
\lskip=\leftskip \rskip=\rightskip
4250
\leftskip=0pt\rightskip=0pt %we want these *outside*.
4251
\cartinner=\hsize \advance\cartinner by-\lskip
4252
\advance\cartinner by-\rskip
4253
\cartouter=\hsize
4254
\advance\cartouter by 18.4pt % allow for 3pt kerns on either
4255
% side, and for 6pt waste from
4256
% each corner char, and rule thickness
4257
\normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4258
% Flag to tell @lisp, etc., not to narrow margin.
4259
\let\nonarrowing=\comment
4260
\vbox\bgroup
4261
\baselineskip=0pt\parskip=0pt\lineskip=0pt
4262
\carttop
4263
\hbox\bgroup
4264
\hskip\lskip
4265
\vrule\kern3pt
4266
\vbox\bgroup
4267
\hsize=\cartinner
4268
\kern3pt
4269
\begingroup
4270
\baselineskip=\normbskip
4271
\lineskip=\normlskip
4272
\parskip=\normpskip
4273
\vskip -\parskip
4274
\def\Ecartouche{%
4275
\endgroup
4276
\kern3pt
4277
\egroup
4278
\kern3pt\vrule
4279
\hskip\rskip
4280
\egroup
4281
\cartbot
4282
\egroup
4283
\endgroup
4284
}}
4285
4286
4287
% This macro is called at the beginning of all the @example variants,
4288
% inside a group.
4289
\def\nonfillstart{%
4290
\aboveenvbreak
4291
\inENV % This group ends at the end of the body
4292
\hfuzz = 12pt % Don't be fussy
4293
\sepspaces % Make spaces be word-separators rather than space tokens.
4294
\singlespace
4295
\let\par = \lisppar % don't ignore blank lines
4296
\obeylines % each line of input is a line of output
4297
\parskip = 0pt
4298
\parindent = 0pt
4299
\emergencystretch = 0pt % don't try to avoid overfull boxes
4300
% @cartouche defines \nonarrowing to inhibit narrowing
4301
% at next level down.
4302
\ifx\nonarrowing\relax
4303
\advance \leftskip by \lispnarrowing
4304
\exdentamount=\lispnarrowing
4305
\let\exdent=\nofillexdent
4306
\let\nonarrowing=\relax
4307
\fi
4308
}
4309
4310
% Define the \E... control sequence only if we are inside the particular
4311
% environment, so the error checking in \end will work.
4312
%
4313
% To end an @example-like environment, we first end the paragraph (via
4314
% \afterenvbreak's vertical glue), and then the group. That way we keep
4315
% the zero \parskip that the environments set -- \parskip glue will be
4316
% inserted at the beginning of the next paragraph in the document, after
4317
% the environment.
4318
%
4319
\def\nonfillfinish{\afterenvbreak\endgroup}
4320
4321
% @lisp: indented, narrowed, typewriter font.
4322
\def\lisp{\begingroup
4323
\nonfillstart
4324
\let\Elisp = \nonfillfinish
4325
\tt
4326
\let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4327
\gobble % eat return
4328
}
4329
4330
% @example: Same as @lisp.
4331
\def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4332
4333
% @small... is usually equivalent to the non-small (@smallbook
4334
% redefines). We must call \example (or whatever) last in the
4335
% definition, since it reads the return following the @example (or
4336
% whatever) command.
4337
%
4338
% This actually allows (for example) @end display inside an
4339
% @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4340
%
4341
\def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4342
\def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4343
\def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4344
\def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4345
4346
% Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4347
% Originally contributed by Pavel@xerox.
4348
\def\smalllispx{\begingroup
4349
\def\Esmalllisp{\nonfillfinish\endgroup}%
4350
\def\Esmallexample{\nonfillfinish\endgroup}%
4351
\smallexamplefonts
4352
\lisp
4353
}
4354
4355
% @display: same as @lisp except keep current font.
4356
%
4357
\def\display{\begingroup
4358
\nonfillstart
4359
\let\Edisplay = \nonfillfinish
4360
\gobble
4361
}
4362
%
4363
% @smalldisplay (when @smallbook): @display plus smaller fonts.
4364
%
4365
\def\smalldisplayx{\begingroup
4366
\def\Esmalldisplay{\nonfillfinish\endgroup}%
4367
\smallexamplefonts \rm
4368
\display
4369
}
4370
4371
% @format: same as @display except don't narrow margins.
4372
%
4373
\def\format{\begingroup
4374
\let\nonarrowing = t
4375
\nonfillstart
4376
\let\Eformat = \nonfillfinish
4377
\gobble
4378
}
4379
%
4380
% @smallformat (when @smallbook): @format plus smaller fonts.
4381
%
4382
\def\smallformatx{\begingroup
4383
\def\Esmallformat{\nonfillfinish\endgroup}%
4384
\smallexamplefonts \rm
4385
\format
4386
}
4387
4388
% @flushleft (same as @format).
4389
%
4390
\def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4391
4392
% @flushright.
4393
%
4394
\def\flushright{\begingroup
4395
\let\nonarrowing = t
4396
\nonfillstart
4397
\let\Eflushright = \nonfillfinish
4398
\advance\leftskip by 0pt plus 1fill
4399
\gobble
4400
}
4401
4402
4403
% @quotation does normal linebreaking (hence we can't use \nonfillstart)
4404
% and narrows the margins.
4405
%
4406
\def\quotation{%
4407
\begingroup\inENV %This group ends at the end of the @quotation body
4408
{\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4409
\singlespace
4410
\parindent=0pt
4411
% We have retained a nonzero parskip for the environment, since we're
4412
% doing normal filling. So to avoid extra space below the environment...
4413
\def\Equotation{\parskip = 0pt \nonfillfinish}%
4414
%
4415
% @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4416
\ifx\nonarrowing\relax
4417
\advance\leftskip by \lispnarrowing
4418
\advance\rightskip by \lispnarrowing
4419
\exdentamount = \lispnarrowing
4420
\let\nonarrowing = \relax
4421
\fi
4422
}
4423
4424
4425
% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4426
% If we want to allow any <char> as delimiter,
4427
% we need the curly braces so that makeinfo sees the @verb command, eg:
4428
% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4429
%
4430
% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4431
%
4432
% [Knuth] p. 344; only we need to do '@' too
4433
\def\dospecials{%
4434
\do\ \do\\\do\@\do\{\do\}\do\$\do\&%
4435
\do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~}
4436
%
4437
% [Knuth] p. 380
4438
\def\uncatcodespecials{%
4439
\def\do##1{\catcode`##1=12}\dospecials}
4440
%
4441
% [Knuth] pp. 380,381,391
4442
% Disable Spanish ligatures ?` and !` of \tt font
4443
\begingroup
4444
\catcode`\`=\active\gdef`{\relax\lq}
4445
\endgroup
4446
%
4447
% Setup for the @verb command.
4448
%
4449
% Eight spaces for a tab
4450
\begingroup
4451
\catcode`\^^I=\active
4452
\gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4453
\endgroup
4454
%
4455
\def\setupverb{%
4456
\tt % easiest (and conventionally used) font for verbatim
4457
\def\par{\leavevmode\endgraf}%
4458
\catcode`\`=\active
4459
\tabeightspaces
4460
% Respect line breaks,
4461
% print special symbols as themselves, and
4462
% make each space count
4463
% must do in this order:
4464
\obeylines \uncatcodespecials \sepspaces
4465
}
4466
4467
% Setup for the @verbatim environment
4468
%
4469
% Real tab expansion
4470
\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4471
%
4472
\def\starttabbox{\setbox0=\hbox\bgroup}
4473
\begingroup
4474
\catcode`\^^I=\active
4475
\gdef\tabexpand{%
4476
\catcode`\^^I=\active
4477
\def^^I{\leavevmode\egroup
4478
\dimen0=\wd0 % the width so far, or since the previous tab
4479
\divide\dimen0 by\tabw
4480
\multiply\dimen0 by\tabw % compute previous multiple of \tabw
4481
\advance\dimen0 by\tabw % advance to next multiple of \tabw
4482
\wd0=\dimen0 \box0 \starttabbox
4483
}%
4484
}
4485
\endgroup
4486
\def\setupverbatim{%
4487
% Easiest (and conventionally used) font for verbatim
4488
\tt
4489
\def\par{\leavevmode\egroup\box0\endgraf}%
4490
\catcode`\`=\active
4491
\tabexpand
4492
% Respect line breaks,
4493
% print special symbols as themselves, and
4494
% make each space count
4495
% must do in this order:
4496
\obeylines \uncatcodespecials \sepspaces
4497
\everypar{\starttabbox}%
4498
}
4499
4500
% Do the @verb magic: verbatim text is quoted by unique
4501
% delimiter characters. Before first delimiter expect a
4502
% right brace, after last delimiter expect closing brace:
4503
%
4504
% \def\doverb'{'<char>#1<char>'}'{#1}
4505
%
4506
% [Knuth] p. 382; only eat outer {}
4507
\begingroup
4508
\catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4509
\gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4510
\endgroup
4511
%
4512
\def\verb{\begingroup\setupverb\doverb}
4513
%
4514
%
4515
% Do the @verbatim magic: define the macro \doverbatim so that
4516
% the (first) argument ends when '@end verbatim' is reached, ie:
4517
%
4518
% \def\doverbatim#1@end verbatim{#1}
4519
%
4520
% For Texinfo it's a lot easier than for LaTeX,
4521
% because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4522
% we need not redefine '\', '{' and '}'
4523
%
4524
% Inspired by LaTeX's verbatim command set [latex.ltx]
4525
%% Include LaTeX hack for completeness -- never know
4526
%% \begingroup
4527
%% \catcode`|=0 \catcode`[=1
4528
%% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4529
%% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4530
%% #1|endgroup|def|Everbatim[]|end[verbatim]]
4531
%% |endgroup
4532
\begingroup
4533
\catcode`\ =\active
4534
\gdef\doverbatim#1@end verbatim{#1\end{verbatim}}
4535
\endgroup
4536
%
4537
\def\verbatim{%
4538
\def\Everbatim{\nonfillfinish\endgroup}%
4539
\begingroup
4540
\nonfillstart
4541
\advance\leftskip by -\defbodyindent
4542
\begingroup\setupverbatim\doverbatim
4543
}
4544
4545
% @verbatiminclude FILE - insert text of file in verbatim environment.
4546
%
4547
% Allow normal characters that we make active in the argument (a file name).
4548
\def\verbatiminclude{%
4549
\begingroup
4550
\catcode`\\=12
4551
\catcode`~=12
4552
\catcode`^=12
4553
\catcode`_=12
4554
\catcode`|=12
4555
\catcode`<=12
4556
\catcode`>=12
4557
\catcode`+=12
4558
\parsearg\doverbatiminclude
4559
}
4560
\def\setupverbatiminclude{%
4561
\begingroup
4562
\nonfillstart
4563
\advance\leftskip by -\defbodyindent
4564
\begingroup\setupverbatim
4565
}
4566
%
4567
\def\doverbatiminclude#1{%
4568
% Restore active chars for included file.
4569
\endgroup
4570
\begingroup
4571
\def\thisfile{#1}%
4572
\expandafter\expandafter\setupverbatiminclude\input\thisfile
4573
\endgroup\nonfillfinish\endgroup
4574
}
4575
4576
4577
\message{defuns,}
4578
% @defun etc.
4579
4580
% Allow user to change definition object font (\df) internally
4581
\def\setdeffont #1 {\csname DEF#1\endcsname}
4582
4583
\newskip\defbodyindent \defbodyindent=.4in
4584
\newskip\defargsindent \defargsindent=50pt
4585
\newskip\deftypemargin \deftypemargin=12pt
4586
\newskip\deflastargmargin \deflastargmargin=18pt
4587
4588
\newcount\parencount
4589
% define \functionparens, which makes ( and ) and & do special things.
4590
% \functionparens affects the group it is contained in.
4591
\def\activeparens{%
4592
\catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
4593
\catcode`\[=\active \catcode`\]=\active}
4594
4595
% Make control sequences which act like normal parenthesis chars.
4596
\let\lparen = ( \let\rparen = )
4597
4598
{\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4599
4600
% Be sure that we always have a definition for `(', etc. For example,
4601
% if the fn name has parens in it, \boldbrax will not be in effect yet,
4602
% so TeX would otherwise complain about undefined control sequence.
4603
\global\let(=\lparen \global\let)=\rparen
4604
\global\let[=\lbrack \global\let]=\rbrack
4605
4606
\gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4607
\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4608
% This is used to turn on special parens
4609
% but make & act ordinary (given that it's active).
4610
\gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4611
4612
% Definitions of (, ) and & used in args for functions.
4613
% This is the definition of ( outside of all parentheses.
4614
\gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4615
\global\advance\parencount by 1
4616
}
4617
%
4618
% This is the definition of ( when already inside a level of parens.
4619
\gdef\opnested{\char`\(\global\advance\parencount by 1 }
4620
%
4621
\gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4622
% also in that case restore the outer-level definition of (.
4623
\ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4624
\global\advance \parencount by -1 }
4625
% If we encounter &foo, then turn on ()-hacking afterwards
4626
\gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
4627
%
4628
\gdef\normalparens{\boldbrax\let&=\ampnr}
4629
} % End of definition inside \activeparens
4630
%% These parens (in \boldbrax) actually are a little bolder than the
4631
%% contained text. This is especially needed for [ and ]
4632
\def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4633
\def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4634
\let\ampnr = \&
4635
\def\lbrb{{\bf\char`\[}}
4636
\def\rbrb{{\bf\char`\]}}
4637
4638
% Active &'s sneak into the index arguments, so make sure it's defined.
4639
{
4640
\catcode`& = 13
4641
\global\let& = \ampnr
4642
}
4643
4644
% First, defname, which formats the header line itself.
4645
% #1 should be the function name.
4646
% #2 should be the type of definition, such as "Function".
4647
4648
\def\defname #1#2{%
4649
% Get the values of \leftskip and \rightskip as they were
4650
% outside the @def...
4651
\dimen2=\leftskip
4652
\advance\dimen2 by -\defbodyindent
4653
\noindent
4654
\setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4655
\dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4656
\dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4657
\parshape 2 0in \dimen0 \defargsindent \dimen1
4658
% Now output arg 2 ("Function" or some such)
4659
% ending at \deftypemargin from the right margin,
4660
% but stuck inside a box of width 0 so it does not interfere with linebreaking
4661
{% Adjust \hsize to exclude the ambient margins,
4662
% so that \rightline will obey them.
4663
\advance \hsize by -\dimen2
4664
\rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4665
% Make all lines underfull and no complaints:
4666
\tolerance=10000 \hbadness=10000
4667
\advance\leftskip by -\defbodyindent
4668
\exdentamount=\defbodyindent
4669
{\df #1}\enskip % Generate function name
4670
}
4671
4672
% Actually process the body of a definition
4673
% #1 should be the terminating control sequence, such as \Edefun.
4674
% #2 should be the "another name" control sequence, such as \defunx.
4675
% #3 should be the control sequence that actually processes the header,
4676
% such as \defunheader.
4677
4678
\def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4679
\medbreak %
4680
% Define the end token that this defining construct specifies
4681
% so that it will exit this group.
4682
\def#1{\endgraf\endgroup\medbreak}%
4683
\def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4684
\parindent=0in
4685
\advance\leftskip by \defbodyindent
4686
\exdentamount=\defbodyindent
4687
\begingroup %
4688
\catcode 61=\active % 61 is `='
4689
\obeylines\activeparens\spacesplit#3}
4690
4691
% #1 is the \E... control sequence to end the definition (which we define).
4692
% #2 is the \...x control sequence for consecutive fns (which we define).
4693
% #3 is the control sequence to call to resume processing.
4694
% #4, delimited by the space, is the class name.
4695
%
4696
\def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4697
\medbreak %
4698
% Define the end token that this defining construct specifies
4699
% so that it will exit this group.
4700
\def#1{\endgraf\endgroup\medbreak}%
4701
\def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4702
\parindent=0in
4703
\advance\leftskip by \defbodyindent
4704
\exdentamount=\defbodyindent
4705
\begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4706
4707
% Used for @deftypemethod and @deftypeivar.
4708
% #1 is the \E... control sequence to end the definition (which we define).
4709
% #2 is the \...x control sequence for consecutive fns (which we define).
4710
% #3 is the control sequence to call to resume processing.
4711
% #4, delimited by a space, is the class name.
4712
% #5 is the method's return type.
4713
%
4714
\def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4715
\medbreak
4716
\def#1{\endgraf\endgroup\medbreak}%
4717
\def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4718
\parindent=0in
4719
\advance\leftskip by \defbodyindent
4720
\exdentamount=\defbodyindent
4721
\begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4722
4723
% Used for @deftypeop. The change from \deftypemethparsebody is an
4724
% extra argument at the beginning which is the `category', instead of it
4725
% being the hardwired string `Method' or `Instance Variable'. We have
4726
% to account for this both in the \...x definition and in parsing the
4727
% input at hand. Thus also need a control sequence (passed as #5) for
4728
% the \E... definition to assign the category name to.
4729
%
4730
\def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4731
\medbreak
4732
\def#1{\endgraf\endgroup\medbreak}%
4733
\def#2##1 ##2 ##3 {%
4734
\def#4{##1}%
4735
\begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4736
\parindent=0in
4737
\advance\leftskip by \defbodyindent
4738
\exdentamount=\defbodyindent
4739
\begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4740
4741
\def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4742
\medbreak %
4743
% Define the end token that this defining construct specifies
4744
% so that it will exit this group.
4745
\def#1{\endgraf\endgroup\medbreak}%
4746
\def#2##1 ##2 {\def#4{##1}%
4747
\begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4748
\parindent=0in
4749
\advance\leftskip by \defbodyindent
4750
\exdentamount=\defbodyindent
4751
\begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4752
4753
% These parsing functions are similar to the preceding ones
4754
% except that they do not make parens into active characters.
4755
% These are used for "variables" since they have no arguments.
4756
4757
\def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4758
\medbreak %
4759
% Define the end token that this defining construct specifies
4760
% so that it will exit this group.
4761
\def#1{\endgraf\endgroup\medbreak}%
4762
\def#2{\begingroup\obeylines\spacesplit#3}%
4763
\parindent=0in
4764
\advance\leftskip by \defbodyindent
4765
\exdentamount=\defbodyindent
4766
\begingroup %
4767
\catcode 61=\active %
4768
\obeylines\spacesplit#3}
4769
4770
% This is used for \def{tp,vr}parsebody. It could probably be used for
4771
% some of the others, too, with some judicious conditionals.
4772
%
4773
\def\parsebodycommon#1#2#3{%
4774
\begingroup\inENV %
4775
\medbreak %
4776
% Define the end token that this defining construct specifies
4777
% so that it will exit this group.
4778
\def#1{\endgraf\endgroup\medbreak}%
4779
\def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4780
\parindent=0in
4781
\advance\leftskip by \defbodyindent
4782
\exdentamount=\defbodyindent
4783
\begingroup\obeylines
4784
}
4785
4786
\def\defvrparsebody#1#2#3#4 {%
4787
\parsebodycommon{#1}{#2}{#3}%
4788
\spacesplit{#3{#4}}%
4789
}
4790
4791
% This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4792
% type is just `struct', because we lose the braces in `{struct
4793
% termios}' when \spacesplit reads its undelimited argument. Sigh.
4794
% \let\deftpparsebody=\defvrparsebody
4795
%
4796
% So, to get around this, we put \empty in with the type name. That
4797
% way, TeX won't find exactly `{...}' as an undelimited argument, and
4798
% won't strip off the braces.
4799
%
4800
\def\deftpparsebody #1#2#3#4 {%
4801
\parsebodycommon{#1}{#2}{#3}%
4802
\spacesplit{\parsetpheaderline{#3{#4}}}\empty
4803
}
4804
4805
% Fine, but then we have to eventually remove the \empty *and* the
4806
% braces (if any). That's what this does.
4807
%
4808
\def\removeemptybraces\empty#1\relax{#1}
4809
4810
% After \spacesplit has done its work, this is called -- #1 is the final
4811
% thing to call, #2 the type name (which starts with \empty), and #3
4812
% (which might be empty) the arguments.
4813
%
4814
\def\parsetpheaderline#1#2#3{%
4815
#1{\removeemptybraces#2\relax}{#3}%
4816
}%
4817
4818
\def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4819
\medbreak %
4820
% Define the end token that this defining construct specifies
4821
% so that it will exit this group.
4822
\def#1{\endgraf\endgroup\medbreak}%
4823
\def#2##1 ##2 {\def#4{##1}%
4824
\begingroup\obeylines\spacesplit{#3{##2}}}%
4825
\parindent=0in
4826
\advance\leftskip by \defbodyindent
4827
\exdentamount=\defbodyindent
4828
\begingroup\obeylines\spacesplit{#3{#5}}}
4829
4830
% Split up #2 at the first space token.
4831
% call #1 with two arguments:
4832
% the first is all of #2 before the space token,
4833
% the second is all of #2 after that space token.
4834
% If #2 contains no space token, all of it is passed as the first arg
4835
% and the second is passed as empty.
4836
4837
{\obeylines
4838
\gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4839
\long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4840
\ifx\relax #3%
4841
#1{#2}{}\else #1{#2}{#3#4}\fi}}
4842
4843
% So much for the things common to all kinds of definitions.
4844
4845
% Define @defun.
4846
4847
% First, define the processing that is wanted for arguments of \defun
4848
% Use this to expand the args and terminate the paragraph they make up
4849
4850
\def\defunargs#1{\functionparens \sl
4851
% Expand, preventing hyphenation at `-' chars.
4852
% Note that groups don't affect changes in \hyphenchar.
4853
% Set the font temporarily and use \font in case \setfont made \tensl a macro.
4854
{\tensl\hyphenchar\font=0}%
4855
#1%
4856
{\tensl\hyphenchar\font=45}%
4857
\ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4858
\interlinepenalty=10000
4859
\advance\rightskip by 0pt plus 1fil
4860
\endgraf\nobreak\vskip -\parskip\nobreak
4861
}
4862
4863
\def\deftypefunargs #1{%
4864
% Expand, preventing hyphenation at `-' chars.
4865
% Note that groups don't affect changes in \hyphenchar.
4866
% Use \boldbraxnoamp, not \functionparens, so that & is not special.
4867
\boldbraxnoamp
4868
\tclose{#1}% avoid \code because of side effects on active chars
4869
\interlinepenalty=10000
4870
\advance\rightskip by 0pt plus 1fil
4871
\endgraf\nobreak\vskip -\parskip\nobreak
4872
}
4873
4874
% Do complete processing of one @defun or @defunx line already parsed.
4875
4876
% @deffn Command forward-char nchars
4877
4878
\def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4879
4880
\def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4881
\begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4882
\catcode 61=\other % Turn off change made in \defparsebody
4883
}
4884
4885
% @defun == @deffn Function
4886
4887
\def\defun{\defparsebody\Edefun\defunx\defunheader}
4888
4889
\def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4890
\begingroup\defname {#1}{\putwordDeffunc}%
4891
\defunargs {#2}\endgroup %
4892
\catcode 61=\other % Turn off change made in \defparsebody
4893
}
4894
4895
% @deftypefun int foobar (int @var{foo}, float @var{bar})
4896
4897
\def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4898
4899
% #1 is the data type. #2 is the name and args.
4900
\def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4901
% #1 is the data type, #2 the name, #3 the args.
4902
\def\deftypefunheaderx #1#2 #3\relax{%
4903
\doind {fn}{\code{#2}}% Make entry in function index
4904
\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}%
4905
\deftypefunargs {#3}\endgroup %
4906
\catcode 61=\other % Turn off change made in \defparsebody
4907
}
4908
4909
% @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4910
4911
\def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4912
4913
% \defheaderxcond#1\relax$$$
4914
% puts #1 in @code, followed by a space, but does nothing if #1 is null.
4915
\def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4916
4917
% #1 is the classification. #2 is the data type. #3 is the name and args.
4918
\def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4919
% #1 is the classification, #2 the data type, #3 the name, #4 the args.
4920
\def\deftypefnheaderx #1#2#3 #4\relax{%
4921
\doind {fn}{\code{#3}}% Make entry in function index
4922
\begingroup
4923
\normalparens % notably, turn off `&' magic, which prevents
4924
% at least some C++ text from working
4925
\defname {\defheaderxcond#2\relax$$$#3}{#1}%
4926
\deftypefunargs {#4}\endgroup %
4927
\catcode 61=\other % Turn off change made in \defparsebody
4928
}
4929
4930
% @defmac == @deffn Macro
4931
4932
\def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4933
4934
\def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4935
\begingroup\defname {#1}{\putwordDefmac}%
4936
\defunargs {#2}\endgroup %
4937
\catcode 61=\other % Turn off change made in \defparsebody
4938
}
4939
4940
% @defspec == @deffn Special Form
4941
4942
\def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4943
4944
\def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4945
\begingroup\defname {#1}{\putwordDefspec}%
4946
\defunargs {#2}\endgroup %
4947
\catcode 61=\other % Turn off change made in \defparsebody
4948
}
4949
4950
% @defop CATEGORY CLASS OPERATION ARG...
4951
%
4952
\def\defop #1 {\def\defoptype{#1}%
4953
\defopparsebody\Edefop\defopx\defopheader\defoptype}
4954
%
4955
\def\defopheader#1#2#3{%
4956
\dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4957
\begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4958
\defunargs {#3}\endgroup %
4959
}
4960
4961
% @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4962
%
4963
\def\deftypeop #1 {\def\deftypeopcategory{#1}%
4964
\deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
4965
\deftypeopcategory}
4966
%
4967
% #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4968
\def\deftypeopheader#1#2#3#4{%
4969
\dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4970
\begingroup
4971
\defname{\defheaderxcond#2\relax$$$#3}
4972
{\deftypeopcategory\ \putwordon\ \code{#1}}%
4973
\deftypefunargs{#4}%
4974
\endgroup
4975
}
4976
4977
% @deftypemethod CLASS TYPE METHOD ARG...
4978
%
4979
\def\deftypemethod{%
4980
\deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4981
%
4982
% #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4983
\def\deftypemethodheader#1#2#3#4{%
4984
\dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4985
\begingroup
4986
\defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}%
4987
\deftypefunargs{#4}%
4988
\endgroup
4989
}
4990
4991
% @deftypeivar CLASS TYPE VARNAME
4992
%
4993
\def\deftypeivar{%
4994
\deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
4995
%
4996
% #1 is the class name, #2 the data type, #3 the variable name.
4997
\def\deftypeivarheader#1#2#3{%
4998
\dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
4999
\begingroup
5000
\defname{\defheaderxcond#2\relax$$$#3}
5001
{\putwordInstanceVariableof\ \code{#1}}%
5002
\defvarargs{#3}%
5003
\endgroup
5004
}
5005
5006
% @defmethod == @defop Method
5007
%
5008
\def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5009
%
5010
% #1 is the class name, #2 the method name, #3 the args.
5011
\def\defmethodheader#1#2#3{%
5012
\dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5013
\begingroup
5014
\defname{#2}{\putwordMethodon\ \code{#1}}%
5015
\defunargs{#3}%
5016
\endgroup
5017
}
5018
5019
% @defcv {Class Option} foo-class foo-flag
5020
5021
\def\defcv #1 {\def\defcvtype{#1}%
5022
\defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5023
5024
\def\defcvarheader #1#2#3{%
5025
\dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
5026
\begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
5027
\defvarargs {#3}\endgroup %
5028
}
5029
5030
% @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5031
%
5032
\def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5033
%
5034
\def\defivarheader#1#2#3{%
5035
\dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
5036
\begingroup
5037
\defname{#2}{\putwordInstanceVariableof\ #1}%
5038
\defvarargs{#3}%
5039
\endgroup
5040
}
5041
5042
% @defvar
5043
% First, define the processing that is wanted for arguments of @defvar.
5044
% This is actually simple: just print them in roman.
5045
% This must expand the args and terminate the paragraph they make up
5046
\def\defvarargs #1{\normalparens #1%
5047
\interlinepenalty=10000
5048
\endgraf\nobreak\vskip -\parskip\nobreak}
5049
5050
% @defvr Counter foo-count
5051
5052
\def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5053
5054
\def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5055
\begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5056
5057
% @defvar == @defvr Variable
5058
5059
\def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5060
5061
\def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5062
\begingroup\defname {#1}{\putwordDefvar}%
5063
\defvarargs {#2}\endgroup %
5064
}
5065
5066
% @defopt == @defvr {User Option}
5067
5068
\def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5069
5070
\def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5071
\begingroup\defname {#1}{\putwordDefopt}%
5072
\defvarargs {#2}\endgroup %
5073
}
5074
5075
% @deftypevar int foobar
5076
5077
\def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5078
5079
% #1 is the data type. #2 is the name, perhaps followed by text that
5080
% is actually part of the data type, which should not be put into the index.
5081
\def\deftypevarheader #1#2{%
5082
\dovarind#2 \relax% Make entry in variables index
5083
\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}%
5084
\interlinepenalty=10000
5085
\endgraf\nobreak\vskip -\parskip\nobreak
5086
\endgroup}
5087
\def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5088
5089
% @deftypevr {Global Flag} int enable
5090
5091
\def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5092
5093
\def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5094
\begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
5095
\interlinepenalty=10000
5096
\endgraf\nobreak\vskip -\parskip\nobreak
5097
\endgroup}
5098
5099
% Now define @deftp
5100
% Args are printed in bold, a slight difference from @defvar.
5101
5102
\def\deftpargs #1{\bf \defvarargs{#1}}
5103
5104
% @deftp Class window height width ...
5105
5106
\def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5107
5108
\def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5109
\begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5110
5111
% These definitions are used if you use @defunx (etc.)
5112
% anywhere other than immediately after a @defun or @defunx.
5113
%
5114
\def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5115
\def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5116
\def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5117
\def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5118
\def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5119
\def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5120
\def\defopx#1 {\errmessage{@defopx in invalid context}}
5121
\def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5122
\def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5123
\def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5124
\def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5125
\def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5126
\def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5127
\def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5128
\def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5129
\def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5130
\def\defunx#1 {\errmessage{@defunx in invalid context}}
5131
\def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5132
\def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5133
5134
5135
\message{macros,}
5136
% @macro.
5137
5138
% To do this right we need a feature of e-TeX, \scantokens,
5139
% which we arrange to emulate with a temporary file in ordinary TeX.
5140
\ifx\eTeXversion\undefined
5141
\newwrite\macscribble
5142
\def\scanmacro#1{%
5143
\begingroup \newlinechar`\^^M
5144
% Undo catcode changes of \startcontents and \doprintindex
5145
\catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5146
% Append \endinput to make sure that TeX does not see the ending newline.
5147
\toks0={#1\endinput}%
5148
\immediate\openout\macscribble=\jobname.tmp
5149
\immediate\write\macscribble{\the\toks0}%
5150
\immediate\closeout\macscribble
5151
\let\xeatspaces\eatspaces
5152
\input \jobname.tmp
5153
\endgroup
5154
}
5155
\else
5156
\def\scanmacro#1{%
5157
\begingroup \newlinechar`\^^M
5158
% Undo catcode changes of \startcontents and \doprintindex
5159
\catcode`\@=0 \catcode`\\=12 \escapechar=`\@
5160
\let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5161
\fi
5162
5163
\newcount\paramno % Count of parameters
5164
\newtoks\macname % Macro name
5165
\newif\ifrecursive % Is it recursive?
5166
\def\macrolist{} % List of all defined macros in the form
5167
% \do\macro1\do\macro2...
5168
5169
% Utility routines.
5170
% Thisdoes \let #1 = #2, except with \csnames.
5171
\def\cslet#1#2{%
5172
\expandafter\expandafter
5173
\expandafter\let
5174
\expandafter\expandafter
5175
\csname#1\endcsname
5176
\csname#2\endcsname}
5177
5178
% Trim leading and trailing spaces off a string.
5179
% Concepts from aro-bend problem 15 (see CTAN).
5180
{\catcode`\@=11
5181
\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5182
\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5183
\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5184
\def\unbrace#1{#1}
5185
\unbrace{\gdef\trim@@@ #1 } #2@{#1}
5186
}
5187
5188
% Trim a single trailing ^^M off a string.
5189
{\catcode`\^^M=12\catcode`\Q=3%
5190
\gdef\eatcr #1{\eatcra #1Q^^MQ}%
5191
\gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5192
\gdef\eatcrb#1Q#2Q{#1}%
5193
}
5194
5195
% Macro bodies are absorbed as an argument in a context where
5196
% all characters are catcode 10, 11 or 12, except \ which is active
5197
% (as in normal texinfo). It is necessary to change the definition of \.
5198
5199
% It's necessary to have hard CRs when the macro is executed. This is
5200
% done by making ^^M (\endlinechar) catcode 12 when reading the macro
5201
% body, and then making it the \newlinechar in \scanmacro.
5202
5203
\def\macrobodyctxt{%
5204
\catcode`\~=12
5205
\catcode`\^=12
5206
\catcode`\_=12
5207
\catcode`\|=12
5208
\catcode`\<=12
5209
\catcode`\>=12
5210
\catcode`\+=12
5211
\catcode`\{=12
5212
\catcode`\}=12
5213
\catcode`\@=12
5214
\catcode`\^^M=12
5215
\usembodybackslash}
5216
5217
\def\macroargctxt{%
5218
\catcode`\~=12
5219
\catcode`\^=12
5220
\catcode`\_=12
5221
\catcode`\|=12
5222
\catcode`\<=12
5223
\catcode`\>=12
5224
\catcode`\+=12
5225
\catcode`\@=12
5226
\catcode`\\=12}
5227
5228
% \mbodybackslash is the definition of \ in @macro bodies.
5229
% It maps \foo\ => \csname macarg.foo\endcsname => #N
5230
% where N is the macro parameter number.
5231
% We define \csname macarg.\endcsname to be \realbackslash, so
5232
% \\ in macro replacement text gets you a backslash.
5233
5234
{\catcode`@=0 @catcode`@\=@active
5235
@gdef@usembodybackslash{@let\=@mbodybackslash}
5236
@gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5237
}
5238
\expandafter\def\csname macarg.\endcsname{\realbackslash}
5239
5240
\def\macro{\recursivefalse\parsearg\macroxxx}
5241
\def\rmacro{\recursivetrue\parsearg\macroxxx}
5242
5243
\def\macroxxx#1{%
5244
\getargs{#1}% now \macname is the macname and \argl the arglist
5245
\ifx\argl\empty % no arguments
5246
\paramno=0%
5247
\else
5248
\expandafter\parsemargdef \argl;%
5249
\fi
5250
\if1\csname ismacro.\the\macname\endcsname
5251
\message{Warning: redefining \the\macname}%
5252
\else
5253
\expandafter\ifx\csname \the\macname\endcsname \relax
5254
\else \errmessage{The name \the\macname\space is reserved}\fi
5255
\global\cslet{macsave.\the\macname}{\the\macname}%
5256
\global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5257
% Add the macroname to \macrolist
5258
\toks0 = \expandafter{\macrolist\do}%
5259
\xdef\macrolist{\the\toks0
5260
\expandafter\noexpand\csname\the\macname\endcsname}%
5261
\fi
5262
\begingroup \macrobodyctxt
5263
\ifrecursive \expandafter\parsermacbody
5264
\else \expandafter\parsemacbody
5265
\fi}
5266
5267
\def\unmacro{\parsearg\unmacroxxx}
5268
\def\unmacroxxx#1{%
5269
\if1\csname ismacro.#1\endcsname
5270
\global\cslet{#1}{macsave.#1}%
5271
\global\expandafter\let \csname ismacro.#1\endcsname=0%
5272
% Remove the macro name from \macrolist
5273
\begingroup
5274
\edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5275
\def\do##1{%
5276
\def\tempb{##1}%
5277
\ifx\tempa\tempb
5278
% remove this
5279
\else
5280
\toks0 = \expandafter{\newmacrolist\do}%
5281
\edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5282
\fi}%
5283
\def\newmacrolist{}%
5284
% Execute macro list to define \newmacrolist
5285
\macrolist
5286
\global\let\macrolist\newmacrolist
5287
\endgroup
5288
\else
5289
\errmessage{Macro #1 not defined}%
5290
\fi
5291
}
5292
5293
% This makes use of the obscure feature that if the last token of a
5294
% <parameter list> is #, then the preceding argument is delimited by
5295
% an opening brace, and that opening brace is not consumed.
5296
\def\getargs#1{\getargsxxx#1{}}
5297
\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5298
\def\getmacname #1 #2\relax{\macname={#1}}
5299
\def\getmacargs#1{\def\argl{#1}}
5300
5301
% Parse the optional {params} list. Set up \paramno and \paramlist
5302
% so \defmacro knows what to do. Define \macarg.blah for each blah
5303
% in the params list, to be ##N where N is the position in that list.
5304
% That gets used by \mbodybackslash (above).
5305
5306
% We need to get `macro parameter char #' into several definitions.
5307
% The technique used is stolen from LaTeX: let \hash be something
5308
% unexpandable, insert that wherever you need a #, and then redefine
5309
% it to # just before using the token list produced.
5310
%
5311
% The same technique is used to protect \eatspaces till just before
5312
% the macro is used.
5313
5314
\def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5315
\let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5316
\def\parsemargdefxxx#1,{%
5317
\if#1;\let\next=\relax
5318
\else \let\next=\parsemargdefxxx
5319
\advance\paramno by 1%
5320
\expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5321
{\xeatspaces{\hash\the\paramno}}%
5322
\edef\paramlist{\paramlist\hash\the\paramno,}%
5323
\fi\next}
5324
5325
% These two commands read recursive and nonrecursive macro bodies.
5326
% (They're different since rec and nonrec macros end differently.)
5327
5328
\long\def\parsemacbody#1@end macro%
5329
{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5330
\long\def\parsermacbody#1@end rmacro%
5331
{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5332
5333
% This defines the macro itself. There are six cases: recursive and
5334
% nonrecursive macros of zero, one, and many arguments.
5335
% Much magic with \expandafter here.
5336
% \xdef is used so that macro definitions will survive the file
5337
% they're defined in; @include reads the file inside a group.
5338
\def\defmacro{%
5339
\let\hash=##% convert placeholders to macro parameter chars
5340
\ifrecursive
5341
\ifcase\paramno
5342
% 0
5343
\expandafter\xdef\csname\the\macname\endcsname{%
5344
\noexpand\scanmacro{\temp}}%
5345
\or % 1
5346
\expandafter\xdef\csname\the\macname\endcsname{%
5347
\bgroup\noexpand\macroargctxt
5348
\noexpand\braceorline
5349
\expandafter\noexpand\csname\the\macname xxx\endcsname}%
5350
\expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5351
\egroup\noexpand\scanmacro{\temp}}%
5352
\else % many
5353
\expandafter\xdef\csname\the\macname\endcsname{%
5354
\bgroup\noexpand\macroargctxt
5355
\noexpand\csname\the\macname xx\endcsname}%
5356
\expandafter\xdef\csname\the\macname xx\endcsname##1{%
5357
\expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5358
\expandafter\expandafter
5359
\expandafter\xdef
5360
\expandafter\expandafter
5361
\csname\the\macname xxx\endcsname
5362
\paramlist{\egroup\noexpand\scanmacro{\temp}}%
5363
\fi
5364
\else
5365
\ifcase\paramno
5366
% 0
5367
\expandafter\xdef\csname\the\macname\endcsname{%
5368
\noexpand\norecurse{\the\macname}%
5369
\noexpand\scanmacro{\temp}\egroup}%
5370
\or % 1
5371
\expandafter\xdef\csname\the\macname\endcsname{%
5372
\bgroup\noexpand\macroargctxt
5373
\noexpand\braceorline
5374
\expandafter\noexpand\csname\the\macname xxx\endcsname}%
5375
\expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5376
\egroup
5377
\noexpand\norecurse{\the\macname}%
5378
\noexpand\scanmacro{\temp}\egroup}%
5379
\else % many
5380
\expandafter\xdef\csname\the\macname\endcsname{%
5381
\bgroup\noexpand\macroargctxt
5382
\expandafter\noexpand\csname\the\macname xx\endcsname}%
5383
\expandafter\xdef\csname\the\macname xx\endcsname##1{%
5384
\expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5385
\expandafter\expandafter
5386
\expandafter\xdef
5387
\expandafter\expandafter
5388
\csname\the\macname xxx\endcsname
5389
\paramlist{%
5390
\egroup
5391
\noexpand\norecurse{\the\macname}%
5392
\noexpand\scanmacro{\temp}\egroup}%
5393
\fi
5394
\fi}
5395
5396
\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5397
5398
% \braceorline decides whether the next nonwhitespace character is a
5399
% {. If so it reads up to the closing }, if not, it reads the whole
5400
% line. Whatever was read is then fed to the next control sequence
5401
% as an argument (by \parsebrace or \parsearg)
5402
\def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5403
\def\braceorlinexxx{%
5404
\ifx\nchar\bgroup\else
5405
\expandafter\parsearg
5406
\fi \next}
5407
5408
% We mant to disable all macros during \shipout so that they are not
5409
% expanded by \write.
5410
\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5411
\edef\next{\macrolist}\expandafter\endgroup\next}
5412
5413
5414
% @alias.
5415
% We need some trickery to remove the optional spaces around the equal
5416
% sign. Just make them active and then expand them all to nothing.
5417
\def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5418
\def\aliasxxx #1{\aliasyyy#1\relax}
5419
\def\aliasyyy #1=#2\relax{\ignoreactivespaces
5420
\edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5421
\expandafter\noexpand\csname#2\endcsname}%
5422
\expandafter\endgroup\next}
5423
5424
5425
\message{cross references,}
5426
% @xref etc.
5427
5428
\newwrite\auxfile
5429
5430
\newif\ifhavexrefs % True if xref values are known.
5431
\newif\ifwarnedxrefs % True if we warned once that they aren't known.
5432
5433
% @inforef is relatively simple.
5434
\def\inforef #1{\inforefzzz #1,,,,**}
5435
\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5436
node \samp{\ignorespaces#1{}}}
5437
5438
% @node's job is to define \lastnode.
5439
\def\node{\ENVcheck\parsearg\nodezzz}
5440
\def\nodezzz#1{\nodexxx [#1,]}
5441
\def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5442
\let\nwnode=\node
5443
\let\lastnode=\relax
5444
5445
% The sectioning commands (@chapter, etc.) call these.
5446
\def\donoderef{%
5447
\ifx\lastnode\relax\else
5448
\expandafter\expandafter\expandafter\setref{\lastnode}%
5449
{Ysectionnumberandtype}%
5450
\global\let\lastnode=\relax
5451
\fi
5452
}
5453
\def\unnumbnoderef{%
5454
\ifx\lastnode\relax\else
5455
\expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5456
\global\let\lastnode=\relax
5457
\fi
5458
}
5459
\def\appendixnoderef{%
5460
\ifx\lastnode\relax\else
5461
\expandafter\expandafter\expandafter\setref{\lastnode}%
5462
{Yappendixletterandtype}%
5463
\global\let\lastnode=\relax
5464
\fi
5465
}
5466
5467
5468
% @anchor{NAME} -- define xref target at arbitrary point.
5469
%
5470
\newcount\savesfregister
5471
\gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5472
\gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5473
\gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5474
5475
% \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5476
% NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5477
% to set \indexdummies so commands such as @code in a section title
5478
% aren't expanded. It would be nicer not to expand the titles in the
5479
% first place, but there's so many layers that that is hard to do.
5480
%
5481
\def\setref#1#2{{%
5482
\indexdummies
5483
\pdfmkdest{#1}%
5484
\dosetq{#1-title}{Ytitle}%
5485
\dosetq{#1-pg}{Ypagenumber}%
5486
\dosetq{#1-snt}{#2}%
5487
}}
5488
5489
% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5490
% the node name, #2 the name of the Info cross-reference, #3 the printed
5491
% node name, #4 the name of the Info file, #5 the name of the printed
5492
% manual. All but the node name can be omitted.
5493
%
5494
\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5495
\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5496
\def\ref#1{\xrefX[#1,,,,,,,]}
5497
\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5498
\unsepspaces
5499
\def\printedmanual{\ignorespaces #5}%
5500
\def\printednodename{\ignorespaces #3}%
5501
\setbox1=\hbox{\printedmanual}%
5502
\setbox0=\hbox{\printednodename}%
5503
\ifdim \wd0 = 0pt
5504
% No printed node name was explicitly given.
5505
\expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5506
% Use the node name inside the square brackets.
5507
\def\printednodename{\ignorespaces #1}%
5508
\else
5509
% Use the actual chapter/section title appear inside
5510
% the square brackets. Use the real section title if we have it.
5511
\ifdim \wd1 > 0pt
5512
% It is in another manual, so we don't have it.
5513
\def\printednodename{\ignorespaces #1}%
5514
\else
5515
\ifhavexrefs
5516
% We know the real title if we have the xref values.
5517
\def\printednodename{\refx{#1-title}{}}%
5518
\else
5519
% Otherwise just copy the Info node name.
5520
\def\printednodename{\ignorespaces #1}%
5521
\fi%
5522
\fi
5523
\fi
5524
\fi
5525
%
5526
% If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5527
% insert empty discretionaries after hyphens, which means that it will
5528
% not find a line break at a hyphen in a node names. Since some manuals
5529
% are best written with fairly long node names, containing hyphens, this
5530
% is a loss. Therefore, we give the text of the node name again, so it
5531
% is as if TeX is seeing it for the first time.
5532
\ifpdf
5533
\leavevmode
5534
\getfilename{#4}%
5535
{\normalturnoffactive
5536
\ifnum\filenamelength>0
5537
\startlink attr{/Border [0 0 0]}%
5538
goto file{\the\filename.pdf} name{#1}%
5539
\else
5540
\startlink attr{/Border [0 0 0]}%
5541
goto name{#1}%
5542
\fi
5543
}%
5544
\linkcolor
5545
\fi
5546
%
5547
\ifdim \wd1 > 0pt
5548
\putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5549
\else
5550
% _ (for example) has to be the character _ for the purposes of the
5551
% control sequence corresponding to the node, but it has to expand
5552
% into the usual \leavevmode...\vrule stuff for purposes of
5553
% printing. So we \turnoffactive for the \refx-snt, back on for the
5554
% printing, back off for the \refx-pg.
5555
{\normalturnoffactive
5556
% Only output a following space if the -snt ref is nonempty; for
5557
% @unnumbered and @anchor, it won't be.
5558
\setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5559
\ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5560
}%
5561
% [mynode],
5562
[\printednodename],\space
5563
% page 3
5564
\turnoffactive \putwordpage\tie\refx{#1-pg}{}%
5565
\fi
5566
\endlink
5567
\endgroup}
5568
5569
% \dosetq is the interface for calls from other macros
5570
5571
% Use \normalturnoffactive so that punctuation chars such as underscore
5572
% and backslash work in node names. (\turnoffactive doesn't do \.)
5573
\def\dosetq#1#2{%
5574
{\let\folio=0%
5575
\normalturnoffactive
5576
\edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5577
\iflinks
5578
\next
5579
\fi
5580
}%
5581
}
5582
5583
% \internalsetq {foo}{page} expands into
5584
% CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5585
% When the aux file is read, ' is the escape character
5586
5587
\def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5588
5589
% Things to be expanded by \internalsetq
5590
5591
\def\Ypagenumber{\folio}
5592
5593
\def\Ytitle{\thissection}
5594
5595
\def\Ynothing{}
5596
5597
\def\Ysectionnumberandtype{%
5598
\ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
5599
\else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
5600
\else \ifnum \subsubsecno=0 %
5601
\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
5602
\else %
5603
\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
5604
\fi \fi \fi }
5605
5606
\def\Yappendixletterandtype{%
5607
\ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
5608
\else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
5609
\else \ifnum \subsubsecno=0 %
5610
\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
5611
\else %
5612
\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
5613
\fi \fi \fi }
5614
5615
\gdef\xreftie{'tie}
5616
5617
% Use TeX 3.0's \inputlineno to get the line number, for better error
5618
% messages, but if we're using an old version of TeX, don't do anything.
5619
%
5620
\ifx\inputlineno\thisisundefined
5621
\let\linenumber = \empty % Non-3.0.
5622
\else
5623
\def\linenumber{\the\inputlineno:\space}
5624
\fi
5625
5626
% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5627
% If its value is nonempty, SUFFIX is output afterward.
5628
5629
\def\refx#1#2{%
5630
\expandafter\ifx\csname X#1\endcsname\relax
5631
% If not defined, say something at least.
5632
\angleleft un\-de\-fined\angleright
5633
\iflinks
5634
\ifhavexrefs
5635
\message{\linenumber Undefined cross reference `#1'.}%
5636
\else
5637
\ifwarnedxrefs\else
5638
\global\warnedxrefstrue
5639
\message{Cross reference values unknown; you must run TeX again.}%
5640
\fi
5641
\fi
5642
\fi
5643
\else
5644
% It's defined, so just use it.
5645
\csname X#1\endcsname
5646
\fi
5647
#2% Output the suffix in any case.
5648
}
5649
5650
% This is the macro invoked by entries in the aux file.
5651
%
5652
\def\xrdef#1{\begingroup
5653
% Reenable \ as an escape while reading the second argument.
5654
\catcode`\\ = 0
5655
\afterassignment\endgroup
5656
\expandafter\gdef\csname X#1\endcsname
5657
}
5658
5659
% Read the last existing aux file, if any. No error if none exists.
5660
\def\readauxfile{\begingroup
5661
\catcode`\^^@=\other
5662
\catcode`\^^A=\other
5663
\catcode`\^^B=\other
5664
\catcode`\^^C=\other
5665
\catcode`\^^D=\other
5666
\catcode`\^^E=\other
5667
\catcode`\^^F=\other
5668
\catcode`\^^G=\other
5669
\catcode`\^^H=\other
5670
\catcode`\^^K=\other
5671
\catcode`\^^L=\other
5672
\catcode`\^^N=\other
5673
\catcode`\^^P=\other
5674
\catcode`\^^Q=\other
5675
\catcode`\^^R=\other
5676
\catcode`\^^S=\other
5677
\catcode`\^^T=\other
5678
\catcode`\^^U=\other
5679
\catcode`\^^V=\other
5680
\catcode`\^^W=\other
5681
\catcode`\^^X=\other
5682
\catcode`\^^Z=\other
5683
\catcode`\^^[=\other
5684
\catcode`\^^\=\other
5685
\catcode`\^^]=\other
5686
\catcode`\^^^=\other
5687
\catcode`\^^_=\other
5688
\catcode`\@=\other
5689
\catcode`\^=\other
5690
% It was suggested to define this as 7, which would allow ^^e4 etc.
5691
% in xref tags, i.e., node names. But since ^^e4 notation isn't
5692
% supported in the main text, it doesn't seem desirable. Furthermore,
5693
% that is not enough: for node names that actually contain a ^
5694
% character, we would end up writing a line like this: 'xrdef {'hat
5695
% b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5696
% argument, and \hat is not an expandable control sequence. It could
5697
% all be worked out, but why? Either we support ^^ or we don't.
5698
%
5699
% The other change necessary for this was to define \auxhat:
5700
% \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5701
% and then to call \auxhat in \setq.
5702
%
5703
\catcode`\~=\other
5704
\catcode`\[=\other
5705
\catcode`\]=\other
5706
\catcode`\"=\other
5707
\catcode`\_=\other
5708
\catcode`\|=\other
5709
\catcode`\<=\other
5710
\catcode`\>=\other
5711
\catcode`\$=\other
5712
\catcode`\#=\other
5713
\catcode`\&=\other
5714
\catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5715
% Make the characters 128-255 be printing characters
5716
{%
5717
\count 1=128
5718
\def\loop{%
5719
\catcode\count 1=\other
5720
\advance\count 1 by 1
5721
\ifnum \count 1<256 \loop \fi
5722
}%
5723
}%
5724
% The aux file uses ' as the escape (for now).
5725
% Turn off \ as an escape so we do not lose on
5726
% entries which were dumped with control sequences in their names.
5727
% For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5728
% Reference to such entries still does not work the way one would wish,
5729
% but at least they do not bomb out when the aux file is read in.
5730
\catcode`\{=1
5731
\catcode`\}=2
5732
\catcode`\%=\other
5733
\catcode`\'=0
5734
\catcode`\\=\other
5735
%
5736
\openin 1 \jobname.aux
5737
\ifeof 1 \else
5738
\closein 1
5739
\input \jobname.aux
5740
\global\havexrefstrue
5741
\global\warnedobstrue
5742
\fi
5743
% Open the new aux file. TeX will close it automatically at exit.
5744
\openout\auxfile=\jobname.aux
5745
\endgroup}
5746
5747
5748
% Footnotes.
5749
5750
\newcount \footnoteno
5751
5752
% The trailing space in the following definition for supereject is
5753
% vital for proper filling; pages come out unaligned when you do a
5754
% pagealignmacro call if that space before the closing brace is
5755
% removed. (Generally, numeric constants should always be followed by a
5756
% space to prevent strange expansion errors.)
5757
\def\supereject{\par\penalty -20000\footnoteno =0 }
5758
5759
% @footnotestyle is meaningful for info output only.
5760
\let\footnotestyle=\comment
5761
5762
\let\ptexfootnote=\footnote
5763
5764
{\catcode `\@=11
5765
%
5766
% Auto-number footnotes. Otherwise like plain.
5767
\gdef\footnote{%
5768
\global\advance\footnoteno by \@ne
5769
\edef\thisfootno{$^{\the\footnoteno}$}%
5770
%
5771
% In case the footnote comes at the end of a sentence, preserve the
5772
% extra spacing after we do the footnote number.
5773
\let\@sf\empty
5774
\ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
5775
%
5776
% Remove inadvertent blank space before typesetting the footnote number.
5777
\unskip
5778
\thisfootno\@sf
5779
\footnotezzz
5780
}%
5781
5782
% Don't bother with the trickery in plain.tex to not require the
5783
% footnote text as a parameter. Our footnotes don't need to be so general.
5784
%
5785
% Oh yes, they do; otherwise, @ifset and anything else that uses
5786
% \parseargline fail inside footnotes because the tokens are fixed when
5787
% the footnote is read. --karl, 16nov96.
5788
%
5789
\long\gdef\footnotezzz{\insert\footins\bgroup
5790
% We want to typeset this text as a normal paragraph, even if the
5791
% footnote reference occurs in (for example) a display environment.
5792
% So reset some parameters.
5793
\interlinepenalty\interfootnotelinepenalty
5794
\splittopskip\ht\strutbox % top baseline for broken footnotes
5795
\splitmaxdepth\dp\strutbox
5796
\floatingpenalty\@MM
5797
\leftskip\z@skip
5798
\rightskip\z@skip
5799
\spaceskip\z@skip
5800
\xspaceskip\z@skip
5801
\parindent\defaultparindent
5802
%
5803
\smallfonts \rm
5804
%
5805
% Hang the footnote text off the number.
5806
\hang
5807
\textindent{\thisfootno}%
5808
%
5809
% Don't crash into the line above the footnote text. Since this
5810
% expands into a box, it must come within the paragraph, lest it
5811
% provide a place where TeX can split the footnote.
5812
\footstrut
5813
\futurelet\next\fo@t
5814
}
5815
\def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5816
\else\let\next\f@t\fi \next}
5817
\def\f@@t{\bgroup\aftergroup\@foot\let\next}
5818
\def\f@t#1{#1\@foot}
5819
\def\@foot{\strut\par\egroup}
5820
5821
}%end \catcode `\@=11
5822
5823
% @| inserts a changebar to the left of the current line. It should
5824
% surround any changed text. This approach does *not* work if the
5825
% change spans more than two lines of output. To handle that, we would
5826
% have adopt a much more difficult approach (putting marks into the main
5827
% vertical list for the beginning and end of each change).
5828
%
5829
\def\|{%
5830
% \vadjust can only be used in horizontal mode.
5831
\leavevmode
5832
%
5833
% Append this vertical mode material after the current line in the output.
5834
\vadjust{%
5835
% We want to insert a rule with the height and depth of the current
5836
% leading; that is exactly what \strutbox is supposed to record.
5837
\vskip-\baselineskip
5838
%
5839
% \vadjust-items are inserted at the left edge of the type. So
5840
% the \llap here moves out into the left-hand margin.
5841
\llap{%
5842
%
5843
% For a thicker or thinner bar, change the `1pt'.
5844
\vrule height\baselineskip width1pt
5845
%
5846
% This is the space between the bar and the text.
5847
\hskip 12pt
5848
}%
5849
}%
5850
}
5851
5852
% For a final copy, take out the rectangles
5853
% that mark overfull boxes (in case you have decided
5854
% that the text looks ok even though it passes the margin).
5855
%
5856
\def\finalout{\overfullrule=0pt}
5857
5858
% @image. We use the macros from epsf.tex to support this.
5859
% If epsf.tex is not installed and @image is used, we complain.
5860
%
5861
% Check for and read epsf.tex up front. If we read it only at @image
5862
% time, we might be inside a group, and then its definitions would get
5863
% undone and the next image would fail.
5864
\openin 1 = epsf.tex
5865
\ifeof 1 \else
5866
\closein 1
5867
% Do not bother showing banner with post-v2.7 epsf.tex (available in
5868
% doc/epsf.tex until it shows up on ctan).
5869
\def\epsfannounce{\toks0 = }%
5870
\input epsf.tex
5871
\fi
5872
%
5873
% We will only complain once about lack of epsf.tex.
5874
\newif\ifwarnednoepsf
5875
\newhelp\noepsfhelp{epsf.tex must be installed for images to
5876
work. It is also included in the Texinfo distribution, or you can get
5877
it from ftp://tug.org/tex/epsf.tex.}
5878
%
5879
\def\image#1{%
5880
\ifx\epsfbox\undefined
5881
\ifwarnednoepsf \else
5882
\errhelp = \noepsfhelp
5883
\errmessage{epsf.tex not found, images will be ignored}%
5884
\global\warnednoepsftrue
5885
\fi
5886
\else
5887
\imagexxx #1,,,\finish
5888
\fi
5889
}
5890
%
5891
% Arguments to @image:
5892
% #1 is (mandatory) image filename; we tack on .eps extension.
5893
% #2 is (optional) width, #3 is (optional) height.
5894
% #4 is (ignored optional) html alt text.
5895
% #5 is (ignored optional) extension.
5896
% #6 is just the usual extra ignored arg for parsing this stuff.
5897
\def\imagexxx#1,#2,#3,#4,#5,#6\finish{%
5898
\ifpdf
5899
\centerline{\dopdfimage{#1}{#2}{#3}}%
5900
\else
5901
% \epsfbox itself resets \epsf?size at each figure.
5902
\setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5903
\setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
5904
\begingroup
5905
\catcode`\^^M = 5 % in case we're inside an example
5906
\normalturnoffactive % allow _ et al. in names
5907
% If the image is by itself, center it.
5908
\ifvmode
5909
\nobreak\bigskip
5910
% Usually we'll have text after the image which will insert
5911
% \parskip glue, so insert it here too to equalize the space
5912
% above and below.
5913
\nobreak\vskip\parskip
5914
\nobreak
5915
\centerline{\epsfbox{#1.eps}}%
5916
\bigbreak
5917
\else
5918
% In the middle of a paragraph, no extra space.
5919
\epsfbox{#1.eps}%
5920
\fi
5921
\endgroup
5922
\fi
5923
}
5924
5925
5926
\message{localization,}
5927
% and i18n.
5928
5929
% @documentlanguage is usually given very early, just after
5930
% @setfilename. If done too late, it may not override everything
5931
% properly. Single argument is the language abbreviation.
5932
% It would be nice if we could set up a hyphenation file here.
5933
%
5934
\def\documentlanguage{\parsearg\dodocumentlanguage}
5935
\def\dodocumentlanguage#1{%
5936
\tex % read txi-??.tex file in plain TeX.
5937
% Read the file if it exists.
5938
\openin 1 txi-#1.tex
5939
\ifeof1
5940
\errhelp = \nolanghelp
5941
\errmessage{Cannot read language file txi-#1.tex}%
5942
\let\temp = \relax
5943
\else
5944
\def\temp{\input txi-#1.tex }%
5945
\fi
5946
\temp
5947
\endgroup
5948
}
5949
\newhelp\nolanghelp{The given language definition file cannot be found or
5950
is empty. Maybe you need to install it? In the current directory
5951
should work if nowhere else does.}
5952
5953
5954
% @documentencoding should change something in TeX eventually, most
5955
% likely, but for now just recognize it.
5956
\let\documentencoding = \comment
5957
5958
5959
% Page size parameters.
5960
%
5961
\newdimen\defaultparindent \defaultparindent = 15pt
5962
5963
\chapheadingskip = 15pt plus 4pt minus 2pt
5964
\secheadingskip = 12pt plus 3pt minus 2pt
5965
\subsecheadingskip = 9pt plus 2pt minus 2pt
5966
5967
% Prevent underfull vbox error messages.
5968
\vbadness = 10000
5969
5970
% Don't be so finicky about underfull hboxes, either.
5971
\hbadness = 2000
5972
5973
% Following George Bush, just get rid of widows and orphans.
5974
\widowpenalty=10000
5975
\clubpenalty=10000
5976
5977
% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
5978
% using an old version of TeX, don't do anything. We want the amount of
5979
% stretch added to depend on the line length, hence the dependence on
5980
% \hsize. We call this whenever the paper size is set.
5981
%
5982
\def\setemergencystretch{%
5983
\ifx\emergencystretch\thisisundefined
5984
% Allow us to assign to \emergencystretch anyway.
5985
\def\emergencystretch{\dimen0}%
5986
\else
5987
\emergencystretch = .15\hsize
5988
\fi
5989
}
5990
5991
% Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
5992
% 4) hoffset; 5) binding offset; 6) topskip. We also call
5993
% \setleading{\textleading}, so the caller should define \textleading.
5994
% The caller should also set \parskip.
5995
%
5996
\def\internalpagesizes#1#2#3#4#5#6{%
5997
\voffset = #3\relax
5998
\topskip = #6\relax
5999
\splittopskip = \topskip
6000
%
6001
\vsize = #1\relax
6002
\advance\vsize by \topskip
6003
\outervsize = \vsize
6004
\advance\outervsize by 2\topandbottommargin
6005
\pageheight = \vsize
6006
%
6007
\hsize = #2\relax
6008
\outerhsize = \hsize
6009
\advance\outerhsize by 0.5in
6010
\pagewidth = \hsize
6011
%
6012
\normaloffset = #4\relax
6013
\bindingoffset = #5\relax
6014
%
6015
\setleading{\textleading}
6016
%
6017
\parindent = \defaultparindent
6018
\setemergencystretch
6019
}
6020
6021
% Use `small' versions.
6022
%
6023
\def\smallenvironments{%
6024
\let\smalldisplay = \smalldisplayx
6025
\let\smallexample = \smalllispx
6026
\let\smallformat = \smallformatx
6027
\let\smalllisp = \smalllispx
6028
}
6029
6030
% @letterpaper (the default).
6031
\def\letterpaper{{\globaldefs = 1
6032
\parskip = 3pt plus 2pt minus 1pt
6033
\textleading = 13.2pt
6034
%
6035
% If page is nothing but text, make it come out even.
6036
\internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}%
6037
}}
6038
6039
% Use @smallbook to reset parameters for 7x9.5 (or so) format.
6040
\def\smallbook{{\globaldefs = 1
6041
\parskip = 2pt plus 1pt
6042
\textleading = 12pt
6043
%
6044
\internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}%
6045
%
6046
\lispnarrowing = 0.3in
6047
\tolerance = 700
6048
\hfuzz = 1pt
6049
\contentsrightmargin = 0pt
6050
\deftypemargin = 0pt
6051
\defbodyindent = .5cm
6052
\smallenvironments
6053
}}
6054
6055
% Use @afourpaper to print on European A4 paper.
6056
\def\afourpaper{{\globaldefs = 1
6057
\parskip = 3pt plus 2pt minus 1pt
6058
\textleading = 12pt
6059
%
6060
\internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}%
6061
%
6062
\tolerance = 700
6063
\hfuzz = 1pt
6064
}}
6065
6066
% Use @afivepaper to print on European A5 paper.
6067
% From romildo@urano.iceb.ufop.br, 2 July 2000.
6068
% He also recommends making @example and @lisp be small.
6069
\def\afivepaper{{\globaldefs = 1
6070
\parskip = 2pt plus 1pt minus 0.1pt
6071
\textleading = 12.5pt
6072
%
6073
\internalpagesizes{166mm}{120mm}{\voffset}{-8mm}{\bindingoffset}{8pt}%
6074
%
6075
\lispnarrowing = 0.2in
6076
\tolerance = 800
6077
\hfuzz = 1.2pt
6078
\contentsrightmargin = 0mm
6079
\deftypemargin = 0pt
6080
\defbodyindent = 2mm
6081
\tableindent = 12mm
6082
%
6083
\smallenvironments
6084
}}
6085
6086
% A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
6087
% 29mm, hence bottom margin 28mm, nominal side margin 3cm.
6088
\def\afourlatex{{\globaldefs = 1
6089
\textleading = 13.6pt
6090
%
6091
\afourpaper
6092
\internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}%
6093
}}
6094
6095
% Use @afourwide to print on European A4 paper in wide format.
6096
\def\afourwide{%
6097
\afourpaper
6098
\internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}%
6099
}
6100
6101
% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6102
% Perhaps we should allow setting the margins, \topskip, \parskip,
6103
% and/or leading, also. Or perhaps we should compute them somehow.
6104
%
6105
\def\pagesizes{\parsearg\pagesizesxxx}
6106
\def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6107
\def\pagesizesyyy#1,#2,#3\finish{{%
6108
\setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6109
\globaldefs = 1
6110
%
6111
\parskip = 3pt plus 2pt minus 1pt
6112
\setleading{\textleading}%
6113
%
6114
\internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}%
6115
}}
6116
6117
% Set default to letter.
6118
%
6119
\letterpaper
6120
6121
6122
\message{and turning on texinfo input format.}
6123
6124
% Define macros to output various characters with catcode for normal text.
6125
\catcode`\"=\other
6126
\catcode`\~=\other
6127
\catcode`\^=\other
6128
\catcode`\_=\other
6129
\catcode`\|=\other
6130
\catcode`\<=\other
6131
\catcode`\>=\other
6132
\catcode`\+=\other
6133
\catcode`\$=\other
6134
\def\normaldoublequote{"}
6135
\def\normaltilde{~}
6136
\def\normalcaret{^}
6137
\def\normalunderscore{_}
6138
\def\normalverticalbar{|}
6139
\def\normalless{<}
6140
\def\normalgreater{>}
6141
\def\normalplus{+}
6142
\def\normaldollar{$}
6143
6144
% This macro is used to make a character print one way in ttfont
6145
% where it can probably just be output, and another way in other fonts,
6146
% where something hairier probably needs to be done.
6147
%
6148
% #1 is what to print if we are indeed using \tt; #2 is what to print
6149
% otherwise. Since all the Computer Modern typewriter fonts have zero
6150
% interword stretch (and shrink), and it is reasonable to expect all
6151
% typewriter fonts to have this, we can check that font parameter.
6152
%
6153
\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6154
6155
% Same as above, but check for italic font. Actually this also catches
6156
% non-italic slanted fonts since it is impossible to distinguish them from
6157
% italic fonts. But since this is only used by $ and it uses \sl anyway
6158
% this is not a problem.
6159
\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6160
6161
% Turn off all special characters except @
6162
% (and those which the user can use as if they were ordinary).
6163
% Most of these we simply print from the \tt font, but for some, we can
6164
% use math or other variants that look better in normal text.
6165
6166
\catcode`\"=\active
6167
\def\activedoublequote{{\tt\char34}}
6168
\let"=\activedoublequote
6169
\catcode`\~=\active
6170
\def~{{\tt\char126}}
6171
\chardef\hat=`\^
6172
\catcode`\^=\active
6173
\def^{{\tt \hat}}
6174
6175
\catcode`\_=\active
6176
\def_{\ifusingtt\normalunderscore\_}
6177
% Subroutine for the previous macro.
6178
\def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
6179
6180
\catcode`\|=\active
6181
\def|{{\tt\char124}}
6182
\chardef \less=`\<
6183
\catcode`\<=\active
6184
\def<{{\tt \less}}
6185
\chardef \gtr=`\>
6186
\catcode`\>=\active
6187
\def>{{\tt \gtr}}
6188
\catcode`\+=\active
6189
\def+{{\tt \char 43}}
6190
\catcode`\$=\active
6191
\def${\ifusingit{{\sl\$}}\normaldollar}
6192
%\catcode 27=\active
6193
%\def^^[{$\diamondsuit$}
6194
6195
% Set up an active definition for =, but don't enable it most of the time.
6196
{\catcode`\==\active
6197
\global\def={{\tt \char 61}}}
6198
6199
\catcode`+=\active
6200
\catcode`\_=\active
6201
6202
% If a .fmt file is being used, characters that might appear in a file
6203
% name cannot be active until we have parsed the command line.
6204
% So turn them off again, and have \everyjob (or @setfilename) turn them on.
6205
% \otherifyactive is called near the end of this file.
6206
\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6207
6208
\catcode`\@=0
6209
6210
% \rawbackslashxx output one backslash character in current font
6211
\global\chardef\rawbackslashxx=`\\
6212
%{\catcode`\\=\other
6213
%@gdef@rawbackslashxx{\}}
6214
6215
% \rawbackslash redefines \ as input to do \rawbackslashxx.
6216
{\catcode`\\=\active
6217
@gdef@rawbackslash{@let\=@rawbackslashxx }}
6218
6219
% \normalbackslash outputs one backslash in fixed width font.
6220
\def\normalbackslash{{\tt\rawbackslashxx}}
6221
6222
% \catcode 17=0 % Define control-q
6223
\catcode`\\=\active
6224
6225
% Used sometimes to turn off (effectively) the active characters
6226
% even after parsing them.
6227
@def@turnoffactive{@let"=@normaldoublequote
6228
@let\=@realbackslash
6229
@let~=@normaltilde
6230
@let^=@normalcaret
6231
@let_=@normalunderscore
6232
@let|=@normalverticalbar
6233
@let<=@normalless
6234
@let>=@normalgreater
6235
@let+=@normalplus
6236
@let$=@normaldollar}
6237
6238
@def@normalturnoffactive{@let"=@normaldoublequote
6239
@let\=@normalbackslash
6240
@let~=@normaltilde
6241
@let^=@normalcaret
6242
@let_=@normalunderscore
6243
@let|=@normalverticalbar
6244
@let<=@normalless
6245
@let>=@normalgreater
6246
@let+=@normalplus
6247
@let$=@normaldollar}
6248
6249
% Make _ and + \other characters, temporarily.
6250
% This is canceled by @fixbackslash.
6251
@otherifyactive
6252
6253
% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6254
% That is what \eatinput is for; after that, the `\' should revert to printing
6255
% a backslash.
6256
%
6257
@gdef@eatinput input texinfo{@fixbackslash}
6258
@global@let\ = @eatinput
6259
6260
% On the other hand, perhaps the file did not have a `\input texinfo'. Then
6261
% the first `\{ in the file would cause an error. This macro tries to fix
6262
% that, assuming it is called before the first `\' could plausibly occur.
6263
% Also back turn on active characters that might appear in the input
6264
% file name, in case not using a pre-dumped format.
6265
%
6266
@gdef@fixbackslash{%
6267
@ifx\@eatinput @let\ = @normalbackslash @fi
6268
@catcode`+=@active
6269
@catcode`@_=@active
6270
}
6271
6272
% Say @foo, not \foo, in error messages.
6273
@escapechar = `@@
6274
6275
% These look ok in all fonts, so just make them not special.
6276
@catcode`@& = @other
6277
@catcode`@# = @other
6278
@catcode`@% = @other
6279
6280
@c Set initial fonts.
6281
@textfonts
6282
@rm
6283
6284
6285
@c Local variables:
6286
@c eval: (add-hook 'write-file-hooks 'time-stamp)
6287
@c page-delimiter: "^\\\\message"
6288
@c time-stamp-start: "def\\\\texinfoversion{"
6289
@c time-stamp-format: "%:y-%02m-%02d.%02H"
6290
@c time-stamp-end: "}"
6291
@c End:
Loggerhead is a web-based interface for Breezy
Version: 2.0.1