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