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