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